Adding custom pytest summary

Contributes to GSK-1650

Author: Hartorn

python-client/.gitignore

@@ -1,3 +1,4 @@
+local_report.md
 .run
 .DS_Store
 # Byte-compiled / optimized / DLL files

python-client/tests/conftest.py

@@ -1,5 +1,14 @@
 from glob import glob
+from io import TextIOWrapper
 from pathlib import Path
+from typing import List
+import os
+from uuid import uuid4
+
+from _pytest.terminal import TerminalReporter
+from _pytest.config import ExitCode, Config
+from _pytest.reports import BaseReport
+from pytest import CollectReport, TestReport
 
 pytest_plugins = []
 for f in glob("**/fixtures/**/*.py", recursive=True):
@@ -11,3 +20,63 @@ def pytest_collection_modifyitems(session, config, items):
     # Only considers functions inside /tests directory as unit tests
     # otherwise test functions in the main part of the repo are also detected
     items[:] = [i for i in items if i.location[0].startswith("tests")]
+
+
+def _write_details(writer: TextIOWrapper, title: str, content: str):
+    if content:
+        writer.write("<details>\n")
+        writer.write(f"<summary>{title}</summary>\n\n")
+        writer.write(f"```\n{content}\n```\n")
+        writer.write("\n</details>\n")
+
+def _write_report(writer: TextIOWrapper, report : BaseReport):
+    writer.write(f"\n\n<h4 id=user-content-{report.html_id}>{report.nodeid}</h4>\n\n")
+    writer.write(f"```python\n{report.longreprtext}\n```\n")
+    _write_details(writer, "Log", report.caplog)
+    _write_details(writer, "Stdout", report.capstdout)
+    _write_details(writer, "Stderr", report.capstderr)
+
+
+def pytest_terminal_summary(
+    terminalreporter: TerminalReporter, exitstatus: ExitCode, config: Config
+):
+    file = Path(os.getenv("GITHUB_STEP_SUMMARY", "local_report.md"))
+
+    with file.open("w", encoding="utf-8") as writer:
+        writer.write("### Pytest report\n")
+        writer.write(f"Test results: {ExitCode(exitstatus).name} {'✅' if exitstatus == ExitCode.OK else '❌'}\n\n")
+
+        writer.write("\n| Status |Count |\n")
+        writer.write("| :---: | :---: |\n")
+
+        total = 0
+        for k, v in terminalreporter.stats.items():
+            if not k or k == "warnings":
+                continue
+            total += len(v)
+            writer.write(f"| {k.capitalize()} | {len(v)} |\n")
+        writer.write(f"| Total | {total} |\n\n")
+
+        failures: List[TestReport] = [
+            report for report in terminalreporter.stats.get("failed", [])
+        ]
+        errors: List[CollectReport] = [
+            report for report in terminalreporter.stats.get("error", [])
+        ]
+
+        writer.write("### Table of contents\n\n")
+        for error in errors:
+            error.html_id = str(uuid4()) 
+            writer.write(f"- [Error : {error.nodeid.split('::')[-1]}](#user-content-{error.html_id})\n") 
+        for failure in failures:
+            failure.html_id = str(uuid4()) 
+            writer.write(f"- [Failure : {failure.nodeid.split('::')[-1]}](#user-content-{failure.html_id})\n") 
+
+
+        writer.write("\n### Errors\n\n")
+        for error in errors:
+            _write_report(writer, error)
+
+        writer.write("\n### Failures\n\n")
+        for failure in failures:
+            _write_report(writer, failure)