From b893eeba30f10d8fc0ca5252de420aa0c39daede Mon Sep 17 00:00:00 2001
From: Paul Goins <paul.goins@canonical.com>
Date: Fri, 1 Mar 2019 12:20:20 +0100
Subject: [PATCH] Added tox environment for gathering coverage

This technique was borrowed from the tox "cover" environment in
openstack/nova's tox.ini.  This leverages the fact that stestr lets
you override the python executable via the PYTHON environment
variable.  Doing this allows us to easily generate coverage for our
unit tests.

An important caveat is that this does not provide any coverage for
tests via zaza, amulet, etc.  It is purely focused on the unit tests.

Note that this replaces the previous .coveragerc; coverage
configuration is instead pulled from tox.ini.

Change-Id: I191b4f8a584e03b967e423a72657622c761f246a
---
 .zuul.yaml |  1 +
 tox.ini    | 28 ++++++++++++++++++++++++++++
 2 files changed, 29 insertions(+)

diff --git a/.zuul.yaml b/.zuul.yaml
index 7051aee..dc27661 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -1,3 +1,4 @@
 - project:
     templates:
       - python35-charm-jobs
+      - openstack-cover-jobs
diff --git a/tox.ini b/tox.ini
index 266fb54..a516f01 100644
--- a/tox.ini
+++ b/tox.ini
@@ -42,6 +42,34 @@ basepython = python3
 deps = -r{toxinidir}/test-requirements.txt
 commands = flake8 {posargs} src unit_tests
 
+[testenv:cover]
+# Technique based heavily upon
+# https://github.com/openstack/nova/blob/master/tox.ini
+basepython = python3
+deps = -r{toxinidir}/requirements.txt
+       -r{toxinidir}/test-requirements.txt
+setenv =
+    {[testenv]setenv}
+    PYTHON=coverage run
+commands =
+    coverage erase
+    ostestr {posargs}
+    coverage combine
+    coverage html -d cover
+    coverage xml -o cover/coverage.xml
+    coverage report
+
+[coverage:run]
+branch = True
+concurrency = multiprocessing
+parallel = True
+source =
+    .
+omit =
+    .tox/*
+    */charmhelpers/*
+    unit_tests/*
+
 [testenv:venv]
 basepython = python3
 commands = {posargs}