spl-core 4.0.0__tar.gz → 4.1.0__tar.gz

{spl_core-4.0.0 → spl_core-4.1.0}/PKG-INFO

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

{spl_core-4.0.0 → spl_core-4.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "spl-core"
-version = "4.0.0"
+version = "4.1.0"
 description = "Software Product Line Support for CMake"
 authors = ["Avengineers <karsten.guenther@kamg.de>"]
 license = "MIT"
@@ -55,6 +55,7 @@ sphinxcontrib-plantuml = "*"
 sphinx-copybutton = "*"
 sphinx-new-tab-link = "*"
 pipenv = "*"
+pypeline-runner = "^0.2.1"
 
 [tool.poetry.group.docs]
 optional = true

spl_core-4.1.0/src/spl_core/__init__.py

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

spl_core-4.1.0/src/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-4.0.0 → spl_core-4.1.0}/src/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-4.1.0/src/spl_core/test_utils/base_variant_test_runner.py

@@ -0,0 +1,61 @@
+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/reports/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 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:
+            assert artifact.exists() or Path.joinpath(spl_build.build_dir, artifact).exists()  # noqa: S101
+
+    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:
+            assert artifact.exists()  # noqa: S101
+
+    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:
+            assert Path.joinpath(spl_build.build_dir, artifact).exists()  # noqa: S101
+        for component in self.component_paths:
+            for artifact in self.expected_component_report_artifacts:
+                assert Path.joinpath(spl_build.build_dir, component, artifact).exists()  # noqa: S101

spl_core-4.1.0/src/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/src/spl_core/__init__.py

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