feat: add bom_ref to OrganizationalEntity

Signed-off-by: yowgf <[email protected]>

Author: Yowgf

cyclonedx/model/contact.py

@@ -288,16 +288,33 @@ class OrganizationalEntity:
 
     def __init__(
         self, *,
+        bom_ref: Optional[Union[str, BomRef]] = None,
         name: Optional[str] = None,
         urls: Optional[Iterable[XsUri]] = None,
         contacts: Optional[Iterable[OrganizationalContact]] = None,
         address: Optional[PostalAddress] = None,
     ) -> None:
+        self._bom_ref = bom_ref
         self.name = name
         self.address = address
         self.urls = urls or []  # type:ignore[assignment]
         self.contacts = contacts or []  # type:ignore[assignment]
 
+    @property
+    @serializable.json_name('bom-ref')
+    @serializable.type_mapping(BomRef)
+    @serializable.xml_attribute()
+    @serializable.xml_name('bom-ref')
+    def bom_ref(self) -> Optional[BomRef]:
+        """
+        An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref MUST be
+        unique within the BOM.
+
+        Returns:
+            `BomRef`
+        """
+        return self._bom_ref
+
     @property
     @serializable.xml_sequence(10)
     @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)

tests/test_model.py

@@ -22,6 +22,7 @@
 from uuid import UUID
 
 from ddt import ddt, named_data
+from sortedcontainers import SortedSet
 
 from cyclonedx._internal.compare import ComparableTuple
 from cyclonedx.exception.model import InvalidLocaleTypeException, InvalidUriException, UnknownHashTypeException
@@ -39,7 +40,7 @@
     XsUri,
 )
 from cyclonedx.model.bom_ref import BomRef
-from cyclonedx.model.contact import OrganizationalContact
+from cyclonedx.model.contact import OrganizationalContact, OrganizationalEntity, PostalAddress
 from cyclonedx.model.issue import IssueClassification, IssueType, IssueTypeSource
 from tests import reorder
 
@@ -463,6 +464,53 @@ def test_sort(self) -> None:
         self.assertListEqual(sorted_contacts, expected_contacts)
 
 
+class TestModelOrganizationalEntity(TestCase):
+    def test_init_with_bom_ref(self) -> None:
+        contacts = [
+            OrganizationalContact(name='a', email='a', phone='a'),
+            OrganizationalContact(name='b', email='a', phone='a'),
+        ]
+        OrganizationalEntity(
+            bom_ref=BomRef('dummy-bom-ref'),
+            name='dummy-organizational-entity',
+            contacts=contacts,
+            address=PostalAddress(
+                country='dummy-country',
+                region='dummy-region',
+            ),
+        )
+
+    def test_init_without_bom_ref(self) -> None:
+        contacts = [
+            OrganizationalContact(name='a', email='a', phone='a'),
+            OrganizationalContact(name='b', email='a', phone='a'),
+        ]
+        OrganizationalEntity(
+            name='dummy-organizational-entity',
+            contacts=contacts,
+            address=PostalAddress(
+                country='dummy-country',
+                region='dummy-region',
+            ),
+        )
+
+    def test_init_from_json(self) -> None:
+        bom_ref = 'Example'
+        name = 'Example'
+        urls = [
+            'https://example.com/'
+        ]
+        specification = {
+            'name': name,
+            'url': urls,
+            'bom-ref': bom_ref
+        }
+        entity = OrganizationalEntity.from_json(specification)
+        assert entity.name == name
+        assert entity.urls == SortedSet([XsUri(url) for url in urls])
+        assert entity.bom_ref == BomRef(bom_ref)
+
+
 class TestModelXsUri(TestCase):
 
     # URI samples taken from http://www.datypic.com/sc/xsd/t-xsd_anyURI.html