test: refactored fixtures for tests which has uncovered #150, #151 and #152

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

Author: madpah

cyclonedx/exception/output.py

@@ -28,3 +28,12 @@ class ComponentVersionRequiredException(CycloneDxException):
     but one is not available/present.
     """
     pass
+
+
+class FormatNotSupportedException(CycloneDxException):
+    """
+    Exception raised when attempting to output a BOM to a format not supported in the requested version.
+
+    For example, JSON is not supported prior to 1.2.
+    """
+    pass

cyclonedx/output/__init__.py

@@ -40,6 +40,15 @@ class SchemaVersion(Enum):
     V1_3: str = 'V1Dot3'
     V1_4: str = 'V1Dot4'
 
+    def to_version(self) -> str:
+        """
+        Return as a version string - e.g. `1.4`
+
+        Returns:
+            `str` version
+        """
+        return f'{self.value[1]}.{self.value[5]}'
+
 
 DEFAULT_SCHEMA_VERSION = SchemaVersion.V1_3
 
@@ -51,6 +60,11 @@ def __init__(self, bom: Bom, **kwargs: int) -> None:
         self._bom = bom
         self._generated: bool = False
 
+    @property
+    @abstractmethod
+    def schema_version(self) -> SchemaVersion:
+        pass
+
     @property
     def generated(self) -> bool:
         return self._generated

cyclonedx/output/json.py

@@ -21,14 +21,14 @@
 from abc import abstractmethod
 from typing import cast, Any, Dict, List, Optional, Union
 
-from . import BaseOutput
+from . import BaseOutput, SchemaVersion
 from .schema import BaseSchemaVersion, SchemaVersion1Dot0, SchemaVersion1Dot1, SchemaVersion1Dot2, SchemaVersion1Dot3, \
     SchemaVersion1Dot4
 from .serializer.json import CycloneDxJSONEncoder
+from ..exception.output import FormatNotSupportedException
 from ..model.bom import Bom
 from ..model.component import Component
 
-
 ComponentDict = Dict[str, Union[
     str,
     List[Dict[str, str]],
@@ -42,14 +42,19 @@ def __init__(self, bom: Bom) -> None:
         super().__init__(bom=bom)
         self._json_output: str = ''
 
+    @property
+    def schema_version(self) -> SchemaVersion:
+        return self.schema_version_enum
+
     def generate(self, force_regeneration: bool = False) -> None:
         if self.generated and not force_regeneration:
             return
 
         schema_uri: Optional[str] = self._get_schema_uri()
         if not schema_uri:
-            # JSON not supported!
-            return
+            raise FormatNotSupportedException(
+                f'JSON is not supported by CycloneDX in schema version {self.schema_version.to_version()}'
+            )
 
         vulnerabilities: Dict[str, List[Dict[Any, Any]]] = {"vulnerabilities": []}
         if self.get_bom().components:

cyclonedx/output/schema.py

@@ -19,9 +19,16 @@
 
 from abc import ABC, abstractmethod
 
+from . import SchemaVersion
+
 
 class BaseSchemaVersion(ABC):
 
+    @property
+    @abstractmethod
+    def schema_version_enum(self) -> SchemaVersion:
+        pass
+
     def bom_supports_metadata(self) -> bool:
         return True
 
@@ -74,6 +81,10 @@ def get_schema_version(self) -> str:
 
 class SchemaVersion1Dot4(BaseSchemaVersion):
 
+    @property
+    def schema_version_enum(self) -> SchemaVersion:
+        return SchemaVersion.V1_4
+
     def get_schema_version(self) -> str:
         return '1.4'
 
@@ -83,6 +94,10 @@ def component_version_optional(self) -> bool:
 
 class SchemaVersion1Dot3(BaseSchemaVersion):
 
+    @property
+    def schema_version_enum(self) -> SchemaVersion:
+        return SchemaVersion.V1_3
+
     def bom_metadata_supports_tools_external_references(self) -> bool:
         return False
 
@@ -107,6 +122,10 @@ def get_schema_version(self) -> str:
 
 class SchemaVersion1Dot2(BaseSchemaVersion):
 
+    @property
+    def schema_version_enum(self) -> SchemaVersion:
+        return SchemaVersion.V1_2
+
     def bom_metadata_supports_tools_external_references(self) -> bool:
         return False
 
@@ -134,6 +153,10 @@ def get_schema_version(self) -> str:
 
 class SchemaVersion1Dot1(BaseSchemaVersion):
 
+    @property
+    def schema_version_enum(self) -> SchemaVersion:
+        return SchemaVersion.V1_1
+
     def bom_metadata_supports_tools(self) -> bool:
         return False
 
@@ -173,6 +196,10 @@ def get_schema_version(self) -> str:
 
 class SchemaVersion1Dot0(BaseSchemaVersion):
 
+    @property
+    def schema_version_enum(self) -> SchemaVersion:
+        return SchemaVersion.V1_0
+
     def bom_metadata_supports_tools(self) -> bool:
         return False
 

cyclonedx/output/xml.py

@@ -21,7 +21,7 @@
 from typing import cast, List, Optional
 from xml.etree import ElementTree
 
-from . import BaseOutput
+from . import BaseOutput, SchemaVersion
 from .schema import BaseSchemaVersion, SchemaVersion1Dot0, SchemaVersion1Dot1, SchemaVersion1Dot2, SchemaVersion1Dot3, \
     SchemaVersion1Dot4
 from ..exception.output import ComponentVersionRequiredException
@@ -39,6 +39,10 @@ def __init__(self, bom: Bom) -> None:
         super().__init__(bom=bom)
         self._root_bom_element: ElementTree.Element = self._create_bom_element()
 
+    @property
+    def schema_version(self) -> SchemaVersion:
+        return self.schema_version_enum
+
     def generate(self, force_regeneration: bool = False) -> None:
         if self.generated and force_regeneration:
             self._root_bom_element = self._create_bom_element()