Rename Tool* to Tools*

Also fixed an import

Need to fix an circular import still...

Author: jkugler

cyclonedx/model/__init__.py

@@ -50,7 +50,7 @@
     SchemaVersion1Dot5,
     SchemaVersion1Dot6,
 )
-
+from .tool import Tool
 
 @serializable.serializable_enum
 class DataFlow(str, Enum):
@@ -1196,7 +1196,6 @@ def __hash__(self) -> int:
     def __repr__(self) -> str:
         return f'<Copyright text={self.text}>'
 
-
 ThisTool = Tool(
     vendor='CycloneDX',
     name='cyclonedx-python-lib',

cyclonedx/model/bom.py

@@ -31,7 +31,7 @@
     MutuallyExclusivePropertiesException,
     UnknownComponentDependencyException,
 )
-from ..model.tool import Tool, ToolRepository, ToolRepositoryHelper
+from ..model.tool import Tool, ToolsRepository, ToolsRepositoryHelper
 from ..schema.schema import (
     SchemaVersion1Dot0,
     SchemaVersion1Dot1,
@@ -74,7 +74,7 @@ def __init__(self, *, tools: Optional[Union[Iterable[Tool], Dict[AnyStr, Any]]]
                  # Deprecated as of v1.6
                  manufacture: Optional[OrganizationalEntity] = None) -> None:
         self.timestamp = timestamp or _get_now_utc()
-        self.tools = tools or ToolRepository()  # type:ignore[assignment]
+        self.tools = tools or ToolsRepository()  # type:ignore[assignment]
         self.authors = authors or []  # type:ignore[assignment]
         self.component = component
         self.supplier = supplier
@@ -120,21 +120,21 @@ def timestamp(self, timestamp: datetime) -> None:
     #    ... # TODO since CDX1.5
 
     @property
-    @serializable.type_mapping(ToolRepositoryHelper)
+    @serializable.type_mapping(ToolsRepositoryHelper)
     @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'tool')
     @serializable.xml_sequence(3)
-    def tools(self) -> ToolRepository:
+    def tools(self) -> ToolsRepository:
         """
         Tools used to create this BOM.
 
         Returns:
-            `ToolRepository` objects.
+            `ToolsRepository` objects.
         """
         return self._tools
 
     @tools.setter
-    def tools(self, tools: Union[Iterable[Tool], ToolRepository]) -> None:
-        if isinstance(tools, ToolRepository):
+    def tools(self, tools: Union[Iterable[Tool], ToolsRepository]) -> None:
+        if isinstance(tools, ToolsRepository):
             self._tools = tools
         else:
             # This allows the old behavior of assigning the list of tools directly to bom.metadata.tools
@@ -148,7 +148,7 @@ def tools(self, tools: Union[Iterable[Tool], ToolRepository]) -> None:
                     'Cannot serialize both old (CycloneDX <= 1.4) and new '
                     '(CycloneDX >= 1.5) format for tools.'
                 )
-            self._tools = ToolRepository(tools=tools)
+            self._tools = ToolsRepository(tools=tools)
 
     @property
     @serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'author')

cyclonedx/model/tool.py

@@ -1,5 +1,6 @@
 from json import loads as json_loads
 from typing import Any, Dict, Iterable, Iterator, List, Optional, Type, Union
+from warnings import warn
 from xml.etree.ElementTree import Element  # nosec B405
 
 import serializable
@@ -141,7 +142,7 @@ def __repr__(self) -> str:
         return f'<Tool name={self.name}, version={self.version}, vendor={self.vendor}>'
 
 
-class ToolRepository:
+class ToolsRepository:
     """
     The repository of tool formats
 
@@ -151,8 +152,18 @@ class ToolRepository:
     and `services` attributes (which are SortedSets of their respective types).
     """
 
+    tools: SortedSet[Tool]
+    """DEPRECATED tools"""
+
+    components: SortedSet[Component]
+    """An array of components used to creatd this SBOM"""
+
+    services: SortedSet[Service]
+    """An array of services used to create this SBOM"""
+
     def __init__(self, *, components: Optional[Iterable[Component]] = None,
                  services: Optional[Iterable[Service]] = None,
+                 # Deprecated in v1.5
                  tools: Optional[Iterable[Tool]] = None) -> None:
 
         if tools and (components or services):
@@ -162,9 +173,13 @@ def __init__(self, *, components: Optional[Iterable[Component]] = None,
                 '(CycloneDX >= 1.5) format for tools.'
             )
 
-        self._components = SortedSet(components) or SortedSet()
-        self._services = SortedSet(services) or SortedSet()
-        self._tools = SortedSet(tools) or SortedSet()
+        if tools:
+            warn('Using Tool is deprecated as of CycloneDX v1.5. Components and Services should be used now. '
+                 'See https://cyclonedx.org/docs/1.5/', DeprecationWarning)
+
+        self._components = SortedSet(components or ())
+        self._services = SortedSet(services or ())
+        self._tools = SortedSet(tools or ())
 
     def __len__(self) -> int:
         return len(self._tools)
@@ -227,9 +242,9 @@ def __iter__(self) -> Iterator[Tool]:
             yield t
 
 
-class ToolRepositoryHelper(BaseHelper):
+class ToolsRepositoryHelper(BaseHelper):
     @classmethod
-    def json_normalize(cls, o: ToolRepository, *,
+    def json_normalize(cls, o: ToolsRepository, *,
                        view: Optional[Type[ViewType]],
                        **__: Any) -> Any:
         if not any([o._tools, o.components, o.services]):  # pylint: disable=protected-access
@@ -250,7 +265,7 @@ def json_normalize(cls, o: ToolRepository, *,
 
     @classmethod
     def json_denormalize(cls, o: Union[List[Dict[str, Any]], Dict[str, Any]],
-                         **__: Any) -> ToolRepository:
+                         **__: Any) -> ToolsRepository:
 
         components = []
         services = []
@@ -271,10 +286,10 @@ def json_denormalize(cls, o: Union[List[Dict[str, Any]], Dict[str, Any]],
         else:
             raise CycloneDxDeserializationException('unexpected: {o!r}')
 
-        return ToolRepository(components=components, services=services, tools=tools)
+        return ToolsRepository(components=components, services=services, tools=tools)
 
     @classmethod
-    def xml_normalize(cls, o: ToolRepository, *,
+    def xml_normalize(cls, o: ToolsRepository, *,
                       element_name: str,
                       view: Optional[Type[ViewType]],
                       xmlns: Optional[str],
@@ -314,5 +329,5 @@ def xml_normalize(cls, o: ToolRepository, *,
     @classmethod
     def xml_denormalize(cls, o: Element,
                         default_ns: Optional[str],
-                        **__: Any) -> ToolRepository:
-        return ToolRepository()
+                        **__: Any) -> ToolsRepository:
+        return ToolsRepository()