openstack
/
coverage2sql
Code Issues Proposed changes
Tooling for converting coverage data into a SQL DB
72 Commits 1 Branch 0 Tags 705 KiB
Python 95.7%
Shell 3.4%
Mako 0.9%
Go to file
Masayuki Igawa c8415e0849
Add usage to README.rst and usage document 
This commit adds an example usage to README.rst and usage document
for convenience.

Change-Id: Id1d6e58eea5f6f70568a1716f19add4d531f4ab1
 		2019-04-17 16:25:00 +09:00
coverage2sql Add files table 2017-03-08 18:39:32 +09:00
doc/source Add usage to README.rst and usage document 2019-04-17 16:25:00 +09:00
etc Add unit tests and remove oslo_db 2016-11-11 11:33:43 +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 Switch to use stestr instead of os-testr 2017-12-16 17:45:42 +09:00
.gitreview Initial Cookiecutter Commit. 2016-04-19 12:24:29 +09: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 Use openstack-tox-cover template 2018-09-09 06:07:27 +02: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
MANIFEST.in Add unit tests and remove oslo_db 2016-11-11 11:33:43 +09:00
README.rst Add usage to README.rst and usage document 2019-04-17 16:25:00 +09:00
babel.cfg Initial Cookiecutter Commit. 2016-04-19 12:24:29 +09:00
requirements.txt Update requirements 2017-04-27 16:53:43 +09:00
setup.cfg Merge "Removed older version of python3.4" 2019-03-27 07:17:40 +00:00
setup.py Update requirements 2017-04-27 16:53:43 +09:00
test-requirements.txt Switch to use stestr instead of os-testr 2017-12-16 17:45:42 +09:00
tox.ini fix tox python3 overrides 2019-01-11 06:10:34 +00:00

README.rst

Team and repository tags

image

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.

Usage

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.

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.

TODO

To see the TODO, go to the launchpad site:

ChangeLog

To see the release notes go here: https://docs.openstack.org/releasenotes/coverage2sql/