spl-core 4.0.0__py3-none-any.whl

spl_core/project_creator/templates/project/{{cookiecutter.name}}/.vscode/settings.json

@@ -0,0 +1,45 @@
+{
+    "python.testing.pytestEnabled": true,
+    "python.testing.pytestArgs": [
+        "test"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.analysis.extraPaths": [
+        "test"
+    ],
+    "cmake.configureOnOpen": false,
+    "cmake.buildDirectory": "${workspaceFolder}/build/${variant:variant}/${buildKit}",
+    "cmake.configureSettings": {
+        "BUILD_KIT": "${buildKit}",
+        "CMAKE_MESSAGE_LOG_LEVEL": "STATUS"
+    },
+    "cmake.generator": "Ninja",
+    "cmake.debugConfig": {
+        "MIMode": "gdb",
+        "miDebuggerPath": "gdb",
+        "stopAtEntry": true
+    },
+    "cmake.configureOnEdit": false,
+    "cmake.buildBeforeRun": false,
+    "cmake.environment": {
+        "PIPENV_VERBOSITY": "-1",
+        "PIPENV_VENV_IN_PROJECT": "1"
+    },
+    "cmake.buildToolArgs": [],
+    "git.ignoreLimitWarning": true,
+    "C_Cpp.errorSquiggles": "enabled",
+    "C_Cpp.default.cStandard": "gnu17",
+    "C_Cpp.default.configurationProvider": "ms-vscode.cmake-tools",
+    "C_Cpp.formatting": "vcFormat",
+    "files.associations": {
+        "*.h": "c",
+        "*.c": "c",
+        "Jenkinsfile": "groovy",
+        "*.py": "python"
+    },
+    "git.repositoryScanMaxDepth": 3,
+    "git-graph.maxDepthOfRepoSearch": 3,
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter"
+    }
+}

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

@@ -0,0 +1,93 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Get mandatory tools",
+            "detail": "Installation of mandatory tools",
+            "type": "shell",
+            "command": ".\\build.ps1 -install",
+            "problemMatcher": []
+        },
+        {
+            "label": "Update all tools",
+            "detail": "Update of all installed scoop packages",
+            "type": "shell",
+            "command": ".\\build.ps1 -command 'scoop update --all'",
+            "problemMatcher": []
+        },
+        {
+            "label": "Environment",
+            "detail": "Print all environment variables for debugging purposes",
+            "type": "shell",
+            "command": "dir env:",
+            "problemMatcher": []
+        },
+        {
+            "type": "cmake",
+            "label": "Build with CMake",
+            "detail": "Build target 'all' of selected variant",
+            "command": "build",
+            "targets": [
+                "all"
+            ],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "problemMatcher": [
+                {
+                    "owner": "c/cpp",
+                    "fileLocation": [
+                        "absolute"
+                    ],
+                    "pattern": {
+                        "regexp": "^ctc (I|W|E)(\\d+): \\[\"(.*)\" (\\d+)/(\\d+)\\] (.*)",
+                        "file": 3,
+                        "line": 4,
+                        "column": 5,
+                        "severity": 1,
+                        "message": 6
+                    }
+                }
+            ]
+        },
+        {
+            "type": "cmake",
+            "label": "Clean with CMake",
+            "command": "clean",
+            "problemMatcher": [],
+            "detail": "Clean build artifacts of selected variant"
+        },
+        {
+            "type": "cmake",
+            "label": "Configure with CMake",
+            "command": "configure",
+            "problemMatcher": [],
+            "detail": "Configure selected variant"
+        },
+        {
+            "label": "Configure variant",
+            "detail": "Feature configuration using KConfig",
+            "type": "shell",
+            "command": "pipenv run guiconfig",
+            "options": {
+                "env": {
+                    "KCONFIG_CONFIG": "variants/${input:variant}/config.txt"
+                }
+            },
+            "problemMatcher": []
+        }
+    ],
+    "inputs": [
+        {
+            "type": "pickString",
+            "id": "variant",
+            "description": "Which variant do you want to select?",
+            "options": [
+{%- for variant in cookiecutter.variants.values() -%}
+                "{{ variant["flavor"] }}/{{ variant["subsystem"] }}",
+{%- endfor -%}
+            ]
+        }
+    ]
+}

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

