properly added .component.swhid

Signed-off-by: Paul Horton <[email protected]>

Author: madpah

cyclonedx/exception/model.py

@@ -53,6 +53,14 @@ class InvalidOmniBorIdException(CycloneDxModelException):
     pass
 
 
+class InvalidSwhidException(CycloneDxModelException):
+    """
+    Raised when a supplied value for an Swhid does not meet the format requirements
+    as defined at https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html.
+    """
+    pass
+
+
 class InvalidUriException(CycloneDxModelException):
     """
     Raised when a `str` is provided that needs to be a valid URI, but isn't.

cyclonedx/model/component.py

@@ -27,7 +27,7 @@
 
 from .._internal.compare import ComparableTuple as _ComparableTuple
 from .._internal.hash import file_sha1sum as _file_sha1sum
-from ..exception.model import InvalidOmniBorIdException, NoPropertiesProvidedException
+from ..exception.model import InvalidOmniBorIdException, InvalidSwhidException, NoPropertiesProvidedException
 from ..exception.serialization import (
     CycloneDxDeserializationException,
     SerializationOfUnexpectedValueException,
@@ -932,6 +932,65 @@ def __str__(self) -> str:
         return self._id
 
 
+@serializable.serializable_class
+class Swhid(serializable.helpers.BaseHelper):
+    """
+    Helper class that allows us to perform validation on data strings that must conform to
+    https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html.
+
+    """
+
+    _VALID_SWHID_REGEX = re.compile(r'^swh:1:(cnp|rel|rev|dir|cnt):([0-9a-z]{40})(.*)?$')
+
+    def __init__(self, id: str) -> None:
+        if Swhid._VALID_SWHID_REGEX.match(id) is None:
+            raise InvalidSwhidException(
+                f'Supplied value "{id} does not meet format specification.'
+            )
+        self._id = id
+
+    @property
+    @serializable.json_name('.')
+    @serializable.xml_name('.')
+    def id(self) -> str:
+        return self._id
+
+    @classmethod
+    def serialize(cls, o: Any) -> str:
+        if isinstance(o, Swhid):
+            return str(o)
+        raise SerializationOfUnexpectedValueException(
+            f'Attempt to serialize a non-Swhid: {o!r}')
+
+    @classmethod
+    def deserialize(cls, o: Any) -> 'Swhid':
+        try:
+            return Swhid(id=str(o))
+        except ValueError as err:
+            raise CycloneDxDeserializationException(
+                f'Swhid string supplied does not parse: {o!r}'
+            ) from err
+
+    def __eq__(self, other: Any) -> bool:
+        if isinstance(other, Swhid):
+            return hash(other) == hash(self)
+        return False
+
+    def __lt__(self, other: Any) -> bool:
+        if isinstance(other, Swhid):
+            return self._id < other._id
+        return NotImplemented
+
+    def __hash__(self) -> int:
+        return hash(self._id)
+
+    def __repr__(self) -> str:
+        return f'<Swhid {self._id}>'
+
+    def __str__(self) -> str:
+        return self._id
+
+
 @serializable.serializable_class
 class Component(Dependable):
     """
@@ -986,7 +1045,7 @@ def __init__(self, *,
                  modified: bool = False, manufacturer: Optional[OrganizationalEntity] = None,
                  authors: Optional[Iterable[OrganizationalContact]] = None,
                  omnibor_ids: Optional[Iterable[OmniborId]] = None,
-                 # swhid: Optional[Iterable[str]] = None,
+                 swhids: Optional[Iterable[Swhid]] = None,
                  # Deprecated in v1.6
                  author: Optional[str] = None,
                  ) -> None:
@@ -1011,7 +1070,7 @@ def __init__(self, *,
         self.cpe = cpe
         self.purl = purl
         self.omnibor_ids = omnibor_ids or []  # type:ignore[assignment]
-        # self.swhid = swhid or []  # type:ignore[assignment]
+        self.swhids = swhids or []  # type:ignore[assignment]
         self.swid = swid
         self.modified = modified
         self.pedigree = pedigree
@@ -1380,25 +1439,26 @@ def omnibor_ids(self) -> 'SortedSet[OmniborId]':
     def omnibor_ids(self, omnibor_ids: Iterable[OmniborId]) -> None:
         self._omnibor_ids = SortedSet(omnibor_ids)
 
-    # @property
-    # @serializable.view(SchemaVersion1Dot6)
-    # @serializable.xml_array(serializable.XmlArraySerializationType.FLAT, child_name='swhid')
-    # @serializable.xml_sequence(17)
-    # def swhid(self) -> SortedSet[str]:
-    #     """
-    #     Specifies the Software Heritage persistent identifier (SWHID). The SWHID, if specified, MUST be valid and
-    #     conform to the specification defined at:
-    #     https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html
-    #
-    #     Returns:
-    #         `Iterable[swhid]` if set else `None`
-    #     """
-    #     return self._swhid
-
-    # @swhid.setter
-    # def swhid(self, swhid: Iterable[str]) -> None:
-    #     self._swhid = SortedSet(swhid)
-    #
+    @property
+    @serializable.json_name('swhid')
+    @serializable.view(SchemaVersion1Dot6)
+    @serializable.xml_array(serializable.XmlArraySerializationType.FLAT, child_name='swhid')
+    @serializable.xml_sequence(17)
+    def swhids(self) -> 'SortedSet[Swhid]':
+        """
+        Specifies the Software Heritage persistent identifier (SWHID). The SWHID, if specified, MUST be valid and
+        conform to the specification defined at:
+        https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html
+
+        Returns:
+            `Iterable[Swhid]` if set else `None`
+        """
+        return self._swhids
+
+    @swhids.setter
+    def swhids(self, swhids: Iterable[Swhid]) -> None:
+        self._swhids = SortedSet(swhids)
+
     @property
     @serializable.view(SchemaVersion1Dot2)
     @serializable.view(SchemaVersion1Dot3)

tests/_data/models.py

@@ -56,6 +56,7 @@
     Patch,
     PatchClassification,
     Pedigree,
+    Swhid,
     Swid,
 )
 from cyclonedx.model.dependency import Dependency
