spl-core 4.0.0__py3-none-any.whl → 4.1.1__py3-none-any.whl

spl_core/__init__.py

@@ -1 +1 @@
-__version__ = "4.0.0"
+__version__ = "4.1.1"

spl_core/common/command_line_executor.py

@@ -0,0 +1,52 @@
+import subprocess
+from pathlib import Path
+from typing import Dict, List, Optional
+
+
+class CommandLineExecutor:
+    def __init__(
+        self,
+        cwd: Optional[Path] = None,
+        env: Optional[Dict[str, str]] = None,
+    ):
+        """
+        A class for executing command line commands.
+
+        Args:
+        - cmd: A string or list of strings representing the command to be executed.
+        - cwd: An optional Path object representing the current working directory.
+        - env: An optional dictionary of environment variables to be used in the command execution.
+        """
+        self.current_working_directory = cwd
+        self.env = env
+
+    def execute(self, cmd: str | List[str]) -> subprocess.CompletedProcess[str]:
+        """
+        Executes the command and returns a CompletedProcess object.
+
+        Returns:
+        - A subprocess.CompletedProcess object representing the result of the command execution.
+        """
+        command = " ".join([cmd] if isinstance(cmd, str) else cmd)
+        output = ""
+        try:
+            print(f"Running command: {command}")
+            with subprocess.Popen(
+                command,
+                cwd=str(self.current_working_directory or Path.cwd()),
+                stdout=subprocess.PIPE,
+                stderr=subprocess.STDOUT,
+                bufsize=1,
+                text=True,
+                env=self.env,
+                universal_newlines=True,
+            ) as process:
+                if process.stdout:
+                    for line in process.stdout:
+                        print(line, end="")
+                        # We have to store the stdout content.
+                        # This is necessary because the stdout object is closed after we printed its content
+                        output += line
+        except Exception:
+            raise RuntimeError(f"Command '{command}' failed.")  # noqa: B904
+        return subprocess.CompletedProcess(args=command, returncode=process.returncode, stdout=output, stderr=None)

spl_core/project_creator/templates/project/{{cookiecutter.name}}/Pipfile

@@ -4,10 +4,7 @@ verify_ssl = true
 name = "pypi"
 
 [packages]
-cookiecutter = "*"
-gcovr = "*"
-hammocking = "*"
-kconfiglib = "*"
+spl-core = "*"
 jinja2 = "*"
 pytest = "*"
 pytest-env = "*"

spl_core/test_utils/base_variant_test_runner.py

@@ -0,0 +1,67 @@
+import re
+from abc import ABC, abstractmethod
+from pathlib import Path
+from typing import List
+
+from spl_core.test_utils.spl_build import SplBuild
+
+
+class BaseVariantTestRunner(ABC):
+    @property
+    def variant(self) -> str:
+        return re.sub(r"^Test_", "", self.__class__.__name__).replace("__", "/")
+
+    @property
+    @abstractmethod
+    def component_paths(self) -> List[Path]:
+        pass
+
+    @property
+    @abstractmethod
+    def expected_build_artifacts(self) -> List[Path]:
+        pass
+
+    @property
+    def expected_test_artifacts(self) -> List[Path]:
+        return [Path("reports/coverage/index.html")]
+
+    @property
+    def expected_variant_report_artifacts(self) -> List[Path]:
+        return [Path("reports/html/index.html")]
+
+    @property
+    def expected_component_report_artifacts(self) -> List[Path]:
+        return [
+            Path("coverage.html"),
+            Path("unit_test_results.html"),
+            Path("unit_test_spec.html"),
+            Path("doxygen/html/index.html"),
+            Path("coverage/index.html"),
+        ]
+
+    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
+        else:
+            assert Path.joinpath(dir, artifact).exists(), f"Artifact {Path.joinpath(dir, artifact)} does not exist"  # noqa: S101
+
+    def test_build(self) -> None:
+        spl_build: SplBuild = SplBuild(variant=self.variant, build_kit="prod")
+        assert 0 == spl_build.execute(target="all")  # noqa: S101
+        for artifact in self.expected_build_artifacts:
+            self.assert_artifact_exists(dir=spl_build.build_dir, artifact=artifact)
+
+    def test_unittest(self) -> None:
+        spl_build: SplBuild = SplBuild(variant=self.variant, build_kit="test")
+        assert 0 == spl_build.execute(target="unittests")  # noqa: S101
+        for artifact in self.expected_test_artifacts:
+            self.assert_artifact_exists(dir=spl_build.build_dir, artifact=artifact)
+
+    def test_reports(self) -> None:
+        spl_build: SplBuild = SplBuild(variant=self.variant, build_kit="test")
+        assert 0 == spl_build.execute(target="all")  # noqa: S101
+        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)

