Add an option to generate a plain-text markdown table for PR coverage

Author: dvg-p4

action.yml

@@ -96,6 +96,11 @@ inputs:
     description: >
       If true, will create an annotation on every line with missing coverage on a pull request.
     default: false
+  INCLUDE_PLAIN_TEXT_REPORT:
+    description: >
+      If true, will include a plain-text markdown coverage table in the job summary,
+      suitable for pasting into text-based tools. Only applies in PR mode.
+    default: false
   ANNOTATION_TYPE:
     description: >
       Only relevant if ANNOTATE_MISSING_LINES is set to true. This parameter allows you to choose between
@@ -182,4 +187,5 @@ runs:
     MERGE_COVERAGE_FILES: ${{ inputs.MERGE_COVERAGE_FILES }}
     ANNOTATE_MISSING_LINES: ${{ inputs.ANNOTATE_MISSING_LINES }}
     ANNOTATION_TYPE: ${{ inputs.ANNOTATION_TYPE }}
+    INCLUDE_PLAIN_TEXT_REPORT: ${{ inputs.INCLUDE_PLAIN_TEXT_REPORT }}
     VERBOSE: ${{ inputs.VERBOSE }}

coverage_comment/main.py

@@ -270,6 +270,29 @@ def process_pr(
         content=summary_comment, github_step_summary=config.GITHUB_STEP_SUMMARY
     )
 
