spl-core 4.0.0__py3-none-any.whl

spl_core/project_creator/templates/project/{{cookiecutter.name}}/doc/software_architecture/index.rst

@@ -0,0 +1,2 @@
+Software Architecture
+=====================

spl_core/project_creator/templates/project/{{cookiecutter.name}}/doc/software_requirements/index.rst

@@ -0,0 +1,7 @@
+Software Requirements
+#####################
+
+.. req:: Requirement 001
+   :status: open
+
+   ...

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

@@ -0,0 +1,46 @@
+Passed test cases
+-----------------
+
+.. needtable::
+   :filter: '{id}' in tags and type == '{case_need}' and 'passed' == result
+   :columns: id, title, is resulted from
+   :style: table
+
+Failed test cases
+-----------------
+
+.. needtable::
+   :filter: '{id}' in tags and type == '{case_need}' and 'failure' == result
+   :columns: id, title, is resulted from
+   :style: table
+
+Skipped test cases
+------------------
+
+.. needtable::
+   :filter: '{id}' in tags and type == '{case_need}' and 'skipped' == result
+   :columns: id, title, is resulted from
+   :style: table
+
+Statistics
+----------
+
+| Test cases: :need_count:`'{id}' in tags and type=='{case_need}'`
+| Failed test cases: :need_count:`'{id}' in tags and 'failure' == result and type=='{case_need}'`
+| Passed test cases: :need_count:`'{id}' in tags and 'passed' == result and type=='{case_need}'`
+| Skipped test cases: :need_count:`'{id}' in tags and 'skipped' == result and type=='{case_need}'`
+| Test suites: :need_count:`'{id}' in tags and type=='{suite_need}'`
+
+Details
+-------
+
+.. {file_type}:: {title}
+   :id: {id}{links_string}
+   :tags: {tags}
+   :file: {file}
+   :auto_suites:
+   :auto_cases:
+
+   {content}
+
+

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

@@ -0,0 +1,38 @@
+{% if build_config.component_info %}
+
+Software Component Report
+#########################
+
+| **Variant:** {{ build_config.variant }}
+| **Component:** {{ build_config.component_info.long_name }}
+
+.. toctree::
+    :maxdepth: 2
+
+    {{ build_config.component_info.path }}/doc/index
+{% if build_config.component_info.has_reports %}
+    {{ build_config.component_info.reports_output_dir }}/unit_test_spec
+    {{ build_config.component_info.reports_output_dir }}/unit_test_results
+    {{ build_config.component_info.reports_output_dir }}/doxygen/html/index
+    {{ build_config.component_info.reports_output_dir }}/coverage
+{% endif %}
+
+{% else %}
+
+Variant Report
+##############
+
+**Variant:** {{ build_config.variant }}
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Contents
+
+    doc/software_requirements/index
+    doc/software_architecture/index
+    doc/components/index
+{% if build_config.target == 'reports' %}
+    {{ build_config.reports_output_dir }}/coverage
+{% endif %}
+
+{% endif %}

spl_core/project_creator/templates/project/{{cookiecutter.name}}/install-mandatory.bat

@@ -0,0 +1 @@
+call %~dp0build.bat -install %* || exit /b 1

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

@@ -0,0 +1,9 @@
+[pytest]
+pythonpath =
+    test
+testpaths =
+    test
+junit_logging = all
+addopts =
+    --capture=tee-sys
+    --verbose

spl_core/project_creator/templates/project/{{cookiecutter.name}}/scoopfile.json

@@ -0,0 +1,47 @@
+{
+    "buckets": [
+        {
+            "Name": "main",
+            "Source": "https://github.com/ScoopInstaller/Main"
+        },
+        {
+            "Name": "extras",
+            "Source": "https://github.com/ScoopInstaller/Extras"
+        },
+        {
+            "Name": "versions",
+            "Source": "https://github.com/ScoopInstaller/Versions"
+        }
+    ],
+    "apps": [
+        {
+            "Source": "main",
+            "Name": "lessmsi"
+        },
+        {
+            "Source": "main",
+            "Name": "7zip"
+        },
+        {
+            "Source": "main",
+            "Name": "innounp"
+        },
+        {
+            "Source": "main",
+            "Name": "dark"
+        },
+        {
+            "Source": "main",
+            "Name": "graphviz"
+        },
+        {
+            "Source": "versions",
+            "Name": "python311"
+        },
+        {
+            "Source": "versions",
+            "Name": "mingw-winlibs-llvm-ucrt",
+            "Version": "13.2.0-16.0.6-11.0.0-r1"
+        }
+    ]
+}

