|
| 1 | +# This file is part of CycloneDX Python Library |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | +# |
| 15 | +# SPDX-License-Identifier: Apache-2.0 |
| 16 | +# Copyright (c) OWASP Foundation. All Rights Reserved. |
| 17 | + |
| 18 | +""" |
| 19 | + This set of classes represents the lifecycles types in the CycloneDX standard. |
| 20 | +
|
| 21 | +.. note:: |
| 22 | + Introduced in CycloneDX v1.5 |
| 23 | +
|
| 24 | +.. note:: |
| 25 | + See the CycloneDX Schema for lifecycles: https://cyclonedx.org/docs/1.5/#metadata_lifecycles |
| 26 | +""" |
| 27 | + |
| 28 | +from enum import Enum |
| 29 | +from json import loads as json_loads |
| 30 | +from typing import TYPE_CHECKING, Any, Dict, List, Optional, Type, Union |
| 31 | +from xml.etree.ElementTree import Element # nosec B405 |
| 32 | + |
| 33 | +import serializable |
| 34 | +from serializable.helpers import BaseHelper |
| 35 | +from sortedcontainers import SortedSet |
| 36 | + |
| 37 | +from .._internal.compare import ComparableTuple as _ComparableTuple |
| 38 | +from ..exception.serialization import CycloneDxDeserializationException |
| 39 | + |
| 40 | +if TYPE_CHECKING: # pragma: no cover |
| 41 | + from serializable import ViewType |
| 42 | + |
| 43 | + |
| 44 | +@serializable.serializable_enum |
| 45 | +class LifecyclePhase(str, Enum): |
| 46 | + """ |
| 47 | + Enum object that defines the permissible 'phase' for a Lifecycle according to the CycloneDX schema. |
| 48 | +
|
| 49 | + .. note:: |
| 50 | + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.3/#type_classification |
| 51 | + """ |
| 52 | + DESIGN = 'design' |
| 53 | + PRE_BUILD = 'pre-build' |
| 54 | + BUILD = 'build' |
| 55 | + POST_BUILD = 'post-build' |
| 56 | + OPERATIONS = 'operations' |
| 57 | + DISCOVERY = 'discovery' |
| 58 | + DECOMMISSION = 'decommission' |
| 59 | + |
| 60 | + |
| 61 | +@serializable.serializable_class |
| 62 | +class PredefinedLifecycle: |
| 63 | + """ |
| 64 | + Object that defines pre-defined phases in the product lifecycle. |
| 65 | +
|
| 66 | + .. note:: |
| 67 | + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.5/#metadata_lifecycles |
| 68 | + """ |
| 69 | + |
| 70 | + def __init__(self, phase: LifecyclePhase) -> None: |
| 71 | + self._phase = phase |
| 72 | + |
| 73 | + @property |
| 74 | + def phase(self) -> LifecyclePhase: |
| 75 | + return self._phase |
| 76 | + |
| 77 | + @phase.setter |
| 78 | + def phase(self, phase: LifecyclePhase) -> None: |
| 79 | + self._phase = phase |
| 80 | + |
| 81 | + def __hash__(self) -> int: |
| 82 | + return hash(self._phase) |
| 83 | + |
| 84 | + def __eq__(self, other: object) -> bool: |
| 85 | + if isinstance(other, PredefinedLifecycle): |
| 86 | + return hash(other) == hash(self) |
| 87 | + return False |
| 88 | + |
| 89 | + def __lt__(self, other: Any) -> bool: |
| 90 | + if isinstance(other, PredefinedLifecycle): |
| 91 | + return self._phase < other._phase |
| 92 | + if isinstance(other, NamedLifecycle): |
| 93 | + return True # put PredefinedLifecycle before any NamedLifecycle |
| 94 | + return NotImplemented |
| 95 | + |
| 96 | + def __repr__(self) -> str: |
| 97 | + return f'<PredefinedLifecycle phase={self._phase}>' |
| 98 | + |
| 99 | + |
| 100 | +@serializable.serializable_class |
| 101 | +class NamedLifecycle: |
| 102 | + """ |
| 103 | + Object that defines custom state in the product lifecycle. |
| 104 | +
|
| 105 | + .. note:: |
| 106 | + See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.5/#metadata_lifecycles |
| 107 | + """ |
| 108 | + |
| 109 | + def __init__(self, name: str, *, description: Optional[str] = None) -> None: |
| 110 | + self._name = name |
| 111 | + self._description = description |
| 112 | + |
| 113 | + @property |
| 114 | + @serializable.xml_sequence(1) |
| 115 | + @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING) |
| 116 | + def name(self) -> str: |
| 117 | + """ |
| 118 | + Name of the lifecycle phase. |
| 119 | +
|
| 120 | + Returns: |
| 121 | + `str` |
| 122 | + """ |
| 123 | + return self._name |
| 124 | + |
| 125 | + @name.setter |
| 126 | + def name(self, name: str) -> None: |
| 127 | + self._name = name |
| 128 | + |
| 129 | + @property |
| 130 | + @serializable.xml_sequence(2) |
| 131 | + @serializable.xml_string(serializable.XmlStringSerializationType.NORMALIZED_STRING) |
| 132 | + def description(self) -> Optional[str]: |
| 133 | + """ |
| 134 | + Description of the lifecycle phase. |
| 135 | +
|
| 136 | + Returns: |
| 137 | + `str` |
| 138 | + """ |
| 139 | + return self._description |
| 140 | + |
| 141 | + @description.setter |
| 142 | + def description(self, description: Optional[str]) -> None: |
| 143 | + self._description = description |
| 144 | + |
| 145 | + def __hash__(self) -> int: |
| 146 | + return hash((self._name, self._description)) |
| 147 | + |
| 148 | + def __eq__(self, other: object) -> bool: |
| 149 | + if isinstance(other, NamedLifecycle): |
| 150 | + return hash(other) == hash(self) |
| 151 | + return False |
| 152 | + |
| 153 | + def __lt__(self, other: Any) -> bool: |
| 154 | + if isinstance(other, NamedLifecycle): |
| 155 | + return _ComparableTuple((self._name, self._description)) < _ComparableTuple( |
| 156 | + (other._name, other._description) |
| 157 | + ) |
| 158 | + if isinstance(other, PredefinedLifecycle): |
| 159 | + return False # put NamedLifecycle after any PredefinedLifecycle |
| 160 | + return NotImplemented |
| 161 | + |
| 162 | + def __repr__(self) -> str: |
| 163 | + return f'<NamedLifecycle name={self._name}>' |
| 164 | + |
| 165 | + |
| 166 | +Lifecycle = Union[PredefinedLifecycle, NamedLifecycle] |
| 167 | +"""TypeAlias for a union of supported lifecycle models. |
| 168 | +
|
| 169 | +- :class:`PredefinedLifecycle` |
| 170 | +- :class:`NamedLifecycle` |
| 171 | +""" |
| 172 | + |
| 173 | +if TYPE_CHECKING: # pragma: no cover |
| 174 | + # workaround for https://github.com/python/mypy/issues/5264 |
| 175 | + # this code path is taken when static code analysis or documentation tools runs through. |
| 176 | + class LifecycleRepository(SortedSet[Lifecycle]): |
| 177 | + """Collection of :class:`Lifecycle`. |
| 178 | +
|
| 179 | + This is a `set`, not a `list`. Order MUST NOT matter here. |
| 180 | + """ |
| 181 | +else: |
| 182 | + class LifecycleRepository(SortedSet): |
| 183 | + """Collection of :class:`Lifecycle`. |
| 184 | +
|
| 185 | + This is a `set`, not a `list`. Order MUST NOT matter here. |
| 186 | + """ |
| 187 | + |
| 188 | + |
| 189 | +class _LifecycleRepositoryHelper(BaseHelper): |
| 190 | + @classmethod |
| 191 | + def json_normalize(cls, o: LifecycleRepository, *, |
| 192 | + view: Optional[Type['ViewType']], |
| 193 | + **__: Any) -> Any: |
| 194 | + if len(o) == 0: |
| 195 | + return None |
| 196 | + return [json_loads(li.as_json( # type:ignore[union-attr] |
| 197 | + view_=view)) for li in o] |
| 198 | + |
| 199 | + @classmethod |
| 200 | + def json_denormalize(cls, o: List[Dict[str, Any]], |
| 201 | + **__: Any) -> LifecycleRepository: |
| 202 | + repo = LifecycleRepository() |
| 203 | + for li in o: |
| 204 | + if 'phase' in li: |
| 205 | + repo.add(PredefinedLifecycle.from_json( # type:ignore[attr-defined] |
| 206 | + li)) |
| 207 | + elif 'name' in li: |
| 208 | + repo.add(NamedLifecycle.from_json( # type:ignore[attr-defined] |
| 209 | + li)) |
| 210 | + else: |
| 211 | + raise CycloneDxDeserializationException(f'unexpected: {li!r}') |
| 212 | + return repo |
| 213 | + |
| 214 | + @classmethod |
| 215 | + def xml_normalize(cls, o: LifecycleRepository, *, |
| 216 | + element_name: str, |
| 217 | + view: Optional[Type['ViewType']], |
| 218 | + xmlns: Optional[str], |
| 219 | + **__: Any) -> Optional[Element]: |
| 220 | + if len(o) == 0: |
| 221 | + return None |
| 222 | + elem = Element(element_name) |
| 223 | + for li in o: |
| 224 | + elem.append(li.as_xml( # type:ignore[union-attr] |
| 225 | + view_=view, as_string=False, element_name='lifecycle', xmlns=xmlns)) |
| 226 | + return elem |
| 227 | + |
| 228 | + @classmethod |
| 229 | + def xml_denormalize(cls, o: Element, |
| 230 | + default_ns: Optional[str], |
| 231 | + **__: Any) -> LifecycleRepository: |
| 232 | + repo = LifecycleRepository() |
| 233 | + ns_map = {'bom': default_ns or ''} |
| 234 | + # Do not iterate over `o` and do not check for expected `.tag` of items. |
| 235 | + # This check could have been done by schema validators before even deserializing. |
| 236 | + for li in o.iterfind('bom:lifecycle', ns_map): |
| 237 | + if li.find('bom:phase', ns_map) is not None: |
| 238 | + repo.add(PredefinedLifecycle.from_xml( # type:ignore[attr-defined] |
| 239 | + li, default_ns)) |
| 240 | + elif li.find('bom:name', ns_map) is not None: |
| 241 | + repo.add(NamedLifecycle.from_xml( # type:ignore[attr-defined] |
| 242 | + li, default_ns)) |
| 243 | + else: |
| 244 | + raise CycloneDxDeserializationException(f'unexpected content: {li!r}') |
| 245 | + return repo |
0 commit comments