Merge remote-tracking branch 'origin/main' into 561_add_components_and_services

Author: jkugler

CHANGELOG.md

@@ -20,4 +20,4 @@
 
 # !! version is managed by semantic_release
 # do not use typing here, or else `semantic_release` might have issues finding the variable
-__version__ = "7.4.0"  # noqa:Q000
+__version__ = "7.4.1"  # noqa:Q000

cyclonedx/__init__.py

@@ -845,7 +845,7 @@ class Property:
     Specifies an individual property with a name and value.
     """
 
-    def __init__(self, *, name: str, value: str) -> None:
+    def __init__(self, *, name: str, value: Optional[str] = None) -> None:
         self.name = name
         self.value = value
 
@@ -868,7 +868,7 @@ def name(self, name: str) -> None:
 
     @property
     @serializable.xml_name('.')
-    def value(self) -> str:
+    def value(self) -> Optional[str]:
         """
         Value of this Property.
 
@@ -878,7 +878,7 @@ def value(self) -> str:
         return self._value
 
     @value.setter
-    def value(self, value: str) -> None:
+    def value(self, value: Optional[str]) -> None:
         self._value = value
 
     def __eq__(self, other: object) -> bool:

cyclonedx/model/__init__.py

@@ -20,7 +20,7 @@
 
 # The full version, including alpha/beta/rc tags
 # !! version is managed by semantic_release
-release = '7.4.0'
+release = '7.4.1'
 
 # -- General configuration ---------------------------------------------------
 

docs/conf.py

@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.poetry]
 name = "cyclonedx-python-lib"
 # !! version is managed by semantic_release
-version = "7.4.0"
+version = "7.4.1"
 description = "Python library for CycloneDX"
 authors = [
   "Paul Horton <[email protected]>",
@@ -93,9 +93,9 @@ pep8-naming = "0.14.1"
 isort = "5.13.2"
 autopep8 = "2.2.0"
 mypy = "1.10.0"
-tox = "4.15.0"
+tox = "4.15.1"
 xmldiff = "2.7.0"
-bandit = "1.7.8"
+bandit = "1.7.9"
 
 [tool.semantic_release]
 # see https://python-semantic-release.readthedocs.io/en/latest/configuration.html

pyproject.toml

@@ -1108,6 +1108,20 @@ def bom_all_same_bomref() -> Tuple[Bom, int]:
     return bom, nr_bomrefs
 
 
+def get_bom_for_issue_630_empty_property() -> Bom:
+    """regression test for issue #630
+    see https://github.com/CycloneDX/cyclonedx-python-lib/issues/630
+    """
+    return _make_bom(components={
+        Component(
+            bom_ref='[email protected]',
+            type=ComponentType.LIBRARY,
+            name='example',
+            version='15.8.0',
+            properties=[Property(name='cdx:npm:package:path')]
+        )
+    })
+
 # ---
 
 
@@ -1147,4 +1161,5 @@ def bom_all_same_bomref() -> Tuple[Bom, int]:
     get_bom_for_issue_497_urls,
     get_bom_for_issue_598_multiple_components_with_purl_qualifiers,
     get_bom_with_component_setuptools_with_v16_fields,
+    get_bom_for_issue_630_empty_property,
 }

tests/_data/models.py

@@ -0,0 +1,10 @@
+<?xml version="1.0" ?>
+<bom xmlns="http://cyclonedx.org/schema/bom/1.0" version="1">
+  <components>
+    <component type="library">
+      <name>example</name>
+      <version>15.8.0</version>
+      <modified>false</modified>
+    </component>
+  </components>
+</bom>

tests/_data/own/xml/1.6/regression_issue630.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" ?>
+<bom xmlns="http://cyclonedx.org/schema/bom/1.1" serialNumber="urn:uuid:1441d33a-e0fc-45b5-af3b-61ee52a88bac" version="1">
+  <components>
+    <component type="library" bom-ref="[email protected]">
+      <name>example</name>
+      <version>15.8.0</version>
+    </component>
+  </components>
+</bom>

tests/_data/snapshots/get_bom_for_issue_630_empty_property-1.0.xml.bin

@@ -0,0 +1,30 @@
+{
+  "components": [
+    {
+      "bom-ref": "[email protected]",
+      "name": "example",
+      "type": "library",
+      "version": "15.8.0"
+    }
+  ],
+  "dependencies": [
+    {
+      "ref": "[email protected]"
+    }
+  ],
+  "metadata": {
+    "timestamp": "2023-01-07T13:44:32.312678+00:00",
+    "tools": [
+      {
+        "name": "cyclonedx-python-lib",
+        "vendor": "CycloneDX",
+        "version": "TESTING"
+      }
+    ]
+  },
+  "serialNumber": "urn:uuid:1441d33a-e0fc-45b5-af3b-61ee52a88bac",
+  "version": 1,
+  "$schema": "http://cyclonedx.org/schema/bom-1.2b.schema.json",
+  "bomFormat": "CycloneDX",
+  "specVersion": "1.2"
+}