src/sage/doctest/forker.py: Show '# [failed in baseline]' earlier

Author: Matthias Koeppe

src/sage/doctest/forker.py

@@ -513,7 +513,7 @@ def __init__(self, *args, **kwds):
 
         - ``stdout`` -- an open file to restore for debugging
 
-        - ``checker`` -- None, or an instance of
+        - ``checker`` -- ``None``, or an instance of
           :class:`doctest.OutputChecker`
 
         - ``verbose`` -- boolean, determines whether verbose printing
@@ -522,6 +522,9 @@ def __init__(self, *args, **kwds):
         - ``optionflags`` -- Controls the comparison with the expected
           output.  See :mod:`testmod` for more information.
 
+        - ``baseline`` -- ``None`` or a dictionary, the ``baseline_stats``
+          value
+
         EXAMPLES::
 
             sage: from sage.doctest.parsing import SageOutputChecker
@@ -535,6 +538,9 @@ def __init__(self, *args, **kwds):
         O = kwds.pop('outtmpfile', None)
         self.msgfile = kwds.pop('msgfile', None)
         self.options = kwds.pop('sage_options')
+        self.baseline = kwds.pop('baseline', None)
+        if self.baseline is None:
+            self.baseline = {}
         doctest.DocTestRunner.__init__(self, *args, **kwds)
         self._fakeout = SageSpoofInOut(O)
         if self.msgfile is None:
@@ -1721,12 +1727,20 @@ def serial_dispatch(self):
         """
         for source in self.controller.sources:
             heading = self.controller.reporter.report_head(source)
+            basename = source.basename
+            if self.controller.baseline_stats:
+                the_baseline_stats = self.controller.baseline_stats.get(basename, {})
+            else:
+                the_baseline_stats = {}
+            if the_baseline_stats.get('failed', False):
+                heading += "  # [failed in baseline]"
             if not self.controller.options.only_errors:
                 self.controller.log(heading)
 
             with tempfile.TemporaryFile() as outtmpfile:
                 result = DocTestTask(source)(self.controller.options,
-                                             outtmpfile, self.controller.logger)
+                                             outtmpfile, self.controller.logger,
+                                             baseline=the_baseline_stats)
                 outtmpfile.seek(0)
                 output = bytes_to_str(outtmpfile.read())
 
@@ -1985,10 +1999,17 @@ def sel_exit():
                             # Start a new worker.
                             import copy
                             worker_options = copy.copy(opt)
+                            basename = source.basename
+                            if self.controller.baseline_stats:
+                                the_baseline_stats = self.controller.baseline_stats.get(basename, {})
+                            else:
+                                the_baseline_stats = {}
                             if target_endtime is not None:
                                 worker_options.target_walltime = (target_endtime - now) / (max(1, pending_tests / opt.nthreads))
-                            w = DocTestWorker(source, options=worker_options, funclist=[sel_exit])
+                            w = DocTestWorker(source, options=worker_options, baseline=the_baseline_stats, funclist=[sel_exit])
                             heading = self.controller.reporter.report_head(w.source)
+                            if the_baseline_stats.get('failed', False):
+                                heading += "  # [failed in baseline]"
                             if not self.controller.options.only_errors:
                                 w.messages = heading + "\n"
                             # Store length of heading to detect if the
@@ -2147,7 +2168,7 @@ class should be accessed by the child process.
         sage: reporter.report(FDS, False, W.exitcode, result, "")
             [... tests, ... s]
     """
-    def __init__(self, source, options, funclist=[]):
+    def __init__(self, source, options, funclist=[], baseline=None):
         """
         Initialization.
 
@@ -2171,6 +2192,7 @@ def __init__(self, source, options, funclist=[]):
         self.source = source
         self.options = options
         self.funclist = funclist
+        self.baseline = baseline
 
         # Open pipe for messages. These are raw file descriptors,
         # not Python file objects!
@@ -2242,7 +2264,7 @@ def run(self):
         os.close(self.rmessages)
         msgpipe = os.fdopen(self.wmessages, "w")
         try:
-            task(self.options, self.outtmpfile, msgpipe, self.result_queue)
+            task(self.options, self.outtmpfile, msgpipe, self.result_queue, baseline=self.baseline)
         finally:
             msgpipe.close()
             self.outtmpfile.close()
@@ -2508,7 +2530,8 @@ def __init__(self, source):
         """
         self.source = source
 
-    def __call__(self, options, outtmpfile=None, msgfile=None, result_queue=None):
+    def __call__(self, options, outtmpfile=None, msgfile=None, result_queue=None, *,
+                 baseline=None):
         """
         Calling the task does the actual work of running the doctests.
 
@@ -2525,6 +2548,9 @@ def __call__(self, options, outtmpfile=None, msgfile=None, result_queue=None):
         - ``result_queue`` -- an instance of :class:`multiprocessing.Queue`
           to store the doctest result. For testing, this can also be None.
 
+        - ``baseline`` -- ``None`` or a dictionary, the ``baseline_stats``
+          value.
+
         OUTPUT:
 
         - ``(doctests, result_dict)`` where ``doctests`` is the number of
@@ -2560,7 +2586,8 @@ def __call__(self, options, outtmpfile=None, msgfile=None, result_queue=None):
                 outtmpfile=outtmpfile,
                 msgfile=msgfile,
                 sage_options=options,
-                optionflags=doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS)
+                optionflags=doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS,
+                baseline=baseline)
             runner.basename = self.source.basename
             runner.filename = self.source.path
             N = options.file_iterations