spl_core/test_utils/spl_build.py

@@ -0,0 +1,77 @@
+import time
+from pathlib import Path
+from typing import List, Optional
+
+from py_app_dev.core.logging import time_it
+
+from spl_core.common.command_line_executor import CommandLineExecutor
+
+
+class SplBuild:
+    """Class for building an SPL repository."""
+
+    def __init__(self, variant: str, build_kit: str):
+        """
+        Initialize a SplBuild instance.
+
+        Args:
+            variant (str): The build variant.
+            build_kit (str): The build kit.
+
+        """
+        self.variant = variant
+        self.build_kit = build_kit
+
+    @property
+    def build_dir(self) -> Path:
+        """
+        Get the build directory.
+
+        Returns:
+            Path: The build directory path.
+
+        """
+        return Path(f"build/{self.variant}/{self.build_kit}")
+
+    @time_it()
+    def execute(self, target: str, additional_args: Optional[List[str]] = None) -> int:
+        """
+        Build the target
+
+        Args:
+            target (str): The build target.
+            additional_args (List[str], optional): Additional arguments for building. Defaults to ["-build"].
+
+        Returns:
+            int: 0 in case of success.
+
+        """
+        if additional_args is None:
+            additional_args = ["-build"]
+        return_code = -1
+        while True:
+            cmd = [
+                "build.bat",
+                "-buildKit",
+                self.build_kit,
+                "-variants",
+                self.variant,
+                "-target",
+                target,
+                "-reconfigure",
+            ]
+            cmd.extend(additional_args)
+            result = CommandLineExecutor().execute(cmd)
+            return_code = result.returncode
+            if result.returncode:
+                if result.stdout:
+                    if any(error in str(result.stdout) for error in ["No valid floating license", "No valid license", "GHS_LMHOST = N/A"]):
+                        print("Probably a license issue, retrying ...")
+                        time.sleep(10)
+                    else:
+                        break
+                else:
+                    break
+            else:
+                break
+        return return_code

