MODIFIED for generating an RVM instead with doorstop for requirements.
Version 1.1.1 of rtm_doorstop used as a base.
Refer to the CHANGELOG.md for a list of adjustments / features added to the base rtm_doorstop version used.
Command Adjustments are located within the CHANGELOG.md as well and should be used over what is listed below in the base version of rtm_doorstop. Both --prefix and --path callouts are needed in the command statements.
Same README.md from rtm_doorstop.
A tool to generate Requirement Traceability Matrices (RTMs) from Doorstop documents.
The rtm_doorstop tool can be used to quickly build an Requirements Traceability Matrix (RTM) from a Doorstop tree. RTMs map product requirements to test cases, which verify that said requirements are met. They are particularly useful to quickly understand the requirement coverage and any areas deficient in quality checks.
This tool can generate RTMs that are in Markdown-compliant format, or write to a CSV file.
| UID | Header | Text | Has Test | Need Test | Tests |
|---------|--------|---------------------|----------|-----------|-------------------------|
| REQ0001 | Ch 1 | Requirement A | True | True | TST0001 |
| REQ0002 | Ch 1.1 | Just a note | False | False | |
| REQ0003 | Ch 1.2 | Another requirement | True | True | TST0003 TST0004 TST0005 |UID,Header,Text,Has Test,Need Test,Tests
REQ0001,Ch 1,Requirement A,True,True,TST0001
REQ0002,Ch1.1,Just a note,False,False,
REQ0003,Ch 1.2,Another requirement,True,True,TST0003 TST0004 TST0005
The tool can be invoked via command line, and has one required argument: PREFIX
rtm_doorstop --prefix=PREFIXor simply
rtm_doorstop PREFIXOptional arguments are --root, --sort_key, and --csv_path.
| Argument | Description |
|---|---|
| root | If Doorstop cannot build a valid tree from the current working directory, you can specify the path to the tree root here |
| sort_key | If the RTM should be sorted, you can specify the key to sort by here. Valid options are 'UID', 'Has Test', or 'Tests' When omitted, no ordering is guaranteed. |
| csv_path | The filepath where the tool should save the RTM to. When omitted, the RTM is printed to console in Markdown format. |
Tests are assumed to be linked to the requirements as as child links. Doorstop specifies these links in the "links" yaml key. For instance, the following test would be linked to requirement REQ046.
active: true
custom: 1
derived: false
header: ''
level: 4
links:
- REQ046: m9tMd0JM8O8idHTViqyYy1OL3dLiVY69bT63jNAGxPs=
normative: true
ref: test_yaml_encoding
reviewed: TIwopA6cvyjBMF17bB6p_RUNA7clNMaaEhXGYlAdpdk=
test_commit_last_passed: d670460b4b4aece5915caf5c68d12f560a9fe3e4
test_commit_latest: d670460b4b4aece5915caf5c68d12f560a9fe3e4
test_result_latest: passed
text: |
Test that inputs can be loaded from a UTF-8 encoded YAML file.You can install "rtm_doorstop" via pip from PyPI:
pip install rtm_doorstopContributions are very welcome, both in Issues and in Pull Requests. Tests can be run with tox.
$ toxIf you encounter any problems, please file an issue along with a detailed description.
Distributed under the terms of the GNU GPL v3.0 license, "rtm_doorstop" is free and open source software