@@ -0,0 +1,43 @@
+# cmake project definition
+cmake_minimum_required(VERSION 3.24.0)
+cmake_policy(VERSION 3.24)
+
+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)
+else()
+    project(${VARIANT} C ASM CXX)
+    set(VARIANT_ADDITIONAL_COMPILE_C_FLAGS -Dstatic= -save-temps)
+endif()
+
+# Fetch all external dependencies into modules directory
+set(FETCHCONTENT_BASE_DIR ${CMAKE_SOURCE_DIR}/build/modules CACHE INTERNAL "")
+set(FETCHCONTENT_QUIET FALSE)
+include(FetchContent)
+
+# Include spl-core
+if(DEFINED ENV{SPLCORE_PATH})
+    message(WARNING "SPLCORE_PATH defined! Use fixed SPL-CORE version from: $ENV{SPLCORE_PATH}")
+    include($ENV{SPLCORE_PATH}/cmake/spl.cmake)
+else()
+    # Fetch spl-core
+    FetchContent_Declare(
+        spl-core
+        GIT_REPOSITORY https://github.com/avengineers/spl-core.git
+        GIT_TAG develop
+    )
+    FetchContent_MakeAvailable(spl-core)
+
+    # Include spl-core
+    include(${spl-core_SOURCE_DIR}/cmake/spl.cmake)
+endif()
+
+include(${CMAKE_SOURCE_DIR}/variants/${VARIANT}/parts.cmake)
+
+# TODO: refactor/remove; we want to explicitly add includes where required
+foreach(component_name ${COMPONENT_NAMES})
+    target_include_directories(${component_name} PUBLIC ${target_include_directories__INCLUDES})
+endforeach()

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

@@ -0,0 +1,23 @@
+mainmenu "SPL Example"
+
+menu "Linking"
+    config LINKER_OUTPUT_FILE
+        string
+        prompt "LINKER_OUTPUT_FILE"
+        default "my_main.exe"
+        help
+          The output file generated by the linker (e.g. my_main.exe).
+
+    config LINKER_BYPRODUCTS_EXTENSIONS
+        string
+        prompt "LINKER_BYPRODUCTS_EXTENSIONS"
+        default "map"
+        help
+          The extensions of other byproducts generated by the linker (e.g. map)
+endmenu
+
+menu "Feature Model"
+    config USE_COMPONENT
+        bool "Enable features of component"
+        default n
+endmenu

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

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 - present 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/project_creator/templates/project/{{cookiecutter.name}}/Pipfile

@@ -0,0 +1,33 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+cookiecutter = "*"
+gcovr = "*"
+hammocking = "*"
+kconfiglib = "*"
+jinja2 = "*"
+pytest = "*"
+pytest-env = "*"
+testfixtures = "*"
+junitparser = "*"
+mashumaro = "*"
+loguru = "*"
+black = "*"
+flake8 = "*"
+sphinx = "*"
+sphinx-rtd-theme = "*"
+sphinxcontrib-mermaid = "*"
+sphinx-needs = "*"
+sphinx-test-reports = "*"
+doxysphinx = "*"
+sphinx-rtd-size = "*"
+sphinxcontrib-datatemplates = "*"
+pyelftools = "*"
+sphinxcontrib-plantuml = "*"
+pipenv = "*"
+
+[requires]
+python_version = "3.11"

spl_core/project_creator/templates/project/{{cookiecutter.name}}/README.md

@@ -0,0 +1,7 @@
+# Software Product Line {{cookiecutter.name}}
+
+
+## Preparation
+
+You can install required tools and install some VS Code extensions. The installer uses Scoop/PowerShell, so it will only run on Windows. The installation is done by executing `install-mandatory.bat`. In case you are sitting behind a proxy server, make sure to add:
+

spl_core/project_creator/templates/project/{{cookiecutter.name}}/build.bat

@@ -0,0 +1 @@
+powershell -ExecutionPolicy Bypass -File %~dp0build.ps1 %* || exit /b 1

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

@@ -0,0 +1,245 @@
+<#
+.DESCRIPTION
+  Wrapper for installing dependencies and building the product.
+
+.Notes
+  On Windows, it may be required to call this script with the proper execution policy.
+You can do this by issuing the following PowerShell command:
+
+PS C:\> powershell -ExecutionPolicy Bypass -File .\build.ps1
+
+For more information on Execution Policies:
+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 = '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")')]
+    [string]$buildKit = "prod",
+    [Parameter(Mandatory = $false, HelpMessage = 'Target to be built. (String, default: "all")')]
+    [string]$target = "all",
+    [Parameter(Mandatory = $false, HelpMessage = 'Variants (of the product) to be built (List of strings, leave empty to be asked or "all" for automatic build of all variants)')]
+    [string[]]$variants = $null,
+    [Parameter(Mandatory = $false, HelpMessage = 'filter for selftests; define in pytest syntax: https://docs.pytest.org/en/6.2.x/usage.html; e.g. "Disco or test_CustA__Disco.py"')]
+    [string]$filter = "",
+    [Parameter(Mandatory = $false, HelpMessage = 'Additional build arguments for Ninja (e.g., "-d explain -d keepdepfile" for debugging purposes)')]
+    [string]$ninjaArgs = "",
+    [Parameter(Mandatory = $false, HelpMessage = 'Delete CMake cache and reconfigure. (Switch, default: false)')]
+    [switch]$reconfigure = $false
+)
+
+# Call a command and handle its exit code
+Function Invoke-CommandLine {
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingInvokeExpression', '', Justification = 'Usually this statement must be avoided (https://learn.microsoft.com/en-us/powershell/scripting/learn/deep-dives/avoid-using-invoke-expression?view=powershell-7.3), here it is OK as it does not execute unknown code.')]
+    param (
+        [Parameter(Mandatory = $true, Position = 0)]
+        [string]$CommandLine,
+        [Parameter(Mandatory = $false, Position = 1)]
+        [bool]$StopAtError = $true,
+        [Parameter(Mandatory = $false, Position = 2)]
+        [bool]$Silent = $false
+    )
+    if (-Not $Silent) {
+        Write-Output "Executing: $CommandLine"
+    }
+    $global:LASTEXITCODE = 0
+    Invoke-Expression $CommandLine
+    if ($global:LASTEXITCODE -ne 0) {
+        if ($StopAtError) {
+            Write-Error "Command line call '$CommandLine' failed with exit code $global:LASTEXITCODE"
+        }
+        else {
+            if (-Not $Silent) {
+                Write-Output "Command line call '$CommandLine' failed with exit code $global:LASTEXITCODE, continuing ..."
+            }
+        }
+    }
+}
+
+# Update/Reload current environment variable PATH with settings from registry
+Function Initialize-EnvPath {
+    # workaround for system-wide installations
+    if ($Env:USER_PATH_FIRST) {
+        $Env:Path = [System.Environment]::GetEnvironmentVariable("Path", "User") + ";" + [System.Environment]::GetEnvironmentVariable("Path", "Machine")
+    }
+    else {
+        $Env:Path = [System.Environment]::GetEnvironmentVariable("Path", "Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path", "User")
+    }
+}
+
+function Test-RunningInCIorTestEnvironment {
+    return [Boolean]($Env:JENKINS_URL -or $Env:PYTEST_CURRENT_TEST -or $Env:GITHUB_ACTIONS)
+}
+
+# Build with given parameters
+Function Invoke-Build {
+    param (
+        [Parameter(Mandatory = $false)]
+        [bool]$clean = $false,
+        [Parameter(Mandatory = $false)]
+        [string]$buildKit = "prod",
+        [Parameter(Mandatory = $true)]
+        [string]$target = "all",
+        [Parameter(Mandatory = $false)]
+        [string[]]$variants = $null,
+        [Parameter(Mandatory = $false)]
+        [string]$filter = "",
+        [Parameter(Mandatory = $false)]
+        [string]$ninjaArgs = "",
+        [Parameter(Mandatory = $false)]
+        [bool]$reconfigure = $false
+    )
+    if ("selftests" -eq $target) {
+        # Run python tests to test all relevant variants and platforms (build kits)
+        # (normally run in CI environment/Jenkins)
+        Write-Output "Running all selfstests ..."
+
+        # Build folder for CMake builds
+        $buildFolder = "build"
+
+        # fresh and clean CMake builds
+        if ($clean) {
+            if (Test-Path -Path $buildFolder) {
+                Write-Output "Removing build folder '$buildFolder' ..."
+                Remove-Item $buildFolder -Force -Recurse
+            }
+        }
+
+        # 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]
+        }
+        # otherwise consider command line option '-filter' if given
+        elseif ($filter) {
+            $filterCmd = "-k '$filter'"
+        }
+
+        # Test result of pytest
+        $pytestJunitXml = "test/output/test-report.xml"
+
+        # Delete any old pytest result
+        if (Test-Path -Path $pytestJunitXml) {
+            Remove-Item $pytestJunitXml -Force
+        }
+
+        # Finally run pytest
+        Invoke-CommandLine -CommandLine "python -m pipenv run python -m pytest test --junitxml=$pytestJunitXml $filterCmd"
+    }
+    else {
+        if ((-Not $variants) -or ($variants -eq 'all')) {
+            $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
+                $variantsList += $variant
+            }
+            $variantsSelected = @()
+            if (-Not $variants) {
+                # variant selection by user if not specified
+                Write-Information -Tags "Info:" -MessageData "no '--variant <variant>' was given, please select from list:"
+                Foreach ($variant in $variantsList) {
+                    Write-Information -Tags "Info:" -MessageData ("(" + [array]::IndexOf($variantsList, $variant) + ") " + $variant)
+                }
+                $variantsSelected += $variantsList[[int](Read-Host "Please enter selected variant number")]
+                Write-Information -Tags "Info:" -MessageData "Selected variant is: $variantsSelected"
+            }
+            else {
+                # otherwise build all variants
+                $variantsSelected = $variantsList
+            }
+        }
+        else {
+            $variantsSelected = $Variants.Replace('\', '/').Replace('./variant/', '').Replace('./variants/', '').Split(',')
+        }
+
+        # Select 'test' build kit based on target
+        if ($target.Contains("unittests") -or $target.Contains("reports")) {
+            $buildKit = "test"
+        }
+
+        Foreach ($variant in $variantsSelected) {
+            Write-Output "Building target '$target' with build kit '$buildKit' for variant '$variant' ..."
+
+            $buildFolder = "build/$variant/$buildKit"
+            # fresh and clean build
+            if ($clean) {
+                if (Test-Path -Path $buildFolder) {
+                    Write-Output "Removing build folder '$buildFolder' ..."
+                    Remove-Item $buildFolder -Force -Recurse
+                }
+            }
+
+            # delete CMake cache and reconfigure
+            if ($reconfigure) {
+                if (Test-Path -Path "$buildFolder/CMakeCache.txt") {
+                    Remove-Item "$buildFolder/CMakeCache.txt" -Force
+                }
+                if (Test-Path -Path "$buildFolder/CMakeFiles") {
+                    Remove-Item "$buildFolder/CMakeFiles" -Force -Recurse
+                }
+            }
+
+            # CMake configure
+            $additionalConfig = "-DBUILD_KIT='$buildKit'"
+            if ($buildKit -eq "test") {
+                $additionalConfig += " -DCMAKE_TOOLCHAIN_FILE='tools/toolchains/gcc/toolchain.cmake'"
+            }
+            Invoke-CommandLine -CommandLine "python -m pipenv run cmake -B '$buildFolder' -G Ninja -DVARIANT='$variant' $additionalConfig"
+
+            # CMake clean all dead artifacts. Required when running incremented builds to delete obsolete artifacts.
+            Invoke-CommandLine -CommandLine "python -m pipenv run cmake --build '$buildFolder' --target $target -- -t cleandead"
+            # CMake build
+            Invoke-CommandLine -CommandLine "python -m pipenv run cmake --build '$buildFolder' --target $target -- $ninjaArgs"
+        }
+    }
+}
+
+## start of script
+# Always set the $InformationPreference variable to "Continue" globally,
+# this way it gets printed on execution and continues execution afterwards.
+$InformationPreference = "Continue"
+
+# Stop on first error
+$ErrorActionPreference = "Stop"
+
+Push-Location $PSScriptRoot
+Write-Output "Running in ${pwd}"
+
+try {
+    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."
+    }
+    else {
+        # Call build system
+        if (Test-RunningInCIorTestEnvironment -or $Env:USER_PATH_FIRST) {
+            Initialize-EnvPath
+        }
+        # Call CMake
+        Invoke-Build `
+            -target $target `
+            -buildKit $buildKit `
+            -variants $variants `
+            -clean $clean `
+            -reconfigure $reconfigure `
+            -ninjaArgs $ninjaArgs `
+            -filter $filter
+    }
+}
+finally {
+    Pop-Location
+    if (-Not (Test-RunningInCIorTestEnvironment)) {
+        Read-Host -Prompt "Press Enter to continue ..."
+    }
+}
+## end of script