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:
When generating PDFs from HTML wkhtmltopdf needs to be installed (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.
When generating PDFs from LATEX pdflatex needs to be installed. It is also available in the package managers of the common linux distributions.
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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | da99978045b47f7b714a73f9684663ffe71240db10bf411408168a5461da10e4 |
|
MD5 | 895645f53eb84f11cff62a647bc12fc5 |
|
BLAKE2b-256 | e7067a9fda0617b0e22a9a342490d8123eb9edad90da3030c26ec7ffe82188f4 |
Hashes for k3testdocumentation_generator-0.2.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0b7fa2c087f59a9575531f5eee6a57ef41c44da03748968f2ad82d8420c06c8 |
|
MD5 | 0f0ea084f9d64642dc2c176ae73e3720 |
|
BLAKE2b-256 | 8f8746a5ae659b20a3eefb3fde64c27391b1b9ce6f344fb82f137f47badd353a |