Glassvision/IfcOpenShell
1
0
Fork 0
mirror of https://github.com/IfcOpenShell/IfcOpenShell.git synced 2026-09-12 06:32:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Implement optionality in IfcTester, and generate integration testcases

Browse Source
This commit is contained in:
Dion Moult
2022-09-13 19:50:51 +10:00
parent fc0b0ca188
commit 422cc4802c
5 changed files with 405 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ifctester/test/ids_doc_generator.py
+142 -23
View File
@@ -24,27 +24,21 @@ import functools
import ifcopenshell
import ifctester
import test_facet
import test_ids
from xml.dom.minidom import parseString
from ifctester import ids
from ifcopenshell import validate
outdir = "build"
class StableUUIDGenerator:
file = None
@classmethod
def generate(cls):
ns = uuid.UUID('b59aa156-82a4-4b4c-a6e5-3d04a0236af9')
if cls.file:
return ifcopenshell.guid.compress(uuid.uuid5(ns, str(cls.file.wrapped_data.getMaxId())).hex)
return ifcopenshell.guid.compress(uuid.uuid4().hex)
# Just for aesthetics so we don't keep on getting brand new GlobalIds on each generation
ifcopenshell.guid.new = StableUUIDGenerator.generate
def regenerate_guids(ifc):
ns = uuid.UUID("b59aa156-82a4-4b4c-a6e5-3d04a0236af9")
for element in ifc.by_type("IfcRoot"):
element.GlobalId = ifcopenshell.guid.compress(uuid.uuid5(ns, str(element.id())).hex)
class DocGenerator:
class FacetDocGenerator:
def __init__(self):
self.facet = None
self.testcases = {}
@@ -55,12 +49,13 @@ class DocGenerator:
result = "pass" if expected is True else "fail"
f = inst.wrapped_data.file
StableUUIDGenerator.file = f
ifc = inst.wrapped_data.file
if "GlobalId" not in name:
regenerate_guids(ifc)
# Validate the file created and loop over the issues, fixing them one by one.
l = validate.json_logger()
validate.validate(f, l)
validate.validate(ifc, l)
for issue in l.statements:
if "GlobalId" in issue["message"]:
issue["instance"].GlobalId = ifcopenshell.guid.new()
@@ -68,17 +63,17 @@ class DocGenerator:
ty = re.findall("\\(.+?\\)", issue["message"])[0][1:-1].split(", ")[0]
issue["instance"].PredefinedType = ty
elif "IfcMaterialList" in issue["message"]:
issue["instance"].Materials = [f.createIfcMaterial("Concrete", None, "CONCRETE")]
issue["instance"].Materials = [ifc.createIfcMaterial("Concrete", None, "CONCRETE")]
else:
raise Exception("About to emit invalid example data:", issue)
# ifc_text = "\n".join([f"{e} /* Testcase */" if e == inst else str(e) for e in f])
lines = f.wrapped_data.to_string().split("\n")[7:-3]
lines = ifc.wrapped_data.to_string().split("\n")[7:-3]
ifc_text = "\n".join([f"{l} /* Testcase */" if f"#{inst.id()}=" in l else l for l in lines])
basename = f"{result}-" + re.sub("[^0-9a-zA-Z]", "_", name.lower())
# Write IFC to disk
f.write(os.path.join(outdir, "testcases", self.facet, f"{basename}.ifc"))
ifc.write(os.path.join(outdir, "testcases", self.facet, f"{basename}.ifc"))
# Create an IDS with the applicability selecting exactly
# the entity type passed to us in `inst`.
@@ -112,8 +107,73 @@ class DocGenerator:
self.facet = facet
test_facet.run = DocGenerator()
class IdsDocGenerator:
def __init__(self):
self.testcases = []
def __call__(self, name, ids, ifc, expected, applicable_entities=[], failed_entities=[]):
ids.validate(ifc)
all_applicable = set()
all_failures = set()
for spec in ids.specifications:
assert spec.status is expected
all_applicable.update(spec.applicable_entities)
for requirement in spec.requirements:
if requirement.status is False:
all_failures.update(requirement.failed_entities)
assert set(all_applicable) == set(applicable_entities)
assert set(all_failures) == set(failed_entities)
result = "pass" if expected is True else "fail"
regenerate_guids(ifc)
l = validate.json_logger()
validate.validate(ifc, l)
for issue in l.statements:
raise Exception("About to emit invalid example data:", issue)
lines = ifc.wrapped_data.to_string().split("\n")[7:-3]
ifc_text = ""
for i, line in enumerate(lines):
step_id = int(line[1 : line.index("=")])
element = ifc.by_id(step_id)
newline = "" if i == 0 else "\n"
if element in applicable_entities:
pass_or_fail = "FAIL" if element in failed_entities else "PASS"
ifc_text += f"{newline}[{pass_or_fail}] {line}"
else:
ifc_text += f"{newline} {line}"
basename = f"{result}-" + re.sub("[^0-9a-zA-Z]", "_", name.lower())
# Write IFC to disk
ifc.write(os.path.join(outdir, "testcases", "ids", f"{basename}.ifc"))
# Write IDS to disk
with open(os.path.join(outdir, "testcases", "ids", f"{basename}.ids"), "w", encoding="utf-8") as ids_file:
ids_file.write(ids.to_string())
reports = []
for spec in ids.specifications:
report = {"applicability": [], "requirements": [], "usage": spec.get_usage(), "status": spec.status}
for facet in spec.applicability:
report["applicability"].append(facet.to_string("applicability"))
for facet in spec.requirements:
report["requirements"].append(
{"status": facet.status, "text": facet.to_string("requirement"), "usage": facet.get_usage()}
)
reports.append(report)
xml_text = "\n".join([l[4:] for l in ids.to_string().split("\n")[4:-1]]).replace("\t", " ")
self.testcases.append(
{"name": name, "ids": xml_text, "ifc": ifc_text, "basename": basename, "result": result, "reports": reports}
)
test_facet.run = FacetDocGenerator()
test_facet.set_facet = test_facet.run.set_facet
test_ids.run = IdsDocGenerator()
pytest.main(["-p", "no:pytest-blender"])
@@ -142,6 +202,42 @@ for facet, testcases in test_facet.run.testcases.items():
)
write()
with open(os.path.join(outdir, f"testcases-ids.md"), "w") as f:
write = functools.partial(print, file=f)
write(f"# IDS integration testcases")
write()
write(
"These testcases are designed to help describe behaviour in edge cases and ambiguities. All valid IDS implementations must demonstrate identical behaviour to these test cases."
)
write()
for testcase in test_ids.run.testcases:
write(f"## [{testcase['result'].upper()}] {testcase['name']}")
write()
write("~~~xml")
write(testcase["ids"])
write("~~~")
write()
write("~~~lua")
write(testcase["ifc"])
write("~~~")
write()
for report in testcase["reports"]:
write("```")
icon = "✔️" if report["status"] else "❌"
write(f"# {icon} Specification ({report['usage']})")
write("Applies to:")
for facet in report["applicability"]:
write(f" - {facet}")
write("Requirements:")
for facet in report["requirements"]:
icon = "✔️" if facet["status"] else "❌"
write(f" - {icon} {facet['text']} ({facet['usage']})")
write("```")
write()
write(
f"[Sample IDS](testcases/ids/{testcase['basename']}.ids) - [Sample IFC](testcases/ids/{testcase['basename']}.ifc)"
)
write()
specs = ifctester.ids.Ids(
title="buildingSMART Sample IDS",
@@ -153,15 +249,38 @@ specs = ifctester.ids.Ids(
purpose="Contractual requirements",
)
spec = ifctester.ids.Specification(name="Project naming", ifcVersion=["IFC4"], description="Projects shall be named correctly for the purposes of identification, project archival, and model federation.", instructions="Each discipline is responsible for naming their own project.")
spec = ifctester.ids.Specification(
name="Project naming",
ifcVersion=["IFC4"],
description="Projects shall be named correctly for the purposes of identification, project archival, and model federation.",
instructions="Each discipline is responsible for naming their own project.",
)
specs.specifications.append(spec)
spec.applicability.append(ifctester.ids.Entity(name="IFCPROJECT"))
spec.requirements.append(ifctester.ids.Attribute(name="Name", value="TEST", instructions="The project manager shall confirm the short project code with the client based on their real estate portfolio naming scheme."))
spec.requirements.append(
ifctester.ids.Attribute(
name="Name",
value="TEST",
instructions="The project manager shall confirm the short project code with the client based on their real estate portfolio naming scheme.",
)
)
spec = ifctester.ids.Specification(name="Fire rating", ifcVersion=["IFC4"], description="All objects must have a fire rating for building compliance checks and to know the protection strategies needed for any penetrations.", instructions="The architect is responsible for including this data.")
spec = ifctester.ids.Specification(
name="Fire rating",
ifcVersion=["IFC4"],
description="All objects must have a fire rating for building compliance checks and to know the protection strategies needed for any penetrations.",
instructions="The architect is responsible for including this data.",
)
specs.specifications.append(spec)
spec.applicability.append(ifctester.ids.Entity(name="IFCWALLTYPE"))
restriction = ifctester.ids.Restriction(options="(-|[0-9]{2,3})\/(-|[0-9]{2,3})\/(-|[0-9]{2,3})", type="pattern")
spec.requirements.append(ifctester.ids.Property(propertySet="Pset_WallCommon", name="FireRating", value=restriction, instructions="Fire rating is specified using the Fire Resistance Level as defined in the Australian National Construction Code (NCC) 2019. Valid examples include -/-/-, -/120/120, and 60/60/60"))
spec.requirements.append(
ifctester.ids.Property(
propertySet="Pset_WallCommon",
name="FireRating",
value=restriction,
instructions="Fire rating is specified using the Fire Resistance Level as defined in the Australian National Construction Code (NCC) 2019. Valid examples include -/-/-, -/120/120, and 60/60/60",
)
)
specs.to_xml(os.path.join(outdir, "library", "sample.ids"))