Usage
reqstool [-h] {command: report-asciidoc,generate-json,status} {location: local,git,maven} ...Use -h/--help for more information about each command and location.
Differences for the location argument
Using Reqstool with Maven or Git location expects that the package or path provided with the -p argument should point to a directory or an artifact that has the structure of the zip file generated by the Reqstool-Java-Maven-Plugin
Usage example
reqstool report-asciidoc git -u URL_TO_REPOSITORY.git -t ACCESS_TOKEN -p PATH_TO_DIR_WITH_ZIP_STRUCTURE -b BRANCH_NAMECommand: status
Status on implementations and tests of requirements.
Usage example
reqstool status local -p path_to_dirExample:
STATUS RESULT
URN |
Req id |
Implementation |
Automated Test |
Manual Test |
ms001 |
REQ_ms001_101 |
Implemented |
T2 P2 |
N/A |
ms001 |
REQ_ms001_102 |
Implemented |
N/A |
T1 F1 |
sys001 |
REQ_sys001_101 |
Missing |
T1 P1 |
N/A |
sys001 |
REQ_sys001_102 |
Missing |
N/A |
N/A |
sys001 |
REQ_sys001_103 |
Implemented |
T0 M1 |
N/A |
ext001 |
REQ_ext001_101 |
Implemented |
T3 P3 |
T1 P1 |
ext001 |
REQ_ext001_103 |
Missing |
N/A |
N/A |
ext002 |
REQ_ext002_101 |
Missing |
N/A |
N/A |
ext002 |
REQ_ext002_102 |
Missing |
N/A |
N/A |
ext002 |
REQ_ext002_103 |
Missing |
N/A |
N/A |
Total Requirements: 10 |
Implemented and Verified |
Implemented |
Not implemented |
2 (20.00%) |
2 (20.00%) |
6 (60.00%) |
Total Tests: 8 |
Total SVCs: 9 |
Passed tests |
Failed tests |
Skipped tests |
SVCs missing tests |
SVCs missing MVRs |
7 (87.50%) |
1 (12.50%) |
0 (60.00%) |
1 (11.11%) |
0 (0.00%) |
Command: report-asciidoc
Generates a report in AsciiDoc.
Default usage
reqstool report-asciidoc local -p path_to_requirements_dir -o path_to_output_file.adoc| The report-asciidoc command relies on PosixPath which could result in issues when running on Windows machines. If an error occurs, don’t hesitate to file a bug report! |
Command: generate-json
Same as report-asciidoc, but instead of generating an AsciiDoc report a complete raw JSON file is generated.
Default usage
reqstool report-asciidoc local -p path_to_requirements_dir -o path_to_output_file.jsonNote: There is currently no JSON Schema for this file and it is a raw dump of the data structures using [jsonpickle](https://github.com/jsonpickle/jsonpickle) the format might change at anytime for the time being.
Using the Docker image
You could also run Reqstool-client from a container, using the same commands as above. However, you will also need to mount the path to the indata and/or where the expected output file should be placed. Below is an example using the report-asciidoc command once you have either built the image yourself or pulled it from ghcr.
docker run --rm -v path_to_requirements_files_folder:/input -v path_to_output_folder:/output <containerId/tag> sh -c "reqstool report-asciidoc local -p ./test -o ./output/report_example.adoc"