feat: bom-refs for known models

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

cyclonedx/model/contact.py

@@ -24,7 +24,7 @@
 
 from .._internal.bom_ref import bom_ref_from_str as _bom_ref_from_str
 from .._internal.compare import ComparableTuple as _ComparableTuple
-from ..schema.schema import SchemaVersion1Dot6
+from ..schema.schema import SchemaVersion1Dot6, SchemaVersion1Dot5
 from . import XsUri
 from .bom_ref import BomRef
 
@@ -49,7 +49,7 @@ def __init__(
         postal_code: Optional[str] = None,
         street_address: Optional[str] = None,
     ) -> None:
-        self._bom_ref = _bom_ref_from_str(bom_ref, optional=True)
+        self._bom_ref = _bom_ref_from_str(bom_ref)
         self.country = country
         self.region = region
         self.locality = locality
@@ -58,11 +58,11 @@ def __init__(
         self.street_address = street_address
 
     @property
-    @serializable.json_name('bom-ref')
     @serializable.type_mapping(BomRef)
     @serializable.xml_attribute()
     @serializable.xml_name('bom-ref')
-    def bom_ref(self) -> Optional[BomRef]:
+    @serializable.json_name('bom-ref')
+    def bom_ref(self) -> 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.
@@ -199,14 +199,33 @@ class OrganizationalContact:
 
     def __init__(
         self, *,
+        bom_ref: Optional[Union[str, BomRef]] = None,
         name: Optional[str] = None,
         phone: Optional[str] = None,
         email: Optional[str] = None,
     ) -> None:
+        self._bom_ref = _bom_ref_from_str(bom_ref)
         self.name = name
         self.email = email
         self.phone = phone
 
+    @property
+    @serializable.view(SchemaVersion1Dot5)
+    @serializable.view(SchemaVersion1Dot6)
+    @serializable.type_mapping(BomRef)
+    @serializable.xml_attribute()
+    @serializable.xml_name('bom-ref')
+    @serializable.json_name('bom-ref')
+    def bom_ref(self) -> 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(1)
     @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
@@ -257,7 +276,8 @@ def phone(self, phone: Optional[str]) -> None:
 
     def __comparable_tuple(self) -> _ComparableTuple:
         return _ComparableTuple((
-            self.name, self.email, self.phone
+            self.name, self.email, self.phone,
+            self.bom_ref
         ))
 
     def __eq__(self, other: object) -> bool:
@@ -289,16 +309,35 @@ 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_from_str(bom_ref)
         self.name = name
         self.address = address
         self.urls = urls or []
         self.contacts = contacts or []
 
+    @property
+    @serializable.view(SchemaVersion1Dot5)
+    @serializable.view(SchemaVersion1Dot6)
+    @serializable.type_mapping(BomRef)
+    @serializable.xml_attribute()
+    @serializable.xml_name('bom-ref')
+    @serializable.json_name('bom-ref')
+    def bom_ref(self) -> 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)

cyclonedx/model/definition.py

