Refactored output classes to use multiple inheritance allowing a single place to define which schema version support various attributes and elements.

Author: madpah

cyclonedx/output/json.py

@@ -1,30 +1,31 @@
 import json
-from abc import abstractmethod
+from abc import ABC, abstractmethod
 
 from . import BaseOutput
+from .schema import BaseSchemaVersion, SchemaVersion1Dot0, SchemaVersion1Dot1, SchemaVersion1Dot2, SchemaVersion1Dot3
 from ..model.cyclonedx import Component
 
 
-class Json(BaseOutput):
+class Json(BaseOutput, BaseSchemaVersion):
 
     def output_as_string(self) -> str:
         return json.dumps(self._get_json())
 
     def output_to_file(self, filename: str):
-        pass
+        raise NotImplemented
 
     def _get_json(self) -> dict:
         components = list(map(self._get_component_as_dict, self.get_bom().get_components()))
 
         response = {
             "bomFormat": "CycloneDX",
-            "specVersion": str(self._get_schema_version()),
+            "specVersion": str(self.get_schema_version()),
             "serialNumber": self.get_bom().get_urn_uuid(),
             "version": 1,
             "components": components
         }
 
-        if self._bom_supports_metadata():
+        if self.bom_supports_metadata():
             response['metadata'] = self._get_metadata_as_dict()
 
         return response
@@ -37,59 +38,29 @@ def _get_component_as_dict(self, component: Component) -> dict:
             "purl": component.get_purl()
         }
 
-        if self._component_supports_author() and component.get_author() is not None:
+        if self.component_supports_author() and component.get_author() is not None:
             c['author'] = component.get_author()
 
         return c
 
-    def _bom_supports_metadata(self) -> bool:
-        return True
-
-    def _component_supports_author(self) -> bool:
-        return True
-
     def _get_metadata_as_dict(self) -> dict:
         metadata = self.get_bom().get_metadata()
         return {
             "timestamp": metadata.get_timestamp().isoformat()
         }
 
-    @abstractmethod
-    def _get_schema_version(self) -> str:
-        pass
-
-
-class JsonV1Dot0(Json):
-
-    def _get_schema_version(self) -> str:
-        return '1.0'
-
-    def _bom_supports_metadata(self) -> bool:
-        return False
-
-    def _component_supports_author(self) -> bool:
-        return False
-
-
-class JsonV1Dot1(Json):
-
-    def _get_schema_version(self) -> str:
-        return '1.1'
-
-    def _bom_supports_metadata(self) -> bool:
-        return False
 
-    def _component_supports_author(self) -> bool:
-        return False
+class JsonV1Dot0(Json, SchemaVersion1Dot0):
+    pass
 
 
-class JsonV1Dot2(Json):
+class JsonV1Dot1(Json, SchemaVersion1Dot1):
+    pass
 
-    def _get_schema_version(self) -> str:
-        return '1.2'
 
+class JsonV1Dot2(Json, SchemaVersion1Dot2):
+    pass
 
-class JsonV1Dot3(Json):
 
-    def _get_schema_version(self) -> str:
-        return '1.3'
+class JsonV1Dot3(Json, SchemaVersion1Dot3):
+    pass

cyclonedx/output/schema.py

@@ -0,0 +1,55 @@
+from abc import ABC, abstractmethod
+
+
+class BaseSchemaVersion(ABC):
+
+    def bom_supports_metadata(self) -> bool:
+        return True
+
+    def component_supports_author(self) -> bool:
+        return True
+
+    def component_supports_bom_ref(self) -> bool:
+        return True
+
+    def get_schema_version(self) -> str:
+        pass
+
+
+class SchemaVersion1Dot3(BaseSchemaVersion):
+
+    def get_schema_version(self) -> str:
+        return '1.3'
+
+
+class SchemaVersion1Dot2(BaseSchemaVersion):
+
+    def get_schema_version(self) -> str:
+        return '1.2'
+
+
+class SchemaVersion1Dot1(BaseSchemaVersion):
+
+    def bom_supports_metadata(self) -> bool:
+        return False
+
+    def component_supports_author(self) -> bool:
+        return False
+
+    def get_schema_version(self) -> str:
+        return '1.1'
+
+
+class SchemaVersion1Dot0(BaseSchemaVersion):
+
+    def bom_supports_metadata(self) -> bool:
+        return False
+
+    def component_supports_author(self) -> bool:
+        return False
+
+    def component_supports_bom_ref(self) -> bool:
+        return False
+
+    def get_schema_version(self) -> str:
+        return '1.0'

cyclonedx/output/xml.py

@@ -1,47 +1,20 @@
-from abc import abstractmethod
 from xml.etree import ElementTree
 
 from . import BaseOutput
