This GitHub action sets OpenModelicaLibraryTesting scripts up and runs them on a provided Modelica package and returns a summary of the test report.

The action will set output variables that can be checked how many tests passed simulation and verification. It will fail if at least one test is failing.

Name of Modelica package to test.

Version of the Modelica package library as specified in version annotation.

library-version: '1.0'

Relative path (from git repository root) to Modelica file containing package to test.
Default: 'package.mo'

Version of OpenModelica used for testing. Add OpenModelica/setup-openmodelica to your workflow to setup OpenModelica.
Default: 'stable'

Relative path (from git repository root) to reference files to compare simulation results to.
Default: ''

File extension of result files.
Allowed values: 'mat', 'csv'
Default: 'mat'

Character to separate model names in reference files. E.g. for Modelica.Blocks.Examples.PID_Controller.mat it would be '.'
Default: '.'

jobs:
  library-testing:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Python 3
        uses: actions/setup-python@v5
        with:
          python-version: '3.10'

      - name: Setup OpenModelica
        uses: OpenModelica/setup-openmodelica@v1
        with:
          version: stable
          packages: |
            omc
          libraries: |
            Modelica 4.0.0
          omc-diff: true

      - uses: OpenModelica/[email protected]
        with:
          library: 'MyLibrary'
          library-version: '2.2.0'
          modelica-file: 'MyLibrary/package.mo'
          omc-version: 'stable'
          reference-files-dir: 'ReferenceFiles'
          reference-files-extension: 'mat'
          reference-files-delimiter: '.'
          pages-root-url: 'https://USERNAME.github.io/REPOSITORY/'

The action will fail if one test fails. In addition the following outputs can be used to determine the testing results.

'True' if all simulation tests are passing, 'False' otherwise.

Number of successful simulation tests.

'True' if all verification tests are passing, 'False' otherwise.

Number of successful verification tests.

Download the MyLibrary.html.zip artifact, unzip it and start a HTML server to display the results. This can be used to host results on a server or GitHub pages.

unzip MyLibrary.html.zip -d html
python3 -m http.server -d html

It's possible to deploy the test results to GitHub pages. On option

# [...]
jobs:
  library-testing:
    # [...]

  deploy:
    needs: library-testing
    permissions:
      contents: write
    if: ${{ always() }}
    concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession.
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Get HTML artifact
        uses: actions/download-artifact@v4
        with:
          path: html/
          pattern: '*.html'
          merge-multiple: true

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          folder: html/
          branch: gh-pages

For future test the SQlite data base sqlite3.db is achieved.

This action tests Modelica library MyLibrary consisting of two models from the Modelica Standard Library and compares them to reference results in examples/ReferenceFiles taken from https://github.com/modelica/MAP-LIB_ReferenceResults. The reference results for MyLibrary.Blocks.Examples.PID_Controller are altered to check that verification will fail for variables spring.w_rel, spring.phi_rel, inertia1.w and inertia1.phi.

The expected output is:

GitHub Actions Test summary

Summary

	Total	Frontend	Backend	SimCode	Templates	Compilation	Simulation	Verification
0	2	2	2	2	2	2	2	1

Results

	Model	Verified	Simulate	Total buildModel	Parsing	Frontend	Backend	SimCode	Templates	Compile
0	MyLibrary.Blocks.Examples.PID_Controller (sim)	0.06 (4/7 failed)	0.03	2.46	1.86	0.23	0.03	0.01	0.03	2.16
1	MyLibrary.Mechanics.MultiBody.Examples.Pendulum (sim)	0.01 (3 verified)	0.26	3.37	1.86	0.25	0.37	0.02	0.05	2.67

The HTML results can be hosted with GitHub Pages, for this example they can be found at OpenModelica.github.io/openmodelica-library-testing-action.

This action is licensed with the OSMC Public License v1.8, see OSMC-License.txt.

This package was initially developed by Hochschule Bielefeld - University of Applied Sciences and Arts as part of the Proper Hybrid Models for Smarter Vehicles (PHyMoS) project, supported by the German Federal Ministry for Economic Affairs and Climate Action with project number 19|200022G.