Add support for null attributes for people, roles, and addresses. New prototoype testable architecture. See #1711.

src/blenderbim/test/tool/__init__.py

@@ -0,0 +1,17 @@
+# BlenderBIM Add-on - OpenBIM Blender Add-on
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of BlenderBIM Add-on.
+#
+# BlenderBIM Add-on is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# BlenderBIM Add-on is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.

src/blenderbim/test/tool/test_address_editor.py

@@ -0,0 +1,197 @@
+# BlenderBIM Add-on - OpenBIM Blender Add-on
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of BlenderBIM Add-on.
+#
+# BlenderBIM Add-on is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# BlenderBIM Add-on is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
+
+import bpy
+import ifcopenshell
+import test.bim.bootstrap
+import blenderbim.core.tool
+import blenderbim.tool as tool
+from blenderbim.tool.address_editor import AddressEditor as subject
+
+
+class TestImplementsTool(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        assert isinstance(subject(), blenderbim.core.tool.AddressEditor)
+
+
+class TestSetAddress(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        ifc = ifcopenshell.file()
+        address = ifc.createIfcPostalAddress()
+        subject().set_address(address)
+        assert bpy.context.scene.BIMOwnerProperties.active_address_id == address.id()
+
+
+class TestImportAttributes(test.bim.bootstrap.NewFile):
+    def test_importing_a_postal_address(self):
+        ifc = ifcopenshell.file()
+        tool.Ifc().set(ifc)
+        address = ifc.createIfcPostalAddress()
+        address.Purpose = "USERDEFINED"
+        address.Description = "Description"
+        address.UserDefinedPurpose = "UserDefinedPurpose"
+        address.InternalLocation = "InternalLocation"
+        address.AddressLines = ["Address", "Lines"]
+        address.PostalBox = "PostalBox"
+        address.Town = "Town"
+        address.Region = "Region"
+        address.PostalCode = "PostalCode"
+        address.Country = "Country"
+        subject().set_address(address)
+        subject().import_attributes()
+        props = bpy.context.scene.BIMOwnerProperties
+        assert props.address_attributes.get("Purpose").enum_value == "USERDEFINED"
+        assert props.address_attributes.get("Description").string_value == "Description"
+        assert props.address_attributes.get("UserDefinedPurpose").string_value == "UserDefinedPurpose"
+        assert props.address_attributes.get("InternalLocation").string_value == "InternalLocation"
+        assert props.address_attributes.get("PostalBox").string_value == "PostalBox"
+        assert props.address_attributes.get("Town").string_value == "Town"
+        assert props.address_attributes.get("Region").string_value == "Region"
+        assert props.address_attributes.get("PostalCode").string_value == "PostalCode"
+        assert props.address_attributes.get("Country").string_value == "Country"
+        assert len(props.address_lines) == 2
+        assert props.address_lines[0].name == "Address"
+        assert props.address_lines[1].name == "Lines"
+
+    def test_importing_a_postal_address_twice(self):
+        self.test_importing_a_postal_address()
+        ifc = tool.Ifc().get()
+        address = ifc.createIfcPostalAddress()
+        address.Purpose = "OFFICE"
+        subject().set_address(address)
+        subject().import_attributes()
+        props = bpy.context.scene.BIMOwnerProperties
+        assert props.address_attributes.get("Purpose").enum_value == "OFFICE"
+        assert len(props.address_lines) == 0
+
+    def test_importing_a_telecom_address(self):
+        ifc = ifcopenshell.file()
+        tool.Ifc().set(ifc)
+        address = ifc.createIfcTelecomAddress()
+        address.Purpose = "USERDEFINED"
+        address.Description = "Description"
+        address.UserDefinedPurpose = "UserDefinedPurpose"
+        address.TelephoneNumbers = ["Telephone", "Numbers"]
+        address.FacsimileNumbers = ["Facsimile", "Numbers"]
+        address.PagerNumber = "PagerNumber"
+        address.ElectronicMailAddresses = ["Electronic", "Mail", "Addresses"]
+        address.WWWHomePageURL = "WWWHomePageURL"
+        address.MessagingIDs = ["Messaging", "IDs"]
+        subject().set_address(address)
+        subject().import_attributes()
+        props = bpy.context.scene.BIMOwnerProperties
+        assert props.address_attributes.get("Purpose").enum_value == "USERDEFINED"
+        assert props.address_attributes.get("Description").string_value == "Description"
+        assert props.address_attributes.get("UserDefinedPurpose").string_value == "UserDefinedPurpose"
+        assert [a.name for a in props.telephone_numbers] == ["Telephone", "Numbers"]
+        assert [a.name for a in props.facsimile_numbers] == ["Facsimile", "Numbers"]
+        assert [a.name for a in props.electronic_mail_addresses] == ["Electronic", "Mail", "Addresses"]
+        assert [a.name for a in props.messaging_ids] == ["Messaging", "IDs"]
+
+    def test_importing_a_telecom_address_twice(self):
+        self.test_importing_a_telecom_address()
+        ifc = tool.Ifc().get()
+        address = ifc.createIfcTelecomAddress()
+        address.Purpose = "OFFICE"
+        subject().set_address(address)
+        subject().import_attributes()
+        props = bpy.context.scene.BIMOwnerProperties
+        assert props.address_attributes.get("Purpose").enum_value == "OFFICE"
+        assert len(props.telephone_numbers) == 0
+        assert len(props.facsimile_numbers) == 0
+        assert len(props.electronic_mail_addresses) == 0
+        assert len(props.messaging_ids) == 0
+
+
+class TestClearAddress(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        ifc = ifcopenshell.file()
+        address = ifc.createIfcPostalAddress()
+        subject().set_address(address)
+        subject().clear_address()
+        assert bpy.context.scene.BIMOwnerProperties.active_address_id == 0
+
+
+class TestGetAddress(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        ifc = ifcopenshell.file()
+        tool.Ifc().set(ifc)
+        address = ifc.createIfcPostalAddress()
+        subject().set_address(address)
+        assert subject().get_address() == address
+
+
+class TestExportAttributes(test.bim.bootstrap.NewFile):
+    def test_exporting_a_postal_address(self):
+        TestImportAttributes().test_importing_a_postal_address()
+        assert subject().export_attributes() == {
+            "Purpose": "USERDEFINED",
+            "Description": "Description",
+            "UserDefinedPurpose": "UserDefinedPurpose",
+            "InternalLocation": "InternalLocation",
+            "AddressLines": ["Address", "Lines"],
+            "PostalBox": "PostalBox",
+            "Town": "Town",
+            "Region": "Region",
+            "PostalCode": "PostalCode",
+            "Country": "Country",
+        }
+
+    def test_exporting_a_telecom_address(self):
+        TestImportAttributes().test_importing_a_telecom_address()
+        assert subject().export_attributes() == {
+            "Purpose": "USERDEFINED",
+            "Description": "Description",
+            "UserDefinedPurpose": "UserDefinedPurpose",
+            "TelephoneNumbers": ["Telephone", "Numbers"],
+            "FacsimileNumbers": ["Facsimile", "Numbers"],
+            "PagerNumber": "PagerNumber",
+            "ElectronicMailAddresses": ["Electronic", "Mail", "Addresses"],
+            "WWWHomePageURL": "WWWHomePageURL",
+            "MessagingIDs": ["Messaging", "IDs"],
+        }
+
+
+class TestAddAttribute(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        subject().add_attribute("AddressLines")
+        subject().add_attribute("TelephoneNumbers")
+        subject().add_attribute("FacsimileNumbers")
+        subject().add_attribute("ElectronicMailAddresses")
+        subject().add_attribute("MessagingIDs")
+        props = bpy.context.scene.BIMOwnerProperties
+        assert len(props.address_lines) == 1
+        assert len(props.telephone_numbers) == 1
+        assert len(props.facsimile_numbers) == 1
+        assert len(props.electronic_mail_addresses) == 1
+        assert len(props.messaging_ids) == 1
+
+
+class TestRemoveAddress(test.bim.bootstrap.NewFile):
+    TestAddAttribute().test_run()
+    subject().remove_attribute("AddressLines", 0)
+    subject().remove_attribute("TelephoneNumbers", 0)
+    subject().remove_attribute("FacsimileNumbers", 0)
+    subject().remove_attribute("ElectronicMailAddresses", 0)
+    subject().remove_attribute("MessagingIDs", 0)
+    props = bpy.context.scene.BIMOwnerProperties
+    assert len(props.address_lines) == 0
+    assert len(props.telephone_numbers) == 0
+    assert len(props.facsimile_numbers) == 0
+    assert len(props.electronic_mail_addresses) == 0
+    assert len(props.messaging_ids) == 0

src/blenderbim/test/tool/test_blender.py

@@ -0,0 +1,17 @@
+# BlenderBIM Add-on - OpenBIM Blender Add-on
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of BlenderBIM Add-on.
+#
+# BlenderBIM Add-on is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# BlenderBIM Add-on is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.

src/blenderbim/test/tool/test_ifc.py

@@ -0,0 +1,58 @@
+# BlenderBIM Add-on - OpenBIM Blender Add-on
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of BlenderBIM Add-on.
+#
+# BlenderBIM Add-on is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# BlenderBIM Add-on is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
+
+import bpy
+import ifcopenshell
+import test.bim.bootstrap
+from blenderbim.tool import Ifc as subject
+
+
+class TestSet(test.bim.bootstrap.NewFile):
+    def test_setting_an_ifc_data(self):
+        ifc = ifcopenshell.file()
+        subject().set(ifc)
+        assert subject().get() == ifc
+
+
+class TestGet(test.bim.bootstrap.NewFile):
+    def test_getting_an_ifc_dataset_from_a_ifc_spf_filepath(self):
+        assert subject().get() is None
+        bpy.context.scene.BIMProperties.ifc_file = "test/files/basic.ifc"
+        result = subject().get()
+        assert isinstance(result, ifcopenshell.file)
+
+    def test_getting_the_active_ifc_dataset_regardless_of_ifc_path(self):
+        bpy.context.scene.BIMProperties.ifc_file = "test/files/basic.ifc"
+        ifc = ifcopenshell.file()
+        subject().set(ifc)
+        assert subject().get() == ifc
+
+
+class TestRun(test.bim.bootstrap.NewFile):
+    def test_running_a_command_on_the_active_ifc_dataset(self):
+        ifc = ifcopenshell.file()
+        subject().set(ifc)
+        wall = subject().run("root.create_entity", ifc_class="IfcWall")
+        assert subject().get().by_type("IfcWall")[0] == wall
+
+
+class TestGetSchema(test.bim.bootstrap.NewFile):
+    def test_getting_the_schema_version_identifier(self):
+        ifc = ifcopenshell.file(schema="IFC4")
+        subject().set(ifc)
+        assert subject().get_schema() == "IFC4"

src/blenderbim/test/tool/test_person_editor.py

@@ -0,0 +1,152 @@
+# BlenderBIM Add-on - OpenBIM Blender Add-on
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of BlenderBIM Add-on.
+#
+# BlenderBIM Add-on is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# BlenderBIM Add-on is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
+
+import bpy
+import ifcopenshell
+import test.bim.bootstrap
+import blenderbim.core.tool
+import blenderbim.tool as tool
+from blenderbim.tool.person_editor import PersonEditor as subject
+
+
+class TestImplementsTool(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        assert isinstance(subject(), blenderbim.core.tool.person_editor.PersonEditor)
+
+
+class TestSetPerson(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        person = ifcopenshell.file().createIfcPerson()
+        subject().set_person(person)
+        assert bpy.context.scene.BIMOwnerProperties.active_person_id == person.id()
+
+
+class TestImportAttributes(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        ifc = ifcopenshell.file()
+        tool.Ifc().set(ifc)
+        person = ifc.createIfcPerson()
+        person.Identification = "identification"
+        person.GivenName = "given_name"
+        person.FamilyName = "family_name"
+        person.MiddleNames = ("middle", "names")
+        person.PrefixTitles = ("prefix", "titles")
+        person.SuffixTitles = ("suffix", "titles")
+        subject().set_person(person)
+        subject().import_attributes()
+        props = bpy.context.scene.BIMOwnerProperties
+        assert props.person_attributes.get("Identification").string_value == "identification"
+        assert props.person_attributes.get("GivenName").string_value == "given_name"
+        assert props.person_attributes.get("FamilyName").string_value == "family_name"
+        assert len(props.middle_names) == 2
+        assert props.middle_names[0].name == "middle"
+        assert props.middle_names[1].name == "names"
+        assert len(props.prefix_titles) == 2
+        assert props.prefix_titles[0].name == "prefix"
+        assert props.prefix_titles[1].name == "titles"
+        assert len(props.suffix_titles) == 2
+        assert props.suffix_titles[0].name == "suffix"
+        assert props.suffix_titles[1].name == "titles"
+
+    def test_overwriting_a_previous_import(self):
+        ifc = ifcopenshell.file()
+        tool.Ifc().set(ifc)
+        person = ifc.createIfcPerson()
+        person.Identification = "identification"
+        person.GivenName = "given_name"
+        subject().set_person(person)
+        subject().import_attributes()
+        person.Identification = "identification2"
+        person.GivenName = None
+        subject().import_attributes()
+        props = bpy.context.scene.BIMOwnerProperties
+        assert props.person_attributes.get("Identification").string_value == "identification2"
+        assert props.person_attributes.get("GivenName").string_value == ""
+
+
+class TestClearPerson(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        props = bpy.context.scene.BIMOwnerProperties
+        props.active_person_id = 1
+        subject().clear_person()
+        assert props.active_person_id == 0
+
+
+class TestExportAttributes(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        ifc = ifcopenshell.file()
+        tool.Ifc().set(ifc)
+        person = ifc.createIfcPerson()
+        person.Identification = "identification"
+        person.GivenName = "given_name"
+        person.FamilyName = "family_name"
+        person.MiddleNames = ("middle", "names")
+        person.PrefixTitles = ("prefix", "titles")
+        person.SuffixTitles = ("suffix", "titles")
+        subject().set_person(person)
+        subject().import_attributes()
+        assert subject().export_attributes() == {
+            "Identification": "identification",
+            "GivenName": "given_name",
+            "FamilyName": "family_name",
+            "MiddleNames": ["middle", "names"],
+            "PrefixTitles": ["prefix", "titles"],
+            "SuffixTitles": ["suffix", "titles"],
+        }
+
+    def test_getting_empty_list_attributes_as_none(self):
+        ifc = ifcopenshell.file()
+        tool.Ifc().set(ifc)
+        result = subject().export_attributes()
+        assert result["MiddleNames"] is None
+        assert result["PrefixTitles"] is None
+        assert result["SuffixTitles"] is None
+
+
+class TestGetPerson(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        ifc = ifcopenshell.file()
+        tool.Ifc().set(ifc)
+        person = ifc.createIfcPerson()
+        subject().set_person(person)
+        assert subject().get_person() == person
+
+
+class TestAddAttribute(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        subject().add_attribute("MiddleNames")
+        subject().add_attribute("PrefixTitles")
+        subject().add_attribute("SuffixTitles")
+        props = bpy.context.scene.BIMOwnerProperties
+        assert len(props.middle_names) == 1
+        assert len(props.prefix_titles) == 1
+        assert len(props.suffix_titles) == 1
+
+
+class TestRemoveAttribute(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        subject().add_attribute("MiddleNames")
+        subject().remove_attribute("MiddleNames", 0)
+        subject().add_attribute("PrefixTitles")
+        subject().remove_attribute("PrefixTitles", 0)
+        subject().add_attribute("SuffixTitles")
+        subject().remove_attribute("SuffixTitles", 0)
+        props = bpy.context.scene.BIMOwnerProperties
+        assert len(props.middle_names) == 0
+        assert len(props.prefix_titles) == 0
+        assert len(props.suffix_titles) == 0

src/blenderbim/test/tool/test_role_editor.py

@@ -0,0 +1,98 @@
+# BlenderBIM Add-on - OpenBIM Blender Add-on
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of BlenderBIM Add-on.
+#
+# BlenderBIM Add-on is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# BlenderBIM Add-on is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
+
+import bpy
+import ifcopenshell
+import test.bim.bootstrap
+import blenderbim.core.tool
+import blenderbim.tool as tool
+from blenderbim.tool.role_editor import RoleEditor as subject
+
+
+class TestImplementsTool(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        assert isinstance(subject(), blenderbim.core.tool.role_editor.RoleEditor)
+
+
+class TestSetRole(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        role = ifcopenshell.file().createIfcActorRole()
+        subject().set_role(role)
+        assert bpy.context.scene.BIMOwnerProperties.active_role_id == role.id()
+
+
+class TestImportAttributes(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        ifc = ifcopenshell.file()
+        tool.Ifc().set(ifc)
+        role = ifc.createIfcActorRole()
+        role.Role = "USERDEFINED"
+        role.UserDefinedRole = "UserDefinedRole"
+        role.Description = "Description"
+        subject().set_role(role)
+        subject().import_attributes()
+        props = bpy.context.scene.BIMOwnerProperties
+        assert props.role_attributes.get("Role").enum_value == "USERDEFINED"
+        assert props.role_attributes.get("UserDefinedRole").string_value == "UserDefinedRole"
+        assert props.role_attributes.get("Description").string_value == "Description"
+
+    def test_importing_twice(self):
+        ifc = ifcopenshell.file()
+        tool.Ifc().set(ifc)
+        role = ifc.createIfcActorRole()
+        role.Role = "USERDEFINED"
+        subject().set_role(role)
+        subject().import_attributes()
+        role.Role = "ARCHITECT"
+        subject().import_attributes()
+        props = bpy.context.scene.BIMOwnerProperties
+        assert props.role_attributes.get("Role").enum_value == "ARCHITECT"
+
+
+class TestClearRole(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        role = ifcopenshell.file().createIfcActorRole()
+        subject().set_role(role)
+        subject().clear_role()
+        assert bpy.context.scene.BIMOwnerProperties.active_role_id == 0
+
+
+class TestGetRole(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        ifc = ifcopenshell.file()
+        tool.Ifc().set(ifc)
+        role = ifc.createIfcActorRole()
+        subject().set_role(role)
+        assert subject().get_role() == role
+
+
+class TestExportAttributes(test.bim.bootstrap.NewFile):
+    def test_run(self):
+        ifc = ifcopenshell.file()
+        tool.Ifc().set(ifc)
+        role = ifc.createIfcActorRole()
+        role.Role = "USERDEFINED"
+        role.UserDefinedRole = "UserDefinedRole"
+        role.Description = "Description"
+        subject().set_role(role)
+        subject().import_attributes()
+        assert subject().export_attributes() == {
+            "Role": "USERDEFINED",
+            "UserDefinedRole": "UserDefinedRole",
+            "Description": "Description",
+        }