spl_core/project_creator/templates/project/{{cookiecutter.name}}/test/test_build.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python3
+
+import unittest
+import os.path
+from pathlib import Path
+from utils import run_process
+
+
+class TestBuild(unittest.TestCase):
+{% for variant in cookiecutter.variants.values() %}
+    def test_build_{{ variant["flavor"] }}__{{ variant["subsystem"] }}(self):
+        variant = '{{ variant["flavor"] }}/{{ variant["subsystem"] }}'
+        self.build_and_expect_default(variant)
+{% endfor %}
+    def build_and_expect_default(self, variant, target='all'):
+        """build wrapper shall build the default target and related outputs."""
+
+        exit_code = run_process([
+            'build.bat',
+            '-variants', variant,
+            '-target', target,
+            '-reconfigure'
+        ])
+
+        self.assertEqual(0, exit_code)
+        self.expect_binary(variant, file_name="my_main.exe")
+
+    def expect_binary(self, variant, bin_type='elf', suffix='', file_name=''):
+        """Hex file of given configuration shall exist."""
+        self.assert_expected_file_exists(self.get_artifact_name(variant, bin_type, suffix, file_name))
+
+    def assert_expected_file_exists(self, expected_file):
+        self.assertTrue(os.path.isfile(expected_file), f"File {expected_file} shall exist.")
+
+    @staticmethod
+    def get_artifact_name(variant, bin_type='elf', suffix='', file_name='') -> Path:
+        """Hex file of given configuration shall exist."""
+        file = file_name if file_name else f"{variant.replace('/', '_')}{suffix}.{bin_type}"
+        return Path(f"build/{variant}/prod/{file}")

spl_core/project_creator/templates/project/{{cookiecutter.name}}/test/test_unittests.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python3
+
+import unittest
+import os.path
+import json
+from utils import run_process
+
+
+class TestUnitTests(unittest.TestCase):
+{% for variant in cookiecutter.variants.values() %}
+    def test_unit_tests_{{ variant["flavor"] }}__{{ variant["subsystem"] }}(self):
+        variant = '{{ variant["flavor"] }}/{{ variant["subsystem"] }}'
+        self.build_unittests_and_expect_files(variant)
+{% endfor %}
+    def build_unittests_and_expect_files(self, variant):
+        exit_code = run_process([
+            'build.bat',
+            '-variants', variant,
+            '-target', 'unittests',
+            '-reconfigure'
+        ])
+
+        """Unit tests execution shall pass."""
+        self.assertEqual(0, exit_code)
+
+        """Coverage report shall be created"""
+        expected_file = f"build/{variant}/test/reports/coverage/index.html"
+        self.assertTrue(os.path.isfile(expected_file), f"File {expected_file} shall exist.")

spl_core/project_creator/templates/project/{{cookiecutter.name}}/test/utils.py

@@ -0,0 +1,26 @@
+#!/usr/bin/env python
+import os
+from subprocess import Popen, PIPE, CalledProcessError
+
+
+"""
+Utility functions needed by all test scripts.
+"""
+
+
+def get_test_data(filename=""):
+    return os.path.dirname(__file__) + "/data/" + filename
+
+
+def get_output_folder():
+    return os.path.dirname(__file__) + "/output"
+
+
+def run_process(command_list):
+    with Popen(command_list, stdout=PIPE, stderr=PIPE, bufsize=1, universal_newlines=True) as p:
+        for line in p.stdout:
+            print(line, end='')
+        for line in p.stderr:
+            print(line, end='')
+
+    return p.returncode

spl_core/project_creator/templates/project/{{cookiecutter.name}}/tools/setup/git-config.ps1

