refactor: review-comment: Make tests adhere to the new structure

opossum-tool · Jan 29, 2025 · c4fd699 · c4fd699
1 parent 378c276
commit c4fd699
Show file tree

Hide file tree

Showing 39 changed files with 42 additions and 168 deletions.
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -5,12 +5,12 @@
 import pytest
 from faker.proxy import Faker
 
-from tests.test_setup.opossum_faker_setup import OpossumFaker, setup_opossum_faker
-from tests.test_setup.opossum_file_faker_setup import (
+from tests.setup.opossum_faker_setup import OpossumFaker, setup_opossum_faker
+from tests.setup.opossum_file_faker_setup import (
     OpossumFileFaker,
     setup_opossum_file_faker,
 )
-from tests.test_setup.scancode_faker_setup import ScanCodeFaker, setup_scancode_faker
+from tests.setup.scancode_faker_setup import ScanCodeFaker, setup_scancode_faker
 
 
 @pytest.fixture

diff --git a/tests/opossum_model_generators/__init__.py → tests/core/entities/__init__.py b/tests/opossum_model_generators/__init__.py → tests/core/entities/__init__.py
diff --git a/tests/test_opossum/__init__.py → tests/core/entities/generators/__init__.py b/tests/test_opossum/__init__.py → tests/core/entities/generators/__init__.py
diff --git a/...s/external_attribution_source_provider.py → ...s/external_attribution_source_provider.py b/...s/external_attribution_source_provider.py → ...s/external_attribution_source_provider.py
@@ -8,7 +8,7 @@
 from faker.providers.person import Provider as PersonProvider
 
 from opossum_lib.core.entities.opossum import ExternalAttributionSource
-from tests.util.generator_helpers import entry_or_none
+from tests.shared.generator_helpers import entry_or_none
 
 
 class ExternalAttributionSourceProvider(BaseProvider):

diff --git a/...sum_model_generators/metadata_provider.py → .../entities/generators/metadata_provider.py b/...sum_model_generators/metadata_provider.py → .../entities/generators/metadata_provider.py
@@ -9,7 +9,7 @@
 from faker.providers.misc import Provider as MiscProvider
 
 from opossum_lib.core.entities.opossum import Metadata
-from tests.util.generator_helpers import entry_or_none
+from tests.shared.generator_helpers import entry_or_none
 
 
 class MetadataProvider(BaseProvider):

diff --git a/...ssum_model_generators/opossum_provider.py → ...e/entities/generators/opossum_provider.py b/...ssum_model_generators/opossum_provider.py → ...e/entities/generators/opossum_provider.py
@@ -7,8 +7,8 @@
 
 from opossum_lib.core.entities.opossum import Opossum, ScanResults
 from opossum_lib.shared.entities.opossum_output_file_model import OpossumOutputFileModel
-from tests.opossum_model_generators.scan_results_provider import ScanResultsProvider
-from tests.test_opossum.generators.generate_outfile_information import (
+from tests.core.entities.generators.scan_results_provider import ScanResultsProvider
+from tests.input_formats.opossum.entities.generators.generate_outfile_information import (  # noqa: E501
     OpossumOutputFileProvider,
 )
 

diff --git a/...ssum_model_generators/package_provider.py → ...e/entities/generators/package_provider.py b/...ssum_model_generators/package_provider.py → ...e/entities/generators/package_provider.py
@@ -11,8 +11,8 @@
 from faker.providers.person.en_US import Provider as PersonProvider
 
 from opossum_lib.core.entities.opossum import OpossumPackage, SourceInfo
-from tests.opossum_model_generators.source_info_provider import SourceInfoProvider
-from tests.util.generator_helpers import entry_or_none, random_list
+from tests.core.entities.generators.source_info_provider import SourceInfoProvider
+from tests.shared.generator_helpers import entry_or_none, random_list
 
 
 class PackageProvider(BaseProvider):

diff --git a/...sum_model_generators/resource_provider.py → .../entities/generators/resource_provider.py b/...sum_model_generators/resource_provider.py → .../entities/generators/resource_provider.py
@@ -13,8 +13,8 @@
     Resource,
     ResourceType,
 )
-from tests.opossum_model_generators.package_provider import PackageProvider
-from tests.util.generator_helpers import random_list
+from tests.core.entities.generators.package_provider import PackageProvider
+from tests.shared.generator_helpers import random_list
 
 
 class ResourceProvider(BaseProvider):

diff --git a/...model_generators/scan_results_provider.py → ...ities/generators/scan_results_provider.py b/...model_generators/scan_results_provider.py → ...ities/generators/scan_results_provider.py
@@ -18,13 +18,13 @@
     ResourceType,
     ScanResults,
 )
