sift/python/lib/sift_client/util/test_results/bounds.py at 3095e63517a9eb48173f40d5bc53bfeefe8ebc0e · sift-stack/sift · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
from __future__ import annotations

from sift_client.sift_types.test_report import (
    NumericBounds,
    TestMeasurement,
    TestMeasurementCreate,
    TestMeasurementType,
    TestMeasurementUpdate,
)


def assign_value_to_measurement(
    measurement: TestMeasurement | TestMeasurementCreate | TestMeasurementUpdate,
    value: float | str | bool,
) -> None:
    """Resolve value type from a given value and assign it to a measurement.

    Args:
        measurement: The measurement to assign the value to.
        value: The value to resolve and assign to the measurement.
    """
    if isinstance(value, bool):
        measurement.boolean_value = value
        measurement.measurement_type = TestMeasurementType.BOOLEAN
    elif isinstance(value, float) or isinstance(value, int):
        measurement.numeric_value = float(value)
        measurement.measurement_type = TestMeasurementType.DOUBLE
    elif isinstance(value, str):
        measurement.string_value = value
        measurement.measurement_type = TestMeasurementType.STRING
    else:
        raise ValueError(f"Invalid value type: {type(value)}")


def evaluate_measurement_bounds(
    measurement: TestMeasurement | TestMeasurementCreate | TestMeasurementUpdate,
    value: float | str | bool,
    bounds: dict[str, float] | NumericBounds | str | bool | None,
) -> bool:
    """Update a measurement with the resolved bounds type and result of evaluating the given value against those bounds.

    Args:
        measurement: The measurement to update.
        value: The value to evaluate the bounds of.
        bounds: The bounds to evaluate the value against. Either a dictionary with "min" and "max" keys, a NumericBounds object, a string, a boolean, or None.

    Returns:
        True if the value is within the bounds, False otherwise.
    """
    assign_value_to_measurement(measurement, value)
    if bounds is None:
        return bool(measurement.passed)

    if isinstance(bounds, dict):
        bounds = NumericBounds(min=bounds.get("min"), max=bounds.get("max"))
    if isinstance(bounds, bool):
        if isinstance(value, str):
            measurement.passed = str(value).lower() == str(bounds).lower()
        else:
            measurement.passed = bool(value) == bounds
        return bool(measurement.passed)
    elif isinstance(bounds, str):
        if not (isinstance(value, str) or isinstance(value, bool)):
            raise ValueError("Value must be a string if bounds provided is a string")
        measurement.string_expected_value = bounds
        if isinstance(value, bool):
            measurement.passed = str(value).lower() == str(bounds).lower()
        else:
            measurement.passed = value == bounds
    elif isinstance(bounds, NumericBounds):
        measurement.numeric_bounds = bounds
        measurement.passed = True
        try:
            if measurement.numeric_bounds.min is not None:
                measurement.passed = measurement.passed and measurement.numeric_bounds.min <= value  # type: ignore
            if measurement.numeric_bounds.max is not None:
                measurement.passed = measurement.passed and measurement.numeric_bounds.max >= value  # type: ignore
        except TypeError:
            raise TypeError(
                f"Value must be a float or int to evaluate numeric bounds but gave {type(value)}"
            ) from None

    return bool(measurement.passed)