BomRef.value default None (#505)

---------

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

Author: jkowalleck

cyclonedx/model/bom_ref.py

@@ -16,7 +16,6 @@
 # Copyright (c) OWASP Foundation. All Rights Reserved.
 
 from typing import Any, Optional
-from uuid import uuid4
 
 
 class BomRef:
@@ -30,31 +29,31 @@ class BomRef:
     """
 
     def __init__(self, value: Optional[str] = None) -> None:
-        self.value = value or str(uuid4())
+        self.value = value
 
     @property
-    def value(self) -> str:
+    def value(self) -> Optional[str]:
         return self._value
 
     @value.setter
-    def value(self, value: str) -> None:
-        self._value = value
+    def value(self, value: Optional[str]) -> None:
+        self._value = value or None
 
     def __eq__(self, other: object) -> bool:
         if isinstance(other, BomRef):
-            return other.value == self.value
+            return str(other) == str(self)
         return False
 
     def __lt__(self, other: Any) -> bool:
         if isinstance(other, BomRef):
-            return self.value < other.value
+            return str(self) < str(other)
         return NotImplemented
 
     def __hash__(self) -> int:
-        return hash(self.value)
+        return hash(str(self))
 
     def __repr__(self) -> str:
-        return f'<BomRef {self.value}>'
+        return f'<BomRef {self._value!r}>'
 
     def __str__(self) -> str:
-        return self.value
+        return self.value or ''

cyclonedx/output/__init__.py

@@ -150,13 +150,13 @@ def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
         self.reset()
 
     def discriminate(self) -> None:
-        known_values = set()
+        known_values = []
         for bomref, _ in self._bomrefs:
             value = bomref.value
-            if value in known_values:
+            if value is None or value in known_values:
                 value = self._make_unique()
                 bomref.value = value
-            known_values.add(value)
+            known_values.append(value)
 
     def reset(self) -> None:
         for bomref, original_value in self._bomrefs:

cyclonedx/serialization/__init__.py

@@ -38,7 +38,7 @@
 class BomRefHelper(BaseHelper):
 
     @classmethod
-    def serialize(cls, o: Any) -> str:
+    def serialize(cls, o: Any) -> Optional[str]:
         if isinstance(o, BomRef):
             return o.value
         raise SerializationOfUnexpectedValueException(

tests/_data/models.py

@@ -360,7 +360,9 @@ def get_bom_with_nested_services() -> Bom:
             bom_ref='my-specific-bom-ref-for-my-second-service',
             services=[
                 Service(
-                    name='yet-another-nested-service', provider=get_org_entity_1(), group='what-group', version='6.5.4'
+                    name='yet-another-nested-service',
+                    bom_ref='yet-another-nested-service',
+                    provider=get_org_entity_1(), group='what-group', version='6.5.4'
                 ),
                 Service(
                     name='another-nested-service',

tests/_data/snapshots/get_bom_with_nested_services-1.2.json.bin

@@ -114,7 +114,7 @@
       "name": "my-second-service",
       "services": [
         {
-          "bom-ref": "00000000-0000-4000-8000-000000000004",
+          "bom-ref": "yet-another-nested-service",
           "group": "what-group",
           "name": "yet-another-nested-service",
           "provider": {

tests/_data/snapshots/get_bom_with_nested_services-1.2.xml.bin

@@ -82,7 +82,7 @@
     <service bom-ref="my-specific-bom-ref-for-my-second-service">
       <name>my-second-service</name>
       <services>
-        <service bom-ref="00000000-0000-4000-8000-000000000004">
+        <service bom-ref="yet-another-nested-service">
           <provider>
             <name>CycloneDX</name>
             <url>https://cyclonedx.org</url>

tests/_data/snapshots/get_bom_with_nested_services-1.3.json.bin

@@ -130,7 +130,7 @@
       "name": "my-second-service",
       "services": [
         {
-          "bom-ref": "00000000-0000-4000-8000-000000000003",
+          "bom-ref": "yet-another-nested-service",
           "group": "what-group",
           "name": "yet-another-nested-service",
           "provider": {

tests/_data/snapshots/get_bom_with_nested_services-1.3.xml.bin

@@ -89,7 +89,7 @@
     <service bom-ref="my-specific-bom-ref-for-my-second-service">
       <name>my-second-service</name>
       <services>
-        <service bom-ref="00000000-0000-4000-8000-000000000003">
+        <service bom-ref="yet-another-nested-service">
           <provider>
             <name>CycloneDX</name>
             <url>https://cyclonedx.org</url>

tests/_data/snapshots/get_bom_with_nested_services-1.4.json.bin

@@ -223,7 +223,7 @@
       "name": "my-second-service",
       "services": [
         {
-          "bom-ref": "00000000-0000-4000-8000-000000000002",
+          "bom-ref": "yet-another-nested-service",
           "group": "what-group",
           "name": "yet-another-nested-service",
           "provider": {

tests/_data/snapshots/get_bom_with_nested_services-1.4.xml.bin

@@ -159,7 +159,7 @@
     <service bom-ref="my-specific-bom-ref-for-my-second-service">
       <name>my-second-service</name>
       <services>
-        <service bom-ref="00000000-0000-4000-8000-000000000002">
+        <service bom-ref="yet-another-nested-service">
           <provider>
             <name>CycloneDX</name>
             <url>https://cyclonedx.org</url>