Adding code coverage reporting.

Author: chisou

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog
 
+* Added code coverage reporting to `test` target for _invoke_.
 * Updated `as_tuple` for  complex objects as well as the `as_tuples` parameter for `select`
   and `get_all` functions to work with strings or 2-tuples. The use of a dictionary
   was removed as dictionaries don't define an order.

requirements.txt

@@ -6,6 +6,7 @@ requests
 Deprecated
 pytest
 pytest-asyncio
+pytest-cov
 responses
 python-dotenv
 invoke

tasks.py

@@ -56,11 +56,14 @@ def lint(c, scope='all'):
     'scope': "Which tests to run, e.g. 'tests.model'"
              "Default: 'tests'",
     'python': ("Whether to run tests within a docker container and which"
-               "Python version to use - 3.7 or 3.11. Default: None")
+               "Python version to use - 3.7 or 3.11. Default: None"),
+    'coverage': "Whether to include coverage analysis.",
 })
-def test(c, scope='tests', python=None):
+def test(c, scope='tests', python=None, coverage=False):
     """Run test."""
 
+    cov_option = '--cov=c8y_api' if coverage else ''
+
     docker_name = None
     if python == '3.7':
         docker_name = 'buster37'
@@ -74,11 +77,14 @@ def test(c, scope='tests', python=None):
         cmd_run = (f'docker run --rm -it -v $(pwd):/code {docker_name} '
                    'bash -c "cd /code '
                    '&& export PYTHONPATH="/code:${PYTHONPATH}" '
-                   f'&& pytest -W ignore::DeprecationWarning {scope}"')
+                   f'&& pytest -W ignore::DeprecationWarning {cov_option} {scope}"')
         print(f"Executing '{cmd_run}' ...")
         c.run(cmd_run, pty=True)
     else:
-        c.run(f"pytest -W ignore::DeprecationWarning {scope}")
+        c.run(f"pytest -W ignore::DeprecationWarning {cov_option} {scope}")
+
+    if coverage:
+        c.run(f"coverage html -d coverage --data-file .coverage")
 
 
 @task