Skip to main content

Tool for generating test documentation

Project description


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


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 

├── TC.XX.01
│   ├──
│   ├── required_equiptment.json
│   ├── requirements_fully_tested.json
│   ├── requirements_partially_tested.json
│   ├──
│   └── test_name.txt
└── TC.XX.02
    └── __test__.json (Abbreviated form allowing the direct instanciation of
                       keys in one file. Will be overwritten if the file also

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

k3testdocumentation-generate-coverage requirements_list.json example_test_dir/ -v -o output.pdf

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

k3testdocumentation-generator-0.2.2.tar.gz (7.3 kB view hashes)

Uploaded Source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page