849-replace-underscore-with-dash-package-manager

Signed-off-by: Neumeier Michael <[email protected]>

Author: mneumei

src/spdx_tools/spdx/jsonschema/external_package_ref_converter.py

@@ -4,7 +4,9 @@
 from beartype.typing import Any, Type
 
 from spdx_tools.spdx.jsonschema.converter import TypedConverter
-from spdx_tools.spdx.jsonschema.external_package_ref_properties import ExternalPackageRefProperty
+from spdx_tools.spdx.jsonschema.external_package_ref_properties import (
+    ExternalPackageRefProperty,
+)
 from spdx_tools.spdx.jsonschema.json_property import JsonProperty
 from spdx_tools.spdx.model import Document, ExternalPackageRef
 
@@ -19,7 +21,7 @@ def _get_property_value(
         if external_ref_property == ExternalPackageRefProperty.COMMENT:
             return external_ref.comment
         elif external_ref_property == ExternalPackageRefProperty.REFERENCE_CATEGORY:
-            return external_ref.category.name
+            return external_ref.category.name.replace("_", "-")  # bugfix to match the spdx spec
         elif external_ref_property == ExternalPackageRefProperty.REFERENCE_LOCATOR:
             return external_ref.locator
         elif external_ref_property == ExternalPackageRefProperty.REFERENCE_TYPE:

tests/spdx/jsonschema/test_external_package_ref_converter.py

@@ -3,8 +3,12 @@
 # SPDX-License-Identifier: Apache-2.0
 import pytest
 
-from spdx_tools.spdx.jsonschema.external_package_ref_converter import ExternalPackageRefConverter
-from spdx_tools.spdx.jsonschema.external_package_ref_properties import ExternalPackageRefProperty
+from spdx_tools.spdx.jsonschema.external_package_ref_converter import (
+    ExternalPackageRefConverter,
+)
+from spdx_tools.spdx.jsonschema.external_package_ref_properties import (
+    ExternalPackageRefProperty,
+)
 from spdx_tools.spdx.model import ExternalPackageRef, ExternalPackageRefCategory
 
 
@@ -23,7 +27,9 @@ def converter() -> ExternalPackageRefConverter:
     ],
 )
 def test_json_property_names(
-    converter: ExternalPackageRefConverter, external_package_ref_property: ExternalPackageRefProperty, expected: str
+    converter: ExternalPackageRefConverter,
+    external_package_ref_property: ExternalPackageRefProperty,
+    expected: str,
 ):
     assert converter.json_property_name(external_package_ref_property) == expected
 
@@ -43,7 +49,7 @@ def test_successful_conversion(converter: ExternalPackageRefConverter):
 
     assert converted_dict == {
         converter.json_property_name(ExternalPackageRefProperty.COMMENT): "comment",
-        converter.json_property_name(ExternalPackageRefProperty.REFERENCE_CATEGORY): "PACKAGE_MANAGER",
+        converter.json_property_name(ExternalPackageRefProperty.REFERENCE_CATEGORY): "PACKAGE-MANAGER",
         converter.json_property_name(ExternalPackageRefProperty.REFERENCE_LOCATOR): "locator",
         converter.json_property_name(ExternalPackageRefProperty.REFERENCE_TYPE): "type",
     }

tests/spdx/writer/json/expected_results/expected.json

@@ -88,7 +88,7 @@
             "externalRefs": [
                 {
                     "comment": "externalPackageRefComment",
-                    "referenceCategory": "PACKAGE_MANAGER",
+                    "referenceCategory": "PACKAGE-MANAGER",
                     "referenceLocator": "org.apache.tomcat:tomcat:9.0.0.M4",
                     "referenceType": "maven-central"
                 }