Tooling for converting coverage data into a SQL DB
Go to file
Masayuki Igawa 1f3763636b
Add PDF documentation build
This commit adds PDF documentation build target 'pdf-docs' that will
build PDF versions of our docs. And this commit also updates 'docs'
target to use sphinx-build command as well as 'pdf-docs' target.

This is one of the Train community goals:

Change-Id: Iae6bc9ae92fe61385c424923eaad35dc449880e9
Story: #2006070
Task: #35455
2019-10-02 18:48:31 +09:00
coverage2sql Add metadata column to coverage table 2019-04-18 16:17:36 +09:00
doc Add PDF documentation build 2019-10-02 18:48:31 +09:00
etc Remove unused config entries from sample config 2019-04-17 15:47:06 +09:00
releasenotes Remove setting of version/release from releasenotes 2017-11-16 22:08:23 +01:00
tools Prepare for using standard python tests 2017-02-02 12:11:19 +00:00
.coveragerc Omit unit test files from coverage 2016-11-11 19:40:27 +09:00
.gitignore Ignore *.db file from git repo 2019-04-17 15:40:38 +09:00
.gitreview OpenDev Migration Patch 2019-04-19 19:36:21 +00:00
.mailmap Initial Cookiecutter Commit. 2016-04-19 12:24:29 +09:00
.stestr.conf Switch to use stestr instead of os-testr 2017-12-16 17:45:42 +09:00
.zuul.yaml Add Python 3 Train unit tests 2019-07-17 05:08:43 +00:00
CONTRIBUTING.rst replace http with https 2018-09-12 16:37:00 -06:00
HACKING.rst Update url in HACKING.rst 2018-09-12 16:49:35 -06:00
LICENSE Initial Cookiecutter Commit. 2016-04-19 12:24:29 +09:00 Add unit tests and remove oslo_db 2016-11-11 11:33:43 +09:00
README.rst Use opendev repository 2019-04-23 17:16:38 +08:00
babel.cfg Initial Cookiecutter Commit. 2016-04-19 12:24:29 +09:00
bindep.txt Fix gate error "mysqladmin: command not found" 2019-07-17 04:34:45 +00:00
requirements.txt Update requirements 2017-04-27 16:53:43 +09:00
setup.cfg Update envlist and classifier 2019-04-22 16:54:11 +09:00 Update requirements 2017-04-27 16:53:43 +09:00
test-requirements.txt Separate requirements for documents tox job 2019-06-03 19:01:50 +09:00
tox.ini Add PDF documentation build 2019-10-02 18:48:31 +09:00


Team and repository tags


coverage2sql README

Command to Read a coverage file and put the data in a SQL database

coverage2sql is a tool for storing data of test coverage into a SQL database. With using this tool, you can store time series coverage data and analyze it if your coverage rate is down.


DB Setup

The usage of coverage2sql is split into 2 stages. First you need to prepare a database with the proper schema; coverage2sql-db-manage should be used to do this. The utility requires db connection info which can be specified with a config file. Obviously the sql connector type, user, password, address, and database name should be specific to your environment. coverage2sql-db-manage will use alembic to setup the db schema. You can run the db migrations with a config file:

coverage2sql-db-manage --config-file etc/coverage2sql.conf upgrade head

This will bring the DB schema up to the latest version for coverage2sql.


Once you have a database setup with the proper database schema you can then use the coverage2sql command to populate the database with data from your test coverage file. coverage2sql takes in a .coverage file through by passing it file paths as positional arguments to the script at this moment.

For example:

coverage2sql --config-file etc/coverage2sql.conf coverage2sql .coverage

There are several options for running coverage2sql, they can be listed with:

coverage2sql --help

The only required option is --database-connection. The options can either be used on the CLI, or put in a config file. If a config file is used you need to specify the location on the CLI.


To see the TODO, go to the launchpad site:


To see the release notes go here: