From db195e8e8b6f61989b625fffd6df7c8f809927b0 Mon Sep 17 00:00:00 2001
From: Paul Goins <paul.goins@canonical.com>
Date: Fri, 1 Mar 2019 12:16:56 +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: I8e37015ffccaef6b30090eec8e1fa3837c1eabe0
---
 .coveragerc |  7 -------
 .zuul.yaml  |  1 +
 tox.ini     | 28 ++++++++++++++++++++++++++++
 3 files changed, 29 insertions(+), 7 deletions(-)
 delete mode 100644 .coveragerc

diff --git a/.coveragerc b/.coveragerc
deleted file mode 100644
index 691f0ec4..00000000
--- a/.coveragerc
+++ /dev/null
@@ -1,7 +0,0 @@
-[report]
-# Regexes for lines to exclude from consideration
-exclude_lines =
-    if __name__ == .__main__.:
-    except UnregisteredHookError as e:
-include=
-    hooks/neutron_*
diff --git a/.zuul.yaml b/.zuul.yaml
index 7051aeeb..dc276615 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 2646a2e7..74f2c010 100644
--- a/tox.ini
+++ b/tox.ini
@@ -39,6 +39,34 @@ deps = -r{toxinidir}/requirements.txt
 commands = flake8 {posargs} hooks unit_tests tests actions lib
            charm-proof
 
+[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}