+    if config.INCLUDE_PLAIN_TEXT_REPORT:
+        try:
+            plain_text_report = template.get_plain_text_markdown(
+                coverage=coverage,
+                diff_coverage=diff_coverage,
+                previous_coverage=previous_coverage,
+                previous_coverage_rate=previous_coverage_rate,
+                files=files_info,
+                count_files=count_files,
+                max_files=None,
+                subproject_id=config.SUBPROJECT_ID,
+                failure_msg=failure_msg,
+            )
+            github.add_job_summary(
+                content=plain_text_report,
+                github_step_summary=config.GITHUB_STEP_SUMMARY,
+            )
+        except template.TemplateError:
+            log.warning(
+                "There was a rendering error when computing the plain-text report. "
+                "The plain-text output will not be available."
+            )
+
     if pr_number is not None and config.ANNOTATE_MISSING_LINES:
         annotations = diff_grouper.get_diff_missing_groups(
             coverage=coverage, diff_coverage=diff_coverage

coverage_comment/settings.py

@@ -64,6 +64,7 @@ class Config:
     MERGE_COVERAGE_FILES: bool = False
     ANNOTATE_MISSING_LINES: bool = False
     ANNOTATION_TYPE: str = "warning"
+    INCLUDE_PLAIN_TEXT_REPORT: bool = False
     MAX_FILES_IN_COMMENT: int = 25
     USE_GH_PAGES_HTML_URL: bool = False
     VERBOSE: bool = False
@@ -95,6 +96,10 @@ def clean_merge_coverage_files(cls, value: str) -> bool:
     def clean_annotate_missing_lines(cls, value: str) -> bool:
         return str_to_bool(value)
 
+    @classmethod
+    def clean_include_plain_text_report(cls, value: str) -> bool:
+        return str_to_bool(value)
+
     @classmethod
     def clean_annotation_type(cls, value: str) -> str:
         if value not in {"notice", "warning", "error"}:

coverage_comment/template.py

@@ -200,6 +200,48 @@ def get_comment_markdown(
     return comment
 
 
+def get_plain_text_markdown(
+    *,
+    coverage: coverage_module.Coverage,
+    diff_coverage: coverage_module.DiffCoverage,
+    previous_coverage_rate: decimal.Decimal | None,
+    previous_coverage: coverage_module.Coverage | None,
+    files: list[FileInfo],
+    max_files: int | None,
+    count_files: int,
+    subproject_id: str | None = None,
+    failure_msg: str | None = None,
+) -> str:
+    env = SandboxedEnvironment()
+    env.filters["pct"] = pct
+
+    missing_diff_lines = {
+        key: list(value)
+        for key, value in itertools.groupby(
+            diff_grouper.get_diff_missing_groups(
+                coverage=coverage, diff_coverage=diff_coverage
+            ),
+            lambda x: x.file,
+        )
+    }
+
+    try:
+        return env.from_string(read_template_file("comment_plain.md.j2")).render(
+            previous_coverage_rate=previous_coverage_rate,
+            coverage=coverage,
+            diff_coverage=diff_coverage,
+            previous_coverage=previous_coverage,
+            count_files=count_files,
+            max_files=max_files,
+            files=files,
+            missing_diff_lines=missing_diff_lines,
+            subproject_id=subproject_id,
+            failure_msg=failure_msg,
+        )
+    except jinja2.exceptions.TemplateError as exc:
+        raise TemplateError from exc
+
+
 def select_files(
     *,
     coverage: coverage_module.Coverage,

coverage_comment/template_files/comment_plain.md.j2

@@ -0,0 +1,49 @@
+{%- if subproject_id %}## Plain-text coverage report ({{ subproject_id }}){% else %}## Plain-text coverage report{% endif %}
+
+**Overall coverage:** {{ coverage.info.percent_covered | pct }}{% if previous_coverage_rate %} (was {{ previous_coverage_rate | pct }}){% endif %}
+
+{% if failure_msg -%}
+> WARNING: {{ failure_msg }}
+
+**Diff coverage:** N/A
+{%- else -%}
+**Diff coverage:** {{ diff_coverage.total_percent_covered | pct }} ({{ diff_coverage.total_num_lines - diff_coverage.total_num_violations }}/{{ diff_coverage.total_num_lines }} new statements covered)
+{%- endif %}
+{% if not files %}
+
+_This PR does not seem to contain any modification to coverable code._
+{%- else %}
+
+| File | Stmts | Missing | Coverage | New stmts coverage | Missing lines |
+| ---- | ----: | ------: | -------: | -----------------: | ------------- |
+{%- for parent, files_in_folder in files|groupby(attribute="path.parent") %}
+{%- for file in files_in_folder %}
+{%- set path = file.coverage.path %}
+{%- if file.previous %}
+{%- set cov_str = (file.previous.info.percent_covered | pct) ~ " -> " ~ (file.coverage.info.percent_covered | pct) %}
+{%- else %}
+{%- set cov_str = file.coverage.info.percent_covered | pct %}
+{%- endif %}
+{%- if file.diff and file.diff.added_statements %}
+{%- set diff_str = (file.diff.percent_covered | pct) ~ " (" ~ (file.diff.covered_statements | length) ~ "/" ~ (file.diff.added_statements | length) ~ ")" %}
+{%- else %}
+{%- set diff_str = "N/A" %}
+{%- endif %}
+{%- set comma = joiner(", ") %}
+{%- set ns = namespace(missing="") %}
+{%- for group in missing_diff_lines.get(path, []) %}
+{%- if group.line_start == group.line_end %}
+{%- set ns.missing = ns.missing ~ comma() ~ (group.line_start | string) %}
+{%- else %}
+{%- set ns.missing = ns.missing ~ comma() ~ (group.line_start | string) ~ "-" ~ (group.line_end | string) %}
+{%- endif %}
+{%- endfor %}
+| {{ path }} | {{ file.coverage.info.num_statements }} | {{ file.coverage.info.missing_lines }} | {{ cov_str }} | {{ diff_str }} | {{ ns.missing }} |
+{%- endfor %}
+{%- endfor %}
+| **Total** | {{ coverage.info.num_statements }} | {{ coverage.info.missing_lines }} | {% if previous_coverage %}{{ previous_coverage.info.percent_covered | pct }} -> {% endif %}{{ coverage.info.percent_covered | pct }} | {{ diff_coverage.total_percent_covered | pct }} ({{ diff_coverage.total_num_lines - diff_coverage.total_num_violations }}/{{ diff_coverage.total_num_lines }}) | |
+{%- if max_files and count_files > max_files %}
+
+_Report truncated to {{ max_files }} files out of {{ count_files }}. See the workflow summary for the full report._
+{%- endif %}
+{%- endif %}

tests/unit/test_template.py

@@ -408,6 +408,200 @@ def test_template__no_files(coverage_obj, diff_coverage_obj_more_files):
     assert "other.py" not in result
 
 
+def test_get_plain_text_markdown(make_coverage, make_coverage_and_diff):
+    previous_cov = make_coverage(
+        """
+        # file: codebase/code.py
+        1 covered
+        2 covered
+        3
+        4 missing
+        5 covered
+        6 covered
+        7
+        8
+        9 covered
+        # file: codebase/other.py
+        1 covered
+        2 covered
+        3 covered
+        4 covered
+        5 covered
+        6 covered
+        # file: codebase/third.py
+        1 covered
+        2 covered
+        3 covered
+        4 covered
+        5 covered
+        6 missing
+        7 missing
+        """
+    )
+    cov, diff_cov = make_coverage_and_diff(
+        """
+        # file: codebase/code.py
+        1 covered
+        2 covered
+        3
+        4
+        5 covered
+        6 covered
+        7
+        8
+        9 covered
+        10
+        11
+        + 12 missing
+        + 13 missing
+        + 14 missing
+        + 15 covered
+        + 16 covered
+        + 17
+        + 18
+        + 19
+        + 20
+        + 21
+        + 22 missing
+        # file: codebase/other.py
+        1 covered
+        2 covered
+        3 covered
+        # file: codebase/third.py
+        1 covered
+        2 covered
+        3 covered
+        4 covered
+        5 covered
+        6 covered
+        7 covered
+        """
+    )
+
+    files, total = template.select_files(
+        coverage=cov,
+        diff_coverage=diff_cov,
+        previous_coverage=previous_cov,
+        max_files=25,
+    )
+
+    result = template.get_plain_text_markdown(
+        coverage=cov,
+        diff_coverage=diff_cov,
+        previous_coverage=previous_cov,
+        previous_coverage_rate=decimal.Decimal("11") / decimal.Decimal("12"),
+        files=files,
+        count_files=total,
+        max_files=25,
+    )
+    print(result)
+    # No HTML anywhere
+    assert "<img" not in result
+    assert "<table" not in result
+    assert "<td" not in result
+    assert "<tr" not in result
+    assert "<a " not in result
+    # Has markdown table
+    assert "| File" in result or "| ---- |" in result
+    # Contains key data
+    assert "code.py" in result
+    assert "other.py" in result
+    assert "third.py" in result
+    assert "80.95%" in result  # overall coverage
+    assert "91.66%" in result  # previous coverage rate
+    assert "33.33%" in result  # diff coverage
+    assert "12-14" in result  # missing line range
+    assert "22" in result  # missing single line
+    assert "**Total**" in result
+
+
+def test_get_plain_text_markdown__no_files(coverage_obj):
+    diff_cov = coverage.DiffCoverage(
+        total_num_lines=0,
+        total_num_violations=0,
+        total_percent_covered=decimal.Decimal("1"),
+        num_changed_lines=0,
+        files={},
+    )
+    result = template.get_plain_text_markdown(
+        coverage=coverage_obj,
+        diff_coverage=diff_cov,
+        previous_coverage=None,
+        previous_coverage_rate=None,
+        files=[],
+        count_files=0,
+        max_files=25,
+    )
+    print(result)
+    assert "does not seem to contain any modification" in result
+    assert "<img" not in result
+    assert "| File" not in result
+
+
+def test_get_plain_text_markdown__with_failure_msg(coverage_obj, diff_coverage_obj):
+    files, total = template.select_files(
+        coverage=coverage_obj,
+        diff_coverage=diff_coverage_obj,
+        previous_coverage=None,
+        max_files=25,
+    )
+    result = template.get_plain_text_markdown(
+        coverage=coverage_obj,
+        diff_coverage=diff_coverage_obj,
+        previous_coverage=None,
+        previous_coverage_rate=None,
+        files=files,
+        count_files=total,
+        max_files=25,
+        failure_msg="The diff is too large to process",
+    )
+    print(result)
+    assert "WARNING: The diff is too large to process" in result
+    assert "N/A" in result  # diff coverage should show N/A
+
+
+def test_get_plain_text_markdown__no_previous(coverage_obj, diff_coverage_obj):
+    files, total = template.select_files(
+        coverage=coverage_obj,
+        diff_coverage=diff_coverage_obj,
+        previous_coverage=None,
+        max_files=25,
+    )
+    result = template.get_plain_text_markdown(
+        coverage=coverage_obj,
+        diff_coverage=diff_coverage_obj,
+        previous_coverage=None,
+        previous_coverage_rate=None,
+        files=files,
+        count_files=total,
+        max_files=25,
+    )
+    print(result)
+    # Should not contain "was" or "->" for coverage evolution
+    assert "(was " not in result
+    assert "-> " not in result
+
+
+def test_get_plain_text_markdown__subproject(coverage_obj, diff_coverage_obj):
+    files, total = template.select_files(
+        coverage=coverage_obj,
+        diff_coverage=diff_coverage_obj,
+        previous_coverage=None,
+        max_files=25,
+    )
+    result = template.get_plain_text_markdown(
+        coverage=coverage_obj,
+        diff_coverage=diff_coverage_obj,
+        previous_coverage=None,
+        previous_coverage_rate=None,
+        files=files,
+        count_files=total,
+        max_files=25,
+        subproject_id="mylib",
+    )
+    assert "(mylib)" in result
+
+
 def test_read_template_file():
     assert template.read_template_file("comment.md.j2").startswith(
         "{%- block title -%}## Coverage report{%- if subproject_id %}"