fix(coverage): missing files in the coverage report if they have no tests

BurnzZ · BurnzZ · commit 9c738e20ad57 · 2025-02-14T14:34:01.000+11:00
This ensures that un-executed files (i.e. files that aren't tested) are included in the coverage report. The current behavior is that coverage.py excludes them by default. See https://coverage.readthedocs.io/en/7.6.10/source.html#execution
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -84,6 +84,7 @@ Unreleased changes template.
   {obj}`--venvs_use_declare_symlink=no` to have it not create symlinks at
   build time (they will be created at runtime instead).
   (Fixes [#2489](https://github.com/bazelbuild/rules_python/issues/2489))
+* (coverage) Fix missing files in the coverage report if they have no tests.
 
 {#v0-0-0-added}
 ### Added
diff --git a/python/private/python_bootstrap_template.txt b/python/private/python_bootstrap_template.txt
@@ -433,6 +433,14 @@ def _RunForCoverage(python_program, main_filename, args, env,
 relative_files = True
 ''')
   PrintVerboseCoverage('Coverage entrypoint:', coverage_entrypoint)
+
+  instrumented_files = [abs_path for abs_path, _ in InstrumentedFilePaths()]
+  unique_dirs = {os.path.dirname(file) for file in instrumented_files}
+  source = ",".join(unique_dirs)
+
+  PrintVerboseCoverage("[coveragepy] Instrumented Files:\n" + "\n".join(instrumented_files))
+  PrintVerboseCoverage("[coveragepy] Sources:\n" + "\n".join(unique_dirs))
+
   # First run the target Python file via coveragepy to create a .coverage
   # database file, from which we can later export lcov.
   ret_code = subprocess.call(
@@ -443,6 +451,7 @@ relative_files = True
       "--rcfile=" + rcfile_name,
       "--append",
       "--branch",
+      "--source=" + source,
       main_filename
     ] + args,
     env=env,
diff --git a/python/private/stage2_bootstrap_template.py b/python/private/stage2_bootstrap_template.py
@@ -293,6 +293,14 @@ def _maybe_collect_coverage(enable):
 relative_files = True
 """
         )
+
+    instrumented_files = [abs_path for abs_path, _ in instrumented_file_paths()]
+    unique_dirs = {os.path.dirname(file) for file in instrumented_files}
+    source = ",".join(unique_dirs)
+
+    print_verbose_coverage("[coveragepy] Instrumented Files:\n" + "\n".join(instrumented_files))
+    print_verbose_coverage("[coveragepy] Sources:\n" + "\n".join(unique_dirs))
+
     try:
         cov = coverage.Coverage(
             config_file=rcfile_name,
@@ -314,6 +322,7 @@ def _maybe_collect_coverage(enable):
                 # see https://github.com/nedbat/coveragepy/blob/bfb0c708fdd8182b2a9f0fc403596693ef65e475/coverage/inorout.py#L153-L164
                 "*/external/*",
             ],
+            source=source,
         )
         cov.start()
         try:
