run-tests

KO | EN

gitlite — search

#javascript #python #ai #typescript #macos #nodejs #java #windows #cli #kubernetes #pytorch #mcp #openai #open-source

(★ 46)

Run MATLAB and Simulink tests and generate artifacts.

run-tests Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Action for Running MATLAB Tests

The [Run MATLAB Tests](#run-matlab-tests) action enables you to run MATLAB&reg; and Simulink&reg; tests and generate test and coverage artifacts on a [GitHub&reg;-hosted](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners) or [self-hosted](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners) runner:

- To use a GitHub-hosted runner, include the [Setup MATLAB](https://github.com/matlab-actions/setup-matlab/) action in your workflow to set up your preferred MATLAB release (R2021a or later) on the runner.
- To use a self-hosted runner, set up a computer with MATLAB on its path and register the runner with GitHub Actions. (On self-hosted UNIX&reg; runners, you can also use the **Setup MATLAB** action instead of having MATLAB already installed.) The runner uses the topmost MATLAB release on the system path to execute your workflow.

## Examples

Use the **Run MATLAB Tests** action to automatically run tests authored using the MATLAB unit testing framework or Simulink Test&trade;. To use the action, you need MATLAB R2013b or a later release. Some of the optional action inputs require newer MATLAB releases or additional toolboxes.

### Run Tests in MATLAB Project

On a self-hosted runner that has MATLAB installed, run the tests in your [MATLAB project](https://www.mathworks.com/help/matlab/projects.html). To run the tests, specify the **Run MATLAB Tests** action in your workflow.

```yaml
name: Run Tests in MATLAB Project
on: [push]
jobs:
    my-job:
        name: Run MATLAB Tests
        runs-on: self-hosted
        steps:
            - name: Check out repository
              uses: actions/checkout@v6
            - name: Run tests
              uses: matlab-actions/run-tests@v3
```

### Generate Test and Coverage Artifacts

Using the latest release of MATLAB on a GitHub-hosted runner, run the tests in your MATLAB project and generate test results in JUnit-style XML format and code coverage results in Cobertura XML format. To set up the latest release of MATLAB on the runner, specify the [Setup MATLAB](https://github.com/matlab-actions/setup-matlab/) action in your workflow. To run the tests and generate the artifacts, specify the **Run MATLAB Tests** action.

```yaml
name: Generate Test and Coverage Artifacts
on: [push]
jobs:
    my-job:
        name: Run MATLAB Tests
        runs-on: ubuntu-latest
        steps:
            - name: Check out repository
              uses: actions/checkout@v6
            - name: Set up MATLAB
              uses: matlab-actions/setup-matlab@v3
            - name: Run tests
              uses: matlab-actions/run-tests@v3
              with:
                  test-results-junit: test-results/results.xml
                  code-coverage-cobertura: code-coverage/coverage.xml
```

### Run Tests in Parallel

Run your MATLAB and Simulink tests in parallel (requires Parallel Computing Toolbox&trade;) using the latest release of the required products on a GitHub-hosted runner. To set up the latest release of MATLAB, Simulink, Simulink Test, and Parallel Computing Toolbox on the runner, specify the [Setup MATLAB](https://github.com/matlab-actions/setup-matlab/) action with its `products` input in your workflow. To run the tests in parallel, specify the **Run MATLAB Tests** action with its `use-parallel` input specified as `true`.

```YAML
name: Run Tests in Parallel
on: [push]
jobs:
  my-job:
    name: Run MATLAB and Simulink Tests
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository
        uses: actions/checkout@v6
      - name: Set up products
        uses: matlab-actions/setup-matlab@v3
        with:
          products: >
            Simulink
            Simulink_Test
            Parallel_Computing_Toolbox
      - name: Run tests
        uses: matlab-actions/run-tests@v3
        with:
          use-parallel: true
```

### Use MATLAB Batch Licensing Token

When you define a workflow using the [Setup MATLAB](https://github.com/matlab-actions/setup-matlab/) action, you need a [MATLAB batch licensing token](https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/main/alternates/non-interactive/MATLAB-BATCH.md#matlab-batch-licensing-token) if your project is private or if your workflow uses transformation products, such as MATLAB Coder&trade; and MATLAB Compiler&trade;. Batch licensing tokens are strings that enable MATLAB to start in noninteractive environments. You can request a token by submitting the [MATLAB Batch Licensing Pilot](https://www.mathworks.com/support/batch-tokens.html) form.

To use a MATLAB batch licensing token:

1. Set the token as a secret. For more information about secrets, see [Using secrets in GitHub Actions](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions).
2. Map the secret to an environment variable named `MLM_LICENSE_TOKEN` in your workflow.

For example, use the latest release of MATLAB on a GitHub-hosted runner to run the tests in your private project. To set up the latest release of MATLAB on the runner, specify the **Setup MATLAB** action in your workflow. To run the tests, specify the **Run MATLAB Tests** action. In this example, `MyToken` is the name of the secret that holds the batch licensing token.

```YAML
name: Use MATLAB Batch Licensing Token
on: [push]
env:
  MLM_LICENSE_TOKEN: ${{ secrets.MyToken }}
jobs:
  my-job:
    name: Run MATLAB Tests in Private Project
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository
        uses: actions/checkout@v6
      - name: Set up MATLAB
        uses: matlab-actions/setup-matlab@v3
      - name: Run tests
        uses: matlab-actions/run-tests@v3
```

## Run MATLAB Tests

When you define your workflow in the `.github/workflows` directory of your repository, specify the **Run MATLAB Tests** action as `matlab-actions/run-tests@v3`.

By default, the action includes any files in your project that have a `Test` label. If your workflow does not use a MATLAB project, or if it uses a MATLAB release before R2019a, then the action includes all tests in the root of your repository and in any of its subfolders. The action fails if any of the included tests fail.

The **Run MATLAB Tests** action accepts optional inputs. For example, you can add folders to the MATLAB search path, control which tests to run, and generate various artifacts.

| Input | Description |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `source-folder` | (Optional) Location of the folder containing source code, specified as a path relative to the project root folder. The specified folder and its subfolders are added to the top of the MATLAB search path. If you specify `source-folder` and then generate a coverage report, the action uses only the source code in the specified folder and its subfolders to generate the report. You can specify multiple folders using a colon-separated or semicolon-separated list.**Example:** `source-folder: source` **Example:** `source-folder: source/folderA; source/folderB` |
| `select-by-folder` | (Optional) Location of the folder used to select test suite elements, specified as a path relative to the project root folder. To create a test suite, the action uses only the tests in the specified folder and its subfolders. You can specify multiple folders using a colon-separated or semicolon-separated list.**Example:** `select-by-folder: test` **Example:** `select-by-folder: test/folderA; test/folderB` |
| `select-by-tag` | (Optional) Test tag used to select test suite elements. To create a test suite, the action uses only the test elements with the specified tag.**Example:** `select-by-tag: Unit` |
| `strict` | (Optional) Option to apply strict checks when running tests, specified as `false` or `true`. By default, the value is `false`. If you specify a value of `true`, the action generates a qualification failure whenever a test issues a warning.**Example:** `strict: true` |
| `use-parallel` | (Optional) Option to run tests in parallel, specified as `false` or `true`. By default, the value is `false` and tests run in serial. If the test runner configuration is suited for parallelization, you can specify a value of `true` to run tests in parallel. This input requires a Parallel Computing Toolbox license.**Example:** `use-parallel: true` |
| `output-detail` | (Optional) Amount of event detail displayed for the test run, specified as `none`, `terse`, `concise`, `detailed`, or `verbose`. By default, the action displays failing and logged events at the `detailed` level and test run progress at the `concise` level.**Example:** `output-detail: verbose` |
| `logging-level` | (Optional) Maximum verbosity level for logged diagnostics included for the test run, specified as `none`, `terse`, `concise`, `detailed`, or `verbose`. By default, the action includes diagnostics logged at the `terse` level.**Example:** `logging-level: detailed` |
| `test-results-html` | (Optional) Location to write the test results in HTML format, specified as a folder path relative to the project root folder.**Example:** `test-results-html: test-results` |
| `test-results-pdf` | (Optional) Location to write the test results in PDF format, specified as a file path relative to the project root folder. On macOS platforms, this input is supported in MATLAB R2020b and later.**Example:** `test-results-pdf: test-results/results.pdf` |
| `test-results-junit` | (Optional) Location to write the test results in JUnit-style XML format, specified as a file path relative to the project root folder.**Example:** `test-results-junit: test-results/results.xml` |
| `test-results-simulink-test` | (Optional) Location to export Simulink Test Manager results in MLDATX format, specified as a file path relative to the project root folder. This input requires a Simulink Test license and is supported in MATLAB R2019a and later.**Example:** `test-results-simulink-test: test-results/results.mldatx` |
| `code-coverage-html` | (Optional) Location to write the code coverage results in HTML format, specified as a folder path relative to the project root folder. The results include statement and function coverage metrics. **Example:** `code-coverage-html: code-coverage` |
| `code-coverage-cobertura` | (Optional) Location to write the code coverage results in Cobertura XML format, specified as a file path relative to the project root folder.**Example:** `code-coverage-cobertura: code-coverage/coverage.xml` |
| `code-coverage-metric-level` | (Optional) Level of code coverage metrics to include in the GitHub job summary, specified as `statement`, `decision`, `condition`, or `mcdc`. By default, the action uses the highest level (`mcdc`) when generating the coverage summary, which results in a table that includes the function, statement, decision, condition, and modified condition/decision coverage (MC/DC) metrics. Use this input to include metrics up to and including a specific level, instead of the highest possible level. For example, to include only function and statement coverage metrics, specify `code-coverage-metric-level` as `statement`. For more information about coverage metric levels, see [Types of Code Coverage for MATLAB Source Code](https://www.mathworks.com/help/matlab-test/ug/types-of-code-coverage-for-matlab-source-code.html).For the action to include coverage metrics in the GitHub job summary, the following requirements must be met:<ul><li>MATLAB Test&trade; must be installed and licensed on the runner.</li><li>You must not specify the `code-coverage-html` or `code-coverage-cobertura` inputs. If you specify either input, the action writes the code coverage results to the specified location but does not include coverage metrics in the GitHub job summary.</li></ul>**Example:** `code-coverage-metric-level: statement` |
| `model-coverage-html` | (Optional) Location to write the model coverage results in HTML format, specified as a folder path relative to the project root folder. This input requires a Simulink Coverage&trade; license and is supported in MATLAB R2018b and later.**Example:** `model-coverage-html: model-coverage` |
| `model-coverage-cobertura` | (Optional) Location to write the model coverage results in Cobertura XML format, specified as a file path relative to the project root folder. This input requires a Simulink Coverage license and is supported in MATLAB R2018b and later.**Example:** `model-coverage-cobertura: model-coverage/coverage.xml` |
| `generate-summary` | (Optional) Option to generate summaries of test and coverage results in the GitHub job summary, specified as `true` or `false`. By default, the value is `true`. If you specify a value of `false`, the action does not generate test and coverage summaries in the GitHub job summary. Generating test and coverage summaries requires a MATLAB Test license.For more information about test and coverage summaries, see [View Test and Coverage Results](#view-test-and-coverage-results).**Example:** `generate-summary: false` |
| `startup-options` | (Optional) MATLAB startup options, specified as a list of options separated by spaces. For more information about startup options, see [Commonly Used Startup Options](https://www.mathworks.com/help/matlab/matlab_env/commonly-used-startup-options.html).Using this input to specify the `-batch` or `-r` option is not supported.**Example:** `startup-options: -nojvm` **Example:** `startup-options: -nojvm -logfile output.log` |

## View Test and Coverage Results

If you have a MATLAB Test license and the `generate-summary` input is `true`, you can view test results and code coverage metrics for your source code in the GitHub job summary.

### Test Results Summary

If you have a MATLAB Test license, after your workflow runs, the GitHub job summary displays the number of tests in the test suite, as well as the number of tests that passed, failed, were incomplete (due to assumption failure), and did not run (due to fatal assertion failure). Additionally, the **All tests** table in the summary includes a row for each executed test file. Each table row displays the status of a test file, its name, and the time it took to run. You can hover over a filename in the table to see the file path within your project.

You can interact with the **All tests** table using the expanders to the left of test filenames and diagnostics. In an expanded table row, individual test results from the corresponding test file appear in a table under the test filename. Each row of the inner table shows the status, procedure name, diagnostics, and duration of a test in the file.

> [!TIP]
> With a MATLAB Test license, you also see your MATLAB and Simulink test results in the GitHub job summary when you take any of these actions:
>
> - Run tests with a [`matlab.buildtool.tasks.TestTask`](https://www.mathworks.com/help/matlab/ref/matlab.buildtool.tasks.testtask-class.html) instance using the [Run MATLAB Build](https://github.com/matlab-actions/run-build/) or [Run MATLAB Command](https://github.com/matlab-actions/run-command/) action.
> - Run tests with a default test runner using the [Run MATLAB Command](https://github.com/matlab-actions/run-command/) action. You can create a default test runner using the [`matlab.unittest.TestRunner.withDefaultPlugins`](https://www.mathworks.com/help/matlab/ref/matlab.unittest.testrunner.withdefaultplugins.html) method.

### Code Coverage Summary

The **MATLAB Code Coverage** table in the GitHub job summary displays the collected code coverage metrics for the MATLAB source code specified by the `source-folder` input of the **Run MATLAB Tests** action. For the action to generate this table, the following requirements must be met:

- MATLAB Test must be installed and licensed on the runner.
- You must not specify the `code-coverage-html` or `code-coverage-cobertura` action inputs.

By default, the table includes the function, statement, decision, condition, and modified condition/decision coverage (MC/DC) metrics. To limit the level of coverage metrics displayed, use the `code-coverage-metric-level` action input.

## Notes

- By default, when you use the **Run MATLAB Tests** action, the root of your repository serves as the MATLAB startup folder. To run your tests using a different folder, specify the `-sd` startup option in the action.
- In MATLAB R2019a and later, the **Run MATLAB Tests** action uses the `-batch` option to start MATLAB noninteractively. MATLAB settings do not persist across different MATLAB sessions launched with the `-batch` option. To run code that requires the same settings, use a single action.
- When you use the **Run MATLAB Tests** action, you execute third-party code that is licensed under separate terms.

## See Also

- [Action for Running MATLAB Builds](https://github.com/matlab-actions/run-build/)
- [Action for Running MATLAB Commands](https://github.com/matlab-actions/run-command/)
- [Action for Setting Up MATLAB](https://github.com/matlab-actions/setup-matlab/)
- [Continuous Integration with MATLAB and Simulink](https://www.mathworks.com/solutions/continuous-integration.html)

## Feedback and Support

If you encounter a product licensing issue, consider requesting a MATLAB batch licensing token to use in your workflow. For more information, see [Use MATLAB Batch Licensing Token](#use-matlab-batch-licensing-token).

If you have an enhancement request or other feedback about this action, create an issue on the [Issues](https://github.com/matlab-actions/run-tests/issues) page.

For support, contact [MathWorks Technical Support](https://www.mathworks.com/support/contact_us.html).

run-tests

run-tests Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

run-tests

run-tests Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README