Test in Renode GitHub Action

Copyright (c) 2024 Antmicro

A GitHub Action for testing embedded software in the Renode simulation environment using the Robot Framework.

See how to use Robot with Renode in the relevant chapter in our documentation.

This action allows you to write a test in Robot using Renode's predefined keyword library and execute them automatically in GitHub Actions, which results in very nice test logs and summaries.

Usage

See action.yml

steps:
- uses: antmicro/renode-test-action@v4
  with:
    renode-revision: 'master'
    tests-to-run: 'tests/**/*.robot'

Action parameters

• renode-revision - indicates the Renode version to be built. Can be the name of a branch or tag in the repository or a commit hash. The default is Renode's master branch.
• renode-repository - indicates the repository containing the Renode source to build. The default is the official Renode repository (https://github.com/renode/renode).
• tests-to-run - path to the Robot files you want to execute.
• renode-arguments - optional, additional arguments passed to Renode. See Renode README for details. Default: no additional arguments.
• artifacts-path - optional, path where test artifacts should be stored. This includes Robot logs and HTML reports. Default: current directory.
• gather-execution-metrics - optional, whether to gather and visualize execution metrics. Default: no.

Using cache

This action caches Renode builds by default using the standard GitHub caching mechanism.