feature: skip covered files in the report

Author: ideepu

README.md

@@ -51,6 +51,7 @@ Note: Either `GITHUB_PR_NUMBER` or `GITHUB_REF` is required. `GITHUB_PR_NUMBER`
 - `ANNOTATE_MISSING_LINES`: Whether to annotate missing lines in the coverage report. Default is False.
 - `ANNOTATION_TYPE`: The type of annotation to use for missing lines. 'notice' or 'warning' or 'error'. Default is 'warning'.
 - `MAX_FILES_IN_COMMENT`: The maximum number of files to include in the coverage report comment. Default is 25.
+- `SKIP_COVERED_FILES_IN_REPORT`: Skip the files with coverage 100% from the report. Default is True.
 - `COMPLETE_PROJECT_REPORT`: Whether to include the complete project coverage report in the comment. Default is False.
 - `COVERAGE_REPORT_URL`: URL of the full coverage report to mention in the comment.
 - `DEBUG`: Whether to enable debug mode. Default is False.

codecov/config.py

@@ -53,6 +53,7 @@ class Config:
     ANNOTATIONS_OUTPUT_PATH: pathlib.Path | None = None
     ANNOTATIONS_DATA_BRANCH: str | None = None
     MAX_FILES_IN_COMMENT: int = 25
+    SKIP_COVERED_FILES_IN_REPORT: bool = True
     COMPLETE_PROJECT_REPORT: bool = False
     COVERAGE_REPORT_URL: str | None = None
     # Only for debugging, not exposed in the action
@@ -87,6 +88,10 @@ def clean_branch_coverage(cls, value: str) -> bool:
     def clean_complete_project_report(cls, value: str) -> bool:
         return str_to_bool(value)
 
+    @classmethod
+    def clean_skip_covered_files_in_report(cls, value: str) -> bool:
+        return str_to_bool(value)
+
     @classmethod
     def clean_debug(cls, value: str) -> bool:
         return str_to_bool(value)

codecov/main.py

@@ -71,15 +71,16 @@ def _process_pr(self):
 
         log.info('Generating comment for PR #%s', self.github.pr_number)
         marker = template.get_marker(marker_id=self.config.SUBPROJECT_ID)
-        files_info, count_files, changed_files_info = template.select_changed_files(
+        files_info, count_files = template.select_changed_files(
             coverage=self.coverage,
             diff_coverage=self.diff_coverage,
             max_files=self.config.MAX_FILES_IN_COMMENT,
+            skip_covered_files_in_report=self.config.SKIP_COVERED_FILES_IN_REPORT,
         )
         coverage_files_info, count_coverage_files = template.select_files(
             coverage=self.coverage,
-            changed_files_info=changed_files_info,
             max_files=self.config.MAX_FILES_IN_COMMENT - count_files,  # Truncate the report to MAX_FILES_IN_COMMENT
+            skip_covered_files_in_report=self.config.SKIP_COVERED_FILES_IN_REPORT,
         )
         try:
             comment = template.get_comment_markdown(

codecov/template.py

@@ -142,11 +142,11 @@ def get_comment_markdown(  # pylint: disable=too-many-arguments,too-many-locals
 
 
 def select_changed_files(
-    *,
     coverage: Coverage,
     diff_coverage: DiffCoverage,
     max_files: int | None,
-) -> tuple[list[FileInfo], int, list[FileInfo]]:
+    skip_covered_files_in_report: bool,
+) -> tuple[list[FileInfo], int]:
     """
     Selects the MAX_FILES files with the most new missing lines sorted by path
     These are the files which have been modified in the PR
@@ -156,44 +156,42 @@ def select_changed_files(
     files = []
     for path, coverage_file in coverage.files.items():
         diff_coverage_file = diff_coverage.files.get(path)
+        if not (diff_coverage_file and diff_coverage_file.added_statements):
+            continue
+
+        if skip_covered_files_in_report and percentage_value(diff_coverage_file.percent_covered) == 100:
+            continue
 
         file_info = FileInfo(
             path=path,
             coverage=coverage_file,
             diff=diff_coverage_file,
         )
-        has_diff = bool(diff_coverage_file and diff_coverage_file.added_statements)
-
-        if has_diff:
-            files.append(file_info)
+        files.append(file_info)
 
-    return sort_and_trucate_files(files=files, max_files=max_files), len(files), files
+    return sort_and_trucate_files(files=files, max_files=max_files), len(files)
 
 
 def select_files(
-    *,
     coverage: Coverage,
-    changed_files_info: list[FileInfo],
     max_files: int | None,
+    skip_covered_files_in_report: bool,
 ) -> tuple[list[FileInfo], int]:
     """
     Selects the no of `max_files` files from the whole project coverage
-    Selects only files which are not in changed files report
     Select only files which have statements (not empty files)
+    Select only files which have lines missing coverage if `skip_covered_files_in_report` is True
     """
 
     files = []
-    changed_files_path = {file.path for file in changed_files_info}
     for path, coverage_file in coverage.files.items():
-        # Don't show the report for files that have been modified in the PR
-        # This is gonne be covered in the changed files report
-        if path in changed_files_path:
-            continue
-
         # Don't show the report for files that have no statements
         if coverage_file.info.num_statements == 0:
             continue
 
+        if skip_covered_files_in_report and percentage_value(coverage_file.info.percent_covered) == 100:
+            continue
+
         file_info = FileInfo(path=path, coverage=coverage_file, diff=None)
         files.append(file_info)
 

tests/test_config.py

@@ -149,6 +149,11 @@ def test_config_clean_complete_project_report():
     assert value is True
 
 
+def test_config_clean_skip_covered_files_in_report():
+    value = config.Config.clean_skip_covered_files_in_report('True')
+    assert value is True
+
+
 def test_config_clean_debug():
     value = config.Config.clean_debug('False')
     assert value is False