BTC EmbeddedPlatform CI: Python Reference Workflows

This repo contains four example workflows that demonstrate how unit tests with BTC EmbeddedPlatform can be automated using Python scripts and the BTC EmbeddedPlatform Rest API.

Installing the package

$ pip install btc_embedded

What can I do if my machine doesn't allow pip access to the internet?

• Check with colleagues / the IT team if your company hosts a mirror of the public repository in your local network and use that instead.
• Plan B:
  • download / clone the module's public repository: https://github.com/btc-embedded/btc_embedded
  • open a terminal and navigate into the btc_embedded directory
  • call pip install . (including the dot)

Using the API wrapper

from btc_embedded import EPRestApi

# create api object and connects to the default port (1337)
ep = EPRestApi()

# create an empty test project
ep.post('profiles')

# ...

Configuration

All sorts of configurations (such as the BTC version or Matlab version to use, compiler, preferences for vector generation, etc.) can be done directly via the API using the preferences endpoint. However, we consider it best practice to separate configuration from the actual test workflow. This can be achieved as follows:

• the file btc_config.yml shows the default api configuration for BTC EmbeddedPlatform workflows
• a copy of this file can be adapted to your needs and provided as a global configuration set, by defining an environment variable BTC_API_CONFIG_FILE that points to this file (on Windows systems, we recommend to place it in "C:/ProgramData/BTC/ep/btc_config.yml")
• Optional: project-specific configurations
  • if you'd like to configure things differently for certain projects, you can add a project-specific configuration
  • Simply place a copy of the btc_config.yml file alongside project source files to provide project-specific configurations
  • project-specific configurations can override selected options defined in the global configuration, to allow adaptable configuration for projects with special needs
  • Check out the TargetLink workflow script for an example on how to use the configuration (line 11)

Documentation

The example workflows (subfolder: examples) are a great place to get started, but at some point you'll need access to the docs to know the specifics for some API commands. - The PDF version of the docs is available as part of this repo (e.g. EPRestApiDocs_xx.x.pdf)

• Assuming you have the application installed and have access to the required license, you can also run it and access a live-documentation in the browser:

python -c "from btc_embedded import EPRestApi; ep = EPRestApi();exit()"

Examples

Example 1: EmbeddedCoder AUTOSAR model

• Testing for a Simulink EmbeddedCoder Autosar Model: Seat Heating Controller
• Model-in-the-loop (MIL)
• Software-in-the-loop (SIL)
• Component Files
• Workflow Script

Example 2: TargetLink model

• Testing for a TargetLink Model: Adaptive Cruise Control
• Model-in-the-loop (MIL)
• Software-in-the-loop (SIL)
• Component Files
• Workflow Script

Example 3: Simulink model - MIL only

• Testing for a Simulink Model: Power Window Controller
• Model-in-the-loop (MIL)
• Component Files
• Workflow Script

Example 4: Handwritten C-Code

• Testing for handwritten C-Code: Sum Product Average Calculator
• Software-in-the-loop (SIL)
• Component Files
• Workflow Script

Repository Structure

Let's have a quick look at the structure of this repository:

Pipeline scripts for various environments

• The folder .github/workflows/ contains four yaml files, each configuring a GitHub Actions workflow for one of the examples, using Python and the BTC EmbeddedPlatform REST API
• Jenkinsfile shows how to integrate a Python & REST-API-based BTC test workflow with Jenkins
• .gitlab-ci.yml shows how to integrate a Python & REST-API-based BTC test workflow with GitLab CI

Examples

• 4 example components (see previous section above for more details)
• 4 workflow scripts (one for each example)
• test_multiple_projects.py showcases the test of multiple projects that yield a combined summary report

Other files

• Do you want to make sure that no unwanted files sneak their way into your git repository and that binary files are treated as such?
  • The .gitignore and .gitattributes files can serve as a great entrypoint for model-based development projects.
  • .gitignore prevents untracked files and folders from being added, if they match one of the specified patterns
  • .gitattributes tells git how to handle certain files if they are tracked, especially to prevent auto-merge attempts.