-from tests.opossum_model_generators.external_attribution_source_provider import (
+from tests.core.entities.generators.external_attribution_source_provider import (
     ExternalAttributionSourceProvider,
 )
-from tests.opossum_model_generators.metadata_provider import MetadataProvider
-from tests.opossum_model_generators.package_provider import PackageProvider
-from tests.opossum_model_generators.resource_provider import ResourceProvider
-from tests.util.generator_helpers import entry_or_none, random_list
+from tests.core.entities.generators.metadata_provider import MetadataProvider
+from tests.core.entities.generators.package_provider import PackageProvider
+from tests.core.entities.generators.resource_provider import ResourceProvider
+from tests.shared.generator_helpers import entry_or_none, random_list
 
 
 class ScanResultsProvider(BaseProvider):

diff --git a/..._model_generators/source_info_provider.py → ...tities/generators/source_info_provider.py b/..._model_generators/source_info_provider.py → ...tities/generators/source_info_provider.py
@@ -8,7 +8,7 @@
 from faker.providers.person.en_US import Provider as PersonProvider
 
 from opossum_lib.core.entities.opossum import SourceInfo
-from tests.util.generator_helpers import entry_or_none
+from tests.shared.generator_helpers import entry_or_none
 
 
 class SourceInfoProvider(BaseProvider):

diff --git a/tests/core/test_opossum_model.py → tests/core/entities/test_opossum.py b/tests/core/test_opossum_model.py → tests/core/entities/test_opossum.py
@@ -7,10 +7,10 @@
 from opossum_lib.input_formats.opossum.services.opossum_file_model_to_opossum_converter import (  # noqa: E501
     OpossumFileModelToOpossumConverter,
 )
-from tests.test_setup.opossum_faker_setup import OpossumFaker
+from tests.setup.opossum_faker_setup import OpossumFaker
 
 
-class TestOpossumModelToOpossumFileConversion:
+class TestOpossumToOpossumModelConversion:
     def test_moves_outfile(self, opossum_faker: OpossumFaker) -> None:
         opossum = opossum_faker.opossum()
 

diff --git a/tests/test_opossum/generators/__init__.py → tests/core/services/__init__.py b/tests/test_opossum/generators/__init__.py → tests/core/services/__init__.py
diff --git a/tests/test_opossum/test_file_generation.py → ...core/services/test_opossum_file_writer.py b/tests/test_opossum/test_file_generation.py → ...core/services/test_opossum_file_writer.py
@@ -11,7 +11,7 @@
     OUTPUT_JSON_NAME,
 )
 from opossum_lib.shared.entities.opossum_file_model import OpossumFileModel
-from tests.test_setup.opossum_file_faker_setup import OpossumFileFaker
+from tests.setup.opossum_file_faker_setup import OpossumFileFaker
 
 
 def test_only_input_information_available_writes_only_input_information(

diff --git a/tests/test_scancode/__init__.py → tests/input_formats/__init__.py b/tests/test_scancode/__init__.py → tests/input_formats/__init__.py
diff --git a/tests/test_scancode/generators/__init__.py → tests/input_formats/opossum/__init__.py b/tests/test_scancode/generators/__init__.py → tests/input_formats/opossum/__init__.py
diff --git a/tests/test_setup/__init__.py → ...nput_formats/opossum/entities/__init__.py b/tests/test_setup/__init__.py → ...nput_formats/opossum/entities/__init__.py
diff --git a/tests/util/__init__.py → ...s/opossum/entities/generators/__init__.py b/tests/util/__init__.py → ...s/opossum/entities/generators/__init__.py
diff --git a/...m/generators/generate_file_information.py → ...s/generators/generate_file_information.py b/...m/generators/generate_file_information.py → ...s/generators/generate_file_information.py
@@ -25,7 +25,7 @@
     ResourcePathModel,
     SourceInfoModel,
 )
-from tests.util.generator_helpers import entry_or_none, random_list
+from tests.shared.generator_helpers import entry_or_none, random_list
 
 
 class MetadataProvider(BaseProvider):

diff --git a/...nerators/generate_opossum_file_content.py → ...nerators/generate_opossum_file_content.py b/...nerators/generate_opossum_file_content.py → ...nerators/generate_opossum_file_content.py
@@ -8,10 +8,10 @@
 from opossum_lib.shared.entities.opossum_file_model import OpossumFileModel
 from opossum_lib.shared.entities.opossum_input_file_model import OpossumInputFileModel
 from opossum_lib.shared.entities.opossum_output_file_model import OpossumOutputFileModel