@@ -0,0 +1,8 @@
+if (Test-Path -Path .git) {
+    git config --local pull.rebase true
+    Write-Host "git config --local pull.rebase was set to 'true'"
+    git config --local fetch.prune true
+    Write-Host "git config --local fetch.prune was set to 'true'"
+} else {
+    Write-Output "This is not a git repository, therefore no configuration was changed."
+}

spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/component/CMakeLists.txt

@@ -0,0 +1,3 @@
+spl_add_source(src/component.c)
+spl_add_test_source(test/test_component.cc)
+spl_create_component(LONG_NAME "Component")

spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/component/doc/design.rst

@@ -0,0 +1,25 @@
+Design
+######
+
+.. figure:: _images/screenshot.png
+
+Requirements
+------------
+   
+.. needtable::
+   :filter: type == 'spec'
+   :columns: id, title, tested by, is implemented by
+   :style: table
+
+.. spec:: First design ID for my component
+   :id: S_001
+   :version: 1.0
+
+   This is the first design element of my component.
+
+
+.. spec:: Second design ID for my component
+   :id: S_002
+   :version: 1.0
+
+   This is the second design element of my component.

spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/component/doc/index.rst

@@ -0,0 +1,8 @@
+Software Detailed Design
+========================
+
+.. contents:: Table of Contents
+    :depth: 2
+
+   design
+   /doc/common/index

spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/component/src/component.c

@@ -0,0 +1,31 @@
+/** @file */
+
+#include "component.h"
+
+
+/*!
+* @rst
+*
+* .. impl:: someInterfaceOfComponent
+*    :id: I_001
+*    :implements: S_001
+*
+*    This function returns the magical number
+*
+* @endrst
+*/
+
+int someInterfaceOfComponent()
+{
+    int result = 7; /* The most magical number. */
+
+#ifdef THE_ANSWER
+    result = THE_ANSWER;
+#endif
+
+#ifdef THE_OFFSET
+    result += THE_OFFSET;
+#endif
+
+    return result;
+}

spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/component/src/component.h

@@ -0,0 +1 @@
+extern int someInterfaceOfComponent();

spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/component/test/test_component.cc

@@ -0,0 +1,60 @@
+/** @file */
+
+#include <gtest/gtest.h>
+using namespace testing;
+
+extern "C"
+{
+#include "component.h"
+}
+
+#include "mockup_components_component.h"
+
+/*! \mainpage
+ *
+ * TODO: table of tests
+ */
+
+
+/*!
+* @rst
+*
+* .. test:: component.test_someInterfaceOfComponent
+*    :id: T_001
+*    :tests: S_001, S_002
+*    :results: [[tr_link('title', 'case')]]
+*
+*    Some test specification
+*
+* @endrst
+*/
+TEST(component, test_someInterfaceOfComponent)
+{
+    /* mock all external dependencies of component */
+    CREATE_MOCK(mymock);
+
+    /* test interface */
+    EXPECT_EQ(7, someInterfaceOfComponent());
+}
+
+
+/*!
+* @rst
+*
+* .. test:: component.test_someInterfaceOfComponent2
+*    :id: T_002
+*    :tests: S_001
+*    :results: [[tr_link('title', 'case')]]
+*
+*    Some test specification 2
+*
+* @endrst
+*/
+TEST(component, test_someInterfaceOfComponent2)
+{
+    /* mock all external dependencies of component */
+    CREATE_MOCK(mymock);
+
+    /* test interface */
+    EXPECT_EQ(7, someInterfaceOfComponent());
+}

spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/main/CMakeLists.txt

@@ -0,0 +1,2 @@
+spl_add_source(src/main.c)
+spl_create_component(LONG_NAME "Main")

spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/main/doc/index.rst

@@ -0,0 +1,14 @@
+Software Detailed Design
+========================
+
+.. contents:: Table of Contents
+    :depth: 2
+
+Introduction
+------------
+
+This is the documentation for the ``Main`` component.
+
+{% if config.USE_COMPONENT %}
+``USE_COMPONENT`` is enabled. Therefore ``Main`` shall call ``Component``.
+{% endif %}

spl_core/project_creator/templates/project/{{cookiecutter.name}}/{% if cookiecutter.touch_components -%} components {%- endif %}/main/src/main.c

