Registry / testing / colcon-test-result

colcon-test-result

JSON →
library0.3.8pypypiunverified

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.

pip install colcon-core colcon-test-result
INSTALL
IMPORT
SIG · COLCON-TEST-RESULT
C
colcon-test-result
testingpythonv0.3.8
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

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
colcon --version
Debug
Known issues
gotchaThe `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.
affects: All versions
gotchaConfusing `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.
affects: All versions
breakingMajor 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.
affects: Potentially across `colcon-core` major version bumps (e.g., 0.x to 1.x)
Errors
Common errors & fixes
colcon: error: unrecognized arguments: test-result
`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'
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`.
Upgrade
Version history
0.3.8latest on PyPI · released Oct 1, 2019
Audit
Dependencies
colcon-corerequiredThis is an extension for colcon, requiring the core colcon package to function.
Agent activity
8 hits · last 30 days
node
6
OpenAI (training)
2
Resources
colcon-test-result — pip install colcon-test-result · libregistry