Finalize switch flow

.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.
 
 

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

@@ -1,21 +1,21 @@
 #!/usr/bin/env python3
+from pathlib import Path
 
 # 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.entities.input_file import InputFileType
+from opossum_lib.core.services.opossum_generator import (
+    OpossumGenerationArguments,
+    OpossumGenerator,
+)
+from opossum_lib.input_formats.opossum.services.opossum_format_reader import (
+    OpossumFormatReader,
+)
+from opossum_lib.input_formats.scancode.services.scancode_format_reader import (
+    ScancodeFormatReader,
 )
 
 
@@ -47,12 +47,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,42 +63,21 @@ 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)
+    (
+        OpossumGenerator(
+            input_format_readers={
+                InputFileType.OPOSSUM: OpossumFormatReader(),
+                InputFileType.SCAN_CODE: ScancodeFormatReader(),
+            }
+        ).generate(
+            opossum_generation_arguments=OpossumGenerationArguments(
+                opossum_files=opossum_files,
+                scancode_json_files=scancode_json_files,
+                outfile=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)
-
-
-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)
-
-
 if __name__ == "__main__":
     opossum_file()

src/opossum_lib/core/entities/input_file.py

@@ -0,0 +1,17 @@
+# SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+from enum import IntEnum, auto
+from pathlib import Path
+
+from pydantic import BaseModel
+
+
+class InputFileType(IntEnum):
+    OPOSSUM = (auto(),)
+    SCAN_CODE = (auto(),)
+
+
+class InputFile(BaseModel):
+    path: Path
+    type: InputFileType