Merge pull request #207 from opossum-tool/finalize_switch_flow

Finalize switch flow

Author: abraemer

.github/workflows/lint_and_run_tests.yml

@@ -48,6 +48,9 @@ jobs:
       - name: Run mypy
         run: uv run python -m mypy src/ tests/
 
+      - name: Run import linter
+        run: uv run lint-imports
+
   test:
     runs-on: ${{ matrix.os }}
     if: |

.importlinter

@@ -0,0 +1,32 @@
+# SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+[importlinter]
+root_package = opossum_lib
+# Optional:
+include_external_packages = True
+exclude_type_checking_imports = True
+
+[importlinter:contract:file-formats-independent]
+name = The different file formats should be independent
+type = independence
+modules =
+    opossum_lib.input_formats.*
+
+
+[importlinter:contract:core-should-not-depend -on-input-files]
+name = Core should not depend on input files
+type = forbidden
+source_modules =
+    opossum_lib.core
+forbidden_modules =
+    opossum_lib.input_formats
+
+[importlinter:contract:shared_objects_not_depend_on_input_formats]
+name = Shared package not depend on input formats
+type = forbidden
+source_modules =
+    opossum_lib.shared
+forbidden_modules =
+    opossum_lib.input_formats

README.md

@@ -64,8 +64,9 @@ Options:
                          that you would like to include in the final output.
                          Option can be repeated.
   -o, --outfile TEXT     The file path to write the generated opossum document
-                         to. If appropriate, the extension ".opossum" will be
-                         appended.  [default: output.opossum]
+                         to. If appropriate, the extension ".opossum" is
+                         appended. If the output file already exists, it is
+                         overwritten.  [default: output.opossum]
   --help                 Show this message and exit.
 
 
@@ -80,6 +81,7 @@ uv run ruff check
 uv run ruff format --check
 uv run python -m mypy src/ tests/
 uv run pytest
