feat: add support for CycloneDX 1.7 (basic)

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

Author: jkowalleck

cyclonedx/model/license.py

@@ -33,11 +33,7 @@
 from .._internal.compare import ComparableTuple as _ComparableTuple
 from ..exception.model import MutuallyExclusivePropertiesException
 from ..exception.serialization import CycloneDxDeserializationException
-from ..schema.schema import (
-    SchemaVersion1Dot5,
-    SchemaVersion1Dot6,
-    SchemaVersion1Dot7,
-)
+from ..schema.schema import SchemaVersion1Dot5, SchemaVersion1Dot6, SchemaVersion1Dot7
 from . import AttachedText, XsUri
 from .bom_ref import BomRef
 

cyclonedx/model/tool.py

@@ -28,12 +28,7 @@
 
 from .._internal.compare import ComparableTuple as _ComparableTuple
 from ..schema import SchemaVersion
-from ..schema.schema import (
-    SchemaVersion1Dot4,
-    SchemaVersion1Dot5,
-    SchemaVersion1Dot6,
-    SchemaVersion1Dot7,
-)
+from ..schema.schema import SchemaVersion1Dot4, SchemaVersion1Dot5, SchemaVersion1Dot6, SchemaVersion1Dot7
 from . import ExternalReference, HashType, _HashTypeRepositorySerializationHelper
 from .component import Component
 from .service import Service

cyclonedx/model/vulnerability.py

@@ -42,12 +42,7 @@
 from .._internal.bom_ref import bom_ref_from_str as _bom_ref_from_str
 from .._internal.compare import ComparableTuple as _ComparableTuple
 from ..exception.model import MutuallyExclusivePropertiesException, NoPropertiesProvidedException
-from ..schema.schema import (
-    SchemaVersion1Dot4,
-    SchemaVersion1Dot5,
-    SchemaVersion1Dot6,
-    SchemaVersion1Dot7,
-)
+from ..schema.schema import SchemaVersion1Dot4, SchemaVersion1Dot5, SchemaVersion1Dot6, SchemaVersion1Dot7
 from . import Property, XsUri
 from .bom_ref import BomRef
 from .contact import OrganizationalContact, OrganizationalEntity

cyclonedx/output/json.py

@@ -131,6 +131,7 @@ class JsonV1Dot6(Json, SchemaVersion1Dot6):
     def _get_schema_uri(self) -> str:
         return 'http://cyclonedx.org/schema/bom-1.6.schema.json'
 
+
 class JsonV1Dot7(Json, SchemaVersion1Dot7):
 
     def _get_schema_uri(self) -> str:

cyclonedx/output/xml.py

@@ -124,6 +124,7 @@ class XmlV1Dot5(Xml, SchemaVersion1Dot5):
 class XmlV1Dot6(Xml, SchemaVersion1Dot6):
     pass
 
+
 class XmlV1Dot7(Xml, SchemaVersion1Dot7):
     pass
 

cyclonedx/schema/schema.py

@@ -40,6 +40,7 @@ class SchemaVersion1Dot7(BaseSchemaVersion):
     def schema_version_enum(self) -> Literal[SchemaVersion.V1_7]:
         return SchemaVersion.V1_7
 
+
 class SchemaVersion1Dot6(BaseSchemaVersion):
 
     @property

docs/outputting.rst

@@ -46,16 +46,16 @@ as a ``str``.
 
     from cyclonedx.output import make_outputter, BaseOutput, OutputFormat, SchemaVersion
 
-    outputter: BaseOutput = make_outputter(bom=bom, output_format=OutputFormat.JSON, schema_version=SchemaVersion.V1_6)
+    outputter: BaseOutput = make_outputter(bom=bom, output_format=OutputFormat.JSON, schema_version=SchemaVersion.V1_7)
     bom_json: str = outputter.output_as_string()
 
 Alternatively, if the output format and schema version are constants, you can use the predefined format+schema combined outputs:
 
 .. code-block:: python
 
-    from cyclonedx.output.json import JsonV1Dot6
+    from cyclonedx.output.json import JsonV1Dot7
 
-    outputter = JsonV1Dot6(bom=bom)
+    outputter = JsonV1Dot7(bom=bom)
     bom_json: str = outputter.output_as_string()
 
 

docs/responsibilities_capabilities.rst

@@ -53,6 +53,7 @@ Capabilities
    * Build a :class:`Component <cyclonedx.model.component.Component>` data model that represents this library
    * Build a :class:`Tool <cyclonedx.model.tool.Tool>` data model that represents this library
 * Implementation of the `CycloneDX Specification`_ for the following versions:
+   * ``1.7``
    * ``1.6``
    * ``1.5``
    * ``1.4``

examples/complex_deserialize.py

@@ -33,9 +33,9 @@
 # region JSON
 
 json_data = """{
-  "$schema": "http://cyclonedx.org/schema/bom-1.6.schema.json",
+  "$schema": "http://cyclonedx.org/schema/bom-1.7.schema.json",
   "bomFormat": "CycloneDX",
-  "specVersion": "1.6",
+  "specVersion": "1.7",
   "serialNumber": "urn:uuid:88fabcfa-7529-4ba2-8256-29bec0c03900",
   "version": 1,
   "metadata": {
@@ -145,7 +145,7 @@
     }
   ]
 }"""
-my_json_validator = JsonStrictValidator(SchemaVersion.V1_6)
+my_json_validator = JsonStrictValidator(SchemaVersion.V1_7)
 try:
     json_validation_errors = my_json_validator.validate_str(json_data)
     if json_validation_errors:
@@ -165,7 +165,7 @@
 # endregion XML
 
 xml_data = """<?xml version="1.0" ?>
-<bom xmlns="http://cyclonedx.org/schema/bom/1.6"
+<bom xmlns="http://cyclonedx.org/schema/bom/1.7"
   serialNumber="urn:uuid:88fabcfa-7529-4ba2-8256-29bec0c03900"
   version="1"
 >
@@ -246,7 +246,7 @@
     </dependency>
   </dependencies>
 </bom>"""
-my_xml_validator: 'XmlValidator' = make_schemabased_validator(OutputFormat.XML, SchemaVersion.V1_6)
+my_xml_validator: 'XmlValidator' = make_schemabased_validator(OutputFormat.XML, SchemaVersion.V1_7)
 try:
     xml_validation_errors = my_xml_validator.validate_str(xml_data)
     if xml_validation_errors:

examples/complex_serialize.py

@@ -89,7 +89,7 @@
 my_json_outputter: 'JsonOutputter' = JsonV1Dot5(bom)
 serialized_json = my_json_outputter.output_as_string(indent=2)
 print(serialized_json)
-my_json_validator = JsonStrictValidator(SchemaVersion.V1_6)
+my_json_validator = JsonStrictValidator(SchemaVersion.V1_7)
 try:
     json_validation_errors = my_json_validator.validate_str(serialized_json)
     if json_validation_errors:
@@ -106,7 +106,7 @@
 # region XML
 """demo with implicit instructions for SchemaVersion, outputter and validator. TypeCheckers will catch errors."""
 
-my_xml_outputter: 'XmlOutputter' = make_outputter(bom, OutputFormat.XML, SchemaVersion.V1_6)
+my_xml_outputter: 'XmlOutputter' = make_outputter(bom, OutputFormat.XML, SchemaVersion.V1_7)
 serialized_xml = my_xml_outputter.output_as_string(indent=2)
 print(serialized_xml)
 my_xml_validator: 'XmlValidator' = make_schemabased_validator(