From 511f118544319becd97f5e8e4a4a6a197fb9f1be Mon Sep 17 00:00:00 2001 From: user202729 <25191436+user202729@users.noreply.github.com> Date: Thu, 13 Feb 2025 21:12:51 +0700 Subject: [PATCH 1/2] Add test for github format of doctest report --- src/sage/doctest/forker.py | 12 ++++++++++++ src/sage/doctest/reporting.py | 8 ++++++++ 2 files changed, 20 insertions(+) diff --git a/src/sage/doctest/forker.py b/src/sage/doctest/forker.py index f3950cde06b..f3e2bf42dc7 100644 --- a/src/sage/doctest/forker.py +++ b/src/sage/doctest/forker.py @@ -1234,6 +1234,18 @@ def _failure_header(self, test, example, message='Failed example:'): Hello there! doctest_var = 42; doctest_var^2 + + TESTS: + + Test GitHub output format (used for GitHub Actions annotations):: + + sage: DTR.options.format = 'github' + sage: print(DTR._failure_header(doctests[0], ex)) + ********************************************************************** + ::error title=Failed example:,file=.../sage/doctest/forker.py,line=12::Failed example: + doctest_var = 42; doctest_var^2 + + sage: DTR.options.format = 'sage' """ out = [self.DIVIDER] with OriginalSource(example): diff --git a/src/sage/doctest/reporting.py b/src/sage/doctest/reporting.py index 54742cd6c1e..78ea6de2706 100644 --- a/src/sage/doctest/reporting.py +++ b/src/sage/doctest/reporting.py @@ -252,6 +252,14 @@ def _log_failure(self, source, fail_msg, event, output=None): Tests run before process (pid=1234) timed out: Output so far... ********************************************************************** + + TESTS: + + Test GitHub output format (used for GitHub Actions annotations):: + + sage: DTR.controller.options.format = 'github' + sage: DTR._log_failure(FDS, "Timed out", "process (pid=1234) timed out", "Output so far...") + ::error title=Timed out,file=.../sage/doctest/reporting.py::Output so far... """ log = self.controller.log format = self.controller.options.format From 3703fb7fc6e121888940d60c6263bb9bbaf0d9f4 Mon Sep 17 00:00:00 2001 From: user202729 <25191436+user202729@users.noreply.github.com> Date: Fri, 12 Sep 2025 17:28:54 +0700 Subject: [PATCH 2/2] Apply suggested change --- src/sage/doctest/forker.py | 1 - 1 file changed, 1 deletion(-) diff --git a/src/sage/doctest/forker.py b/src/sage/doctest/forker.py index d5b90ce9371..22c58126386 100644 --- a/src/sage/doctest/forker.py +++ b/src/sage/doctest/forker.py @@ -1258,7 +1258,6 @@ def _failure_header(self, test, example, message='Failed example:', extra=None): ::error title=Failed example:,file=.../sage/doctest/forker.py,line=12::Failed example: doctest_var = 42; doctest_var^2 - sage: DTR.options.format = 'sage' """ out = [self.DIVIDER] with OriginalSource(example):