Add failure outcome details when Multidim measurements fail so that the user can check them (e.g. on the console).

PiperOrigin-RevId: 509680299

Author: OpenHTF Owners

openhtf/core/test_state.py

@@ -27,12 +27,13 @@
 import copy
 import enum
 import functools
+import itertools
 import logging
 import mimetypes
 import os
 import socket
 import sys
-from typing import Any, Dict, Iterator, List, Optional, Set, Text, TYPE_CHECKING, Union
+from typing import Any, Dict, Iterator, List, Optional, Set, Text, Tuple, TYPE_CHECKING, Union
 
 import attr
 
@@ -79,6 +80,9 @@ class _Infer(enum.Enum):
 INFER_MIMETYPE: Literal[_Infer.INFER] = _Infer.INFER
 MimetypeT = Union[None, Literal[INFER_MIMETYPE], Text]
 
+# MultiDim measurement failure code.
+MULTIDIM_FAIL = 'Multidim Measurement Failure'
+
 
 class BlankDutIdError(Exception):
   """DUT serial cannot be blank at the end of a test."""
@@ -447,6 +451,45 @@ def finalize_from_phase_outcome(
       )
       self._finalize(test_record.Outcome.FAIL)
 
+  def _is_failed_multidim_measurement(self, meas: measurements.Measurement
+                                      ) -> bool:
+    """Returns whether the given value is a failed multidim measurement."""
+    return bool(meas.outcome != measurements.Outcome.PASS and meas.dimensions)
+
+  def _get_failed_multidim_measurements(
+      self,
+  ) -> List[Tuple[str, openhtf.core.measurements.Measurement]]:
+    """Gets all the failed phase multidim measurements in the test record.
+
+    Returns:
+      a flat list containing tuples of (measurement_name, measurement) values.
+    """
+    failed_phases = (
+        phase
+        for phase in self.test_record.phases
+        if phase.outcome == test_record.PhaseOutcome.FAIL
+    )
+    phases_meas_items = (phase.measurements.items() for phase in failed_phases)
+    flat_meas_items = itertools.chain.from_iterable(phases_meas_items)
+    failed_multidim_meas = [
+        meas_item
+        for meas_item in flat_meas_items
+        if self._is_failed_multidim_measurement(meas_item[1])
+    ]
+    return failed_multidim_meas
+
+  def _add_multidim_outcome_details(self):
+    """Adds additional outcome details for failed multidim measurements."""
+    failed_multidim_meas = self._get_failed_multidim_measurements()
+
+    for name, measurement in failed_multidim_meas:
+      message = [f' failed_item: {name} ({measurement.outcome})']
+      message.append(f'  measured_value: {measurement.measured_value}')
+      message.append('  validators:')
+      for validator in measurement.validators:
+        message.append(f'   validator: {str(validator)}')
+      self.test_record.add_outcome_details(MULTIDIM_FAIL, '\n'.join(message))
+
   def finalize_normally(self) -> None:
     """Mark the state as finished.
 
@@ -461,21 +504,28 @@ def finalize_normally(self) -> None:
       # Vacuously PASS a TestRecord with no phases.
       self._finalize(test_record.Outcome.PASS)
     elif any(
-        phase.outcome == test_record.PhaseOutcome.FAIL for phase in phases):
+        phase.outcome == test_record.PhaseOutcome.FAIL for phase in phases
+    ):
+      # Look for multidim failures to add to outcome details.
+      self._add_multidim_outcome_details()
       # Any FAIL phase results in a test failure.
       self._finalize(test_record.Outcome.FAIL)
     elif all(
-        phase.outcome == test_record.PhaseOutcome.SKIP for phase in phases):
+        phase.outcome == test_record.PhaseOutcome.SKIP for phase in phases
+    ):
       # Error when all phases are skipped; otherwise, it could lead to
       # unintentional passes.
       self.state_logger.error('All phases were skipped, outcome ERROR.')
       self.test_record.add_outcome_details(
-          'ALL_SKIPPED', 'All phases were unexpectedly skipped.')
+          'ALL_SKIPPED', 'All phases were unexpectedly skipped.'
+      )
       self._finalize(test_record.Outcome.ERROR)
     elif any(d.is_failure for d in self.test_record.diagnoses):
       self._finalize(test_record.Outcome.FAIL)
-    elif any(s.outcome == test_record.SubtestOutcome.FAIL
-             for s in self.test_record.subtests):
+    elif any(
+        s.outcome == test_record.SubtestOutcome.FAIL
+        for s in self.test_record.subtests
+    ):
       self._finalize(test_record.Outcome.FAIL)
     else:
       # Otherwise, the test run was successful.
@@ -484,7 +534,8 @@ def finalize_normally(self) -> None:
 
     self.state_logger.debug(
         'Finishing test execution normally with outcome %s.',
-        self.test_record.outcome.name)
+        self.test_record.outcome.name,
+    )
 
   def abort(self) -> None:
     if self._is_aborted():