spdx_tools.spdx3.model.relationship

  1# SPDX-FileCopyrightText: 2023 spdx contributors
  2#
  3# SPDX-License-Identifier: Apache-2.0
  4from dataclasses import field
  5from datetime import datetime
  6from enum import Enum, auto
  7
  8from beartype.typing import List, Optional
  9
 10from spdx_tools.common.typing.dataclass_with_properties import dataclass_with_properties
 11from spdx_tools.common.typing.type_checks import check_types_and_set_values
 12from spdx_tools.spdx3.model import CreationInfo, Element, ExternalIdentifier, ExternalReference, IntegrityMethod
 13
 14
 15class RelationshipType(Enum):
 16    AFFECTS = auto()
 17    AMENDS = auto()
 18    ANCESTOR = auto()
 19    AVAILABLE_FROM = auto()
 20    BUILD_DEPENDENCY = auto()
 21    BUILD_TOOL = auto()
 22    COORDINATED_BY = auto()
 23    CONTAINS = auto()
 24    CONFIG_OF = auto()
 25    COPY = auto()
 26    DATA_FILE = auto()
 27    DEPENDENCY_MANIFEST = auto()
 28    DEPENDS_ON = auto()
 29    DESCENDANT = auto()
 30    DESCRIBES = auto()
 31    DEV_DEPENDENCY = auto()
 32    DEV_TOOL = auto()
 33    DISTRIBUTION_ARTIFACT = auto()
 34    DOCUMENTATION = auto()
 35    DOES_NOT_AFFECT = auto()
 36    DYNAMIC_LINK = auto()
 37    EXAMPLE = auto()
 38    EVIDENCE_FOR = auto()
 39    EXPANDED_FROM_ARCHIVE = auto()
 40    EXPLOIT_CREATED_BY = auto()
 41    FILE_ADDED = auto()
 42    FILE_DELETED = auto()
 43    FILE_MODIFIED = auto()
 44    FIXED_BY = auto()
 45    FIXED_IN = auto()
 46    FOUND_BY = auto()
 47    GENERATES = auto()
 48    HAS_ASSESSMENT_FOR = auto()
 49    HAS_ASSOCIATED_VULNERABILITY = auto()
 50    HOST_OF = auto()
 51    INPUT_OF = auto()
 52    INVOKED_BY = auto()
 53    METAFILE = auto()
 54    ON_BEHALF_OF = auto()
 55    OPTIONAL_COMPONENT = auto()
 56    OPTIONAL_DEPENDENCY = auto()
 57    OTHER = auto()
 58    OUTPUT_OF = auto()
 59    PACKAGES = auto()
 60    PATCH = auto()
 61    PREREQUISITE = auto()
 62    PROVIDED_DEPENDENCY = auto()
 63    PUBLISHED_BY = auto()
 64    REPORTED_BY = auto()
 65    REPUBLISHED_BY = auto()
 66    REQUIREMENT_FOR = auto()
 67    RUNTIME_DEPENDENCY = auto()
 68    SPECIFICATION_FOR = auto()
 69    STATIC_LINK = auto()
 70    TEST = auto()
 71    TEST_CASE = auto()
 72    TEST_DEPENDENCY = auto()
 73    TEST_TOOL = auto()
 74    TESTED_ON = auto()
 75    TRAINED_ON = auto()
 76    UNDER_INVESTIGATION_FOR = auto()
 77    VARIANT = auto()
 78
 79
 80class RelationshipCompleteness(Enum):
 81    INCOMPLETE = auto()
 82    COMPLETE = auto()
 83    NOASSERTION = auto()
 84
 85
 86@dataclass_with_properties
 87class Relationship(Element):
 88    # due to the inheritance we need to make all fields non-default in the __annotation__,
 89    # the __init__ method still raises an error if required fields are not set
 90    from_element: str = None
 91    to: List[str] = field(default_factory=list)
 92    relationship_type: RelationshipType = None
 93    completeness: Optional[RelationshipCompleteness] = None
 94    start_time: Optional[datetime] = None
 95    end_time: Optional[datetime] = None
 96
 97    def __init__(
 98        self,
 99        spdx_id: str,
100        from_element: str,
101        relationship_type: RelationshipType,
102        to: List[str] = None,
103        creation_info: Optional[CreationInfo] = None,
104        name: Optional[str] = None,
105        summary: Optional[str] = None,
106        description: Optional[str] = None,
107        comment: Optional[str] = None,
108        verified_using: List[IntegrityMethod] = None,
109        external_reference: List[ExternalReference] = None,
110        external_identifier: List[ExternalIdentifier] = None,
111        extension: Optional[str] = None,
112        completeness: Optional[RelationshipCompleteness] = None,
113        start_time: Optional[datetime] = None,
114        end_time: Optional[datetime] = None,
115    ):
116        to = [] if to is None else to
117        verified_using = [] if verified_using is None else verified_using
118        external_reference = [] if external_reference is None else external_reference
119        external_identifier = [] if external_identifier is None else external_identifier
120        check_types_and_set_values(self, locals())