spl-core 4.0.0__tar.gz

spl_core-4.0.0/LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2024 Marquardt GmbH and members of AVENGINEERS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

spl_core-4.0.0/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.1
+Name: spl-core
+Version: 4.0.0
+Summary: Software Product Line Support for CMake
+Home-page: https://github.com/avengineers/spl-core
+License: MIT
+Author: Avengineers
+Author-email: karsten.guenther@kamg.de
+Requires-Python: >=3.10,<3.12
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+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: gcovr
+Requires-Dist: hammocking
+Requires-Dist: kconfiglib
+Requires-Dist: py-app-dev (>=2.1.0,<3.0.0)
+Project-URL: Bug Tracker, https://github.com/avengineers/spl-core/issues
+Project-URL: Changelog, https://github.com/avengineers/spl-core/blob/develop/CHANGELOG.md
+Project-URL: Documentation, https://spl-core.readthedocs.io
+Project-URL: Repository, https://github.com/avengineers/spl-core
+Description-Content-Type: text/markdown
+
+# SPL (Software Product Line) Core
+
+_SPL Core_ is our CMake module to support multiple projects as variants of one SPL repository.
+
+## CI (Continuous Integration)
+
+-   [![selftests](https://github.com/avengineers/spl/actions/workflows/test.yml/badge.svg)](https://github.com/avengineers/spl/actions/workflows/test.yml)
+
+## Installation of Dependencies
+
+```powershell
+.\build.ps1 -install
+```
+
+## Building
+
+-   Execution of all tests
+-   Building documentation
+
+```powershell
+.\build.ps1
+```
+
+## Project Creator
+
+With the integrated project creator you can create a new SPL workspace, e.g.:
+
+```powershell
+pipenv run python src/project_creator/creator.py workspace --name MyProject --variant FLV1/SYS1 --out_dir C:\dev
+```
+
+Note: one can use the `--variant` argument several times to create a project with multiple variants.
+

spl_core-4.0.0/README.md

@@ -0,0 +1,32 @@
+# SPL (Software Product Line) Core
+
+_SPL Core_ is our CMake module to support multiple projects as variants of one SPL repository.
+
+## CI (Continuous Integration)
+
+-   [![selftests](https://github.com/avengineers/spl/actions/workflows/test.yml/badge.svg)](https://github.com/avengineers/spl/actions/workflows/test.yml)
+
+## Installation of Dependencies
+
+```powershell
+.\build.ps1 -install
+```
+
+## Building
+
+-   Execution of all tests
+-   Building documentation
+
+```powershell
+.\build.ps1
+```
+
+## Project Creator
+
+With the integrated project creator you can create a new SPL workspace, e.g.:
+
+```powershell
+pipenv run python src/project_creator/creator.py workspace --name MyProject --variant FLV1/SYS1 --out_dir C:\dev
+```
+
+Note: one can use the `--variant` argument several times to create a project with multiple variants.

spl_core-4.0.0/pyproject.toml

@@ -0,0 +1,185 @@
+[tool.poetry]
+name = "spl-core"
+version = "4.0.0"
+description = "Software Product Line Support for CMake"
+authors = ["Avengineers <karsten.guenther@kamg.de>"]
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/avengineers/spl-core"
+documentation = "https://spl-core.readthedocs.io"
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries",
+]
+packages = [
+    { include = "spl_core", from = "src" },
+]
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/avengineers/spl-core/issues"
+"Changelog" = "https://github.com/avengineers/spl-core/blob/develop/CHANGELOG.md"
+
+[tool.poetry.dependencies]
+python = ">=3.10,<3.12"
+py-app-dev = "^2.1.0"
+cookiecutter = {version="==2.1.1"}
+gcovr = "*"
+hammocking = "*"
+kconfiglib = "*"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.0"
+pytest-cov = "^4.0"
+black = "^23.1.0"
+pre-commit = "^3.1.1"
+ruff = "^0.3.0"
+jinja2 = "*"
+testfixtures = "*"
+junitparser = "*"
+mashumaro = "*"
+loguru = "*"
+m2r = "*"
+flake8 = "*"
+sphinx = "*"
+sphinx-rtd-theme = "*"
+sphinxcontrib-mermaid = "*"
+sphinx-needs = "*"
+sphinx-test-reports = "*"
+doxysphinx = "*"
+sphinx-rtd-size = "*"
+sphinxcontrib-datatemplates = "*"
+sphinxcontrib-plantuml = "*"
+sphinx-copybutton = "*"
+sphinx-new-tab-link = "*"
+pipenv = "*"
+
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+myst-parser = ">=0.16"
+sphinx = ">=4.0"
+sphinxcontrib-mermaid = "^0.8.1"
+mlx-traceability = "^10.0.0"
+sphinx-copybutton = "^0.5.2"
+sphinx-new-tab-link = "^0.2.2"
+sphinx-book-theme = "^1.1.2"
+sphinx-design = "^0.5.0"
+
+[tool.semantic_release]
+version_toml = ["pyproject.toml:tool.poetry.version"]
+version_variables = [
+    "src/spl_core/__init__.py:__version__",
+    "docs/conf.py:release",
+]
+build_command = "pip install poetry && poetry build"
+
+[tool.semantic_release.changelog]
+exclude_commit_patterns = [
+    "chore*",
+    "ci*",
+]
+
+[tool.semantic_release.changelog.environment]
+keep_trailing_newline = true
+
+[tool.semantic_release.branches.main]
+match = "develop"
+
+[tool.semantic_release.branches.noop]
+match = "(?!develop$)"
+prerelease = true
+
+[tool.pytest.ini_options]
+addopts = " --verbose --capture=tee-sys --junitxml=out/test-report.xml"
+pythonpath = ["src", "tests"]
+testpaths = ["tests"]
+junit_logging = "all"
+
+[tool.coverage.run]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "@overload",
+    "if TYPE_CHECKING",
+    "raise NotImplementedError",
+    'if __name__ == "__main__":',
+]
+
+[tool.ruff]
+target-version = "py38"
+line-length = 220
+lint.ignore = [
+    "D203", # 1 blank line required before class docstring
+    "D212", # Multi-line docstring summary should start at the first line
+    "D100", # Missing docstring in public module
+    "D101", # Missing docstring in public class
+    "D102", # Missing docstring in public method
+    "D103", # Missing docstring in public function
+    "D104", # Missing docstring in public package
+    "D107", # Missing docstring in `__init__`
+    "D401", # First line of docstring should be in imperative mood
+    "S603", # subprocess calls with shell=True
+]
+lint.select = [
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "S",   # flake8-bandit
+    "F",   # pyflake
+    "E",   # pycodestyle
+    "W",   # pycodestyle
+    "UP",  # pyupgrade
+    "I",   # isort
+    "RUF", # ruff specific
+]
+exclude = [
+    "bootstrap.py"
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*" = [
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "S101",
+]
+"setup.py" = ["D100"]
+"conftest.py" = ["D100"]
+"docs/conf.py" = ["D100"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["spl_core", "tests"]
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+mypy_path = "src/"
+no_implicit_optional = true
+show_error_codes = true
+warn_unreachable = true
+warn_unused_ignores = true
+exclude = [
+    'docs/.*',
+    'setup.py',
+]
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+allow_untyped_defs = true
+
+[[tool.mypy.overrides]]
+module = "docs.*"
+ignore_errors = true
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

spl_core-4.0.0/src/spl_core/__init__.py

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

spl_core-4.0.0/src/spl_core/common/cmake.py

@@ -0,0 +1,52 @@
+import logging
+import subprocess
+from subprocess import CompletedProcess
+
+from spl_core.project_creator.variant import Variant
+from spl_core.project_creator.workspace_artifacts import WorkspaceArtifacts
+
+
+class CMake:
+    executable = "cmake"
+
+    def __init__(self, workspace_artifacts: WorkspaceArtifacts):
+        self.logger = logging.getLogger(__name__)
+        self.workspace_artifacts = workspace_artifacts
+
+    def run(self, variant: Variant, build_kit: str = "prod", target: str = "all") -> CompletedProcess[bytes]:
+        ret_status = self.configure(variant, build_kit)
+        if ret_status.returncode == 0:
+            ret_status = self.build(variant, build_kit, target)
+        return ret_status
+
+    def configure(self, variant: Variant, build_kit: str = "prod") -> CompletedProcess[bytes]:
+        arguments = (
+            f" --log-level=DEBUG"
+            f" -S{self.workspace_artifacts.root_dir}"
+            f" -B{self.workspace_artifacts.get_build_dir(variant, build_kit)}"
+            f" -G Ninja "
+            f" -DBUILD_KIT:STRING={build_kit}"
+            f" -DVARIANT:STRING={variant.to_string()}"
+            f" -DCMAKE_BUILD_TYPE:STRING={variant.to_string('_')}"
+        )
+        if build_kit == "test":
+            toolchain = self.workspace_artifacts.root_dir.joinpath(
+                "tools\\toolchains\\gcc\\toolchain.cmake"
+            )
+            arguments += f" -DCMAKE_TOOLCHAIN_FILE={toolchain}"
+        return self.run_cmake(arguments)
+
+    def build(
+        self, variant: Variant, build_kit: str = "prod", target: str = "all"
+    ) -> CompletedProcess[bytes]:
+        arguments = (
+            f" --build {self.workspace_artifacts.get_build_dir(variant, build_kit)}"
+            f" --config {variant.to_string('_')}"
+            f" --target {target} -- "
+        )
+        return self.run_cmake(arguments)
+
+    def run_cmake(self, arguments: str) -> CompletedProcess[bytes]:
+        command = self.executable + " " + arguments
+        print(f"Running {command}")
+        return subprocess.run(command.split())

spl_core-4.0.0/src/spl_core/common/path.py

@@ -0,0 +1,17 @@
+from pathlib import Path
+
+
+def to_path(input_path: str, check_if_exists: bool = True) -> Path:
+    return_path = Path(input_path)
+    if not check_if_exists or return_path.exists():
+        return return_path.absolute()
+    else:
+        raise FileNotFoundError(input_path)
+
+
+def existing_path(input_path: str) -> Path:
+    return to_path(input_path, True)
+
+
+def non_existing_path(input_path: str) -> Path:
+    return to_path(input_path, False)

spl_core-4.0.0/src/spl_core/gcov_maid/gcov_maid.py

@@ -0,0 +1,48 @@
+import argparse
+from pathlib import Path
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(description="Script with command line options")
+    parser.add_argument(
+        "--working-dir", help="Working directory", required=True
+    )  # Make the option mandatory
+    parser.add_argument(
+        "--wipe-all-gcda", action="store_true", help="Wipe all gcda files recursively"
+    )
+    parser.add_argument(
+        "--wipe-orphaned-gcno",
+        action="store_true",
+        help="Wipe orphaned gcno files recursively",
+    )
+
+    args = parser.parse_args()
+
+    # Access the command line options
+    working_dir = Path(args.working_dir)  # Convert the string to a Path object
+    wipe_gcda = bool(args.wipe_all_gcda)  # Convert the switch value to boolean
+    wipe_gcno = bool(args.wipe_orphaned_gcno)  # Convert the switch value to boolean
+
+    if wipe_gcda:
+        wipe_gcda_files(working_dir)
+
+    if wipe_gcno:
+        wipe_gcno_files(working_dir)
+
+
+def wipe_gcda_files(working_dir: Path) -> None:
+    for file in working_dir.glob("**/*.gcda"):
+        print(f"Deleting obsolete coverage data file: {file}")
+        file.unlink()
+
+
+def wipe_gcno_files(working_dir: Path) -> None:
+    for file in working_dir.glob("**/*.gcno"):
+        obj_file = file.with_suffix(".obj")
+        if not obj_file.exists():
+            print(f"Deleting obsolete coverage notes file: {file}")
+            file.unlink()
+
+
+if __name__ == "__main__":
+    main()