new test_sensors suite

Author: j-atkins

tests/test_sensors.py

@@ -0,0 +1,127 @@
+import pydantic
+import pytest
+
+from virtualship.instruments.sensors import (
+    ADCP_SUPPORTED_SENSORS,
+    ARGO_FLOAT_SUPPORTED_SENSORS,
+    CTD_BGC_SUPPORTED_SENSORS,
+    CTD_SUPPORTED_SENSORS,
+    DRIFTER_SUPPORTED_SENSORS,
+    UNDERWATER_ST_SUPPORTED_SENSORS,
+    XBT_SUPPORTED_SENSORS,
+    SensorType,
+)
+from virtualship.models.expedition import (
+    SensorConfig,
+    _check_sensor_compatibility,
+    _serialize_sensor_list,
+)
+
+EXPECTED_SENSOR_MEMBERS = {
+    "TEMPERATURE",
+    "SALINITY",
+    "VELOCITY",
+    "OXYGEN",
+    "CHLOROPHYLL",
+    "NITRATE",
+    "PHOSPHATE",
+    "PH",
+    "PHYTOPLANKTON",
+    "PRIMARY_PRODUCTION",
+}
+
+
+def test_sensor_type_all_members_exist():
+    """All expected SensorType members are present."""
+    actual = {m.name for m in SensorType}
+    assert actual == EXPECTED_SENSOR_MEMBERS
+
+
+def test_sensor_type_lookup_by_value():
+    """Can construct a SensorType from its string value."""
+    assert SensorType("SALINITY") is SensorType.SALINITY
+
+
+def test_sensor_type_invalid_value_error():
+    """Invalid string raises ValueError."""
+    with pytest.raises(ValueError):
+        SensorType("NOT_A_SENSOR")
+
+
+def test_all_allowlists_are_frozenset():
+    """All per-instrument allowlists must be frozensets (immutable)."""
+    for allowlist in (
+        ARGO_FLOAT_SUPPORTED_SENSORS,
+        CTD_SUPPORTED_SENSORS,
+        CTD_BGC_SUPPORTED_SENSORS,
+        DRIFTER_SUPPORTED_SENSORS,
+        ADCP_SUPPORTED_SENSORS,
+        UNDERWATER_ST_SUPPORTED_SENSORS,
+        XBT_SUPPORTED_SENSORS,
+    ):
+        assert isinstance(allowlist, frozenset)
+
+
+def test_sensor_config_basic_construction():
+    """Standard construction with SensorType enum."""
+    sc = SensorConfig(sensor_type=SensorType.TEMPERATURE)
+    assert sc.sensor_type is SensorType.TEMPERATURE
+    assert sc.enabled is True
+
+
+def test_sensor_config_disabled():
+    """Can explicitly set enabled=False."""
+    sc = SensorConfig(sensor_type=SensorType.SALINITY, enabled=False)
+    assert sc.enabled is False
+
+
+def test_sensor_config_from_string_shorthand():
+    """A bare string should be accepted as shorthand."""
+    sc = SensorConfig.model_validate("TEMPERATURE")
+    assert sc.sensor_type is SensorType.TEMPERATURE
+    assert sc.enabled is True
+
+
+def test_sensor_config_invalid_string_error():
+    """An unknown sensor name should raise error."""
+    with pytest.raises(pydantic.ValidationError):
+        SensorConfig.model_validate("NOT_REAL")
+
+
+def test_serialize_sensor_list_disabled_excluded():
+    """Disabled sensors are excluded from serialisation."""
+    sensors = [
+        SensorConfig(sensor_type=SensorType.TEMPERATURE, enabled=True),
+        SensorConfig(sensor_type=SensorType.SALINITY, enabled=False),
+    ]
+    assert _serialize_sensor_list(sensors) == ["TEMPERATURE"]
+
+
+def test_check_sensor_compatibility_unsupported_error():
+    """Unsupported sensor raises ValueError."""
+    sensors = [SensorConfig(sensor_type=SensorType.OXYGEN)]
+    with pytest.raises(ValueError, match="does not support sensor"):
+        _check_sensor_compatibility(sensors, DRIFTER_SUPPORTED_SENSORS, "Drifter")
+
+
+def test_check_sensor_compatibility_all_disabled_error():
+    """All sensors disabled raises ValueError."""
+    sensors = [SensorConfig(sensor_type=SensorType.TEMPERATURE, enabled=False)]
+    with pytest.raises(ValueError, match="no enabled sensors"):
+        _check_sensor_compatibility(sensors, DRIFTER_SUPPORTED_SENSORS, "Drifter")
+
+
+def test_check_sensor_compatibility_empty_error():
+    """Empty sensor list raises ValueError."""
+    with pytest.raises(ValueError, match="no enabled sensors"):
+        _check_sensor_compatibility([], DRIFTER_SUPPORTED_SENSORS, "Drifter")
+
+
+def test_check_sensor_compatibility_mixed_error():
+    """Mix of valid and invalid sensors raises ValueError."""
+    sensors = [
+        SensorConfig(sensor_type=SensorType.TEMPERATURE),
+        SensorConfig(sensor_type=SensorType.OXYGEN),
+    ]
+    with pytest.raises(ValueError, match="does not support"):
+        _check_sensor_compatibility(sensors, DRIFTER_SUPPORTED_SENSORS, "Drifter")