tox-envreport¶
tox-envreport
is a plugin for tox
to document the setup of used virtual environments.
By installing this plugin, 2 types of files are created automatically during each tox run:
.tox/py34/env-report.json
..tox
folder. E.g: .tox/tox-report.json
.Warning
This plugin is an early alpha version and under heavy development. The used structure inside export files may change in future.
A report contains the following information and more:
- System: host, platform,
- Virtual environment: name, path, tested package (incl. hashes)
- Python: executable, version, installed packages (incl. version)
- Executed commands : setup, test (all incl. output and return code)
Installation¶
pip install tox-envreport
Usage¶
The installation of the plugin is enough to automatically activate it for each tox run.
There is nothing more to do or to configure.
Access reports¶
tox-envreport
creates one common tox-report.json
file, which contains all information about all used virtual
environments (venv) by tox.
Beside this a venv specific file is generated as well and contains information about the related venv only.
You can find this file in the venv-specific tox-folder. E.g: MY_PROJECT/.tox/py27/env-report.json
for a venv called py27.
Motivation¶
tox-envreport
was created for an automotive project, which needs to archive beside test results also used
test environments.
The goal is to provide enough information to be able to setup an identical test environment in 20+ years.
tox-envreport
is part of a software bundle, which was designed to fulfill
the parameters of the ISO 26262 standard
for safety critical software in automotive companies.
Other tools are: sphinx-needs.