colcon-test-result

0.3.8 · active · verified Fri Apr 17

colcon-test-result is an extension for the `colcon` build tool that provides commands to display and analyze test results generated by `colcon test`. It simplifies checking test outcomes without diving into raw XML files. The current version is 0.3.8, and it sees several releases per year, often in sync with ROS 2 development cycles.

Common errors

```
colcon: error: unrecognized arguments: test-result
```
cause `colcon-test-result` extension is not installed or not discoverable by your `colcon` installation.

fix Run `pip install colcon-test-result` to install the extension. Ensure your Python environment (and thus `colcon`) can find the installed package.
```
No test results found in 'install/test_results' for test-result type 'all'
```
cause The `colcon` workspace does not contain any generated test result XML files, likely because `colcon test` was not run, failed, or was run in a different directory.

fix First, navigate to your `colcon` workspace root. Then, run `colcon test` to execute tests and generate results. After tests complete, retry `colcon test-result --all`.

Warnings

gotcha The `colcon test-result` command will report 'No test results found' if `colcon test` has not been run previously in the workspace, or if the tests failed to produce valid XML result files in the expected location (typically `install/test_results`).
Fix: Ensure `colcon test` completes successfully before attempting to view results. Check the build log for test failures or output issues. Use `colcon test --event-handlers console_direct+` for more direct test output.
gotcha Confusing `colcon test-result` (the command) with the `--test-result-level` argument of `colcon test`. The argument modifies the verbosity of test summary *during* the `test` phase, while the command provides a post-run summary and analysis.
Fix: Use `colcon test ... --test-result-level {none, package, aborted, failed, summary}` for inline reporting, and `colcon test-result ...` for comprehensive post-run analysis.
breaking Major version updates of `colcon-core` can sometimes introduce changes that might require updates to extensions like `colcon-test-result` for full compatibility or to address internal API shifts.
Fix: Always install compatible versions. If encountering issues after a `colcon-core` upgrade, check the release notes for both `colcon-core` and `colcon-test-result` for known compatibility issues or required version ranges. Upgrade `colcon-test-result` to the latest version that supports your `colcon-core` version.

Install

pip install colcon-core colcon-test-result Install core colcon and test result extension

Quickstart

This quickstart demonstrates how to install the `colcon-test-result` extension along with `colcon-core` and verify its availability by invoking its help command. To use its full functionality, you would typically first run `colcon test` in a workspace to generate test results, and then use `colcon test-result` to view them (e.g., `colcon test-result --verbose --all`).

pip install colcon-core colcon-test-result
colcon test-result --help

view raw JSON →