@@ -93,6 +93,9 @@ def __str__(self) -> str:
 class Requirement:
     """
     A requirement comprising a standard.
+
+    .. note::
+        See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/json/#definitions_standards_items_requirements
     """
 
     def __init__(
@@ -286,6 +289,9 @@ def __repr__(self) -> str:
 class Level:
     """
     Level of compliance for a standard.
+
+    .. note::
+        See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/json/#definitions_standards_items_levels
     """
 
     def __init__(
@@ -402,6 +408,9 @@ class Standard:
     """
     A standard of regulations, industry or organizational-specific standards, maturity models, best practices,
     or any other requirements.
+
+    .. note::
+        See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_standard
     """
 
     def __init__(

cyclonedx/model/license.py

@@ -32,8 +32,9 @@
 from .._internal.compare import ComparableTuple as _ComparableTuple
 from ..exception.model import MutuallyExclusivePropertiesException
 from ..exception.serialization import CycloneDxDeserializationException
-from ..schema.schema import SchemaVersion1Dot6
-from . import AttachedText, XsUri
+from ..schema.schema import SchemaVersion1Dot6, SchemaVersion1Dot5
+from . import AttachedText, XsUri, BomRef
+from .._internal.bom_ref import bom_ref_from_str as _bom_ref_from_str
 
 
 @serializable.serializable_enum
@@ -75,6 +76,7 @@ class DisjunctiveLicense:
 
     def __init__(
         self, *,
+        bom_ref: Optional[Union[str, BomRef]] = None,
         id: Optional[str] = None, name: Optional[str] = None,
         text: Optional[AttachedText] = None, url: Optional[XsUri] = None,
         acknowledgement: Optional[LicenseAcknowledgement] = None,
@@ -86,12 +88,31 @@ def __init__(
                 'Both `id` and `name` have been supplied - `name` will be ignored!',
                 category=RuntimeWarning, stacklevel=1
             )
+        self._bom_ref = _bom_ref_from_str(bom_ref)
         self._id = id
         self._name = name if not id else None
         self._text = text
         self._url = url
         self._acknowledgement = acknowledgement
 
+    @property
+    @serializable.view(SchemaVersion1Dot5)
+    @serializable.view(SchemaVersion1Dot6)
+    @serializable.type_mapping(BomRef)
+    @serializable.xml_attribute()
+    @serializable.xml_name('bom-ref')
+    @serializable.json_name('bom-ref')
+    def bom_ref(self) -> 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(1)
     def id(self) -> Optional[str]:
@@ -186,16 +207,6 @@ def url(self, url: Optional[XsUri]) -> None:
     # def properties(self, ...) -> None:
     #     ...  # TODO since CDX1.5
 
-    # @property
-    # @serializable.json_name('bom-ref')
-    # @serializable.type_mapping(BomRefHelper)
-    # @serializable.view(SchemaVersion1Dot5)
-    # @serializable.view(SchemaVersion1Dot6)
-    # @serializable.xml_attribute()
-    # @serializable.xml_name('bom-ref')
-    # def bom_ref(self) -> BomRef:
-    #     ...  # TODO since CDX1.5
-
     @property
     @serializable.view(SchemaVersion1Dot6)
     @serializable.xml_attribute()
@@ -227,6 +238,7 @@ def __comparable_tuple(self) -> _ComparableTuple:
             self._id, self._name,
             self._url,
             self._text,
+            self._bom_ref,
         ))
 
     def __eq__(self, other: object) -> bool:
@@ -264,11 +276,31 @@ class LicenseExpression:
 
     def __init__(
         self, value: str, *,
+        bom_ref: Optional[Union[str, BomRef]] = None,
         acknowledgement: Optional[LicenseAcknowledgement] = None,
     ) -> None:
+        self._bom_ref = _bom_ref_from_str(bom_ref)
         self._value = value
         self._acknowledgement = acknowledgement
 
+    @property
+    @serializable.view(SchemaVersion1Dot5)
+    @serializable.view(SchemaVersion1Dot6)
+    @serializable.type_mapping(BomRef)
+    @serializable.xml_attribute()
+    @serializable.xml_name('bom-ref')
+    @serializable.json_name('bom-ref')
+    def bom_ref(self) -> 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_name('.')
     @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING)
@@ -286,16 +318,6 @@ def value(self) -> str:
     def value(self, value: str) -> None:
         self._value = value
 
-    # @property
-    # @serializable.json_name('bom-ref')
-    # @serializable.type_mapping(BomRefHelper)
-    # @serializable.view(SchemaVersion1Dot5)
-    # @serializable.view(SchemaVersion1Dot6)
-    # @serializable.xml_attribute()
-    # @serializable.xml_name('bom-ref')
-    # def bom_ref(self) -> BomRef:
-    #     ...  # TODO since CDX1.5
-
     @property
     @serializable.view(SchemaVersion1Dot6)
     @serializable.xml_attribute()
@@ -325,6 +347,7 @@ def __comparable_tuple(self) -> _ComparableTuple:
         return _ComparableTuple((
             self._acknowledgement,
             self._value,
+            self.bom_ref,
         ))
 
     def __hash__(self) -> int:

cyclonedx/model/lifecycle.py

@@ -64,7 +64,8 @@ class PredefinedLifecycle:
     Object that defines pre-defined phases in the product lifecycle.
 
     .. note::
-        See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#metadata_lifecycles
+        See the CycloneDX Schema definition:
+        https://cyclonedx.org/docs/1.6/json/#tab-pane_metadata_lifecycles_items_oneOf_i0
     """
 
     def __init__(self, phase: LifecyclePhase) -> None:
@@ -103,7 +104,8 @@ class NamedLifecycle:
     Object that defines custom state in the product lifecycle.
 
     .. note::
-        See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#metadata_lifecycles
+        See the CycloneDX Schema definition:
+        https://cyclonedx.org/docs/1.6/json/#tab-pane_metadata_lifecycles_items_oneOf_i1
     """
 
     def __init__(self, name: str, *, description: Optional[str] = None) -> None: