# encoding: utf-8
# This file is part of CycloneDX Python Lib
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# Copyright (c) OWASP Foundation. All Rights Reserved.
from abc import ABC, abstractmethod
from typing import Any, Iterable, List, Optional, Set
import serializable
from sortedcontainers import SortedSet
from cyclonedx.model import ComparableTuple
from cyclonedx.serialization import BomRefHelper
from .bom_ref import BomRef
[docs]
class DependencyDependencies(serializable.BaseHelper): # type: ignore
@classmethod
[docs]
def serialize(cls, o: object) -> List[str]:
if isinstance(o, SortedSet):
return list(map(lambda i: str(i.ref), o))
raise ValueError(f'Attempt to serialize a non-Dependency: {o.__class__}')
@classmethod
[docs]
def deserialize(cls, o: object) -> Set["Dependency"]:
dependencies: Set["Dependency"] = set()
if isinstance(o, list):
for v in o:
dependencies.add(Dependency(ref=BomRef(value=v)))
return dependencies
@serializable.serializable_class
[docs]
class Dependency:
"""
Models a Dependency within a BOM.
.. note::
See https://cyclonedx.org/docs/1.4/xml/#type_dependencyType
"""
def __init__(self, ref: BomRef, dependencies: Optional[Iterable["Dependency"]] = None) -> None:
self.ref = ref
self.dependencies = SortedSet(dependencies or [])
@property # type: ignore[misc]
@serializable.type_mapping(BomRefHelper)
@serializable.xml_attribute()
[docs]
def ref(self) -> BomRef:
return self._ref
@ref.setter
def ref(self, ref: BomRef) -> None:
self._ref = ref
@property # type: ignore[misc]
@serializable.json_name('dependsOn')
@serializable.type_mapping(DependencyDependencies)
@serializable.xml_array(serializable.XmlArraySerializationType.FLAT, 'dependency')
[docs]
def dependencies(self) -> "SortedSet[Dependency]":
return self._dependencies
@dependencies.setter
def dependencies(self, dependencies: Iterable["Dependency"]) -> None:
self._dependencies = SortedSet(dependencies)
[docs]
def dependencies_as_bom_refs(self) -> Set[BomRef]:
return set(map(lambda d: d.ref, self.dependencies))
[docs]
def __eq__(self, other: object) -> bool:
if isinstance(other, Dependency):
return hash(other) == hash(self)
return False
[docs]
def __lt__(self, other: Any) -> bool:
if isinstance(other, Dependency):
return ComparableTuple((self.ref, tuple(self.dependencies))) < ComparableTuple(
(other.ref, tuple(other.dependencies)))
return NotImplemented
[docs]
def __hash__(self) -> int:
return hash((self.ref, tuple(self.dependencies)))
[docs]
def __repr__(self) -> str:
return f'<Dependency ref={self.ref}, targets={len(self.dependencies)}>'
[docs]
class Dependable(ABC):
"""
Dependable objects can be part of the Dependency Graph
"""
@property
@abstractmethod
[docs]
def bom_ref(self) -> BomRef:
pass