Embed table inside another details section

Author: dvg-p4

coverage_comment/main.py

@@ -205,6 +205,26 @@ def process_pr(
         except github.CannotDeterminePR:
             pr_number = None
 
+    plain_text_report: str | None = None
+    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,
+            )
+        except template.TemplateError:
+            log.warning(
+                "There was a rendering error when computing the plain-text report. "
+                "The plain-text output will not be available."
+            )
+
     try:
         comment = template.get_comment_markdown(
             coverage=coverage,
@@ -226,6 +246,7 @@ def process_pr(
             marker=marker,
             subproject_id=config.SUBPROJECT_ID,
             failure_msg=failure_msg,
+            plain_text_report=plain_text_report,
         )
         # Same as above except `max_files` is None
         summary_comment = template.get_comment_markdown(
@@ -248,6 +269,7 @@ def process_pr(
             marker=marker,
             subproject_id=config.SUBPROJECT_ID,
             failure_msg=failure_msg,
+            plain_text_report=plain_text_report,
         )
     except template.MissingMarker:
         log.error(
@@ -270,29 +292,6 @@ 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/template.py

@@ -142,6 +142,7 @@ def get_comment_markdown(
     custom_template: str | None = None,
     pr_targets_default_branch: bool = True,
     failure_msg: str | None = None,
+    plain_text_report: str | None = None,
 ):
     loader = CommentLoader(base_template=base_template, custom_template=custom_template)
     env = SandboxedEnvironment(loader=loader)
@@ -190,6 +191,7 @@ def get_comment_markdown(
             marker=marker,
             pr_targets_default_branch=pr_targets_default_branch,
             failure_msg=failure_msg,
+            plain_text_report=plain_text_report,
         )
     except jinja2.exceptions.TemplateError as exc:
         raise TemplateError from exc

coverage_comment/template_files/comment.md.j2

@@ -275,4 +275,11 @@ This report was generated by [python-coverage-comment-action](https://github.com
 {%- endif -%}
 {%- endblock coverage_by_file %}
 
+{% if plain_text_report %}
+<details><summary>Plain-text coverage table (for copy-paste)</summary>
+
+{{ plain_text_report }}
+</details>
+
+{% endif -%}
 {{ marker -}}

tests/unit/test_template.py

@@ -408,6 +408,65 @@ def test_template__no_files(coverage_obj, diff_coverage_obj_more_files):
     assert "other.py" not in result
 
 
+def test_template__with_plain_text_report(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_comment_markdown(
+        coverage=coverage_obj,
+        diff_coverage=diff_coverage_obj,
+        previous_coverage=None,
+        previous_coverage_rate=None,
+        files=files,
+        count_files=total,
+        max_files=25,
+        minimum_green=decimal.Decimal("100"),
+        minimum_orange=decimal.Decimal("70"),
+        marker="<!-- foo -->",
+        github_host="https://github.com",
+        repo_name="org/repo",
+        pr_number=3,
+        branch_name=None,
+        base_template=template.read_template_file("comment.md.j2"),
+        plain_text_report="## Plain-text coverage report\n\n| File | Coverage |\n| ---- | -------: |\n| code.py | 50% |",
+    )
+    assert "<details><summary>Plain-text coverage table (for copy-paste)</summary>" in result
+    assert "## Plain-text coverage report" in result
+    assert "| code.py | 50% |" in result
+    assert "<!-- foo -->" in result
+
+
+def test_template__without_plain_text_report(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_comment_markdown(
+        coverage=coverage_obj,
+        diff_coverage=diff_coverage_obj,
+        previous_coverage=None,
+        previous_coverage_rate=None,
+        files=files,
+        count_files=total,
+        max_files=25,
+        minimum_green=decimal.Decimal("100"),
+        minimum_orange=decimal.Decimal("70"),
+        marker="<!-- foo -->",
+        github_host="https://github.com",
+        repo_name="org/repo",
+        pr_number=3,
+        branch_name=None,
+        base_template=template.read_template_file("comment.md.j2"),
+    )
+    assert "Plain-text coverage table" not in result
+    assert "<!-- foo -->" in result
+
+
 def test_get_plain_text_markdown(make_coverage, make_coverage_and_diff):
     previous_cov = make_coverage(
         """