-from tests.test_opossum.generators.generate_file_information import (
+from tests.input_formats.opossum.entities.generators.generate_file_information import (
     FileInformationProvider,
 )
-from tests.test_opossum.generators.generate_outfile_information import (
+from tests.input_formats.opossum.entities.generators.generate_outfile_information import (  # noqa: E501
     OpossumOutputFileProvider,
 )
 

diff --git a/...enerators/generate_outfile_information.py → ...enerators/generate_outfile_information.py b/...enerators/generate_outfile_information.py → ...enerators/generate_outfile_information.py
@@ -14,7 +14,7 @@
     Metadata,
     OpossumOutputFileModel,
 )
-from tests.util.generator_helpers import entry_or_none
+from tests.shared.generator_helpers import entry_or_none
 
 
 class OpossumOutputFileProvider(BaseProvider):

diff --git a/tests/input_formats/opossum/entities/services/__init__.py b/tests/input_formats/opossum/entities/services/__init__.py
diff --git a/...test_opossum/test_conversion_roundtrip.py → ...ies/services/test_conversion_roundtrip.py b/...test_opossum/test_conversion_roundtrip.py → ...ies/services/test_conversion_roundtrip.py
@@ -7,7 +7,7 @@
     OpossumFileModelToOpossumConverter,
 )
 from opossum_lib.shared.entities.opossum_file_model import OpossumFileModel
-from tests.test_setup.opossum_file_faker_setup import OpossumFileFaker
+from tests.setup.opossum_file_faker_setup import OpossumFileFaker
 
 
 class TestConversionRoundtrip:

diff --git a/...test_opossum_file_to_opossum_converter.py → ...possum_file_model_to_opossum_converter.py b/...test_opossum_file_to_opossum_converter.py → ...possum_file_model_to_opossum_converter.py
@@ -10,10 +10,10 @@
     OpossumPackageIdentifierModel,
     OpossumPackageModel,
 )
-from tests.test_setup.opossum_file_faker_setup import OpossumFileFaker
+from tests.setup.opossum_file_faker_setup import OpossumFileFaker
 
 
-class TestOpossumFileToOpossumConverter:
+class TestOpossumFileModelToOpossumConverter:
     def test_output_file_moved(self, opossum_file_faker: OpossumFileFaker) -> None:
         output_file = opossum_file_faker.output_file()
         input_file = opossum_file_faker.opossum_file_content(out_file=output_file)

diff --git a/tests/test_opossum/test_read_opossum_file.py → ...es/services/test_opossum_format_reader.py b/tests/test_opossum/test_read_opossum_file.py → ...es/services/test_opossum_format_reader.py
@@ -10,11 +10,11 @@
     OpossumFormatReader,
 )
 
-TEST_DATA_DIRECTORY = Path(__file__).resolve().parent.parent / "data"
+TEST_DATA_DIR = Path(__file__).resolve().parent.parent.parent.parent.parent / "data"
 
 
 def test_read_opossum_file_corrupted_file_exits_1(caplog: LogCaptureFixture) -> None:
-    input_path = TEST_DATA_DIRECTORY / "opossum_input_corrupt.opossum"
+    input_path = TEST_DATA_DIR / "opossum_input_corrupt.opossum"
     opossum_format_reader = OpossumFormatReader()
 
     with pytest.raises(SystemExit) as system_exit:
@@ -24,7 +24,7 @@ def test_read_opossum_file_corrupted_file_exits_1(caplog: LogCaptureFixture) ->
 
 
 def test_read_opossum_file_containing_output_json() -> None:
-    input_path = TEST_DATA_DIRECTORY / "opossum_input_with_result.opossum"
+    input_path = TEST_DATA_DIR / "opossum_input_with_result.opossum"
     opossum_format_reader = OpossumFormatReader()
 
     result = opossum_format_reader.read(input_path)

diff --git a/tests/input_formats/scancode/__init__.py b/tests/input_formats/scancode/__init__.py
diff --git a/tests/input_formats/scancode/entities/__init__.py b/tests/input_formats/scancode/entities/__init__.py
diff --git a/tests/input_formats/scancode/entities/generators/__init__.py b/tests/input_formats/scancode/entities/generators/__init__.py
diff --git a/...code/generators/generate_scancode_file.py → ...ties/generators/generate_scancode_file.py b/...code/generators/generate_scancode_file.py → ...ties/generators/generate_scancode_file.py
@@ -37,7 +37,7 @@
     SystemEnvironmentModel,
     UrlModel,
 )
