ENH: Added coverage option for test command (#100)

* ENH: Added coverage option for `test` command

* Apply suggestions from code review and also print report to terminal

---------

Co-authored-by: Stefan van der Walt <[email protected]>

Author: ganesh-k13

spin/cmds/meson.py

@@ -165,8 +165,14 @@ def _get_configured_command(command_name):
 
 @click.command()
 @click.argument("pytest_args", nargs=-1)
+@click.option(
+    "-c",
+    "--coverage",
+    is_flag=True,
+    help="Generate a coverage report of executed tests. An HTML copy of the report is written to `build/coverage`.",
+)
 @click.pass_context
-def test(ctx, pytest_args):
+def test(ctx, pytest_args, coverage=False):
     """🔧 Run tests
 
     PYTEST_ARGS are passed through directly to pytest, e.g.:
@@ -236,6 +242,19 @@ def test(ctx, pytest_args):
             print("Stopping. Please investigate the build error.")
             sys.exit(1)
 
+    if coverage:
+        coverage_dir = os.path.join(os.getcwd(), "build/coverage/")
+        if os.path.isdir(coverage_dir):
+            print(f"Removing `{coverage_dir}`")
+            shutil.rmtree(coverage_dir)
+        os.makedirs(coverage_dir)
+        pytest_args = [
+            *pytest_args,
+            "--cov-report=term",
+            f"--cov-report=html:{coverage_dir}",
+            f"--cov={package}",
+        ]
+
     print(f'$ export PYTHONPATH="{site_path}"')
     _run(
         [sys.executable, "-m", "pytest", f"--rootdir={site_path}"] + list(pytest_args),