|
| 1 | +"""Tests for the CleanSequenceTrait class.""" |
| 2 | + |
| 3 | +from unittest.mock import AsyncMock |
| 4 | + |
| 5 | +import pytest |
| 6 | + |
| 7 | +from roborock.data import HomeDataDevice |
| 8 | +from roborock.devices.device import RoborockDevice |
| 9 | +from roborock.devices.traits.v1.clean_sequence import CleanSequenceTrait |
| 10 | +from roborock.exceptions import RoborockParsingException |
| 11 | +from roborock.roborock_typing import RoborockCommand |
| 12 | +from tests import mock_data |
| 13 | + |
| 14 | +S5E = mock_data.DEVICE_PRODUCT_PAIRS["home_data_device_s5e.json"][0] |
| 15 | + |
| 16 | + |
| 17 | +@pytest.fixture(name="clean_sequence_trait") |
| 18 | +def clean_sequence_trait_fixture( |
| 19 | + device: RoborockDevice, |
| 20 | + discover_features_fixture: None, |
| 21 | +) -> CleanSequenceTrait | None: |
| 22 | + """Return the discovered CleanSequenceTrait from the device.""" |
| 23 | + assert device.v1_properties |
| 24 | + return device.v1_properties.clean_sequence |
| 25 | + |
| 26 | + |
| 27 | +def test_requires_feature() -> None: |
| 28 | + """The trait is only created on devices that report order cleaning (robot feature 123).""" |
| 29 | + assert CleanSequenceTrait.requires_feature == "is_order_clean_supported" |
| 30 | + |
| 31 | + |
| 32 | +@pytest.mark.parametrize("device_info", [S5E]) |
| 33 | +async def test_refresh( |
| 34 | + clean_sequence_trait: CleanSequenceTrait | None, |
| 35 | + mock_rpc_channel: AsyncMock, |
| 36 | + device_info: HomeDataDevice, |
| 37 | +) -> None: |
| 38 | + """The response is the list of segment ids in cleaning order.""" |
| 39 | + assert clean_sequence_trait is not None |
| 40 | + mock_rpc_channel.send_command.side_effect = [[8, 3, 7, 10, 1, 9]] |
| 41 | + |
| 42 | + await clean_sequence_trait.refresh() |
| 43 | + |
| 44 | + mock_rpc_channel.send_command.assert_called_once_with(RoborockCommand.GET_CLEAN_SEQUENCE) |
| 45 | + assert clean_sequence_trait.rooms == [8, 3, 7, 10, 1, 9] |
| 46 | + |
| 47 | + |
| 48 | +@pytest.mark.parametrize("device_info", [S5E]) |
| 49 | +@pytest.mark.parametrize("response", [{"unexpected": "shape"}, ["7"], [7, None]]) |
| 50 | +async def test_refresh_bad_format( |
| 51 | + clean_sequence_trait: CleanSequenceTrait | None, |
| 52 | + mock_rpc_channel: AsyncMock, |
| 53 | + device_info: HomeDataDevice, |
| 54 | + response: object, |
| 55 | +) -> None: |
| 56 | + """A response that is not a list of segment ids raises a parsing error.""" |
| 57 | + assert clean_sequence_trait is not None |
| 58 | + mock_rpc_channel.send_command.side_effect = [response] |
| 59 | + |
| 60 | + with pytest.raises(RoborockParsingException): |
| 61 | + await clean_sequence_trait.refresh() |
| 62 | + |
| 63 | + |
| 64 | +@pytest.mark.parametrize("device_info", [S5E]) |
| 65 | +async def test_set_order( |
| 66 | + clean_sequence_trait: CleanSequenceTrait | None, |
| 67 | + mock_rpc_channel: AsyncMock, |
| 68 | + device_info: HomeDataDevice, |
| 69 | +) -> None: |
| 70 | + """set_order sends the list as is and updates the trait.""" |
| 71 | + assert clean_sequence_trait is not None |
| 72 | + mock_rpc_channel.send_command.side_effect = [["ok"]] |
| 73 | + |
| 74 | + await clean_sequence_trait.set_order([7, 8, 3, 10, 1, 9]) |
| 75 | + |
| 76 | + mock_rpc_channel.send_command.assert_called_once_with( |
| 77 | + RoborockCommand.SET_CLEAN_SEQUENCE, params=[7, 8, 3, 10, 1, 9] |
| 78 | + ) |
| 79 | + assert clean_sequence_trait.rooms == [7, 8, 3, 10, 1, 9] |
| 80 | + |
| 81 | + |
| 82 | +@pytest.mark.parametrize("device_info", [S5E]) |
| 83 | +@pytest.mark.parametrize("rooms", [[], [7, 7]]) |
| 84 | +async def test_set_order_rejects_bad_input( |
| 85 | + clean_sequence_trait: CleanSequenceTrait | None, |
| 86 | + mock_rpc_channel: AsyncMock, |
| 87 | + device_info: HomeDataDevice, |
| 88 | + rooms: list[int], |
| 89 | +) -> None: |
| 90 | + """An empty list or a repeated room is refused before anything is sent.""" |
| 91 | + assert clean_sequence_trait is not None |
| 92 | + |
| 93 | + with pytest.raises(ValueError): |
| 94 | + await clean_sequence_trait.set_order(rooms) |
| 95 | + mock_rpc_channel.send_command.assert_not_called() |
0 commit comments