Merge pull request #165 from opossum-tool/refactor-split-into-packages

Refactor: split into packages

Author: abraemer

pyproject.toml

@@ -39,6 +39,7 @@ package = true
 warn_return_any = true
 warn_unused_configs = true
 disallow_untyped_defs = true
+mypy_path='src:tests'
 
 [[tool.mypy.overrides]]
 module = [

src/opossum_lib/cli.py

@@ -10,14 +10,9 @@
 from pathlib import Path
 
 import click
-from spdx_tools.spdx.model.document import Document as SpdxDocument
-from spdx_tools.spdx.parser.error import SPDXParsingError
-from spdx_tools.spdx.parser.parse_anything import parse_file
-from spdx_tools.spdx.validation.document_validator import validate_full_spdx_document
 
-from opossum_lib.file_generation import generate_json_file_from_tree, write_dict_to_file
-from opossum_lib.graph_generation import generate_graph_from_spdx
-from opossum_lib.tree_generation import generate_tree_from_graph
+from opossum_lib.opossum.file_generation import write_opossum_information_to_file
+from opossum_lib.spdx.convert_to_opossum import convert_spdx_to_opossum_information
 
 
 @click.group()
@@ -56,35 +51,15 @@ def generate(spdx: list[str], outfile: str) -> None:
         sys.exit(1)
 
     the_spdx_file = spdx[0]
-    try:
-        document: SpdxDocument = parse_file(the_spdx_file)
-
-    except SPDXParsingError as err:
-        log_string = "\n".join(
-            ["There have been issues while parsing the provided document:"]
-            + [message for message in err.get_messages()]
-        )
-        logging.error(log_string)
-        sys.exit(1)
-    validation_messages = validate_full_spdx_document(document)
-    if validation_messages:
-        logging.warning(
-            "The given SPDX document is not valid, this might cause "
-            "issues with the conversion."
-        )
-
-    graph = generate_graph_from_spdx(document)
-    tree = generate_tree_from_graph(graph)
-
-    opossum_information = generate_json_file_from_tree(tree)
+    opossum_information = convert_spdx_to_opossum_information(the_spdx_file)
 
     if not outfile.endswith(".opossum"):
         outfile += ".opossum"
 
     if Path.is_file(Path(outfile)):
         logging.warning(f"{outfile} already exists and will be overwritten.")
 
-    write_dict_to_file(opossum_information, Path(outfile))
+    write_opossum_information_to_file(opossum_information, Path(outfile))
 
 
 if __name__ == "__main__":

src/opossum_lib/opossum/__init__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+COMPRESSION_LEVEL = 5

src/opossum_lib/opossum/constants.py

@@ -0,0 +1,62 @@
+# SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+import json
+from dataclasses import fields
+from pathlib import Path
+from zipfile import ZIP_DEFLATED, ZipFile
+
+from opossum_lib.opossum.constants import COMPRESSION_LEVEL
+from opossum_lib.opossum.opossum_file import (
+    ExternalAttributionSource,
+    Metadata,
+    OpossumInformation,
+    OpossumPackage,
+    Resource,
+    SourceInfo,
+)
+
+
+def write_opossum_information_to_file(
+    opossum_information: OpossumInformation, file_path: Path
+) -> None:
+    with ZipFile(
+        file_path, "w", compression=ZIP_DEFLATED, compresslevel=COMPRESSION_LEVEL
+    ) as z:
+        z.writestr("input.json", json.dumps(to_dict(opossum_information), indent=4))
+
+
+def to_dict(
+    element: Resource
+    | Metadata
+    | OpossumPackage
+    | OpossumInformation
+    | SourceInfo
+    | ExternalAttributionSource
+    | str
+    | int
+    | bool
+    | dict[str, OpossumPackage]
+    | dict[str, list[str]]
+    | list[str]
+    | None,
+) -> dict | str | list[str] | bool | int | None:
+    if isinstance(element, Resource):
+        return element.to_dict()
+    if isinstance(
+        element,
+        Metadata
+        | OpossumPackage
+        | OpossumInformation
+        | SourceInfo
+        | ExternalAttributionSource,
+    ):
+        result = []
+        for f in fields(element):
+            value = to_dict(getattr(element, f.name))
+            result.append((f.name, value))
+        return {k: v for (k, v) in result if v is not None}
+    elif isinstance(element, dict):
+        return {k: to_dict(v) for k, v in element.items()}
+    else:
+        return element

src/opossum_lib/opossum/file_generation.py

@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: Apache-2.0
 from typing import Any
 
-from opossum_lib.opossum_file import (
+from opossum_lib.opossum.opossum_file import (
     OpossumInformation,
     OpossumPackageIdentifier,
     Resource,

src/opossum_lib/merger.py src/opossum_lib/opossum/merger.py

@@ -12,13 +12,13 @@
 from spdx_tools.spdx.writer.tagvalue.package_writer import write_package
 from spdx_tools.spdx.writer.tagvalue.snippet_writer import write_snippet
 
-from opossum_lib.constants import (
+from opossum_lib.opossum.opossum_file import OpossumPackage, SourceInfo
+from opossum_lib.spdx.constants import (
     PURL,
     SPDX_FILE_IDENTIFIER,
     SPDX_PACKAGE_IDENTIFIER,
     SPDX_SNIPPET_IDENTIFIER,
 )
-from opossum_lib.opossum_file import OpossumPackage, SourceInfo
 
 
 def _get_purl(package: Package) -> str | None:

src/opossum_lib/opossum_file.py src/opossum_lib/opossum/opossum_file.py

@@ -5,4 +5,3 @@
 SPDX_FILE_IDENTIFIER = "SPDX-File"
 SPDX_PACKAGE_IDENTIFIER = "SPDX-Package"
 SPDX_SNIPPET_IDENTIFIER = "SPDX-Snippet"
-COMPRESSION_LEVEL = 5

src/opossum_lib/spdx/__init__.py

@@ -1,95 +1,77 @@
 # SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
 #
 # SPDX-License-Identifier: Apache-2.0
-import json
+
+import logging
+import sys
 import uuid
-from dataclasses import fields
-from pathlib import Path
-from zipfile import ZIP_DEFLATED, ZipFile
 
 from networkx import DiGraph, shortest_path
 from spdx_tools.spdx.model.document import CreationInfo
+from spdx_tools.spdx.model.document import Document as SpdxDocument
 from spdx_tools.spdx.model.file import File
 from spdx_tools.spdx.model.package import Package
 from spdx_tools.spdx.model.snippet import Snippet
+from spdx_tools.spdx.parser.error import SPDXParsingError
+from spdx_tools.spdx.parser.parse_anything import parse_file
+from spdx_tools.spdx.validation.document_validator import validate_full_spdx_document
 
-from opossum_lib.attribution_generation import (
+from opossum_lib.opossum.opossum_file import (
+    ExternalAttributionSource,
+    Metadata,
+    OpossumInformation,
+    OpossumPackage,
+    OpossumPackageIdentifier,
+    Resource,
+    ResourceType,
+    SourceInfo,
+)
+from opossum_lib.spdx.attribution_generation import (
     create_document_attribution,
     create_file_attribution,
     create_package_attribution,
     create_snippet_attribution,
 )
-from opossum_lib.constants import (
-    COMPRESSION_LEVEL,
+from opossum_lib.spdx.constants import (
     SPDX_FILE_IDENTIFIER,
     SPDX_PACKAGE_IDENTIFIER,
     SPDX_SNIPPET_IDENTIFIER,
 )
-from opossum_lib.helper_methods import (
+from opossum_lib.spdx.graph_generation import generate_graph_from_spdx
+from opossum_lib.spdx.helper_methods import (
     _create_file_path_from_graph_path,
     _get_source_for_graph_traversal,
     _node_represents_a_spdx_element,
     _replace_node_ids_with_labels_and_add_resource_type,
     _weakly_connected_component_sub_graphs,
 )
-from opossum_lib.opossum_file import (
-    ExternalAttributionSource,
-    Metadata,
-    OpossumInformation,
-    OpossumPackage,
-    OpossumPackageIdentifier,
-    Resource,
-    ResourceType,
-    SourceInfo,
-)
+from opossum_lib.spdx.tree_generation import generate_tree_from_graph
 
 
-def write_dict_to_file(
-    opossum_information: OpossumInformation, file_path: Path
-) -> None:
-    with ZipFile(
-        file_path, "w", compression=ZIP_DEFLATED, compresslevel=COMPRESSION_LEVEL
-    ) as z:
-        z.writestr("input.json", json.dumps(to_dict(opossum_information), indent=4))
-
-
-def to_dict(
-    element: Resource
-    | Metadata
-    | OpossumPackage
-    | OpossumInformation
-    | SourceInfo
-    | ExternalAttributionSource
-    | str
-    | int
-    | bool
-    | dict[str, OpossumPackage]
-    | dict[str, list[str]]
-    | list[str]
-    | None,
-) -> dict | str | list[str] | bool | int | None:
-    if isinstance(element, Resource):
-        return element.to_dict()
-    if isinstance(
-        element,
-        Metadata
-        | OpossumPackage
-        | OpossumInformation
-        | SourceInfo
-        | ExternalAttributionSource,
-    ):
-        result = []
-        for f in fields(element):
-            value = to_dict(getattr(element, f.name))
-            result.append((f.name, value))
-        return {k: v for (k, v) in result if v is not None}
-    elif isinstance(element, dict):
-        return {k: to_dict(v) for k, v in element.items()}
-    else:
-        return element
+def convert_spdx_to_opossum_information(filename: str) -> OpossumInformation:
+    try:
+        document: SpdxDocument = parse_file(filename)
+
+    except SPDXParsingError as err:
+        log_string = "\n".join(
+            ["There have been issues while parsing the provided document:"]
+            + [message for message in err.get_messages()]
+        )
+        logging.error(log_string)
+        sys.exit(1)
+    validation_messages = validate_full_spdx_document(document)
+    if validation_messages:
+        logging.warning(
+            "The given SPDX document is not valid, this might cause "
+            "issues with the conversion."
+        )
+    graph = generate_graph_from_spdx(document)
+    tree = generate_tree_from_graph(graph)
+    opossum_information = convert_tree_to_opossum_information(tree)
+    return opossum_information
 
 
-def generate_json_file_from_tree(tree: DiGraph) -> OpossumInformation:
+def convert_tree_to_opossum_information(tree: DiGraph) -> OpossumInformation:
     metadata = create_metadata(tree)
     resources = Resource(type=ResourceType.TOP_LEVEL)
     resources_to_attributions: dict[str, list[str]] = dict()

src/opossum_lib/attribution_generation.py src/opossum_lib/spdx/attribution_generation.py

@@ -7,7 +7,7 @@
 from spdx_tools.spdx.model import File, Package, Snippet
 from spdx_tools.spdx.model.document import CreationInfo, Document
 
-from opossum_lib.helper_methods import _node_represents_a_spdx_element
+from opossum_lib.spdx.helper_methods import _node_represents_a_spdx_element
 
 
 def generate_graph_from_spdx(document: Document) -> DiGraph:

src/opossum_lib/constants.py src/opossum_lib/spdx/constants.py

@@ -7,7 +7,7 @@
 from spdx_tools.spdx.constants import DOCUMENT_SPDX_ID
 from spdx_tools.spdx.model import File, Package, Snippet
 
-from opossum_lib.opossum_file import ResourceType
+from opossum_lib.opossum.opossum_file import ResourceType
 
 
 def _get_source_for_graph_traversal(connected_subgraph: DiGraph) -> str | None:

src/opossum_lib/file_generation.py src/opossum_lib/spdx/convert_to_opossum.py

@@ -8,7 +8,7 @@
 from spdx_tools.spdx.model.file import File
 from spdx_tools.spdx.model.package import Package
 
-from opossum_lib.helper_methods import (
+from opossum_lib.spdx.helper_methods import (
     _get_source_for_graph_traversal,
     _weakly_connected_component_sub_graphs,
 )

src/opossum_lib/graph_generation.py src/opossum_lib/spdx/graph_generation.py

@@ -11,7 +11,7 @@
 from spdx_tools.spdx.writer.write_anything import write_file
 
 from opossum_lib.cli import generate
-from tests.helper_methods import _create_minimal_document
+from tests.test_spdx.helper_methods import _create_minimal_document
 
 
 @pytest.mark.parametrize("options", ["--outfile", "-o"])

src/opossum_lib/helper_methods.py src/opossum_lib/spdx/helper_methods.py

@@ -8,16 +8,19 @@
 from spdx_tools.spdx.model.package import Package
 from spdx_tools.spdx.parser.parse_anything import parse_file
 
-from opossum_lib.constants import (
+from opossum_lib.opossum.opossum_file import (
+    ExternalAttributionSource,
+    OpossumInformation,
+)
+from opossum_lib.spdx.constants import (
     SPDX_FILE_IDENTIFIER,
     SPDX_PACKAGE_IDENTIFIER,
     SPDX_SNIPPET_IDENTIFIER,
 )
-from opossum_lib.file_generation import generate_json_file_from_tree
-from opossum_lib.graph_generation import generate_graph_from_spdx
-from opossum_lib.opossum_file import ExternalAttributionSource, OpossumInformation
-from opossum_lib.tree_generation import generate_tree_from_graph
-from tests.helper_methods import (
+from opossum_lib.spdx.convert_to_opossum import convert_tree_to_opossum_information
+from opossum_lib.spdx.graph_generation import generate_graph_from_spdx
+from opossum_lib.spdx.tree_generation import generate_tree_from_graph
+from tests.test_spdx.helper_methods import (
     _create_minimal_document,
     _generate_document_with_from_root_node_unreachable_file,
 )
@@ -233,12 +236,14 @@ def test_tree_generation_for_bigger_examples_spdx() -> None:
 
 
 def _get_opossum_information_from_file(file_name: str) -> OpossumInformation:
-    document = parse_file(str(Path(__file__).resolve().parent / "data" / file_name))
+    document = parse_file(
+        str(Path(__file__).resolve().parent.parent / "data" / file_name)
+    )
     return _get_opossum_information_from_document(document)
 
 
 def _get_opossum_information_from_document(document: Document) -> OpossumInformation:
     graph = generate_graph_from_spdx(document)
     tree = generate_tree_from_graph(graph)
-    opossum_information = generate_json_file_from_tree(tree)
+    opossum_information = convert_tree_to_opossum_information(tree)
     return opossum_information