-from tests.util.generator_helpers import entry_or_none, random_list
+from tests.shared.generator_helpers import entry_or_none, random_list
 
 type TempPathTree = dict[str, TempPathTree | None]
 

diff --git a/tests/input_formats/scancode/entities/services/__init__.py b/tests/input_formats/scancode/entities/services/__init__.py
diff --git a/...est_scancode/test_get_attribution_info.py → ...ies/services/test_get_attribution_info.py b/...est_scancode/test_get_attribution_info.py → ...ies/services/test_get_attribution_info.py
@@ -11,7 +11,7 @@
     OpossumPackageModel,
     SourceInfoModel,
 )
-from tests.test_setup.scancode_faker_setup import ScanCodeFaker
+from tests.setup.scancode_faker_setup import ScanCodeFaker
 
 
 def test_get_attribution_info_directory(scancode_faker: ScanCodeFaker) -> None:

diff --git a/...ncode/test_convert_scancode_to_opossum.py → ...est_scancode_data_to_opossum_converter.py b/...ncode/test_convert_scancode_to_opossum.py → ...est_scancode_data_to_opossum_converter.py
@@ -10,7 +10,7 @@
 from opossum_lib.input_formats.scancode.services.scancode_data_to_opossum_converter import (  # noqa: E501
     ScancodeDataToOpossumConverter,
 )
-from tests.test_setup.scancode_faker_setup import ScanCodeFaker
+from tests.setup.scancode_faker_setup import ScanCodeFaker
 
 
 def test_extract_scancode_header_produces_expected_result(

diff --git a/tests/setup/__init__.py b/tests/setup/__init__.py
diff --git a/tests/test_setup/opossum_faker_setup.py → tests/setup/opossum_faker_setup.py b/tests/test_setup/opossum_faker_setup.py → tests/setup/opossum_faker_setup.py
@@ -7,8 +7,8 @@
 
 from faker import Faker, Generator
 
-from tests.opossum_model_generators.opossum_provider import OpossumProvider
-from tests.opossum_model_generators.scan_results_provider import ScanResultsProvider
+from tests.core.entities.generators.opossum_provider import OpossumProvider
+from tests.core.entities.generators.scan_results_provider import ScanResultsProvider
 
 
 class OpossumFaker(Faker):

diff --git a/tests/test_setup/opossum_file_faker_setup.py → tests/setup/opossum_file_faker_setup.py b/tests/test_setup/opossum_file_faker_setup.py → tests/setup/opossum_file_faker_setup.py
@@ -8,14 +8,14 @@
 
 from faker import Faker, Generator
 
-from tests.test_opossum.generators.generate_file_information import (
+from tests.input_formats.opossum.entities.generators.generate_file_information import (
     FileInformationProvider,
     MetadataProvider,
 )
-from tests.test_opossum.generators.generate_opossum_file_content import (
+from tests.input_formats.opossum.entities.generators.generate_opossum_file_content import (  # noqa: E501
     OpossumFileContentProvider,
 )
-from tests.test_opossum.generators.generate_outfile_information import (
+from tests.input_formats.opossum.entities.generators.generate_outfile_information import (  # noqa: E501
     OpossumOutputFileProvider,
 )
 

diff --git a/tests/test_setup/scancode_faker_setup.py → tests/setup/scancode_faker_setup.py b/tests/test_setup/scancode_faker_setup.py → tests/setup/scancode_faker_setup.py
@@ -8,7 +8,9 @@
 
 from faker import Faker, Generator
 
-from tests.test_scancode.generators.generate_scancode_file import ScanCodeDataProvider
+from tests.input_formats.scancode.entities.generators.generate_scancode_file import (
+    ScanCodeDataProvider,
+)
 
 
 class ScanCodeFaker(Faker):

diff --git a/tests/shared/__init__.py b/tests/shared/__init__.py
diff --git a/tests/util/generator_helpers.py → tests/shared/generator_helpers.py b/tests/util/generator_helpers.py → tests/shared/generator_helpers.py
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -17,7 +17,7 @@
     OUTPUT_JSON_NAME,
 )
 from opossum_lib.shared.entities.opossum_input_file_model import OpossumPackageModel
-from tests.test_setup.opossum_file_faker_setup import OpossumFileFaker
+from tests.setup.opossum_file_faker_setup import OpossumFileFaker
 
 test_data_path = Path(__file__).resolve().parent / "data"
 

diff --git a/tests/test_scancode/model_helpers.py b/tests/test_scancode/model_helpers.py