refactor(workspace): issues raised by SonarQube (#426)

* refactor(unit tests): us Pytest tmp_path instead of constructing a custom path

* fix: low severity issues raised by SonarQube

* refactor(tests): simplify conftest that creates a workspace

Author: DavidVujic

components/polylith/check/report.py

@@ -91,8 +91,8 @@ def extract_collected_imports(
 
 
 def collect_all_imports(root: Path, ns: str, project_data: dict) -> dict:
-    bases = {b for b in project_data.get("bases", [])}
-    components = {c for c in project_data.get("components", [])}
+    bases = set(project_data.get("bases", []))
+    components = set(project_data.get("components", []))
 
     bases_paths = workspace.paths.collect_bases_paths(root, ns, bases)
     components_paths = workspace.paths.collect_components_paths(root, ns, components)
@@ -141,8 +141,8 @@ def create_report(
     third_party_libs: Set,
     is_strict: bool = False,
 ) -> dict:
-    bases = {b for b in project_data.get("bases", [])}
-    components = {c for c in project_data.get("components", [])}
+    bases = set(project_data.get("bases", []))
+    components = set(project_data.get("components", []))
 
     brick_imports = collected_imports["brick_imports"]
     third_party_imports = collected_imports["third_party_imports"]

components/polylith/diff/collect.py

@@ -92,7 +92,7 @@ def get_latest_tag(root: Path, key: Union[str, None]) -> Union[str, None]:
         capture_output=True,
     )
 
-    return next((tag for tag in res.stdout.decode("utf-8").split()), None)
+    return next(iter(res.stdout.decode("utf-8").split()), None)
 
 
 def get_files(tag: str) -> List[Path]:

components/polylith/diff/report.py

@@ -78,7 +78,7 @@ def print_detected_changes_in_projects(projects: List[str], short: bool) -> None
 
 
 def print_projects_affected_by_changes(projects: Set[str], short: bool) -> None:
-    sorted_projects = sorted(list(projects))
+    sorted_projects = sorted(projects)
 
     print_detected_changes(sorted_projects, "proj", short)
 

components/polylith/info/collect.py

@@ -13,7 +13,7 @@ def get_matching_bricks(
 
     res = set(bricks).intersection(paths_in_namespace)
 
-    return sorted(list(res))
+    return sorted(res)
 
 
 def get_project_bricks(project_packages: List[dict], components, bases, namespace: str):

components/polylith/libs/report.py

@@ -13,8 +13,8 @@
 
 
 def get_third_party_imports(root: Path, ns: str, project_data: dict) -> dict:
-    bases = {b for b in project_data.get("bases", [])}
-    components = {c for c in project_data.get("components", [])}
+    bases = set(project_data.get("bases", []))
+    components = set(project_data.get("components", []))
 
     bases_paths = workspace.paths.collect_bases_paths(root, ns, bases)
     components_paths = workspace.paths.collect_components_paths(root, ns, components)

components/polylith/parsing/core.py

@@ -65,4 +65,4 @@ def copy_brick(
 def parse_brick_namespace_from_path(bricks: dict) -> str:
     parts = {str.split(v, "/")[0] for v in bricks.values()}
 
-    return next(part for part in parts)
+    return next(iter(parts))

test/components/polylith/bricks/test_base.py

@@ -1,29 +1,9 @@
 from pathlib import Path
 
-import pytest
 from polylith.bricks.base import create_base, get_bases_data
 
-create_base_params = [
-    (
-        "1. Creates expected directories and files",
-        set(["bases", "test"]),
-        set(
-            [
-                Path("test/temp/bases/test_namespace/test_package/core.py"),
-                Path("test/temp/test/bases/test_namespace/test_package/test_core.py"),
-            ]
-        ),
-    )
-]
-create_base_ids = [x[0] for x in create_base_params]
 
-
-@pytest.mark.parametrize(
-    "id, expected_dirs, expected_dir_structure",
-    create_base_params,
-    ids=create_base_ids,
-)
-def test_create_base(handle_workspace_files, id, expected_dirs, expected_dir_structure):
+def test_create_base(handle_workspace_files, tmp_path: Path):
     options = {
         "namespace": "test_namespace",
         "package": "test_package",
@@ -32,16 +12,12 @@ def test_create_base(handle_workspace_files, id, expected_dirs, expected_dir_str
     }
     create_base(path=handle_workspace_files, options=options)
 
-    results = [
-        x for x in handle_workspace_files.iterdir() if x.name != "workspace.toml"
+    expected_dirs = [
+        Path(tmp_path / "bases/test_namespace/test_package/core.py"),
+        Path(tmp_path / "test/bases/test_namespace/test_package/test_core.py"),
     ]
 
-    assert all([item.is_dir() for item in results if item in expected_dirs])
-    assert (
-        set([item.name for item in results]).intersection(expected_dirs)
-        == expected_dirs
-    )
-    assert all([item.exists for item in expected_dir_structure])
+    assert all(item.exists() for item in expected_dirs)
 
 
 def test_get_bases_data_valid_with_test_file_structure(create_test_base):

test/conftest.py

@@ -1,25 +1,36 @@
-import shutil
 from pathlib import Path
 
 import pytest
 from polylith.bricks.base import create_base
 
+source_file = """
+[tool.polylith]
+namespace = "test_space"
 
-@pytest.fixture(scope="function")
-def handle_workspace_files():
-    """Creates a temporary directory with a valid workspace file and removes the directory in tear-down.
+[tool.polylith.structure]
+theme = "loose"
 
-    Yields:
-        Path: The temp directory path
-    """
-    temp_dir = Path("test/temp")
-    temp_dir.mkdir(parents=True, exist_ok=True)
-    workspace_file = temp_dir / "workspace.toml"
+[tool.polylith.tag.patterns]
+stable = "stable-*"
+release = "v[0-9]*"
+
+[tool.polylith.test]
+enabled = true
+
+[tool.polylith.resources]
+brick_docs_enabled = false
+"""
+
+
+@pytest.fixture(scope="function")
+def handle_workspace_files(tmp_path: Path) -> Path:
+    """Returns a temporary directory with a valid workspace file."""
+    workspace_file = tmp_path / "workspace.toml"
     workspace_file.touch()
-    source_file = Path("test/test_data/workspace.toml")
-    workspace_file.write_text(source_file.read_text())
-    yield temp_dir
-    shutil.rmtree(temp_dir)
+
+    workspace_file.write_text(source_file)
+
+    return tmp_path
 
 
 @pytest.fixture(scope="function")
@@ -42,5 +53,7 @@ def create_test_base(handle_workspace_files):
         "description": "test desc",
         "modulename": "core",
     }
+
     create_base(path=handle_workspace_files, options=options)
+
     yield handle_workspace_files