python(feat): Support specifying units on test results from client library.

Author: ian-sift

python/lib/sift_client/_tests/resources/test_test_results.py

@@ -201,6 +201,7 @@ def test_create_test_measurements(self, sift_client):
                 "string_value": "1.10.3",
                 "passed": True,
                 "timestamp": step2.start_time,
+                "unit": "K",
             },
             update_step=True,
         )
@@ -232,6 +233,7 @@ def test_create_test_measurements(self, sift_client):
         assert measurement2.id_ is not None
         assert measurement3.id_ is not None
         assert measurement4.id_ is not None
+        assert measurement2.unit == "K"
         self.test_measurements["measurement1"] = measurement1
         self.test_measurements["measurement2"] = measurement2
         self.test_measurements["measurement3"] = measurement3
@@ -248,12 +250,13 @@ def test_update_test_measurements(self, sift_client):
             update={
                 "passed": False,
                 "string_expected_value": "1.10.4",
+                "unit": "C",
             },
             update_step=True,
         )
         assert measurement2.passed == False
         assert measurement2.string_expected_value == "1.10.4"
-
+        assert measurement2.unit == "C"
         # Update the measurement using class function.
         measurement4 = measurement4.update(
             {

python/lib/sift_client/sift_types/_base.py

@@ -94,6 +94,7 @@ class ModelCreateUpdateBase(BaseModel, ABC):
 
     model_config = ConfigDict(frozen=False)
     _to_proto_helpers: ClassVar[dict[str, MappingHelper]] = {}
+    _field_helpers_called: set[str] = set()
 
     def __init__(self, **data: Any):
         super().__init__(**data)
@@ -146,13 +147,19 @@ def _build_proto_and_paths(
                 if mapping_helper.update_field:
                     paths.append(mapping_helper.update_field)
             elif isinstance(value, dict):
-                if field_name in self.__class__._to_proto_helpers:
-                    assert self.__class__._to_proto_helpers[field_name].converter, (
-                        f"Expecting to run a coverter given a helper was defined for: {field_name}"
-                    )
+                if (
+                    field_name in self.__class__._to_proto_helpers
+                    and not field_name in self._field_helpers_called
+                ):
+                    self._field_helpers_called.add(field_name)
+                    if (
+                        self.__class__._to_proto_helpers.get(field_name)
+                        and self.__class__._to_proto_helpers[field_name].converter
+                    ):
+                        value = self.__class__._to_proto_helpers[field_name].converter(value)
                     sub_paths = self._build_proto_and_paths(
                         proto_msg,
-                        {field_name: self.__class__._to_proto_helpers[field_name].converter(value)},  # type: ignore[misc]
+                        {field_name: value},  # type: ignore[misc]
                         "",
                         already_setting_path_override=True,
                     )
@@ -178,6 +185,7 @@ def _build_proto_and_paths(
                         assert self.__class__._to_proto_helpers[field_name].converter, (
                             f"Expecting to run a coverter given a helper was defined for: {field_name}"
                         )
+                        self._field_helpers_called.add(field_name)
                         for item in value:
                             repeated_field.append(
                                 self.__class__._to_proto_helpers[field_name].converter(**item)  # type: ignore

python/lib/sift_client/sift_types/test_report.py

@@ -271,6 +271,7 @@ class TestMeasurementUpdate(TestMeasurementBase, ModelUpdate[TestMeasurementProt
         "string_expected_value": MappingHelper(
             proto_attr_path="string_bounds.expected_value", update_field="string_bounds"
         ),
+        "unit": MappingHelper(proto_attr_path="unit.abbreviated_name", update_field="unit"),
     }
 
     def _add_resource_id_to_proto(self, proto_msg: TestMeasurementProto):
@@ -286,7 +287,6 @@ class TestMeasurementCreate(TestMeasurementBase, ModelCreate[TestMeasurementProt
     test_step_id: str
     passed: bool
     timestamp: datetime
-    unit: str | None = None
 
     def to_proto(self) -> TestMeasurementProto:
         """Convert to protobuf message with custom logic."""
@@ -301,6 +301,8 @@ def to_proto(self) -> TestMeasurementProto:
 
         proto.timestamp.FromDatetime(self.timestamp)
 
+        if self.unit:
+            proto.unit.abbreviated_name = self.unit
         if self.numeric_value is not None:
             proto.numeric_value = self.numeric_value
         elif self.string_value is not None:

python/lib/sift_client/util/test_results/context_manager.py

@@ -268,17 +268,27 @@ def measure(
         name: str,
         value: float | str | bool,
         bounds: dict[str, float] | NumericBounds | str | None = None,
+        timestamp: datetime | None = None,
+        unit: str | None = None,
     ) -> bool:
         """Measure a value and return the result.
 
-        returns: The measurement object.
+        Args:
+            name: The name of the measurement.
+            value: The value of the measurement.
+            bounds: [Optional] The bounds to compare the value to.
+            timestamp: [Optional] The timestamp of the measurement. Defaults to the current time.
+            unit: [Optional] The unit of the measurement.
+
+        returns: The result of the measurement.
         """
         assert self.current_step is not None
         create = TestMeasurementCreate(
             test_step_id=str(self.current_step.id_),
             name=name,
             passed=True,
-            timestamp=datetime.now(timezone.utc),
+            timestamp=timestamp if timestamp else datetime.now(timezone.utc),
+            unit=unit,
         )
         evaluate_measurement_bounds(create, value, bounds)
         measurement = self.client.test_results.create_measurement(create)