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

spl_core/{project_creator/templates/project/{{cookiecutter.name}} → kickstart/templates/project}/doc/doxygen-awesome/doxygen-awesome.css

@@ -204,7 +204,7 @@ html {
         --code-background: #2a2c2f;
 
         --tablehead-background: #2a2c2f;
-    
+
         --blockquote-background: #222325;
         --blockquote-foreground: #7e8c92;
 
@@ -888,7 +888,7 @@ div.header {
         flex-wrap: nowrap;
         align-items: flex-start;
     }
-    
+
     div.contents .textblock {
         min-width: 200px;
         flex-grow: 1;
@@ -980,21 +980,21 @@ html.dark-mode div.contents .dotgraph iframe
 h2.groupheader {
     border-bottom: 0px;
     color: var(--page-foreground-color);
-    box-shadow: 
-        100px 0 var(--page-background-color), 
+    box-shadow:
+        100px 0 var(--page-background-color),
         -100px 0 var(--page-background-color),
         100px 0.75px var(--separator-color),
         -100px 0.75px var(--separator-color),
-        500px 0 var(--page-background-color), 
+        500px 0 var(--page-background-color),
         -500px 0 var(--page-background-color),
         500px 0.75px var(--separator-color),
         -500px 0.75px var(--separator-color),
-        900px 0 var(--page-background-color), 
+        900px 0 var(--page-background-color),
         -900px 0 var(--page-background-color),
         900px 0.75px var(--separator-color),
         -900px 0.75px var(--separator-color),
         1400px 0 var(--page-background-color),
-        -1400px 0 var(--page-background-color), 
+        -1400px 0 var(--page-background-color),
         1400px 0.75px var(--separator-color),
         -1400px 0.75px var(--separator-color),
         1900px 0 var(--page-background-color),
@@ -1165,8 +1165,8 @@ div.toc li a.aboveActive {
 
     div.contents .toc.interactive > h3::before {
         content: "";
-        width: 0; 
-        height: 0; 
+        width: 0;
+        height: 0;
         border-left: 4px solid transparent;
         border-right: 4px solid transparent;
         border-top: 5px solid var(--primary-color);
@@ -1857,8 +1857,8 @@ table.memberdecls img[src="closed.png"],
 table.memberdecls img[src="open.png"],
 div.dynheader img[src="open.png"],
 div.dynheader img[src="closed.png"] {
-    width: 0; 
-    height: 0; 
+    width: 0;
+    height: 0;
     border-left: 4px solid transparent;
     border-right: 4px solid transparent;
     border-top: 5px solid var(--primary-color);
@@ -1876,7 +1876,7 @@ table.memberdecls img {
 table.memberdecls img[src="closed.png"],
 div.dynheader img[src="closed.png"] {
     transform: rotate(-90deg);
-    
+
 }
 
 .compoundTemplParams {
@@ -1919,7 +1919,7 @@ div.dynheader img[src="closed.png"] {
         margin-bottom: calc(0px - var(--page-font-size));
     }
 
-    table.memberdecls .memItemRight, 
+    table.memberdecls .memItemRight,
     table.memberdecls .mdescRight,
     table.memberdecls .memTemplItemRight {
         border-top: 0;
@@ -2105,8 +2105,8 @@ html.dark-mode .iconfopen, html.dark-mode .iconfclosed {
     background-color: transparent;
 }
 
-/* 
- Class Index Doxygen 1.8 
+/*
+ Class Index Doxygen 1.8
 */
 
 table.classindex {
@@ -2251,7 +2251,7 @@ div.contents .toc::-webkit-scrollbar-thumb,
     background-color: transparent;
     border: var(--webkit-scrollbar-padding) solid transparent;
     border-radius: calc(var(--webkit-scrollbar-padding) + var(--webkit-scrollbar-padding));
-    background-clip: padding-box;  
+    background-clip: padding-box;
 }
 
 #nav-tree:hover::-webkit-scrollbar-thumb,

spl_core/{project_creator/templates/project/{{cookiecutter.name}} → kickstart/templates/project}/doc/test_report_template.txt

@@ -42,5 +42,3 @@ Details
    :auto_cases:
 
    {content}
-
-

spl_core/{project_creator/templates/project/{{cookiecutter.name}} → kickstart/templates/project}/index.rst

@@ -34,5 +34,6 @@ Variant Report
 {% if build_config.target == 'reports' %}
     {{ build_config.reports_output_dir }}/coverage
 {% endif %}
+    doc/results/index
 
 {% endif %}

spl_core/kickstart/templates/project/pipfile

@@ -0,0 +1,6 @@
+[packages]
+pytest = "8.1.1"
+spl-core = "*"
+
+[requires]
+python_version = "3.11"

spl_core/{project_creator/templates/project/{{cookiecutter.name}} → kickstart/templates/project}/pytest.ini

@@ -5,5 +5,6 @@ testpaths =
     test
 junit_logging = all
 addopts =
+    -vv
     --capture=tee-sys
-    --verbose
+    --junitxml=build/test-report.xml

spl_core/kickstart/templates/project/scoopfile.json

@@ -0,0 +1,14 @@
+{
+  "buckets": [
+    {
+      "Name": "versions",
+      "Source": "https://github.com/ScoopInstaller/Versions"
+    }
+  ],
+  "apps": [
+    {
+      "Source": "versions",
+      "Name": "mingw-winlibs-llvm-ucrt"
+    }
+  ]
+}

spl_core/{project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_tools -%} tools {%- endif %}/toolchains/clang/toolchain.cmake → kickstart/templates/project/tools/toolchains/clang/toolchain.cmake}

@@ -1,7 +1,7 @@
 # TODO: caching required due to cmake tools extension issue: https://github.com/microsoft/vscode-cmake-tools/issues/1188
 # TODO: get debugging running (lldb-mi not found in any current package, switching back to gcc)
 set(CMAKE_C_COMPILER clang CACHE STRING "C Compiler")
-# TODO: clarify why llvm-cov produces invalid gcov files (contain blank lines), releated GCOVR issue: https://github.com/gcovr/gcovr/issues/331
+# TODO: clarify why llvm-cov produces invalid gcov files (contain blank lines), related GCOVR issue: https://github.com/gcovr/gcovr/issues/331
 set(GCOVR_ADDITIONAL_OPTIONS --gcov-executable \"llvm-cov gcov\" --gcov-ignore-parse-errors --html-title \"Code Coverage Report \(tool suite: LLVM Clang\)\")
 
 set(CMAKE_CXX_COMPILER clang++ CACHE STRING "CXX Compiler")

spl_core/main.py

@@ -0,0 +1,44 @@
+import sys
+from pathlib import Path
+
+import typer
+from py_app_dev.core.exceptions import UserNotificationException
+from py_app_dev.core.logging import logger, setup_logger, time_it
+
+from spl_core import __version__
+from spl_core.kickstart.create import KickstartProject
+
+package_name = "please"
+
+app = typer.Typer(name=package_name, help="Software Product Line Support for CMake.", no_args_is_help=True, add_completion=False)
+
+
+@app.callback(invoke_without_command=True)
+def version(
+    version: bool = typer.Option(None, "--version", "-v", is_eager=True, help="Show version and exit."),
+) -> None:
+    if version:
+        typer.echo(f"{package_name} {__version__}")
+        raise typer.Exit()
+
+
+@app.command()
+@time_it("init")
+def init(
+    project_dir: Path = typer.Option(Path.cwd().absolute(), help="The project directory"),  # noqa: B008
+    force: bool = typer.Option(False, help="Force the initialization of the project even if the directory is not empty."),
+) -> None:
+    KickstartProject(project_dir, force).run()
+
+
+def main() -> None:
+    try:
+        setup_logger()
+        app()
+    except UserNotificationException as e:
+        logger.error(f"{e}")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

spl_core/test_utils/base_variant_test_runner.py

@@ -39,6 +39,18 @@ class BaseVariantTestRunner(ABC):
             Path("coverage/index.html"),
         ]
 
+    @property
+    def create_artifacts_archive(self) -> bool:
+        return True
+
+    @property
+    def create_artifacts_json(self) -> bool:
+        return True
+
+    @property
+    def expected_archive_artifacts(self) -> List[Path]:
+        return self.expected_build_artifacts
+
     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
@@ -50,6 +62,11 @@ class BaseVariantTestRunner(ABC):
         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)
+        if self.create_artifacts_archive:
+            # create artifacts archive
+            spl_build.create_artifacts_archive(self.expected_archive_artifacts)
+        if self.create_artifacts_json:
+            spl_build.create_artifacts_json(self.expected_archive_artifacts)
 
     def test_unittest(self) -> None:
         spl_build: SplBuild = SplBuild(variant=self.variant, build_kit="test")

spl_core/test_utils/spl_build.py

@@ -1,4 +1,7 @@
+import json
 import time
+import zipfile
+from dataclasses import dataclass
 from pathlib import Path
 from typing import List, Optional
 
@@ -7,6 +10,34 @@ from py_app_dev.core.logging import time_it
 from spl_core.common.command_line_executor import CommandLineExecutor
 
 
+@dataclass
+class ArchiveArtifact:
+    archive_path: Path
+    absolute_path: Path
+
+
+class ArtifactsCollection:
+    def __init__(self, artifacts: List[Path], build_dir: Path):
+        self.archive_artifacts: List[ArchiveArtifact] = []
+        for artifact in artifacts:
+            if artifact.is_absolute():
+                artifact_path = artifact
+            else:
+                artifact_path = Path.joinpath(build_dir.absolute(), artifact)
+            if artifact_path.is_dir():
+                for artifact in artifact_path.glob("**/*"):
+                    if artifact.is_file():
+                        if artifact_path.is_relative_to(build_dir.absolute()):
+                            self.archive_artifacts.append(ArchiveArtifact(archive_path=artifact.relative_to(build_dir.absolute()), absolute_path=artifact.absolute()))
+                        else:
+                            self.archive_artifacts.append(ArchiveArtifact(archive_path=Path(artifact.name), absolute_path=artifact.absolute()))
+            else:
+                if artifact_path.is_relative_to(build_dir.absolute()):
+                    self.archive_artifacts.append(ArchiveArtifact(archive_path=artifact_path.relative_to(build_dir.absolute()), absolute_path=artifact_path.absolute()))
+                else:
+                    self.archive_artifacts.append(ArchiveArtifact(archive_path=Path(artifact_path.name), absolute_path=artifact_path.absolute()))
+
+
 class SplBuild:
     """Class for building an SPL repository."""
 
@@ -75,3 +106,57 @@ class SplBuild:
             else:
                 break
         return return_code
+
+    def create_artifacts_archive(self, expected_artifacts: List[Path]) -> Path:
+        """
+        Create a zip file containing the collected artifacts.
+
+        Args:
+            expected_artifacts: List of Path of artifacts which should be archived
+
+        Returns:
+            Path: The path to the created zip file.
+
+        Raises:
+            Exception: If there is an error creating the zip file.
+
+        """
+        zip_path = self.build_dir / "artifacts.zip"
+
+        # Delete the file if it already exists
+        if zip_path.exists():
+            zip_path.unlink()
+
+        try:
+            with zipfile.ZipFile(zip_path, "w") as zip_file:
+                artifacts_collection = ArtifactsCollection(artifacts=expected_artifacts, build_dir=self.build_dir)
+                for artifact in artifacts_collection.archive_artifacts:
+                    zip_file.write(artifact.absolute_path, arcname=artifact.archive_path)
+            print(f"Zip file created at: {zip_path}")
+            return zip_path
+        except Exception as e:
+            print(f"Error creating artifacts zip file: {e}")
+            raise e
+
+    def create_artifacts_json(self, expected_artifacts: List[Path]) -> Path:
+        """
+        Create a JSON file listing the collected artifacts.
+
+        Returns:
+            Path: The path to the created JSON file.
+
+        Raises:
+            Exception: If there is an error creating the JSON file.
+
+        """
+        artifacts_collection = ArtifactsCollection(artifacts=expected_artifacts, build_dir=self.build_dir)
+        json_content = {
+            "variant": self.variant,
+            "build_kit": self.build_kit,
+            "artifacts": [str(artifact.archive_path.as_posix()) for artifact in artifacts_collection.archive_artifacts],
+        }
+        json_path = self.build_dir / "artifacts.json"
+
+        json_path.write_text(json.dumps(json_content, indent=4))
+
+        return json_path

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spl-core
-Version: 4.1.1
+Version: 4.2.0
 Summary: Software Product Line Support for CMake
 Home-page: https://github.com/avengineers/spl-core
 License: MIT
@@ -17,10 +17,22 @@ 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: doxysphinx (>=3.3.7,<4.0.0)
 Requires-Dist: gcovr
 Requires-Dist: hammocking
 Requires-Dist: kconfiglib
 Requires-Dist: py-app-dev (>=2.1.0,<3.0.0)
+Requires-Dist: sphinx (>=7.3.5,<8.0.0)
+Requires-Dist: sphinx-copybutton (>=0.5.2,<0.6.0)
+Requires-Dist: sphinx-needs (>=2.0.0,<3.0.0)
+Requires-Dist: sphinx-new-tab-link (>=0.4.0,<0.5.0)
+Requires-Dist: sphinx-rtd-size (>=0.2.0,<0.3.0)
+Requires-Dist: sphinx-rtd-theme (>=2.0.0,<3.0.0)
+Requires-Dist: sphinx-test-reports (>=1.0.2,<2.0.0)
+Requires-Dist: sphinxcontrib-datatemplates (>=0.11.0,<0.12.0)
+Requires-Dist: sphinxcontrib-mermaid (>=0.9.2,<0.10.0)
+Requires-Dist: sphinxcontrib-plantuml (>=0.29,<0.30)
+Requires-Dist: typer[all] (>=0.12.3,<0.13.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
@@ -55,7 +67,7 @@ _SPL Core_ is our CMake module to support multiple projects as variants of one S
 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
+pipenv run python src/project_creator/creator.py workspace --name MyProject --variant MyVariant --out_dir C:\dev
 ```
 
 Note: one can use the `--variant` argument several times to create a project with multiple variants.

spl_core-4.2.0.dist-info/RECORD

@@ -0,0 +1,60 @@
+spl_core/__init__.py,sha256=pU56ZDjCDnUbINe39hYuKXHy9UI9Tf4xjWgnxBlxEDk,22
+spl_core/__run.py,sha256=DphnN7_Bjiw_mOOztsHxTDHS8snz1g2MMWAaJpZxPKM,361
+spl_core/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+spl_core/common/command_line_executor.py,sha256=ID0Hw_ETduDoeHNDLJtbRPVPQTJPh_Zt7PdrBW2pAG4,2079
+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
+spl_core/kconfig/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+spl_core/kconfig/kconfig.py,sha256=JLBSUvPnc5dEZNWHeuMTFgP9iBgtzEV6tnrhE4-5oCg,9795
+spl_core/kickstart/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+spl_core/kickstart/create.py,sha256=Lv7-3nb71HKmclHBSCliLKiFdmAIOBl1VTvA39YboLQ,2741
+spl_core/kickstart/templates/application/.vscode/cmake-variants.json,sha256=sF_dsbdrDwhfIo5EfGzvIgMZZcz5Z5k4Al0qrS8j7AY,553
+spl_core/kickstart/templates/application/KConfig,sha256=tl_9L535AhJdCHBhi4xDez3sK_Yc78e0KBekg5e-48w,589
+spl_core/kickstart/templates/application/src/greeter/CMakeLists.txt,sha256=MX7J58ZkxUNRshAUb1AdT_qO-XJABVO6vfpgEHeVp1g,117
+spl_core/kickstart/templates/application/src/greeter/doc/_images/screenshot.png,sha256=LsjExuSbDPsy3BzpPrfYMsD2fwYdNZzKS56s6aSn8Rc,11090
+spl_core/kickstart/templates/application/src/greeter/doc/index.rst,sha256=60b9gaeeCKp-J0nnB5f8Ndk8g18NbGQobuCj0WfPNsQ,500
+spl_core/kickstart/templates/application/src/greeter/src/greeter.c,sha256=ikOfwUoSZekDHjVb9nnh_99cOQBmB8nNxgshl12cGc0,431
+spl_core/kickstart/templates/application/src/greeter/src/greeter.h,sha256=CFvhZ41kcD9XC3T6sJtWntkRYxR6HI8xY5xGpvAy9Jk,99
+spl_core/kickstart/templates/application/src/greeter/test/test_greeter.cc,sha256=Vg6u4Cn1Q6ntsdc3JlK1VTiPT3tDejvHD-280QKuAhc,482
+spl_core/kickstart/templates/application/src/main/CMakeLists.txt,sha256=9gu3ydUv1cT3WjXw944lAvVK0MzJaCD1zKqvRZmTt_o,68
+spl_core/kickstart/templates/application/src/main/doc/index.rst,sha256=vJah60GsBx70m-Q1d9sR34cSziwA7wMR-10jMSSlO6c,303
+spl_core/kickstart/templates/application/src/main/src/main.c,sha256=vNj-JGFqD70h_AVpjFiHeB6pvbW2OpZeSF7munyY6tY,215
+spl_core/kickstart/templates/application/test/EnglishVariant/test__EnglishVariant.py,sha256=P66U-6oCKTwLQ_tFFVPEyRbTvfQjKoREnqqWXou4OOc,437
+spl_core/kickstart/templates/application/test/German/test__GermanVariant.py,sha256=v4O8mbDA7tAHNus2fQ4MJvXp6kBLyersBy7J-rgpoq4,436
+spl_core/kickstart/templates/application/variants/EnglishVariant/config.cmake,sha256=SbFIGrclTicjW-TNH4QlUilaSs1CCmL882PBrlVau8g,94
+spl_core/kickstart/templates/application/variants/EnglishVariant/parts.cmake,sha256=CnNxm2Cf2X_0vkS52xj5WNTLffVQP9CflkEaDEtlxXs,61
+spl_core/kickstart/templates/application/variants/GermanVariant/config.cmake,sha256=SbFIGrclTicjW-TNH4QlUilaSs1CCmL882PBrlVau8g,94
+spl_core/kickstart/templates/application/variants/GermanVariant/config.txt,sha256=6gfkKIlqKPOK2pI4TIGN58FG7VCRfgcFLzR9HPog4dg,188
+spl_core/kickstart/templates/application/variants/GermanVariant/parts.cmake,sha256=CnNxm2Cf2X_0vkS52xj5WNTLffVQP9CflkEaDEtlxXs,61
+spl_core/kickstart/templates/project/.gitignore,sha256=Ibd6YbqO2UPfauJzrdgY7z4ar0aPmEwYQ-ncDKzZrlg,638
+spl_core/kickstart/templates/project/.vscode/cmake-kits.json,sha256=oLn_-InkXE3Th6OL5hlSxBZsx2dBaKShrHZVcyAcfFU,269
+spl_core/kickstart/templates/project/.vscode/extensions.json,sha256=49RYati_P9i3zdiKuaTIkNQnA1uH1eIUd6DusIa9TT0,624
+spl_core/kickstart/templates/project/.vscode/launch.json,sha256=30-tsNapUNNIvVDohdIf4SEnHrHh8qbWuTjLJjsMcEY,1103
+spl_core/kickstart/templates/project/.vscode/settings.json,sha256=w2zAkNk4P0eZC5zDxiG7jKy35Jl37TyVDg38lXjq3hw,1369
+spl_core/kickstart/templates/project/.vscode/tasks.json,sha256=fPaiY-vpI-3wMK0dpc3LZma4-YYyaI_xc6uQrEUf6sw,3434
+spl_core/kickstart/templates/project/CMakeLists.txt,sha256=pufvVYIpu56BQv04JgJMBzi0DG_pLN0S7d0s4zU8WRg,1817
+spl_core/kickstart/templates/project/build.bat,sha256=HlOqePYRoHTrp7v6oQ551dXI-qCymGCG0gQ9Au6bpos,73
+spl_core/kickstart/templates/project/build.ps1,sha256=oQSCxUoleJSkBSRW3nTqg_23eANh9mfjlJPgTfH21Ak,11057
+spl_core/kickstart/templates/project/conf.py,sha256=wGhSzSyUx5otw3kPeOzIEKFIxA-Z70K-foUuQWYBY64,6775
+spl_core/kickstart/templates/project/doc/Doxyfile.in,sha256=NOj07VHEUeEfYIrETKg--G2ShBXMqFh61q1FdhfY-5U,123953
+spl_core/kickstart/templates/project/doc/common/index.rst,sha256=tOqSYkFdxIJtBcllwMwWEkw9_cbbAsg9NPU2AanyJNc,91
+spl_core/kickstart/templates/project/doc/components/index.rst,sha256=1n4qdJD38Q-sRaiqW3rF2rQK9ag3OchslA8uTzmarkM,590
+spl_core/kickstart/templates/project/doc/doxygen-awesome/LICENSE,sha256=49p1TD9lfMeFlPouijKDZl94x0PfJIX6nkmKiXMFEZE,1072
+spl_core/kickstart/templates/project/doc/doxygen-awesome/doxygen-awesome.css,sha256=bNr_9KABkHTxWMkHqXJcXXxEScP2nlnJ2eV9me1Vjmw,63045
+spl_core/kickstart/templates/project/doc/software_architecture/index.rst,sha256=Oq602GCpTJmV-uQDfsvgcEChSLGNDPIjBecCXv5wEg0,44
+spl_core/kickstart/templates/project/doc/software_requirements/index.rst,sha256=FmnMsx1Ih2qulGuLcch7vBW5Gxkv42P3BeAeih7c3Ro,95
+spl_core/kickstart/templates/project/doc/test_report_template.txt,sha256=Pj9npGI1sVMDBrDQJ1jS_T_ysLgwvBzNO8T5FMjYsIE,1213
+spl_core/kickstart/templates/project/index.rst,sha256=7HHmhxme_djB5iostqFc_7U8liKmTCNQZraC9nopEfg,1044
+spl_core/kickstart/templates/project/pipfile,sha256=vV8woA8pI6kHXBf00_68802SW5o-wG44K-64apbv0wI,85
+spl_core/kickstart/templates/project/pytest.ini,sha256=TB-kMa5upQAA6NgiPrTxVWCFaDTIoZN04ZnQL6byzjQ,159
+spl_core/kickstart/templates/project/scoopfile.json,sha256=DcfZ8jYf9hmPHM-AWwnPKQJCzRG3fCuYtMeoY01nkag,219
+spl_core/kickstart/templates/project/tools/toolchains/clang/toolchain.cmake,sha256=fDD-eb6DeqmAYkCbILL2V5PLnCPRdTu1Tpg0WfDC_dE,713
+spl_core/kickstart/templates/project/tools/toolchains/gcc/toolchain.cmake,sha256=AmLzPyhTgfc_Dsre4AlsvSOkVGW6VswWvrEnUL8JLhA,183
+spl_core/main.py,sha256=_hL4j155WZMXog_755bgAH1PeUwvTdJZvVdVw9EWhvo,1225
+spl_core/test_utils/base_variant_test_runner.py,sha256=4ugideRMJqj1oaSboMSK7qZnAwg3O8Ysk23SdIi_t1o,3221
+spl_core/test_utils/spl_build.py,sha256=TtYFTY94Fa9eXdtY9NavrCulx-NEONRm81GSLHGB_yQ,5599
+spl_core-4.2.0.dist-info/LICENSE,sha256=UjjA0o8f5tT3wVm7qodTLAhPWLl6kgVyn9FPAd1VeYY,1099
+spl_core-4.2.0.dist-info/METADATA,sha256=UkiI2qgKeYngvGmzv_dCUTc3PNVq6OxP791HfUb5idc,2590
+spl_core-4.2.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+spl_core-4.2.0.dist-info/RECORD,,

spl_core/common/cmake.py

@@ -1,52 +0,0 @@
-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/project_creator/creator.py

@@ -1,133 +0,0 @@
-import argparse
-import logging
-import shutil
-from pathlib import Path
-from typing import Any, Dict, List
-
-from cookiecutter.main import cookiecutter
-
-from spl_core.common.path import existing_path
-from spl_core.project_creator.variant import Variant
-from spl_core.project_creator.workspace_artifacts import WorkspaceArtifacts
-
-
-class Creator:
-    def __init__(self, project_name: str, out_dir: Path):
-        self.logger = logging.getLogger(__name__)
-        self.project_name = project_name
-        self.out_dir = out_dir.absolute()
-        self.project_root_dir = self.out_dir.joinpath(self.project_name)
-        self.project_artifacts = WorkspaceArtifacts(self.project_root_dir)
-
-    @classmethod
-    def from_folder(cls, project_dir: Path) -> "Creator":
-        return cls(project_dir.name, project_dir.parent)
-
-    @staticmethod
-    def create_project_description(name: str, variants: List[Variant], touch_only_variants_data: bool = False) -> Dict[str, Any]:
-        project_description = {"name": name, "variants": {}, "touch_components": not touch_only_variants_data, "touch_tools": not touch_only_variants_data}
-        variants.sort()
-        for index, variant in enumerate(variants):
-            project_description["variants"] = {str(index): vars(variant) for index, variant in enumerate(variants)}
-        return project_description
-
-    @property
-    def project_template_path(self) -> Path:
-        return Path(__file__).parent.joinpath("templates/project")
-
-    @property
-    def variant_template_path(self) -> Path:
-        return Path(__file__).parent.joinpath("templates/variant")
-
-    def materialize(self, variants: List[Variant]) -> Path:
-        result_path = self.materialize_workspace(variants)
-        self.materialize_variants(variants)
-        self.logger.info(f"Project created under: {result_path}")
-        return Path(result_path)
-
-    def materialize_workspace(self, variants: List[Variant], touch_only_variants_data: bool = False) -> Path:
-        project_description = self.create_project_description(self.project_name, variants, touch_only_variants_data)
-        result_path = cookiecutter(str(self.project_template_path), output_dir=f"{self.out_dir}", no_input=True, extra_context=project_description, overwrite_if_exists=True)
-        return result_path
-
-    def materialize_variants(self, variants: List[Variant]) -> None:
-        for variant in variants:
-            self.materialize_variant(vars(variant), self.project_artifacts.variants_dir)
-
-    def materialize_variant(self, variant_description: Dict[str, Any], out_dir: Path) -> Path:
-        result_path = cookiecutter(str(self.variant_template_path), output_dir=f"{out_dir}", no_input=True, extra_context=variant_description, overwrite_if_exists=True)
-        self.logger.info(f"Variant created under: {result_path}")
-        return Path(result_path)
-
-    def add_variants(self, variants: List[Variant]) -> None:
-        existing_variants = self.collect_project_variants()
-        new_variants = [variant for variant in variants if variant not in existing_variants]
-        if len(new_variants):
-            self.materialize_workspace(new_variants + existing_variants, touch_only_variants_data=True)
-            self.materialize_variants(variants)
-            if len(new_variants) != len(variants):
-                self.logger.warning(f"Skip adding variants" f" ({', '.join([str(v) for v in variants if v not in new_variants])})" f" because they already exist in {self.project_root_dir}.")
-        else:
-            self.logger.warning(f"Nothing to add. All the provided variants" f" ({', '.join([str(v) for v in variants])}) already exist in {self.project_root_dir}.")
-
-    def delete_variants(self, variants: List[Variant]) -> None:
-        existing_variants = self.collect_project_variants()
-        variants_to_be_deleted = [variant for variant in variants if variant in existing_variants]
-        if len(variants_to_be_deleted):
-            remaining_variants = list(set(existing_variants) - set(variants_to_be_deleted))
-            self.materialize_workspace(remaining_variants, touch_only_variants_data=True)
-            for variant in variants_to_be_deleted:
-                self.delete_variant_dir(variant)
-            if len(variants_to_be_deleted) != len(variants):
-                self.logger.warning(f"Skip deleting variants" f" ({', '.join([str(v) for v in variants if v not in variants_to_be_deleted])})" f" because they do not exist in {self.project_root_dir}.")
-        else:
-            self.logger.warning(f"Nothing to delete. None of the provided variants" f" ({', '.join([str(v) for v in variants])}) exists in {self.project_root_dir}.")
-
-    def delete_variant_dir(self, variant: Variant) -> None:
-        variant_dir = self.project_artifacts.variants_dir.joinpath(f"{variant}")
-        if variant_dir.exists():
-            shutil.rmtree(variant_dir)
-
-    def collect_project_variants(self) -> List[Variant]:
-        variants = []
-        variant_dirs = self.project_artifacts.variants_dir.glob("*/*/")
-        for variant_dir in variant_dirs:
-            variants.append(Variant(variant_dir.parent.name, variant_dir.name))
-        return variants
-
-
-def main(command_arguments: Any = None) -> None:
-    arguments = parse_arguments(command_arguments)
-    if arguments.command_scope == "workspace":
-        Creator(arguments.name, arguments.out_dir).materialize(arguments.variant)
-    else:  # scope is variant
-        creator = Creator.from_folder(arguments.workspace_dir)
-        if arguments.add:
-            creator.add_variants(arguments.add)
-        else:
-            creator.delete_variants(arguments.delete)
-
-
-def parse_arguments(command_arguments: Any = None) -> argparse.Namespace:
-    parser = argparse.ArgumentParser(description="Workspace creator")
-    subparsers = parser.add_subparsers(dest="command_scope")
-
-    parser_workspace = subparsers.add_parser("workspace", help="Create a workspace")
-    parser_workspace.add_argument("--name", required=True, type=str, help="Workspace name. A directory with this name will be created in the <out_dir>.")
-    parser_workspace.add_argument("--variant", required=True, action="append", type=Variant.from_string, help="Variant name as <flavor>/<subsystem>. E.g. FLV1/SYS1. " "This option can be used multiple times.")
-    parser_workspace.add_argument("--out_dir", required=True, type=existing_path, help="Target directory where the workspace folder will be created.")
-
-    parser_variant = subparsers.add_parser("variant", help="Add/delete variant to existing workspace")
-    command_group = parser_variant.add_mutually_exclusive_group(required=True)
-    command_group.add_argument(
-        "--add", action="append", type=Variant.from_string, metavar="VARIANT", help="Add a variant to a workspace. Variant name as <flavor>/<subsystem>." " E.g. FLV1/SYS1. This option can be used multiple times."
-    )
-    command_group.add_argument(
-        "--delete", action="append", type=Variant.from_string, metavar="VARIANT", help="Delete a variant from a workspace. Variant name as <flavor>/<subsystem>." " E.g. FLV1/SYS1. This option can be used multiple times."
-    )
-    parser_variant.add_argument("--workspace_dir", required=True, type=existing_path, help="Workspace root directory.")
-    return parser.parse_args(command_arguments)
-
-
-if __name__ == "__main__":
-    main()

spl_core/project_creator/templates/project/cookiecutter.json

@@ -1,14 +0,0 @@
-{
-  "name": "project",
-  "touch_components": "True",
-  "touch_tools": "True",
-  "variants": {
-    "1": {
-      "flavor": "flavor",
-      "subsystem": "subsystem"
-    }
-  },
-  "_copy_without_render": [
-        "*.rst"
-    ]
-}

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

@@ -1,2 +0,0 @@
-[flake8]
-max-line-length = 240