{spl_core-4.0.0.dist-info → spl_core-4.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spl-core
-Version: 4.0.0
+Version: 4.1.1
 Summary: Software Product Line Support for CMake
 Home-page: https://github.com/avengineers/spl-core
 License: MIT

{spl_core-4.0.0.dist-info → spl_core-4.1.1.dist-info}/RECORD

@@ -1,6 +1,7 @@
-spl_core/__init__.py,sha256=SQa6Ci17DORmGXi_wkOW9pPlUojF-qtjH6NV1WOThsU,22
+spl_core/__init__.py,sha256=NtWqZUv_8plp1gndoYX_eAqe7K65oPMh-hIvB4Evdc8,22
 spl_core/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 spl_core/common/cmake.py,sha256=qId_QIGqvG_qkJWOTJjiW723nev6p0vvP3O0Jlfppz4,2054
+spl_core/common/command_line_executor.py,sha256=2ck2ndExyjfFORGMHhtOPTWA3gJGJ_GdZfopen2ISoY,2019
 spl_core/common/path.py,sha256=sDujd3n4XP1XGjHc7ImXEdjihO6A8BOIDbKCf7HgQ0Y,462
 spl_core/gcov_maid/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 spl_core/gcov_maid/gcov_maid.py,sha256=5rPIeL9daQDm5ad9xzaIhlDf_0H5g6r2zHo8WN8T4-8,1455
@@ -20,7 +21,7 @@ spl_core/project_creator/templates/project/{{cookiecutter.name}}/.vscode/tasks.j
 spl_core/project_creator/templates/project/{{cookiecutter.name}}/CMakeLists.txt,sha256=YHU4FBV3K4O3MUk289tLpC_t-rEAdbcXylWqNHRPVFY,1400
 spl_core/project_creator/templates/project/{{cookiecutter.name}}/KConfig,sha256=gqH4r2MYLLDtfUDQo2nYyx-rgHjBI62ca5U9TTlLFpc,598
 spl_core/project_creator/templates/project/{{cookiecutter.name}}/LICENSE,sha256=be3z6Wl8HeMABfG-fLSW2qst-PXlaByWyCbC6ztQT9A,1108
-spl_core/project_creator/templates/project/{{cookiecutter.name}}/Pipfile,sha256=6fajvqjqtuiWFcp0yFnseUNr_yJaKOx8bRUC7D4EKIg,563
+spl_core/project_creator/templates/project/{{cookiecutter.name}}/Pipfile,sha256=Axw_VeFUvmaDzw2zKCbzv6ddzerOXy_eoVi-fFwm8Y8,513
 spl_core/project_creator/templates/project/{{cookiecutter.name}}/README.md,sha256=3-uBrhvLWhjaaJxKVQXc3kajwS2o49_snrQxw6V8kWM,337
 spl_core/project_creator/templates/project/{{cookiecutter.name}}/build.bat,sha256=HlOqePYRoHTrp7v6oQ551dXI-qCymGCG0gQ9Au6bpos,73
 spl_core/project_creator/templates/project/{{cookiecutter.name}}/build.ps1,sha256=37Eui885PQC62nOD6l4dEgaeXBntiVxLBy_NYWvWDzU,10528
@@ -59,7 +60,9 @@ spl_core/project_creator/templates/variant/{{cookiecutter.flavor}}/{{cookiecutte
 spl_core/project_creator/templates/variant/{{cookiecutter.flavor}}/{{cookiecutter.subsystem}}/parts.cmake,sha256=s-SMLPvajH4ZGupruSuh-SbL8jackverQpxGqdoD-Io,77
 spl_core/project_creator/variant.py,sha256=juZWBvLT7i1ZtP1LlGBDalzTf0mhFvfoON43VoqjZOA,532
 spl_core/project_creator/workspace_artifacts.py,sha256=E4oZjnFgC2-cz9jYIYUZzOC9R07LBJAbgGwHAuK0Arg,1279
-spl_core-4.0.0.dist-info/LICENSE,sha256=UjjA0o8f5tT3wVm7qodTLAhPWLl6kgVyn9FPAd1VeYY,1099
-spl_core-4.0.0.dist-info/METADATA,sha256=kTNj8t3EdkGLOxnG_apFFWSLKwPMWJ4lYl4Nji0rBBA,1997
-spl_core-4.0.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-spl_core-4.0.0.dist-info/RECORD,,
+spl_core/test_utils/base_variant_test_runner.py,sha256=FRPkyEyUVsFMmfshzooXzOPUeYaoMBQKFVi5m671P38,2665
+spl_core/test_utils/spl_build.py,sha256=J7gj9Q979pivkYi6Bm2YUSCpjCXQ72rioCZbAgcCoLY,2172
+spl_core-4.1.1.dist-info/LICENSE,sha256=UjjA0o8f5tT3wVm7qodTLAhPWLl6kgVyn9FPAd1VeYY,1099
+spl_core-4.1.1.dist-info/METADATA,sha256=T0AkQPYgFf7UCpqGiAZqJ26AN_0l39OT7_qcbG9XKfg,1997
+spl_core-4.1.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+spl_core-4.1.1.dist-info/RECORD,,