Showcase JUnit XML <properties> for requirement traceability via sphinx-test-reports#63
Draft
Copilot wants to merge 2 commits into
Draft
Showcase JUnit XML <properties> for requirement traceability via sphinx-test-reports#63Copilot wants to merge 2 commits into
<properties> for requirement traceability via sphinx-test-reports#63Copilot wants to merge 2 commits into
Conversation
4 tasks
…-machine example - Add <properties> with verifies entries to coffee_machine_junit.xml, mapping each test case to its SWREQ IDs - Add tr_extra_options and tr_property_link_types to conf.py so sphinx-test-reports extracts the property and creates sphinx-needs links - Update cargo_test_to_junit.py with SPEC_TO_SWREQ mapping so future XML regeneration also emits <properties> elements Agent-Logs-Url: https://github.com/useblocks/sphinx-needs-demo/sessions/fae64db7-26cd-40e4-9ee9-e7e17e7e1554 Co-authored-by: arnoox <18502091+arnoox@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Showcase: Use sphinx-test-reports JUnit XML properties for requirement traceability
Showcase JUnit XML May 21, 2026
<properties> for requirement traceability via sphinx-test-reports
arnoox
reviewed
May 21, 2026
Contributor
There was a problem hiding this comment.
Can't we move the config into ubproject.toml?
Contributor
There was a problem hiding this comment.
Well, I was thinking we could demonstrate how to provide test run information from cargo, like: logs, execution time, ...
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Demonstrates the sphinx-test-reports feature that extracts JUnit XML
<properties>and maps them to sphinx-needs link fields, creating an automatic traceability chain from SWREQ → test spec → test-run result.Changes
docs/testsuites/coffee_machine_junit.xml— each test case now carries a<properties>block with averifiesproperty pointing to its SWREQ(s):docs/conf.py— two new sphinx-test-reports options wired into the existingSPHINX-TEST-REPORTSsection:These remain in
conf.py(notubproject.toml) because they are sphinx-test-reports Python variables with no TOML equivalent.scripts/cargo_test_to_junit.py— adds aSPEC_TO_SWREQmapping and emits<properties>during XML generation, so the traceability data survives futurecargo testregeneration runs.