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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f02344c2fe0f685c54d718daa097a723e8b609aad6c81bcdfa9cc6c95322890 |
|
MD5 | b1a329ffd8c9adebd44a8d7617860be5 |
|
BLAKE2b-256 | a97d2dae936f7127156f0f4eae14b4346337494de9b7ed9703e5025766048523 |
Hashes for k3testdocumentation_generator-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e902ca909f8d31e8b88b2a3f1a6e938614caeb22111377cdb0856c8d9e8867ad |
|
MD5 | 2f0ca6485e6e4e492049d5543af93896 |
|
BLAKE2b-256 | c55605c1163b3e1a8a4700303571c7585ac817b33a52416ec590f365615c39d6 |