Finalize switch flow

src/opossum_lib/cli.py

@@ -5,19 +5,12 @@
 # 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.opossum_generator import (
+    OpossumGenerationArguments,
+    OpossumGenerator,
 )
-from opossum_lib.spdx.convert_to_opossum import convert_spdx_to_opossum_information
 
 
 @click.group()
@@ -73,49 +66,15 @@ def generate(
       - ScanCode
       - Opossum
     """
-    validate_input_and_exit_on_error(spdx_files, scancode_json_files, opossum_files)
-    opossum_file_content = convert_after_valid_input(
-        spdx_files, 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.generate(
+        opossum_generation_arguments=OpossumGenerationArguments(
+            spdx_files=spdx_files,
+            opossum_files=opossum_files,
+            scancode_json_files=scancode_json_files,
+            outfile=outfile,
+        )
     )
 
 
-def validate_input_and_exit_on_error(
-    spdx_files: list[str], scancode_json_files: list[str], opossum_files: list[str]
-) -> None:
-    total_number_of_files = (
-        len(spdx_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(
-    spdx_files: list[str], scancode_json_files: list[str], opossum_files: list[str]
-) -> OpossumFileContent:
-    if len(spdx_files) == 1:
-        spdx_input_file = spdx_files[0]
-        return convert_spdx_to_opossum_information(spdx_input_file)
-    elif 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/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 Enum, auto
+
+from pydantic import BaseModel
+
+
+class FileType(Enum):
+    SPDX = (auto(),)
+    OPOSSUM = (auto(),)
+    SCAN_CODE = (auto(),)
+
+
+class InputFile(BaseModel):
+    path: str
+    type: FileType

src/opossum_lib/core/opossum_generation_arguments.py

@@ -0,0 +1,50 @@
+# SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import logging
+import sys
+from pathlib import Path
+
+from pydantic import BaseModel
+
+from opossum_lib.core.input_file import FileType, InputFile
+
+
+class OpossumGenerationArguments(BaseModel):
+    spdx_files: list[str]
+    scancode_json_files: list[str]
+    opossum_files: list[str]
+    outfile: str
+
+    def validate_input_and_exit_on_error(self) -> None:
+        total_number_of_files = (
+            len(self.spdx_files)
+            + len(self.scancode_json_files)
+            + len(self.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 add_outfile_ending_and_warn_on_existing_outfile(self) -> None:
+        if not self.outfile.endswith(".opossum"):
+            self.outfile += ".opossum"
+
+        if Path.is_file(Path(self.outfile)):
+            logging.warning(f"{self.outfile} already exists and will be overwritten.")
+
+    def generate_input_file_list(self) -> list[InputFile]:
+        result = []
+        result += [
+            InputFile(path=path, type=FileType.SCAN_CODE)
+            for path in self.scancode_json_files
+        ]
+        result += [
+            InputFile(path=path, type=FileType.OPOSSUM) for path in self.opossum_files
+        ]
+        result += [InputFile(path=path, type=FileType.SPDX) for path in self.spdx_files]
+        return result

src/opossum_lib/core/opossum_generator.py

@@ -0,0 +1,41 @@
+# SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from pathlib import Path
+
+from opossum_lib.core.input_file import FileType, InputFile
+from opossum_lib.core.opossum_generation_arguments import OpossumGenerationArguments
+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.spdx.convert_to_opossum import convert_spdx_to_opossum_information
+
+
+class OpossumGenerator:
+    @staticmethod
+    def generate(opossum_generation_arguments: OpossumGenerationArguments) -> None:
+        opossum_generation_arguments.validate_input_and_exit_on_error()
+        input_files = opossum_generation_arguments.generate_input_file_list()
+        opossum_file_content = OpossumGenerator._convert_after_valid_input(input_files)
+        opossum_generation_arguments.add_outfile_ending_and_warn_on_existing_outfile()
+
+        OpossumFileWriter.write_opossum_information_to_file(
+            opossum_file_content, Path(opossum_generation_arguments.outfile)
+        )
+
+    @staticmethod
+    def _convert_after_valid_input(
+        input_file_list: list[InputFile],
+    ) -> OpossumFileContent:
+        input_file = input_file_list[0]
+
+        if input_file.type == FileType.SPDX:
+            return convert_spdx_to_opossum_information(input_file.path)
+        elif input_file.type == FileType.SCAN_CODE:
+            return convert_scancode_file_to_opossum(input_file.path)
+        else:
+            return read_opossum_file(input_file.path)

src/opossum_lib/opossum/opossum_file_to_opossum_converter.py

@@ -6,12 +6,7 @@
 from pathlib import PurePath
 
 import opossum_lib.opossum.opossum_file
-from opossum_lib.opossum.opossum_file import (
-    ExternalAttributionSource as FileExternalAttributionSource,
-)
-from opossum_lib.opossum.opossum_file import OpossumInformation
-from opossum_lib.opossum.opossum_file_content import OpossumFileContent
-from opossum_lib.opossum_model import (
+from opossum_lib.core.opossum_model import (
     BaseUrlsForSources,
     ExternalAttributionSource,
     FrequentLicense,
@@ -25,6 +20,11 @@
     SourceInfo,
     _convert_path_to_str,
 )
+from opossum_lib.opossum.opossum_file import (
+    ExternalAttributionSource as FileExternalAttributionSource,
+)
+from opossum_lib.opossum.opossum_file import OpossumInformation
+from opossum_lib.opossum.opossum_file_content import OpossumFileContent
 
 
 class OpossumFileToOpossumConverter:

src/opossum_lib/scancode/convert_scancode_to_opossum.py

@@ -9,7 +9,7 @@
 import uuid
 from pathlib import PurePath
 
-import opossum_lib.opossum_model as opossum_model
+import opossum_lib.core.opossum_model as opossum_model
 from opossum_lib.opossum.opossum_file_content import OpossumFileContent
 from opossum_lib.scancode.constants import SCANCODE_SOURCE_NAME
 from opossum_lib.scancode.model import File, FileType, Header, ScanCodeData

tests/opossum_model_generators/external_attribution_source_provider.py

@@ -7,7 +7,7 @@
 from faker.providers.misc import Provider as MiscProvider
 from faker.providers.person import Provider as PersonProvider
 
-from opossum_lib.opossum_model import ExternalAttributionSource
+from opossum_lib.core.opossum_model import ExternalAttributionSource
 from tests.util.generator_helpers import entry_or_none
 
 

tests/opossum_model_generators/metadata_provider.py

@@ -8,7 +8,7 @@
 from faker.providers.lorem.en_US import Provider as LoremProvider
 from faker.providers.misc import Provider as MiscProvider
 
-from opossum_lib.opossum_model import Metadata
+from opossum_lib.core.opossum_model import Metadata
 from tests.util.generator_helpers import entry_or_none
 
 

tests/opossum_model_generators/opossum_provider.py

@@ -5,8 +5,8 @@
 
 from faker.providers import BaseProvider
 
+from opossum_lib.core.opossum_model import Opossum, ScanResults
 from opossum_lib.opossum.output_model import OpossumOutputFile
-from opossum_lib.opossum_model import Opossum, ScanResults
 from tests.opossum_model_generators.scan_results_provider import ScanResultsProvider
 from tests.test_opossum.generators.generate_outfile_information import (
     OpossumOutputFileProvider,

tests/opossum_model_generators/package_provider.py

@@ -10,7 +10,7 @@
 from faker.providers.misc.en_US import Provider as MiscProvider
 from faker.providers.person.en_US import Provider as PersonProvider
 
-from opossum_lib.opossum_model import OpossumPackage, SourceInfo
+from opossum_lib.core.opossum_model import OpossumPackage, SourceInfo
 from tests.opossum_model_generators.source_info_provider import SourceInfoProvider
 from tests.util.generator_helpers import entry_or_none, random_list
 

tests/opossum_model_generators/resource_provider.py

@@ -8,7 +8,7 @@
 from faker.providers.file import Provider as FileProvider
 from faker.providers.misc import Provider as MiscProvider
 
-from opossum_lib.opossum_model import OpossumPackage, Resource, ResourceType
+from opossum_lib.core.opossum_model import OpossumPackage, Resource, ResourceType
 from tests.opossum_model_generators.package_provider import PackageProvider
 from tests.util.generator_helpers import random_list
 

tests/opossum_model_generators/scan_results_provider.py

@@ -8,7 +8,7 @@
 from faker.providers.file.en_US import Provider as FileProvider
 from faker.providers.misc.en_US import Provider as MiscProvider
 
-from opossum_lib.opossum_model import (
+from opossum_lib.core.opossum_model import (
     BaseUrlsForSources,
     ExternalAttributionSource,
     FrequentLicense,

tests/opossum_model_generators/source_info_provider.py

@@ -7,7 +7,7 @@
 from faker.providers.misc import Provider as MiscProvider
 from faker.providers.person.en_US import Provider as PersonProvider
 
-from opossum_lib.opossum_model import SourceInfo
+from opossum_lib.core.opossum_model import SourceInfo
 from tests.util.generator_helpers import entry_or_none
 
 

tests/test_scancode/test_convert_scancode_to_opossum.py

@@ -6,7 +6,7 @@
 import pytest
 from _pytest.logging import LogCaptureFixture
 
-from opossum_lib.opossum_model import Resource
+from opossum_lib.core.opossum_model import Resource
 from opossum_lib.scancode.convert_scancode_to_opossum import (
     convert_scancode_to_opossum,
 )