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

spl_core/__init__.py

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

spl_core/__run.py

@@ -0,0 +1,12 @@
+"""
+Used to run spl-core from the command line when run from this repository.
+
+This is required because the spl-core Python module is not visible when running from the repository.
+"""
+
+import runpy
+import sys
+from pathlib import Path
+
+sys.path.insert(0, Path(__file__).parent.parent.absolute().as_posix())
+runpy.run_module("spl_core.main", run_name="__main__")

spl_core/common/command_line_executor.py

@@ -30,7 +30,9 @@ class CommandLineExecutor:
         command = " ".join([cmd] if isinstance(cmd, str) else cmd)
         output = ""
         try:
-            print(f"Running command: {command}")
+            print("=" * 120)
+            print(f"= Running command: {command}")
+            print("=" * 120)
             with subprocess.Popen(
                 command,
                 cwd=str(self.current_working_directory or Path.cwd()),

spl_core/kickstart/create.py

@@ -0,0 +1,66 @@
+import shutil
+from pathlib import Path
+from typing import List, Optional, Union
+
+from py_app_dev.core.exceptions import UserNotificationException
+from py_app_dev.core.logging import logger
+
+
+class ProjectBuilder:
+    def __init__(self, project_dir: Path, input_dir: Optional[Path] = None) -> None:
+        self.project_dir = project_dir
+        self.input_dir = input_dir if input_dir else Path(__file__).parent.joinpath("templates")
+
+        self.dirs: List[Path] = []
+        self.check_target_directory_flag = True
+
+    def with_disable_target_directory_check(self) -> "ProjectBuilder":
+        self.check_target_directory_flag = False
+        return self
+
+    def with_dir(self, dir: Union[Path, str]) -> "ProjectBuilder":
+        self.dirs.append(self.resolve_file_path(dir))
+        return self
+
+    def resolve_file_paths(self, files: List[Path | str]) -> List[Path]:
+        return [self.resolve_file_path(file) for file in files]
+
+    def resolve_file_path(self, file: Union[Path, str]) -> Path:
+        return self.input_dir.joinpath(file) if isinstance(file, str) else file
+
+    @staticmethod
+    def _check_target_directory(project_dir: Path) -> None:
+        if project_dir.is_dir() and any(project_dir.iterdir()):
+            raise UserNotificationException(f"Project directory '{project_dir}' is not empty. Use --force to override.")
+
+    def build(self) -> None:
+        if self.check_target_directory_flag:
+            self._check_target_directory(self.project_dir)
+        for dir in self.dirs:
+            shutil.copytree(dir, self.project_dir, dirs_exist_ok=True)
+
+
+class KickstartProject:
+    """Kickstart a new project in the given directory.
+
+    Args:
+        project_dir (Path): The directory where the project should be created.
+        force (bool, optional): If True, the project directory will be overridden if it is not empty. Defaults to False.
+        no_application (bool, optional): If True, the project will not contain variants and components.
+    """
+
+    def __init__(self, project_dir: Path, force: bool = False, no_application: bool = False) -> None:
+        self.logger = logger.bind()
+        self.project_dir = project_dir
+        self.force = force
+        self.no_application = no_application
+
+    def run(self) -> None:
+        self.logger.info(f"Kickstart new project in '{self.project_dir.absolute().as_posix()}'")
+        project_builder = ProjectBuilder(self.project_dir)
+        if self.force:
+            project_builder.with_disable_target_directory_check()
+        project_builder.with_dir("project")
+        if not self.no_application:
+            project_builder.with_dir("application")
+        project_builder.build()

spl_core/kickstart/templates/application/.vscode/cmake-variants.json

@@ -0,0 +1,20 @@
+{
+  "variant": {
+    "choices": {"EnglishVariant": {
+        "buildType": "EnglishVariant",
+        "long": "select to build variant 'EnglishVariant'",
+        "settings": {
+          "VARIANT": "EnglishVariant"
+        },
+        "short": "EnglishVariant"
+      }, "GermanVariant": {
+        "buildType": "GermanVariant",
+        "long": "select to build variant 'GermanVariant'",
+        "settings": {
+          "VARIANT": "GermanVariant"
+        },
+        "short": "GermanVariant"
+      }},
+    "default": "EnglishVariant"
+  }
+}

spl_core/{project_creator/templates/project/{{cookiecutter.name}} → kickstart/templates/application}/KConfig

@@ -17,7 +17,7 @@ menu "Linking"
 endmenu
 
 menu "Feature Model"
-    config USE_COMPONENT
-        bool "Enable features of component"
+    config LANG_DE
+        bool "German language selection"
         default n
 endmenu

spl_core/kickstart/templates/application/src/greeter/CMakeLists.txt

@@ -0,0 +1,3 @@
+spl_add_source(src/greeter.c)
+spl_add_test_source(test/test_greeter.cc)
+spl_create_component(LONG_NAME "Greeter")

spl_core/kickstart/templates/application/src/greeter/doc/index.rst

@@ -0,0 +1,26 @@
+Software Detailed Design
+========================
+
+.. figure:: _images/screenshot.png
+
+.. mermaid::
+
+   graph TD
+      A[Start] --> B{Language}
+      B -->|DE| C[Hallo Welt]
+      B -->|EN| D[Hello World]
+      C --> E[End]
+      D --> E
+
+Requirements
+------------
+
+.. spec:: Say Hello
+   :id: SWDD_GREETER-001
+   :integrity: QM
+
+{% if config.LANG_DE %}
+   It shall greet the user with ``Hallo Welt``.
+{% else %}
+   It shall greet the user with ``Hello World``.
+{% endif %}

spl_core/kickstart/templates/application/src/greeter/src/greeter.c

@@ -0,0 +1,24 @@
+/**
+ * @file greeter.c
+ * @brief Greeter implementation.
+ */
+
+
+#include "greeter.h"
+#include "autoconf.h"
+
+/*!
+* @rst
+*
+* .. impl:: Select the greeting message
+*    :id: SWIMPL_GREETER-001
+*    :implements: SWDD_GREETER-001
+* @endrst
+*/
+const char* get_greeting() {
+    #if defined(CONFIG_LANG_DE) && CONFIG_LANG_DE == 1
+        return "Hallo, Welt!";
+    #else
+        return "Hello, world!";
+    #endif
+}

spl_core/kickstart/templates/application/src/greeter/src/greeter.h

@@ -0,0 +1,6 @@
+#ifndef GREETER_H
+#define GREETER_H
+
+extern const char* get_greeting();
+
+#endif // GREETER_H

spl_core/kickstart/templates/application/src/greeter/test/test_greeter.cc

@@ -0,0 +1,27 @@
+/**
+ * @file
+ */
+#include <gtest/gtest.h>
+
+extern "C" {
+    #include "greeter.h"
+    #include "autoconf.h"
+}
+
+#if defined(CONFIG_LANG_DE) && CONFIG_LANG_DE == 1
+const char *greeting = "Hallo, Welt!";
+#else
+const char *greeting = "Hello, world!";
+#endif
+/*!
+* @rst
+*
+* .. test:: greeter.test_get_greeting
+*    :id: TS_GREETER-001
+*    :tests: SWDD_GREETER-001
+*
+* @endrst
+*/
+TEST(greeter, test_get_greeting) {
+    EXPECT_STREQ(greeting, get_greeting());
+}

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

@@ -9,6 +9,10 @@ Introduction
 
 This is the documentation for the ``Main`` component.
 
-{% if config.USE_COMPONENT %}
-``USE_COMPONENT`` is enabled. Therefore ``Main`` shall call ``Component``.
+The application will say
+{% if config.LANG_DE %}
+``Hallo Welt``
+{% else %}
+``Hello World``
 {% endif %}
+.

spl_core/kickstart/templates/application/src/main/src/main.c

@@ -0,0 +1,13 @@
+/**
+ * @file main.c
+ * @brief Main file for the greeter application.
+ */
+
+#include <stdio.h>
+#include "greeter.h"
+
+int main(int argc, char *argv[])
+{
+    printf("%s\n", get_greeting());
+    return 0;
+}

spl_core/kickstart/templates/application/test/EnglishVariant/test__EnglishVariant.py

@@ -0,0 +1,16 @@
+from pathlib import Path
+from typing import List
+
+from spl_core.test_utils.base_variant_test_runner import BaseVariantTestRunner
+
+
+class Test_EnglishVariant(BaseVariantTestRunner):
+    @property
+    def component_paths(self) -> List[Path]:
+        return [
+            Path("src/greeter"),
+        ]
+
+    @property
+    def expected_build_artifacts(self) -> List[Path]:
+        return [Path("my_main.exe"), Path("compile_commands.json")]

spl_core/kickstart/templates/application/test/German/test__GermanVariant.py

@@ -0,0 +1,16 @@
+from pathlib import Path
+from typing import List
+
+from spl_core.test_utils.base_variant_test_runner import BaseVariantTestRunner
+
+
+class Test_GermanVariant(BaseVariantTestRunner):
+    @property
+    def component_paths(self) -> List[Path]:
+        return [
+            Path("src/greeter"),
+        ]
+
+    @property
+    def expected_build_artifacts(self) -> List[Path]:
+        return [Path("my_main.exe"), Path("compile_commands.json")]

spl_core/kickstart/templates/application/variants/EnglishVariant/parts.cmake

@@ -0,0 +1,2 @@
+spl_add_component(src/main)
+spl_add_component(src/greeter)

spl_core/kickstart/templates/application/variants/GermanVariant/config.cmake

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

spl_core/kickstart/templates/application/variants/GermanVariant/config.txt

@@ -0,0 +1,13 @@
+
+#
+# Linking
+#
+CONFIG_LINKER_OUTPUT_FILE="my_main.exe"
+CONFIG_LINKER_BYPRODUCTS_EXTENSIONS="map"
+# end of Linking
+
+#
+# Feature Model
+#
+CONFIG_LANG_DE=y
+# end of Feature Model

spl_core/kickstart/templates/application/variants/GermanVariant/parts.cmake

@@ -0,0 +1,2 @@
+spl_add_component(src/main)
+spl_add_component(src/greeter)

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

@@ -1,3 +1,6 @@
+# Python virtual environment
+.venv
+
 # Binary output dir, not recommended to push binary results to Git.
 /build
 

spl_core/kickstart/templates/project/.vscode/extensions.json

@@ -0,0 +1,20 @@
+{
+    "recommendations": [
+        "mhutchie.git-graph",
+        "ms-vscode.cmake-tools",
+        "twxs.cmake",
+        "ms-vscode.cpptools",
+        "ms-vscode.cpptools-themes",
+        "visualstudioexptteam.intellicode-api-usage-examples",
+        "visualstudioexptteam.vscodeintellicode",
+        "haugerbr.project-tasks",
+        "avengineers.show-link-list",
+        "ms-python.vscode-pylance",
+        "ms-python.python",
+        "donjayamanne.python-environment-manager",
+        "felipecaputo.git-project-manager",
+        "ms-vscode.powershell",
+        "waderyan.gitblame",
+        "sandcastle.vscode-open"
+    ]
+}

spl_core/{project_creator/templates/project/{{cookiecutter.name}} → kickstart/templates/project}/.vscode/tasks.json

@@ -69,13 +69,25 @@
             "label": "Configure variant",
             "detail": "Feature configuration using KConfig",
             "type": "shell",
-            "command": "pipenv run guiconfig",
+            "command": ".venv/Scripts/poetry run guiconfig",
             "options": {
                 "env": {
                     "KCONFIG_CONFIG": "variants/${input:variant}/config.txt"
                 }
             },
             "problemMatcher": []
+        },
+        {
+            "label": "open report html",
+            "command": "${workspaceFolder}/build/${input:variant}/test/src/${input:component}/reports/html/index.html",
+            "type": "shell",
+            "presentation": {
+                "reveal": "always"
+            },
+            "group": {
+                "kind": "build",
+                "isDefault": false
+            }
         }
     ],
     "inputs": [
@@ -84,9 +96,17 @@
             "id": "variant",
             "description": "Which variant do you want to select?",
             "options": [
-{%- for variant in cookiecutter.variants.values() -%}
-                "{{ variant["flavor"] }}/{{ variant["subsystem"] }}",
-{%- endfor -%}
+                "EnglishVariant",
+                "GermanVariant"
+            ]
+        },
+        {
+            "type": "pickString",
+            "id": "component",
+            "description": "Which component do you want to select?",
+            "options": [
+                "greeter",
+                "main"
             ]
         }
     ]

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