+uv run lint-imports
 ```
 
 # Build

pyproject.toml

@@ -12,7 +12,6 @@ dependencies = [
     "click>=8.1.8,<9",
     "pydantic>=2.10.6",
     "pyinstaller>=6.11.1",
-    "faker>=35.0.0",
 ]
 
 [project.urls]
@@ -22,11 +21,12 @@ Repository = "https://github.com/opossum-tool/opossum-file"
 opossum-file = "opossum_lib.cli:opossum_file"
 
 [dependency-groups]
-test = ["pytest>=8.3.4,<9"]
+test = ["pytest>=8.3.4,<9", "faker>=35.0.0",]
 dev = [
     "mypy>=1.14.1,<2",
     "pre-commit>=4.1.0,<5",
     "ruff>=0.9.3",
+    "import-linter>=2.1",
 ]
 
 [tool.uv]

src/opossum_lib/cli.py

@@ -3,19 +3,21 @@
 # SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
 #
 # SPDX-License-Identifier: Apache-2.0
-
-
 import logging
 import sys
 from pathlib import Path
 
 import click
 
-from opossum_lib.opossum.file_generation import OpossumFileWriter
-from opossum_lib.opossum.opossum_file_content import OpossumFileContent
-from opossum_lib.opossum.read_opossum_file import read_opossum_file
-from opossum_lib.scancode.convert_scancode_to_opossum import (
-    convert_scancode_file_to_opossum,
+from opossum_lib.core.services.generate_impl import (
+    generate_impl,
+)
+from opossum_lib.core.services.input_reader import InputReader
+from opossum_lib.input_formats.opossum.services.opossum_file_reader import (
+    OpossumFileReader,
+)
+from opossum_lib.input_formats.scancode.services.scancode_file_reader import (
+    ScancodeFileReader,
 )
 
 
@@ -47,12 +49,13 @@ def opossum_file() -> None:
     default="output.opossum",
     show_default=True,
     help="The file path to write the generated opossum document to. "
-    'If appropriate, the extension ".opossum" will be appended.',
+    'If appropriate, the extension ".opossum" is appended. '
+    "If the output file already exists, it is overwritten.",
 )
 def generate(
-    scancode_json_files: list[str],
-    opossum_files: list[str],
-    outfile: str,
+    scancode_json_files: list[Path],
+    opossum_files: list[Path],
+    outfile: Path,
 ) -> None:
     """
     Generate an Opossum file from various other file formats.
@@ -62,41 +65,19 @@ def generate(
       - ScanCode
       - Opossum
     """
-    validate_input_and_exit_on_error(scancode_json_files, opossum_files)
-    opossum_file_content = convert_after_valid_input(scancode_json_files, opossum_files)
-
-    if not outfile.endswith(".opossum"):
-        outfile += ".opossum"
 
-    if Path.is_file(Path(outfile)):
-        logging.warning(f"{outfile} already exists and will be overwritten.")
-
-    OpossumFileWriter.write_opossum_information_to_file(
-        opossum_file_content, Path(outfile)
-    )
-
-
-def validate_input_and_exit_on_error(
-    scancode_json_files: list[str], opossum_files: list[str]
-) -> None:
     total_number_of_files = len(scancode_json_files) + len(opossum_files)
     if total_number_of_files == 0:
         logging.warning("No input provided. Exiting.")
         sys.exit(1)
     if total_number_of_files > 1:
         logging.error("Merging of multiple files not yet supported!")
         sys.exit(1)
+    input_readers: list[InputReader] = []
+    input_readers += [ScancodeFileReader(path=path) for path in scancode_json_files]
+    input_readers += [OpossumFileReader(path=path) for path in opossum_files]
 
-
-def convert_after_valid_input(
-    scancode_json_files: list[str], opossum_files: list[str]
-) -> OpossumFileContent:
-    if len(scancode_json_files) == 1:
-        scancode_json_input_file = scancode_json_files[0]
-        return convert_scancode_file_to_opossum(scancode_json_input_file)
-    else:
-        opossum_input_file = opossum_files[0]
-        return read_opossum_file(opossum_input_file)
+    generate_impl(input_readers=input_readers, output_file=Path(outfile))
 
 
 if __name__ == "__main__":

src/opossum_lib/opossum/__init__.py src/opossum_lib/core/__init__.py

@@ -0,0 +1,16 @@
+#  SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+#  #
+#  SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict
+
+from opossum_lib.shared.entities.opossum_input_file_model import BaseUrlsForSourcesModel
+
+
+class BaseUrlsForSources(BaseModel):
+    model_config = ConfigDict(frozen=True, extra="allow")
+
+    def to_opossum_file_model(self) -> BaseUrlsForSourcesModel:
+        return BaseUrlsForSourcesModel(**self.model_dump())

src/opossum_lib/scancode/__init__.py src/opossum_lib/core/entities/__init__.py

@@ -0,0 +1,25 @@
+#  SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+#  #
+#  SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict
+
+from opossum_lib.shared.entities.opossum_input_file_model import (
+    ExternalAttributionSourceModel,
+)
+
+
+class ExternalAttributionSource(BaseModel):
+    model_config = ConfigDict(frozen=True, extra="forbid")
+    name: str
+    priority: int
+    is_relevant_for_preferred: bool | None = None
+
+    def to_opossum_file_model(self) -> ExternalAttributionSourceModel:
+        return ExternalAttributionSourceModel(
+            name=self.name,
+            priority=self.priority,
+            is_relevant_for_preferred=self.is_relevant_for_preferred,
+        )

src/opossum_lib/core/entities/base_url_for_sources.py

@@ -0,0 +1,23 @@
+#  SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+#  #
+#  SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict
+
+from opossum_lib.shared.entities.opossum_input_file_model import FrequentLicenseModel
+
+
+class FrequentLicense(BaseModel):
+    model_config = ConfigDict(frozen=True, extra="forbid")
+    full_name: str
+    short_name: str
+    default_text: str
+
+    def to_opossum_file_model(self) -> FrequentLicenseModel:
+        return FrequentLicenseModel(
+            full_name=self.full_name,
+            short_name=self.short_name,
+            default_text=self.default_text,
+        )

src/opossum_lib/core/entities/external_attribution_source.py

@@ -0,0 +1,22 @@
+#  SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+#  #
+#  SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict
+
+from opossum_lib.shared.entities.opossum_input_file_model import MetadataModel
+
+
+class Metadata(BaseModel):
+    model_config = ConfigDict(frozen=True, extra="allow")
+    project_id: str
+    file_creation_date: str
+    project_title: str
+    project_version: str | None = None
+    expected_release_date: str | None = None
+    build_date: str | None = None
+
+    def to_opossum_file_model(self) -> MetadataModel:
+        return MetadataModel(**self.model_dump())

src/opossum_lib/core/entities/frequent_license.py

@@ -0,0 +1,26 @@
+# SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict
+
+from opossum_lib.core.entities.scan_results import ScanResults
+from opossum_lib.shared.entities.opossum_file_model import OpossumFileModel
+from opossum_lib.shared.entities.opossum_output_file_model import OpossumOutputFileModel
+
+type OpossumPackageIdentifier = str
+type ResourcePath = str
+
+
+class Opossum(BaseModel):
+    model_config = ConfigDict(frozen=True, extra="forbid")
+    scan_results: ScanResults
+    review_results: OpossumOutputFileModel | None = None
+
+    def to_opossum_file_model(self) -> OpossumFileModel:
+        return OpossumFileModel(
+            input_file=self.scan_results.to_opossum_file_model(),
+            output_file=self.review_results,
+        )

src/opossum_lib/core/entities/metadata.py

@@ -0,0 +1,60 @@
+#  SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+#  #
+#  SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal
+
+from pydantic import BaseModel, ConfigDict
+
+from opossum_lib.core.entities.source_info import SourceInfo
+from opossum_lib.shared.entities.opossum_input_file_model import OpossumPackageModel
+
+
+class OpossumPackage(BaseModel):
+    model_config = ConfigDict(frozen=True, extra="forbid")
+    source: SourceInfo
+    attribution_confidence: int | None = None
+    comment: str | None = None
+    package_name: str | None = None
+    package_version: str | None = None
+    package_namespace: str | None = None
+    package_type: str | None = None
+    package_purl_appendix: str | None = None
+    copyright: str | None = None
+    license_name: str | None = None
+    license_text: str | None = None
+    url: str | None = None
+    first_party: bool | None = None
+    exclude_from_notice: bool | None = None
+    pre_selected: bool | None = None
+    follow_up: Literal["FOLLOW_UP"] | None = None
+    origin_id: str | None = None
+    origin_ids: tuple[str, ...] | None = None
+    criticality: Literal["high"] | Literal["medium"] | None = None
+    was_preferred: bool | None = None
+
+    def to_opossum_file_model(self) -> OpossumPackageModel:
+        return OpossumPackageModel(
+            source=self.source.to_opossum_file_model(),
+            attribution_confidence=self.attribution_confidence,
+            comment=self.comment,
+            package_name=self.package_name,
+            package_version=self.package_version,
+            package_namespace=self.package_namespace,
+            package_type=self.package_type,
+            package_p_u_r_l_appendix=self.package_purl_appendix,
+            copyright=self.copyright,
+            license_name=self.license_name,
+            license_text=self.license_text,
+            url=self.url,
+            first_party=self.first_party,
+            exclude_from_notice=self.exclude_from_notice,
+            pre_selected=self.pre_selected,
+            follow_up=self.follow_up,
+            origin_id=self.origin_id,
+            origin_ids=self.origin_ids,
+            criticality=self.criticality,
+            was_preferred=self.was_preferred,
+        )