display report plugin shall now include finish phases

Author: happz

docs/releases/pending/report-display-include-finish.fmf

@@ -0,0 +1,4 @@
+description:
+    The :py:ref:`/plugins/report/display` report plugin will now
+    report results of the ``finish`` step as well as tests and the
+    ``prepare`` results.

tmt/steps/finish/__init__.py

@@ -1,4 +1,4 @@
-from typing import Optional, TypeVar, cast
+from typing import TYPE_CHECKING, Optional, TypeVar, cast
 
 import fmf
 
@@ -19,6 +19,9 @@
 )
 from tmt.utils.environment import Environment
 
+if TYPE_CHECKING:
+    from tmt.base.plan import Plan
+
 
 @container
 class FinishStepData(tmt.steps.WhereableStepData, tmt.steps.StepData):
@@ -63,6 +66,8 @@ class Finish(tmt.steps.StepWithQueue[FinishStepData, PluginOutcome]):
 
     _plugin_base_class = FinishPlugin
 
+    results: list[PhaseResult]
+
     @property
     def _preserved_workdir_members(self) -> set[str]:
         """
@@ -81,6 +86,32 @@ def _preserved_workdir_members(self) -> set[str]:
 
         return members
 
+    def __init__(
+        self,
+        *,
+        plan: 'Plan',
+        raw_data: list[tmt.steps._RawStepData],
+        logger: tmt.log.Logger,
+    ) -> None:
+        """
+        Initialize finish step data
+        """
+
+        super().__init__(plan=plan, raw_data=raw_data, logger=logger)
+
+        self.results = []
+        self.finalizations_applied = 0
+
+    def load(self) -> None:
+        super().load()
+
+        self.results = self._load_results(PhaseResult, allow_missing=True)
+
+    def save(self) -> None:
+        super().save()
+
+        self._save_results(self.results)
+
     def wake(self) -> None:
         """
         Wake up the step (process workdir and command line)
@@ -153,7 +184,7 @@ def go(self, force: bool = False) -> None:
                         ],
                     )
 
-            results: list[PhaseResult] = []
+            self.results: list[PhaseResult] = []
             exceptions: list[Exception] = []
 
             def _record_exception(
@@ -166,7 +197,7 @@ def _record_exception(
             def _is_failed() -> bool:
                 return bool(exceptions) or any(
                     result.result in (ResultOutcome.ERROR, ResultOutcome.FAIL)
-                    for result in results
+                    for result in self.results
                 )
 
             for outcome in self._queue.run():
@@ -186,7 +217,7 @@ def _is_failed() -> bool:
 
                     _record_exception(outcome, outcome.exc)
 
-                    results.append(
+                    self.results.append(
                         PhaseResult(
                             name=outcome.phase.name,
                             result=ResultOutcome.ERROR,
@@ -206,7 +237,7 @@ def _is_failed() -> bool:
                 # log them and save them, but do not emit any special result.
                 # Plugin was alive till the very end, and returned results.
                 if outcome.result:
-                    results += outcome.result.results
+                    self.results += outcome.result.results
 
                     if outcome.result.exceptions:
                         for exc in outcome.result.exceptions:
@@ -219,7 +250,7 @@ def _is_failed() -> bool:
 
                     break
 
-            self._save_results(results)
+            self._save_results(self.results)
 
             if _is_failed():
                 raise tmt.utils.GeneralError(

tmt/steps/report/display.py

@@ -308,7 +308,7 @@ class ReportDisplay(tmt.steps.report.ReportPlugin[ReportDisplayData]):
     Show results on the terminal.
 
     Give a concise summary of results produced by tests and ``prepare``
-    phases, directly on the terminal.
+    and ``finish`` phases, directly on the terminal.
 
     Allows to select the desired level of verbosity:
 
@@ -389,3 +389,10 @@ def go(self, *, logger: Optional[tmt.log.Logger] = None) -> None:
             display_guest,
             logger,
         )
+
+        self._print_step_results(
+            self.step.plan.finish,
+            self.step.plan.finish.results,
+            display_guest,
+            logger,
+        )