170 ifc check via ids by Cudok · Pull Request #809 · BIM2SIM/bim2sim

Cudok · 2025-06-10T10:24:17Z

implementation of ifc check include IDS support

Idea: have an eye an the status of this issue with ifcTester

is working

and add underscore to file path

hopefully the integration test are running

not possible to use, because sim_settings are not part of the base sim_settings

to resolve the dependencies of the PluginIFCCheck the ifccheck task is moved to a new group this group should deal with preprocessing of ifc files

and implementation for ids check

and implemented vor report summary_prop

into other test functions

veronikarichter

Thanks for the revision! Some points remain. Please also consider reformatting the files for a maximum line length of 79 characters and double check spacing and indentation.

veronikarichter · 2026-03-02T08:31:52Z

bim2sim/plugins/PluginIFCCheck/bim2sim_ifccheck/__init__.py

+Holds a plugin with only base tasks mostly for demonstration.
+"""
+from bim2sim.plugins import Plugin
+from bim2sim.tasks import prepro, common, bps


Please rather use a more common name instead prepro, either 'preprocessing' or something like 'check', since the ifc check is not really a preprocessing (it does not modify the data) but just a preliminary check.

Also, the import of 'bps' is obsolete. Please remove.

veronikarichter · 2026-03-02T08:32:31Z

bim2sim/plugins/PluginIFCCheck/bim2sim_ifccheck/__init__.py

+"""
+from bim2sim.plugins import Plugin
+from bim2sim.tasks import prepro, common, bps
+from bim2sim.sim_settings import BuildingSimSettings


Suggested change

from bim2sim.sim_settings import BuildingSimSettings

not used.

veronikarichter · 2026-03-02T08:38:45Z

bim2sim/plugins/PluginIFCCheck/bim2sim_ifccheck/sim_settings.py

+        mandatory=False  # TODO make is mandatory AND
+        # adapt all tests and examples AND
+        # remove default values in check_ifc.py


Is there a reason why this is not yet set to mandatory? Since the IFC check is now a separate plugin, the IDS check could be set to mandatory.
In some cases, an IDS check may not be applicable. Could you add a sim_setting if the IFC Check should be executed with or without the IDS checking part? If there is a separate sim_setting to enable the IDS functionality, it may be feasible to keep mandatory=False here.

veronikarichter · 2026-03-02T08:50:32Z

bim2sim/plugins/PluginIFCCheck/test/regression/test_ifccheck.py

+        # xpaths to elements in html
+        # fail percent (unique)
+        xpath_fail_perc = '//div[@class="fail percent"]'
+        # create function for xpath generation
+        xpath_ids_var = Gen_xpath(
+                xpath_incl_var = ('//p/span[@class="item" and ' +
+                                  'contains(normalize-space(.),"{}")]/ strong[{}]'))
+
+        # Specifications passed
+        xpath_spec_pass = xpath_ids_var.gen_xpath_name_pos("Specifications passed", 1)
+        # Specifications total
+        xpath_spec_total = xpath_ids_var.gen_xpath_name_pos("Specifications passed", 2)
+        # Requirements passed
+        xpath_req_pass = xpath_ids_var.gen_xpath_name_pos("Requirements passed", 1)
+        # Requirements total
+        xpath_req_total = xpath_ids_var.gen_xpath_name_pos("Requirements passed", 2)
+        # Checks passed
+        xpath_checks_pass = xpath_ids_var.gen_xpath_name_pos("Checks passed", 1)
+        # Checks total
+        xpath_checks_total = xpath_ids_var.gen_xpath_name_pos("Checks passed", 2)
+
+        self.xpaths = [
+            xpath_fail_perc,
+            xpath_spec_pass, xpath_spec_total,
+            xpath_req_pass, xpath_req_total,
+            xpath_checks_pass, xpath_checks_total]
+
+        reg_result = self.run_regression_test()
+
+        self.assertTrue(reg_result[0], "Comparison of the ifc tester " +
+                        "html reports (IDS) fails. " +
+                        "expected: {} ".format(reg_result[1]) +
+                        "test: {}".format(reg_result[2]))


In my opinion this is still to complicated for a generalized regression test. If I would need to add another regression test for either the ifctester, the summary_prop, the summary_inst or the summary, I would need to write additional full tests which are prone to errors. I assume the structure of the html-result files won't chance across example files (e.g., if I would try to setup another regression test for the DigitalHub), but I would still need to write a quite lenghty test (instead of applying a evaluate_summary function or similar).

You can still decide to keep it like it is, but in my opinion its too hard to handle and adapt to other test cases.

veronikarichter · 2026-03-02T08:50:53Z

bim2sim/plugins/PluginIFCCheck/test/regression/test_ifccheck.py

+
+    def test_run_ifc_check_fzk_haus_sum_prop(self):
+        """Run IFCCheck regression test with AC20-FZK-Haus.ifc
+           checking the html report "summary_prop" generated


What is summary_prop? please clarify.

veronikarichter · 2026-03-02T13:37:41Z