feat: introduce opossum files to CLI

* create interface with basic test
* create empty function shell for conversion

Author: Hellgartner

src/opossum_lib/cli.py

@@ -12,6 +12,8 @@
 import click
 
 from opossum_lib.opossum.file_generation import write_opossum_information_to_file
+from opossum_lib.opossum.opossum_file import OpossumInformation
+from opossum_lib.opossum.read_opossum_file import read_opossum_file
 from opossum_lib.spdx.convert_to_opossum import convert_spdx_to_opossum_information
 
 
@@ -27,6 +29,12 @@ def opossum_file() -> None:
     multiple=True,
     type=click.Path(exists=True),
 )
+@click.option(
+    "--opossum",
+    help="opossum files used as input.",
+    multiple=True,
+    type=click.Path(exists=True),
+)
 @click.option(
     "--outfile",
     "-o",
@@ -35,23 +43,16 @@ def opossum_file() -> None:
     help="The file path to write the generated opossum document to. "
     'If appropriate, the extension ".opossum" will be appended.',
 )
-def generate(spdx: list[str], outfile: str) -> None:
+def generate(spdx: list[str], opossum: list[str], outfile: str) -> None:
     """
     Generate an Opossum file from various other file formats.
 
     \b
     Currently supported input formats:
       - SPDX
     """
-    if len(spdx) == 0:
-        logging.warning("No input provided. Exiting.")
-        sys.exit(1)
-    if len(spdx) > 1:
-        logging.error("Merging of multiple SPDX files not yet supported!")
-        sys.exit(1)
-
-    the_spdx_file = spdx[0]
-    opossum_information = convert_spdx_to_opossum_information(the_spdx_file)
+    validate_input_exit_on_error(spdx, opossum)
+    opossum_information = convert_after_valid_input(spdx, opossum)
 
     if not outfile.endswith(".opossum"):
         outfile += ".opossum"
@@ -62,5 +63,26 @@ def generate(spdx: list[str], outfile: str) -> None:
     write_opossum_information_to_file(opossum_information, Path(outfile))
 
 
+def validate_input_exit_on_error(spdx: list[str], opossum: list[str]) -> None:
+    total_number_of_files = len(spdx) + len(opossum)
+    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: list[str], opossum_files: list[str]
+) -> OpossumInformation:
+    if len(spdx) == 1:
+        the_spdx_file = spdx[0]
+        return convert_spdx_to_opossum_information(the_spdx_file)
+    else:
+        opossum_file = opossum_files[0]
+        return read_opossum_file(opossum_file)
+
+
 if __name__ == "__main__":
     opossum_file()

src/opossum_lib/opossum/read_opossum_file.py

@@ -0,0 +1,29 @@
+# SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+import logging
+from datetime import datetime
+
+from opossum_lib.opossum.opossum_file import (
+    Metadata,
+    OpossumInformation,
+    Resource,
+    ResourceType,
+)
+
+
+def read_opossum_file(filename: str) -> OpossumInformation:
+    logging.info(f"Converting opossum to opossum {filename}")
+    dummy_metadata = Metadata(
+        projectId="test id",
+        fileCreationDate=datetime.now().isoformat(),
+        projectTitle="test title",
+    )
+    return OpossumInformation(
+        metadata=dummy_metadata,
+        resources=Resource(type=ResourceType.FILE, children={}),
+        externalAttributions={},
+        resourcesToAttributions={},
+        attributionBreakpoints=[],
+        externalAttributionSources={},
+    )

tests/data/opossum_input.opossum

@@ -13,9 +13,19 @@
 from opossum_lib.cli import generate
 from tests.test_spdx.helper_methods import _create_minimal_document
 
+test_data_path = Path(__file__).resolve().parent / "data"
+
+
+def generate_valid_spdx_argument(filename: str = "SPDX.spdx") -> str:
+    return "--spdx " + str(test_data_path / filename)
+
+
+def generate_valid_opossum_argument(filename: str = "opossum_input.opossum") -> str:
+    return "--opossum " + str(test_data_path / filename)
+
 
 @pytest.mark.parametrize("options", ["--outfile", "-o"])
-def test_cli_with_system_exit_code_0(tmp_path: Path, options: str) -> None:
+def test_successful_conversion_of_spdx_file(tmp_path: Path, options: str) -> None:
     runner = CliRunner()
 
     result = runner.invoke(
@@ -47,6 +57,22 @@ def test_cli_with_system_exit_code_0(tmp_path: Path, options: str) -> None:
     assert opossum_dict == expected_opossum_dict
 
 
+def test_successful_conversion_of_opossum_file(tmp_path: Path) -> None:
+    runner = CliRunner()
+
+    result = runner.invoke(
+        generate,
+        [
+            "--opossum",
+            str(Path(__file__).resolve().parent / "data" / "opossum_input.opossum"),
+            "-o",
+            str(tmp_path / "output_opossum"),
+        ],
+    )
+
+    assert result.exit_code == 0
+
+
 def test_cli_no_output_file_provided() -> None:
     runner = CliRunner()
 
@@ -104,17 +130,24 @@ def test_cli_with_invalid_document(caplog: LogCaptureFixture) -> None:
     ]
 
 
-def test_cli_with_multiple_documents(caplog: LogCaptureFixture) -> None:
+@pytest.mark.parametrize(
+    "options",
+    [
+        generate_valid_spdx_argument() + " " + generate_valid_spdx_argument(),
+        generate_valid_spdx_argument() + " " + generate_valid_opossum_argument(),
+        generate_valid_opossum_argument() + " " + generate_valid_opossum_argument(),
+    ],
+)
+def test_cli_with_multiple_files(caplog: LogCaptureFixture, options: list[str]) -> None:
     runner = CliRunner()
-    path_to_spdx = str(Path(__file__).resolve().parent / "data" / "SPDX.spdx")
 
     result = runner.invoke(
         generate,
-        ["--spdx", path_to_spdx, "--spdx", path_to_spdx],
+        options,
     )
     assert result.exit_code == 1
 
-    assert caplog.messages == ["Merging of multiple SPDX files not yet supported!"]
+    assert caplog.messages == ["Merging of multiple files not yet supported!"]
 
 
 def test_cli_without_inputs(caplog: LogCaptureFixture) -> None: