spl-core 7.4.0__tar.gz → 7.5.1__tar.gz

{spl_core-7.4.0 → spl_core-7.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: spl-core
-Version: 7.4.0
+Version: 7.5.1
 Summary: Software Product Line Support for CMake
 License: MIT
 Author: Avengineers
@@ -15,10 +15,10 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Libraries
-Requires-Dist: cookiecutter (==2.1.1)
+Requires-Dist: cookiecutter (==2.6.0)
 Requires-Dist: doxysphinx (>=3.3,<4.0)
 Requires-Dist: gcovr (>=8.3,<9.0)
-Requires-Dist: hammocking (>=0.8,<0.9)
+Requires-Dist: hammocking (>=0.8,<0.10)
 Requires-Dist: kconfiglib (>=14.1,<15.0)
 Requires-Dist: mlx-traceability (>=10.0,<11.0)
 Requires-Dist: myst-parser (>=0.16)
@@ -26,15 +26,15 @@ Requires-Dist: py-app-dev (>=2.1,<3.0)
 Requires-Dist: sphinx (>=7.3,<8.0)
 Requires-Dist: sphinx-book-theme (>=1.1,<2.0)
 Requires-Dist: sphinx-copybutton (>=0.5,<0.6)
-Requires-Dist: sphinx-design (>=0.5,<0.6)
+Requires-Dist: sphinx-design (>=0.5,<0.7)
 Requires-Dist: sphinx-needs (>=2.0,<3.0)
-Requires-Dist: sphinx-new-tab-link (>=0.4,<0.5)
+Requires-Dist: sphinx-new-tab-link (>=0.4,<0.9)
 Requires-Dist: sphinx-rtd-size (>=0.2,<0.3)
 Requires-Dist: sphinx-rtd-theme (>=2.0,<3.0)
 Requires-Dist: sphinx-test-reports (>=1.0,<2.0)
 Requires-Dist: sphinxcontrib-datatemplates (>=0.11,<0.12)
 Requires-Dist: sphinxcontrib-mermaid (>=0.9,<0.10)
-Requires-Dist: sphinxcontrib-plantuml (>=0.29,<0.30)
+Requires-Dist: sphinxcontrib-plantuml (>=0.29,<0.31)
 Requires-Dist: typer (>=0,<1)
 Project-URL: Bug Tracker, https://github.com/avengineers/spl-core/issues
 Project-URL: Changelog, https://github.com/avengineers/spl-core/blob/develop/CHANGELOG.md

{spl_core-7.4.0 → spl_core-7.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "spl-core"
-version = "7.4.0"
+version = "7.5.1"
 description = "Software Product Line Support for CMake"
 authors = ["Avengineers <karsten.guenther@kamg.de>"]
 license = "MIT"
@@ -26,9 +26,9 @@ please = "spl_core.main:main"
 [tool.poetry.dependencies]
 python = ">=3.10,<3.12"
 py-app-dev = "^2.1"
-cookiecutter = "==2.1.1"
+cookiecutter = "==2.6.0"
 gcovr = "^8.3"
-hammocking = "^0.8"
+hammocking = ">=0.8,<0.10"
 kconfiglib = "^14.1"
 typer = "^0"
 doxysphinx = "^3.3"
@@ -39,19 +39,19 @@ sphinx-needs = "^2.0"
 sphinx-test-reports = "^1.0"
 sphinx-rtd-size = "^0.2"
 sphinxcontrib-datatemplates = "^0.11"
-sphinxcontrib-plantuml = "^0.29"
+sphinxcontrib-plantuml = ">=0.29,<0.31"
 sphinx-copybutton = "^0.5"
-sphinx-new-tab-link = "^0.4"
+sphinx-new-tab-link = ">=0.4,<0.9"
 myst-parser = ">=0.16"
 mlx-traceability = "^10.0"
 sphinx-book-theme = "^1.1"
-sphinx-design = "^0.5"
+sphinx-design = ">=0.5,<0.7"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.0"
 pytest-cov = "^4.0"
 pre-commit = "^3.1.1"
-ruff = "^0.5"
+ruff = ">=0.5,<0.13"
 jinja2 = "*"
 testfixtures = "*"
 junitparser = "*"
@@ -138,6 +138,8 @@ exclude = ["bootstrap.py", "src/spl_core/kickstart/templates/project/conf.py"]
 "setup.py" = ["D100"]
 "conftest.py" = ["D100"]
 "docs/conf.py" = ["D100"]
+"**/test_*.py" = ["S101"]
+"src/spl_core/test_utils/base_variant_test_runner.py" = ["S101"]
 
 [tool.ruff.lint.isort]
 known-first-party = ["spl_core", "tests"]

spl_core-7.5.1/src/spl_core/__init__.py

@@ -0,0 +1 @@
+__version__ = "7.5.1"

spl_core-7.5.1/src/spl_core/kickstart/templates/application/test/EnglishVariant/test__EnglishVariant.py

@@ -0,0 +1,56 @@
+from typing import ClassVar
+
+import pytest
+
+from spl_core.test_utils.spl_build import SplBuild
+
+
+class Test_EnglishVariant:
+    variant: str = "EnglishVariant"
+    components: ClassVar[list[str]] = ["src/greeter"]
+
+    @pytest.mark.unittests
+    def test_unittests(self) -> None:
+        # Arrange
+        spl_build: SplBuild = SplBuild(variant=self.variant, build_kit="test", build_type="Debug", target="unittests")
+
+        # Act
+        result = spl_build.execute()
+
+        # Assert
+        assert result == 0, "Building unittests failed"
+        for artifact in spl_build.get_components_artifacts(self.components):
+            assert artifact.exists(), f"Artifact {artifact} does not exist"
+
+    @pytest.mark.reports
+    def test_reports(self) -> None:
+        # Arrange
+        spl_build: SplBuild = SplBuild(variant=self.variant, build_kit="test", build_type="Debug", target="reports")
+
+        # Act
+        result = spl_build.execute()
+
+        # Assert
+        assert result == 0, "Building reports failed"
+        for artifact in spl_build.get_components_artifacts(self.components):
+            assert artifact.exists(), f"Artifact {artifact} does not exist"
+
+    @pytest.mark.build
+    @pytest.mark.parametrize(
+        ("build_type"),
+        [
+            pytest.param("Debug", marks=pytest.mark.debug),
+            pytest.param("Release", marks=pytest.mark.release),
+        ],
+    )
+    def test_build(self, build_type: str) -> None:
+        # Arrange
+        spl_build: SplBuild = SplBuild(variant=self.variant, build_kit="prod", build_type=build_type, target="all")
+
+        # Act
+        result = spl_build.execute()
+
+        # Assert
+        assert result == 0, "Building failed"
+        for artifact in [spl_build.build_dir / "main.exe", *spl_build.get_variant_artifacts()]:
+            assert artifact.exists(), f"Artifact {artifact} does not exist"

spl_core-7.5.1/src/spl_core/kickstart/templates/application/test/German/test__GermanVariant.py

@@ -0,0 +1,56 @@
+from typing import ClassVar
+
+import pytest
+
+from spl_core.test_utils.spl_build import SplBuild
+
+
+class Test_GermanVariant:
+    variant: str = "GermanVariant"
+    components: ClassVar[list[str]] = ["src/greeter"]
+
+    @pytest.mark.unittests
+    def test_unittests(self) -> None:
+        # Arrange
+        spl_build: SplBuild = SplBuild(variant=self.variant, build_kit="test", build_type="Debug", target="unittests")
+
+        # Act
+        result = spl_build.execute()
+
+        # Assert
+        assert result == 0, "Building unittests failed"
+        for artifact in spl_build.get_components_artifacts(self.components):
+            assert artifact.exists(), f"Artifact {artifact} does not exist"
+
+    @pytest.mark.reports
+    def test_reports(self) -> None:
+        # Arrange
+        spl_build: SplBuild = SplBuild(variant=self.variant, build_kit="test", build_type="Debug", target="reports")
+
+        # Act
+        result = spl_build.execute()
+
+        # Assert
+        assert result == 0, "Building reports failed"
+        for artifact in spl_build.get_components_artifacts(self.components):
+            assert artifact.exists(), f"Artifact {artifact} does not exist"
+
+    @pytest.mark.build
+    @pytest.mark.parametrize(
+        ("build_type"),
+        [
+            pytest.param("Debug", marks=pytest.mark.debug),
+            pytest.param("Release", marks=pytest.mark.release),
+        ],
+    )
+    def test_build(self, build_type: str) -> None:
+        # Arrange
+        spl_build: SplBuild = SplBuild(variant=self.variant, build_kit="prod", build_type=build_type, target="all")
+
+        # Act
+        result = spl_build.execute()
+
+        # Assert
+        assert result == 0, "Building failed"
+        for artifact in [spl_build.build_dir / "main.exe", *spl_build.get_variant_artifacts()]:
+            assert artifact.exists(), f"Artifact {artifact} does not exist"

{spl_core-7.4.0 → spl_core-7.5.1}/src/spl_core/test_utils/base_variant_test_runner.py

@@ -55,14 +55,14 @@ class BaseVariantTestRunner(ABC):
 
     def assert_artifact_exists(self, dir: Path, artifact: Path) -> None:
         if artifact.is_absolute():
-            assert artifact.exists(), f"Artifact {artifact} does not exist"  # noqa: S101
+            assert artifact.exists(), f"Artifact {artifact} does not exist"
         else:
-            assert Path.joinpath(dir, artifact).exists(), f"Artifact {Path.joinpath(dir, artifact)} does not exist"  # noqa: S101
+            assert Path.joinpath(dir, artifact).exists(), f"Artifact {Path.joinpath(dir, artifact)} does not exist"
 
     @pytest.mark.build
     def test_build(self, build_type: Optional[str] = None) -> None:
         spl_build: SplBuild = SplBuild(variant=self.variant, build_kit="prod", build_type=build_type)
-        assert 0 == spl_build.execute(target="all")  # noqa: S101
+        assert 0 == spl_build.execute(target="all")
         for artifact in self.expected_build_artifacts:
             self.assert_artifact_exists(dir=spl_build.build_dir, artifact=artifact)
         if self.create_artifacts_archive:
@@ -74,16 +74,26 @@ class BaseVariantTestRunner(ABC):
     @pytest.mark.unittests
     def test_unittests(self, build_type: Optional[str] = None) -> None:
         spl_build: SplBuild = SplBuild(variant=self.variant, build_kit="test", build_type=build_type)
-        assert 0 == spl_build.execute(target="unittests")  # noqa: S101
+        assert 0 == spl_build.execute(target="unittests")
         for artifact in self.expected_test_artifacts:
             self.assert_artifact_exists(dir=spl_build.build_dir, artifact=artifact)
 
     @pytest.mark.reports
     def test_reports(self, build_type: Optional[str] = None) -> None:
         spl_build: SplBuild = SplBuild(variant=self.variant, build_kit="test", build_type=build_type)
-        assert 0 == spl_build.execute(target="reports")  # noqa: S101
+        assert 0 == spl_build.execute(target="reports")
         for artifact in self.expected_variant_report_artifacts:
             self.assert_artifact_exists(dir=spl_build.build_dir, artifact=artifact)
         for component in self.component_paths:
             for artifact in self.expected_component_report_artifacts:
-                self.assert_artifact_exists(dir=Path.joinpath(spl_build.build_dir, "reports", "html", spl_build.build_dir, component, "reports"), artifact=artifact)
+                self.assert_artifact_exists(
+                    dir=Path.joinpath(
+                        spl_build.build_dir,
+                        "reports",
+                        "html",
+                        spl_build.build_dir,
+                        component,
+                        "reports",
+                    ),
+                    artifact=artifact,
+                )

{spl_core-7.4.0 → spl_core-7.5.1}/src/spl_core/test_utils/spl_build.py

@@ -3,7 +3,7 @@ import time
 import zipfile
 from dataclasses import dataclass
 from pathlib import Path
-from typing import List, Optional
+from typing import Callable, ClassVar, List, Optional
 
 from py_app_dev.core.logging import time_it
 
@@ -39,54 +39,76 @@ class ArtifactsCollection:
 
 
 class SplBuild:
-    """Class for building an SPL repository."""
-
-    def __init__(self, variant: str, build_kit: str, build_type: Optional[str] = None) -> None:
-        """
-        Initialize a SplBuild instance.
-
-        Args:
-            variant (str): The build variant.
-            build_kit (str): The build kit.
-            build_type (str, optional): The build type. Defaults to None.
-
-        """
+    """
+    Class for building an SPL repository.
+
+    Relies on build.bat in the root of the SPL repository.
+    """
+
+    @dataclass
+    class BuildArtifacts:
+        artifacts: list[str]
+        # callable to resolve the path to the component artifacts specific to the build target
+        path_resolver: Callable[[Path, str], Path]
+
+    TARGET_VARIANT_BUILD_ARTIFACTS: ClassVar[dict[str, list[str]]] = {"prod/all": ["compile_commands.json"]}
+
+    TARGET_COMPONENT_BUILD_ARTIFACTS: ClassVar[dict[str, "SplBuild.BuildArtifacts"]] = {
+        "test/unittests": BuildArtifacts(
+            [
+                "coverage.json",
+                "junit.xml",
+                "reports/coverage/index.html",
+            ],
+            lambda build_dir, component_name: build_dir / component_name,
+        ),
+        "test/reports": BuildArtifacts(
+            [
+                "coverage.html",
+                "coverage/index.html",
+                "doxygen/html/index.html",
+                "unit_test_results.html",
+                "unit_test_spec.html",
+            ],
+            lambda build_dir, component_name: build_dir / "reports" / "html" / build_dir / component_name / "reports",
+        ),
+    }
+
+    def __init__(self, variant: str, build_kit: str, build_type: Optional[str] = None, target: Optional[str] = None) -> None:
         self.variant = variant
         self.build_kit = build_kit
         self.build_type = build_type
+        self.target = target
 
     @property
     def build_dir(self) -> Path:
         """
-        Get the build directory.
-
-        Returns:
-            Path: The build directory path.
-
+        Output directory of all build artifacts.
         """
         if self.build_type:
             return Path(f"build/{self.variant}/{self.build_kit}/{self.build_type}")
         return Path(f"build/{self.variant}/{self.build_kit}")
 
     @time_it()
-    def execute(self, target: str, additional_args: Optional[List[str]] = None) -> int:
+    def execute(self, target: Optional[str] = None, additional_args: Optional[List[str]] = None) -> int:
         """
-        Build the target
+        Execute an SPL build (of a given target).
 
         Args:
-            target (str): The build target.
-            additional_args (List[str], optional): Additional arguments for building. Defaults to ["-build"].
+            target: The target to build, optional, defaults to value given in the constructor.
+            additional_args: Additional arguments to pass to the build command.
 
         Returns:
             int: 0 in case of success.
 
         """
-        if additional_args is None:
-            additional_args = ["-build"]
+        if target is None:
+            target = self.target if self.target else "all"
         return_code = -1
         while True:
             cmd = [
                 "build.bat",
+                "-build",
                 "-buildKit",
                 self.build_kit,
                 "-variants",
@@ -97,7 +119,8 @@ class SplBuild:
             ]
             if self.build_type:
                 cmd.extend(["-buildType", self.build_type])
-            cmd.extend(additional_args)
+            if additional_args:
+                cmd.extend(additional_args)
             result = CommandLineExecutor().execute(cmd)
             return_code = result.returncode
             if result.returncode:
@@ -113,6 +136,29 @@ class SplBuild:
                 break
         return return_code
 
+    def get_component_artifacts(self, component_name: str) -> list[Path]:
+        if not self.target:
+            return []
+        target_data = self.TARGET_COMPONENT_BUILD_ARTIFACTS.get(self.build_kit + "/" + self.target)
+        if not target_data:
+            return []
+
+        return [target_data.path_resolver(self.build_dir, component_name) / artifact for artifact in target_data.artifacts]
+
+    def get_components_artifacts(self, component_names: list[str]) -> list[Path]:
+        artifacts = []
+        for component_name in component_names:
+            artifacts.extend(self.get_component_artifacts(component_name))
+        return artifacts
+
+    def get_variant_artifacts(self) -> list[Path]:
+        if not self.target:
+            return []
+        target_data = self.TARGET_VARIANT_BUILD_ARTIFACTS.get(self.build_kit + "/" + self.target)
+        if not target_data:
+            return []
+        return [self.build_dir / artifact for artifact in target_data]
+
     def create_artifacts_archive(self, expected_artifacts: List[Path]) -> Path:
         """
         Create a zip file containing the collected artifacts.

spl_core-7.4.0/src/spl_core/__init__.py

@@ -1 +0,0 @@
-__version__ = "7.4.0"

spl_core-7.4.0/src/spl_core/kickstart/templates/application/test/EnglishVariant/test__EnglishVariant.py

@@ -1,16 +0,0 @@
-from pathlib import Path
-from typing import List
-
-from spl_core.test_utils.base_variant_test_runner import BaseVariantTestRunner
-
-
-class Test_EnglishVariant(BaseVariantTestRunner):
-    @property
-    def component_paths(self) -> List[Path]:
-        return [
-            Path("src/greeter"),
-        ]
-
-    @property
-    def expected_build_artifacts(self) -> List[Path]:
-        return [Path("my_main.exe"), Path("compile_commands.json")]

spl_core-7.4.0/src/spl_core/kickstart/templates/application/test/German/test__GermanVariant.py

@@ -1,16 +0,0 @@
-from pathlib import Path
-from typing import List
-
-from spl_core.test_utils.base_variant_test_runner import BaseVariantTestRunner
-
-
-class Test_GermanVariant(BaseVariantTestRunner):
-    @property
-    def component_paths(self) -> List[Path]:
-        return [
-            Path("src/greeter"),
-        ]
-
-    @property
-    def expected_build_artifacts(self) -> List[Path]:
-        return [Path("my_main.exe"), Path("compile_commands.json")]