Skip to content

Commit 8ee7d76

Browse files
authored
fix(mower): document error semantics and log unknown status codes (#1009)
1 parent f1fa0ee commit 8ee7d76

4 files changed

Lines changed: 83 additions & 0 deletions

File tree

‎roborock/data/mower/mower_code_mappings.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
"""Code mappings for Roborock mower devices."""
22

3+
import logging
34
from typing import Self, cast
45

56
from roborock.data.code_mappings import RoborockModeEnum
67

8+
_LOGGER = logging.getLogger(__name__)
9+
710
__all__ = [
811
"MowerAfsStatus",
912
"MowerChargeState",
@@ -38,6 +41,7 @@ def from_code(cls, code: int | str) -> Self:
3841
"""Resolve a wire value by name, string value, or integer code."""
3942
if (member := cls.from_any_optional(code)) is not None:
4043
return member
44+
_LOGGER.debug("Unknown %s code %r; defaulting to UNKNOWN", cls.__name__, code)
4145
return cast(Self, cls.UNKNOWN) # type: ignore[attr-defined]
4246

4347

‎roborock/data/mower/mower_containers.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ class MowerStatus(RoborockBase):
4848
"""Core mower status backed by mower DPS updates (data points 120-145)."""
4949

5050
error_code: MowerErrorCode | None = field(default=None, metadata={"dps": RoborockMowerDataProtocol.ERROR_CODE})
51+
"""None means no error code was supplied; UNKNOWN means an unknown error."""
5152
battery: int | None = field(default=None, metadata={"dps": RoborockMowerDataProtocol.BATTERY})
5253
mow_type: MowerMowType | None = field(default=None, metadata={"dps": RoborockMowerDataProtocol.MOW_TYPE})
5354
mow_state: MowerDetailState | None = field(default=None, metadata={"dps": RoborockMowerDataProtocol.MOW_STATE})

‎tests/data/mower/test_mower_code_mappings.py‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
"""Tests for mower code mappings."""
22

3+
import logging
4+
35
import pytest
46

57
from roborock.data import mower
@@ -127,3 +129,50 @@ def test_from_code_accepts_wire_forms_and_falls_back(
127129
enum_cls: type[MowerEnum], raw: int | str, expected: MowerEnum
128130
) -> None:
129131
assert enum_cls.from_code(raw) is expected
132+
133+
134+
@pytest.mark.parametrize("enum_cls", [MowerMowType, MowerErrorCode])
135+
@pytest.mark.parametrize("raw", [9999, "9999", "FUTURE_VALUE"])
136+
def test_unrecognized_mower_value_logs_debug(
137+
enum_cls: type[MowerEnum], raw: int | str, caplog: pytest.LogCaptureFixture
138+
) -> None:
139+
with caplog.at_level(logging.DEBUG):
140+
member = enum_cls.from_code(raw)
141+
142+
assert member.value == "unknown"
143+
assert len(caplog.records) == 1
144+
record = caplog.records[0]
145+
assert record.levelno == logging.DEBUG
146+
assert enum_cls.__name__ in record.getMessage()
147+
assert repr(raw) in record.getMessage()
148+
149+
150+
@pytest.mark.parametrize(
151+
("enum_cls", "raw"),
152+
[
153+
(MowerMowType, 1),
154+
(MowerMowType, "GLOBAL"),
155+
(MowerMowType, "global"),
156+
(MowerMowType, "1"),
157+
(MowerMowType, -1),
158+
(MowerErrorCode, 0),
159+
(MowerErrorCode, "0"),
160+
(MowerErrorCode, "UNKNOWN"),
161+
(MowerErrorCode, "unknown"),
162+
],
163+
)
164+
def test_recognized_mower_value_does_not_log(
165+
enum_cls: type[MowerEnum], raw: int | str, caplog: pytest.LogCaptureFixture
166+
) -> None:
167+
with caplog.at_level(logging.DEBUG):
168+
enum_cls.from_code(raw)
169+
170+
assert not caplog.records
171+
172+
173+
def test_optional_mower_enum_lookups_remain_silent(caplog: pytest.LogCaptureFixture) -> None:
174+
with caplog.at_level(logging.DEBUG):
175+
assert MowerErrorCode.from_code_optional(9999) is None
176+
assert MowerErrorCode.from_any_optional("FUTURE_VALUE") is None
177+
178+
assert not caplog.records

‎tests/data/mower/test_mower_containers.py‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,3 +113,32 @@ def test_mower_status_from_empty_dps(dps: dict[int | str, object] | None) -> Non
113113

114114
def test_mower_status_from_dps_unknown_state() -> None:
115115
assert MowerStatus.from_dps({"123": 9999}).mow_state is MowerDetailState.UNKNOWN
116+
117+
118+
@pytest.mark.parametrize("key", ["error_code", "errorCode", 120, "120"])
119+
@pytest.mark.parametrize(
120+
("raw", "expected"),
121+
[
122+
(None, None),
123+
(0, MowerErrorCode.UNKNOWN),
124+
("0", MowerErrorCode.UNKNOWN),
125+
("UNKNOWN", MowerErrorCode.UNKNOWN),
126+
(18, MowerErrorCode.LIFT),
127+
("LIFT", MowerErrorCode.LIFT),
128+
(9999, MowerErrorCode.UNKNOWN),
129+
],
130+
)
131+
def test_mower_status_error_semantics(key: int | str, raw: int | str | None, expected: MowerErrorCode | None) -> None:
132+
"""A missing code and an unknown error remain distinct through serialization."""
133+
if key in ("error_code", "errorCode"):
134+
status = MowerStatus.from_dict({str(key): raw})
135+
else:
136+
status = MowerStatus.from_dps({key: raw})
137+
138+
assert status.error_code is expected
139+
serialized = status.as_dict()
140+
if expected is None:
141+
assert "errorCode" not in serialized
142+
else:
143+
assert serialized["errorCode"] == expected.value
144+
assert MowerStatus.from_dict(serialized).error_code is expected

0 commit comments

Comments
 (0)