@@ -0,0 +1,17 @@
+#include "autoconf.h"
+
+#if CONFIG_USE_COMPONENT
+#include "component.h"
+#endif
+
+#include <stdio.h>
+
+int main(void)
+{
+    printf("Main program calculating ...\n");
+#if CONFIG_USE_COMPONENT
+    return someInterfaceOfComponent();
+#else
+    return 0;
+#endif
+}

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

@@ -0,0 +1,8 @@
+# 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
+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")
+set(CMAKE_ASM_COMPILER ${CMAKE_C_COMPILER} CACHE STRING "ASM Compiler")

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

@@ -0,0 +1,3 @@
+set(CMAKE_C_COMPILER gcc CACHE STRING "C Compiler")
+set(CMAKE_CXX_COMPILER g++ CACHE STRING "CXX Compiler")
+set(CMAKE_ASM_COMPILER ${CMAKE_C_COMPILER} CACHE STRING "ASM Compiler")

spl_core/project_creator/templates/variant/cookiecutter.json

@@ -0,0 +1,4 @@
+{
+  "flavor": "flavor",
+  "subsystem": "subsystem"
+}

spl_core/project_creator/templates/variant/{{cookiecutter.flavor}}/{{cookiecutter.subsystem}}/config.cmake

@@ -0,0 +1 @@
+set(CMAKE_TOOLCHAIN_FILE tools/toolchains/clang/toolchain.cmake CACHE PATH "toolchain file")

spl_core/project_creator/templates/variant/{{cookiecutter.flavor}}/{{cookiecutter.subsystem}}/config.txt

@@ -0,0 +1 @@
+CONFIG_USE_COMPONENT=y

spl_core/project_creator/templates/variant/{{cookiecutter.flavor}}/{{cookiecutter.subsystem}}/parts.cmake

@@ -0,0 +1,2 @@
+spl_add_component(components/main)
+spl_add_component(components/component)

spl_core/project_creator/variant.py

@@ -0,0 +1,23 @@
+import dataclasses
+
+
+@dataclasses.dataclass
+class Variant:
+    flavor: str
+    subsystem: str
+
+    @classmethod
+    def from_string(cls, variant: str) -> "Variant":
+        return cls(*variant.split("/"))
+
+    def __str__(self) -> str:
+        return self.to_string()
+
+    def to_string(self, delimiter: str = "/") -> str:
+        return f"{self.flavor}{delimiter}{self.subsystem}"
+
+    def __lt__(self, other: "Variant") -> bool:
+        return f"{self}" < f"{other}"
+
+    def __hash__(self) -> int:
+        return hash(f"{self}")

spl_core/project_creator/workspace_artifacts.py

@@ -0,0 +1,36 @@
+from pathlib import Path
+
+from spl_core.project_creator.variant import Variant
+
+
+class WorkspaceArtifacts:
+    def __init__(self, project_root_dir: Path):
+        self.workspace_root_dir = project_root_dir
+        self.variants_dir = self.root_dir.joinpath("variants")
+        self.src_dir = self.root_dir.joinpath("src")
+        self.test_dir = self.root_dir.joinpath("test")
+        self.components_dir = self.root_dir.joinpath("components")
+
+    @property
+    def root_dir(self) -> Path:
+        return self.workspace_root_dir
+
+    @property
+    def build_script(self) -> Path:
+        return self.root_dir.joinpath("build.bat")
+
+    @property
+    def kconfig_model_file(self) -> Path:
+        return self.root_dir.joinpath("KConfig")
+
+    def get_build_dir(self, variant: Variant, build_kit: str) -> Path:
+        return self.root_dir.joinpath(f"build/{variant}/{build_kit}")
+
+    def get_variant_dir(self, variant: Variant) -> Path:
+        return self.variants_dir.joinpath(f"{variant.flavor}/{variant.subsystem}")
+
+    def get_component_path(self, component_name: str) -> Path:
+        return self.components_dir.joinpath(component_name)
+
+    def get_kconfig_config_file(self, variant: Variant) -> Path:
+        return self.get_variant_dir(variant).joinpath("config.txt")

spl_core-4.0.0.dist-info/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.dist-info/METADATA

@@ -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.
+