@@ -131,7 +132,20 @@ def get_bom_with_component_setuptools_with_v16_fields() -> Bom:
     component.manufacturer = get_org_entity_1()
     component.authors = [get_org_contact_1(), get_org_contact_2()]
     component.omnibor_ids = [OmniborId('gitoid:blob:sha1:261eeb9e9f8b2b4b0d119366dda99c6fd7d35c64')]
-    # component.swhid = 'swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2'
+    component.swhids = [
+        Swhid('swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2'),
+        Swhid('swh:1:rel:22ece559cc7cc2364edc5e5593d63ae8bd229f9f'),
+        Swhid('swh:1:cnt:4d99d2d18326621ccdd70f5ea66c2e2ac236ad8b;'
+              'origin=https://gitorious.org/ocamlp3l/ocamlp3l_cvs.git;'
+              'visit=swh:1:snp:d7f1b9eb7ccb596c2622c4780febaa02549830f9;'
+              'anchor=swh:1:rev:2db189928c94d62a3b4757b3eec68f0a4d4113f0;'
+              'path=/Examples/SimpleFarm/simplefarm.ml;lines=9-15'),
+        Swhid('swh:1:cnt:f10371aa7b8ccabca8479196d6cd640676fd4a04;origin=https://github.com/web-platform-tests/wpt;'
+              'visit=swh:1:snp:b37d435721bbd450624165f334724e3585346499;'
+              'anchor=swh:1:rev:259d0612af038d14f2cd889a14a3adb6c9e96d96;'
+              'path=/html/semantics/document-metadata/the-meta-element/pragma-directives/attr-meta-http-equiv-refresh/'
+              'support/x%3Burl=foo/')
+    ]
     return _make_bom(components=[component])
 
 

tests/_data/snapshots/get_bom_with_component_setuptools_with_v16_fields-1.6.json.bin

@@ -44,6 +44,12 @@
         "gitoid:blob:sha1:261eeb9e9f8b2b4b0d119366dda99c6fd7d35c64"
       ],
       "purl": "pkg:pypi/[email protected]?extension=tar.gz",
+      "swhid": [
+        "swh:1:cnt:4d99d2d18326621ccdd70f5ea66c2e2ac236ad8b;origin=https://gitorious.org/ocamlp3l/ocamlp3l_cvs.git;visit=swh:1:snp:d7f1b9eb7ccb596c2622c4780febaa02549830f9;anchor=swh:1:rev:2db189928c94d62a3b4757b3eec68f0a4d4113f0;path=/Examples/SimpleFarm/simplefarm.ml;lines=9-15",
+        "swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2",
+        "swh:1:cnt:f10371aa7b8ccabca8479196d6cd640676fd4a04;origin=https://github.com/web-platform-tests/wpt;visit=swh:1:snp:b37d435721bbd450624165f334724e3585346499;anchor=swh:1:rev:259d0612af038d14f2cd889a14a3adb6c9e96d96;path=/html/semantics/document-metadata/the-meta-element/pragma-directives/attr-meta-http-equiv-refresh/support/x%3Burl=foo/",
+        "swh:1:rel:22ece559cc7cc2364edc5e5593d63ae8bd229f9f"
+      ],
       "type": "library",
       "version": "50.3.2"
     }

tests/_data/snapshots/get_bom_with_component_setuptools_with_v16_fields-1.6.xml.bin

@@ -73,6 +73,10 @@
       </licenses>
       <purl>pkg:pypi/[email protected]?extension=tar.gz</purl>
       <omniborId>gitoid:blob:sha1:261eeb9e9f8b2b4b0d119366dda99c6fd7d35c64</omniborId>
+      <swhid>swh:1:cnt:4d99d2d18326621ccdd70f5ea66c2e2ac236ad8b;origin=https://gitorious.org/ocamlp3l/ocamlp3l_cvs.git;visit=swh:1:snp:d7f1b9eb7ccb596c2622c4780febaa02549830f9;anchor=swh:1:rev:2db189928c94d62a3b4757b3eec68f0a4d4113f0;path=/Examples/SimpleFarm/simplefarm.ml;lines=9-15</swhid>
+      <swhid>swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2</swhid>
+      <swhid>swh:1:cnt:f10371aa7b8ccabca8479196d6cd640676fd4a04;origin=https://github.com/web-platform-tests/wpt;visit=swh:1:snp:b37d435721bbd450624165f334724e3585346499;anchor=swh:1:rev:259d0612af038d14f2cd889a14a3adb6c9e96d96;path=/html/semantics/document-metadata/the-meta-element/pragma-directives/attr-meta-http-equiv-refresh/support/x%3Burl=foo/</swhid>
+      <swhid>swh:1:rel:22ece559cc7cc2364edc5e5593d63ae8bd229f9f</swhid>
     </component>
   </components>
   <dependencies>