+from .schema import BaseSchemaVersion, SchemaVersion1Dot0, SchemaVersion1Dot1, SchemaVersion1Dot2, SchemaVersion1Dot3
 from ..model.cyclonedx import Component
 
 
-def _xml_pretty_print(elem: ElementTree.Element, level: int = 0) -> ElementTree.Element:
-    """
-    Helper method lifed from cyclonedx-python original project for formatting
-    XML without using any XML-libraries.
-
-    NOTE: This method is recursive.
-
-    :param elem:
-    :param level:
-    :return:
-    """
-    i = "\n" + level * "    "
-    if len(elem):
-        if not elem.text or not elem.text.strip():
-            elem.text = i + "    "
-        if not elem.tail or not elem.tail.strip():
-            elem.tail = i
-        for elem in elem:
-            _xml_pretty_print(elem, level + 1)
-        if not elem.tail or not elem.tail.strip():
-            elem.tail = i
-    else:
-        if level and (not elem.tail or not elem.tail.strip()):
-            elem.tail = i
-    return elem
-
-
-class Xml(BaseOutput):
+class Xml(BaseOutput, BaseSchemaVersion):
     XML_VERSION_DECLARATION: str = '<?xml version="1.0" encoding="UTF-8"?>'
 
     def get_target_namespace(self) -> str:
-        return 'http://cyclonedx.org/schema/bom/{}'.format(self._get_schema_version())
+        return 'http://cyclonedx.org/schema/bom/{}'.format(self.get_schema_version())
 
     def output_as_string(self) -> str:
         bom = self._get_bom_root_element()
 
-        if self._bom_supports_metadata():
+        if self.bom_supports_metadata():
             bom = self._add_metadata(bom=bom)
 
         components = ElementTree.SubElement(bom, 'components')
@@ -53,18 +26,21 @@ def output_as_string(self) -> str:
     def output_to_file(self, filename: str):
         pass
 
+    def _component_supports_bom_ref_attribute(self) -> bool:
+        return True
+
     def _get_bom_root_element(self) -> ElementTree.Element:
         return ElementTree.Element('bom', {'xmlns': self.get_target_namespace(), 'version': '1',
                                            'serialNumber': self.get_bom().get_urn_uuid()})
 
     def _get_component_as_xml_element(self, component: Component) -> ElementTree.Element:
         element_attributes = {'type': component.get_type().value}
-        if self._component_supports_bom_ref_attribute():
+        if self.component_supports_bom_ref():
             element_attributes['bom-ref'] = component.get_purl()
 
         component_element = ElementTree.Element('component', element_attributes)
 
-        if self._component_supports_author() and component.get_author() is not None:
+        if self.component_supports_author() and component.get_author() is not None:
             ElementTree.SubElement(component_element, 'author').text = component.get_author()
 
         # if publisher and publisher != "UNKNOWN":
@@ -104,57 +80,20 @@ def _add_metadata(self, bom: ElementTree.Element) -> ElementTree.Element:
         ElementTree.SubElement(metadata_e, 'timestamp').text = self.get_bom().get_metadata().get_timestamp().isoformat()
         return bom
 
-    def _bom_supports_metadata(self) -> bool:
-        return True
-
-    def _component_supports_author(self) -> bool:
-        return True
-
-    def _component_supports_bom_ref_attribute(self) -> bool:
-        return True
-
-    @abstractmethod
-    def _get_schema_version(self) -> str:
-        pass
-
 
-class XmlV1Dot0(Xml):
+class XmlV1Dot0(Xml, SchemaVersion1Dot0):
 
     def _get_bom_root_element(self) -> ElementTree.Element:
         return ElementTree.Element('bom', {'xmlns': self.get_target_namespace(), 'version': '1'})
 
-    def _get_schema_version(self) -> str:
-        return '1.0'
-
-    def _bom_supports_metadata(self) -> bool:
-        return False
-
-    def _component_supports_bom_ref_attribute(self) -> bool:
-        return False
-
-    def _component_supports_author(self) -> bool:
-        return False
-
-
-class XmlV1Dot1(Xml):
-
-    def _get_schema_version(self) -> str:
-        return '1.1'
-
-    def _bom_supports_metadata(self) -> bool:
-        return False
-
-    def _component_supports_author(self) -> bool:
-        return False
-
 
-class XmlV1Dot2(Xml):
+class XmlV1Dot1(Xml, SchemaVersion1Dot1):
+    pass
 
-    def _get_schema_version(self) -> str:
-        return '1.2'
 
+class XmlV1Dot2(Xml, SchemaVersion1Dot2):
+    pass
 
-class XmlV1Dot3(Xml):
 
-    def _get_schema_version(self) -> str:
-        return '1.3'
+class XmlV1Dot3(Xml, SchemaVersion1Dot3):
+    pass