Tool to generate SQA reports for INDIGO-DataCloud products.
The script collects data from YAMLs (statically gathered) and service APIs (dynamic retrieval) of tools used in the project. This data is then used to create the PDF reports using a TEX template.
Each product has its corresponding YAML file, stored in the specs directory.
There is an additional data directory, where extended information that will appear in the reports is stored. An example of this is the code style standards.
The main script generate_reports.py has different options, see --help option for displaying them. Three arguments are needed: 1) the template file 2) the specs directory 3) report period range, e.g:
python generate_reports.py templates/report.tex specs/ "20-24 Jun 2016" --output-dir=/srv/sqa-reports/build
Note: The second argument (spec directory) can be also a file, useful while debugging. For instance:
python generate_reports.py templates/report.tex specs/opie.yaml "20-24 Jun 2016" --output-dir=/srv/sqa-reports/build
A Dockerfile has been provided to facilitate the setup of the adequate environment for the report generation.
docker pull indigodatacloud/sqa-reports
docker run -it indigodatacloud/sqa-reports bash
(container)$ python generate_reports.py templates/report.tex specs/ "20-24 Jun 2016" --output-dir=/srv/sqa-reports/build
TEX and PDF reports should be available in /srv/sqa-reports/build.
Note that in this case additional development libraries need to be available in the OS before installing the requirements.txt
virtualenv .venv
source .venv/bin/activate
pip install -r requirements.txt
python generate_reports.py templates/report.tex specs/ "20-24 Jun 2016" --output-dir=/srv/sqa-reports/build
TEX and PDF reports should be available in /srv/sqa-reports/build. add one more line add one more line line line line