Tool for generating test documentation
Project description
k3testdocumentation-generator
Tool for generating test documentation & test coverage out of a file/folder hierarchy (or an equivalent json file). A default file/folder hierarchy is defined below with which the tool will work without customisations/custom templates.
Tool for generationg the Documentation: k3testdocumentation-generator
Tool for generationg the Coverage: k3testdocumentation-generate-coverage
Installation (use within viruatlenv or equivalent)
pip install k3testdocumentation-generator
Prerequisites/Limitations:
wkhtmltopdf needs to be installed when generating PDFs (required by the pdfkit library). It is available in the package managers of the common linux distributions.
May require running a virtual X server on a headless environment.
Default File/Folder Hierarchy
Create a the test directory structure (example included in src).
This structure works with the inbuilt template. To support a different
structure create a custom template and pass it using the --template parameter.
Note: any json file will be opened and interpreted. In the default structure
all json files need contain a list of strings
example_test_dir/
├── TC.XX.01
│ ├── precondition.md
│ ├── required_equiptment.json
│ ├── requirements_fully_tested.json
│ ├── requirements_partially_tested.json
│ ├── test_description.md
│ └── test_name.txt
└── TC.XX.02
├── test_descrition.md
└── __test__.json (Abbreviated form allowing the direct instanciation of
keys in one file. Will be overwritten if the file also
exists)
Corresponding k3testdocumentation-generator command:
k3testdocumentation-generator example_test_dir/ -v -o output.pdf
Corresponding k3testdocumentation-generate-coverage command:
and a required json file exists with requirements in the folling format
["R1","R2","P1","P2"]
k3testdocumentation-generate-coverage requirements_list.json example_test_dir/ -v -o output.pdf
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for k3testdocumentation-generator-0.2.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19b72c244223b46111ac716161f3adcb525db4d769444c47f6a9a93af1426ff9 |
|
MD5 | e5bf946513de73c954b1df70af331b49 |
|
BLAKE2b-256 | 5e581730127e7cad70d9db2a989c7c5198674e1b34f94b3cb167b3129d3ae970 |
Hashes for k3testdocumentation_generator-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dcb7d76ac5a49a02c3d526c2d303505578634751483c7d5615a8c4bd9e17c852 |
|
MD5 | d673ccadace235a0c57c5db6097e8014 |
|
BLAKE2b-256 | cec60605b63b5977237fb7c248a509be57cbb6eb8ff451ce4e3ca584b034ad29 |