@@ -2,15 +2,23 @@
 cmake_minimum_required(VERSION 3.24.0)
 cmake_policy(VERSION 3.24)
 
+# configure the current variant to be build
 set(BUILD_KIT prod CACHE STRING "Target Group to build.")
 
 include(${CMAKE_SOURCE_DIR}/variants/${VARIANT}/config.cmake)
 
 if(BUILD_KIT STREQUAL prod)
     project(${VARIANT} C ASM)
+    set(VARIANT_ADDITIONAL_COMPILE_C_FLAGS -Dstatic_scope_file=static)
 else()
+    # In case of test the project is a C++ project due to GTest usage
     project(${VARIANT} C ASM CXX)
-    set(VARIANT_ADDITIONAL_COMPILE_C_FLAGS -Dstatic= -save-temps)
+
+    # define static to nothing on file scope to allow access to
+    # static variables and function in unit test cases.
+    # Furthermore store temporary files during compilation to
+    # get preprocessed files.
+    set(VARIANT_ADDITIONAL_COMPILE_C_FLAGS -Dstatic_scope_file= -save-temps)
 endif()
 
 # Fetch all external dependencies into modules directory

spl_core/{project_creator/templates/project/{{cookiecutter.name}} → kickstart/templates/project}/build.ps1

@@ -15,6 +15,8 @@ https://go.microsoft.com/fwlink/?LinkID=135170
 param(
     [Parameter(Mandatory = $false, HelpMessage = 'Install all dependencies required to build. (Switch, default: false)')]
     [switch]$install = $false,
+    [Parameter(Mandatory = $false, HelpMessage = 'Build the target.')]
+    [switch]$build = $false,
     [Parameter(Mandatory = $false, HelpMessage = 'Clean build, wipe out all build artifacts. (Switch, default: false)')]
     [switch]$clean = $false,
     [Parameter(Mandatory = $false, HelpMessage = 'Build kit to be used. (String, default: "prod")')]
@@ -74,6 +76,38 @@ function Test-RunningInCIorTestEnvironment {
     return [Boolean]($Env:JENKINS_URL -or $Env:PYTEST_CURRENT_TEST -or $Env:GITHUB_ACTIONS)
 }
 
+# Consider CI environment variables (e.g. on Jenkins BRANCH_NAME and CHANGE_TARGET) to filter tests in release branch builds
+function Get-ReleaseBranchPytestFilter {
+    $ChangeId = $env:CHANGE_ID
+    $BranchName = $env:BRANCH_NAME
+    $ChangeTarget = $env:CHANGE_TARGET
+
+    $targetBranch = ''
+
+    if (-not $ChangeId -and $BranchName -and $BranchName.StartsWith("release/")) {
+        $targetBranch = $BranchName
+    }
+
+    if ($ChangeId -and $ChangeTarget -and $ChangeTarget.StartsWith("release/") ) {
+        $targetBranch = $ChangeTarget
+    }
+
+    $filter = ''
+    if ($targetBranch -and ($targetBranch -match 'release/([^/]+/[^/]+)(.*)')) {
+        $filter = $Matches[1]
+    }
+
+    return $filter
+}
+
+function Invoke-Bootstrap {
+    # Download bootstrap scripts from external repository
+    Invoke-RestMethod https://raw.githubusercontent.com/avengineers/bootstrap-installer/v1.5.0/install.ps1 | Invoke-Expression
+    # Execute bootstrap script
+    . .\.bootstrap\bootstrap.ps1
+}
+
+
 # Build with given parameters
 Function Invoke-Build {
     param (
@@ -110,9 +144,9 @@ Function Invoke-Build {
 
         # Filter pytest test cases
         $filterCmd = ''
-        # Consider environment variable BRANCH_NAME (e.g. on Jenkins) to filter tests in release branch builds
-        if ($Env:BRANCH_NAME -and ($Env:BRANCH_NAME -match 'release/([^/]+/[^/]+)(.*)')) {
-            $filterCmd = "-k " + $Matches[1]
+        $releaseBranchFilter = Get-ReleaseBranchPytestFilter
+        if ($releaseBranchFilter) {
+            $filterCmd = "-k '$releaseBranchFilter'"
         }
         # otherwise consider command line option '-filter' if given
         elseif ($filter) {
@@ -135,7 +169,7 @@ Function Invoke-Build {
             $dirs = Get-Childitem -Include config.cmake -Path variants -Recurse | Resolve-Path -Relative
             $variantsList = @()
             Foreach ($dir in $dirs) {
-                $variant = (get-item $dir).Directory.Parent.BaseName + "/" + (get-item $dir).Directory.BaseName
+                $variant = (get-item $dir).Directory.BaseName
                 $variantsList += $variant
             }
             $variantsSelected = @()
@@ -158,7 +192,7 @@ Function Invoke-Build {
         }
 
         # Select 'test' build kit based on target
-        if ($target.Contains("unittests") -or $target.Contains("reports")) {
+        if ($target.Contains("unittests") -or $target.Contains("reports") -or $target.Contains("docs")) {
             $buildKit = "test"
         }
 
@@ -211,21 +245,17 @@ Push-Location $PSScriptRoot
 Write-Output "Running in ${pwd}"
 
 try {
+    if (Test-RunningInCIorTestEnvironment -or $Env:USER_PATH_FIRST) {
+        Initialize-EnvPath
+    }
+
     if ($install) {
-        # Installation of Scoop, Python and pipenv via bootstrap
-        if (-Not (Test-Path -Path '.bootstrap')) {
-            New-Item -ItemType Directory '.bootstrap'
-        }
-        Invoke-RestMethod "https://raw.githubusercontent.com/avengineers/bootstrap/v1.3.0/bootstrap.ps1" -OutFile ".\.bootstrap\bootstrap.ps1"
-        Invoke-CommandLine ". .\.bootstrap\bootstrap.ps1" -Silent $true
-        Write-Output "For installation changes to take effect, please close and re-open your current shell."
+        # bootstrap environment
+        Invoke-Bootstrap
     }
-    else {
+
+    if ($build) {
         # Call build system
-        if (Test-RunningInCIorTestEnvironment -or $Env:USER_PATH_FIRST) {
-            Initialize-EnvPath
-        }
-        # Call CMake
         Invoke-Build `
             -target $target `
             -buildKit $buildKit `

spl_core/{project_creator/templates/project/{{cookiecutter.name}} → kickstart/templates/project}/conf.py

@@ -1,15 +1,14 @@
-# -*- coding: utf-8 -*-
 """ Configuration  """
 
+import datetime
 import json
 import os
-import datetime
 import re
 
 day = datetime.date.today()
 # meta data #################################################################
 
-project = "Project"
+project = "Hello SPL"
 copyright = f"{day.year} Avengineers"
 release = f"{day}"
 
@@ -64,8 +63,11 @@ html_theme_options = {
 }
 
 # EXTENSIONS AND THEIR CONFIGS ##############################################
-extensions = ["sphinx_rtd_size"]
 
+# extensions and their configuration #########################################
+extensions = []
+
+extensions.append("sphinx_rtd_size")
 sphinx_rtd_size_width = "90%"
 
 # mermaid config - @see https://pypi.org/project/sphinxcontrib-mermaid/ #####
@@ -170,14 +172,14 @@ html_context = {
 # Check if the SPHINX_BUILD_CONFIGURATION_FILE environment variable exists
 # and if so, load the JSON file and set the 'html_context' variable
 if "SPHINX_BUILD_CONFIGURATION_FILE" in os.environ:
-    with open(os.environ["SPHINX_BUILD_CONFIGURATION_FILE"], "r") as file:
+    with open(os.environ["SPHINX_BUILD_CONFIGURATION_FILE"]) as file:
         html_context["build_config"] = json.load(file)
         include_patterns.extend(html_context["build_config"].get("include_patterns", []))
 
 # Check if the SPHINX_BUILD_CONFIGURATION_FILE environment variable exists
 # and if so, load the JSON file and set the 'html_context' variable
 if "AUTOCONF_JSON_FILE" in os.environ:
-    with open(os.environ["AUTOCONF_JSON_FILE"], "r") as file:
+    with open(os.environ["AUTOCONF_JSON_FILE"]) as file:
         html_context["config"] = json.load(file)["features"]
 
 if "VARIANT" in os.environ:

spl_core/{project_creator/templates/project/{{cookiecutter.name}} → kickstart/templates/project}/doc/Doxyfile.in

@@ -1316,7 +1316,7 @@ HTML_FILE_EXTENSION    = .html
 # of the possible markers and block names see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_HEADER            = 
+HTML_HEADER            =
 
 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
 # generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -2356,7 +2356,7 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             =
+PREDEFINED             = "static_scope_file=static"
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

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

@@ -2,4 +2,4 @@ Common Documentation of the Project
 ===================================
 
 
-Some text...
+Some text...

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

@@ -4,15 +4,14 @@ Components
 {% for component_info in build_config.components_info %}
 {% if component_info.has_docs %}
 
-{{ component_info.long_name }}
---------------------
+{{ component_info.long_name or component_info.name }}
+-----------------------------------------------------
 
 .. toctree::
     :maxdepth: 2
 
     /{{ component_info.path }}/doc/index
 {% if (build_config.target == 'reports') and component_info.has_reports %}
-    /{{ component_info.reports_output_dir }}/unit_test_spec
     /{{ component_info.reports_output_dir }}/unit_test_results
     /{{ component_info.reports_output_dir }}/doxygen/html/index
     /{{ component_info.reports_output_dir }}/coverage