Eugenio Panadero
c6aaacbb08
* Add new service `clean_spot` to vacuums
- Add as base component service, with associated support flag to make it optional
- Implement on Demo vacuum
- Implement on Xiaomi vacuum
- Update tests for platforms Demo and Xiaomi
- Change default icon for vacuums to `mdi:roomba`, but keep the one for the Xiaomi
- (In a polymer PR: add new service to command toolbar in the 'more-info' card)
* Add `clean_spot` service description
* fix default properties for vacuum component
268 lines
11 KiB
Python
268 lines
11 KiB
Python
"""The tests for the Xiaomi vacuum platform."""
|
|
import asyncio
|
|
from datetime import timedelta
|
|
from unittest import mock
|
|
|
|
import pytest
|
|
|
|
from homeassistant.components.vacuum import (
|
|
ATTR_BATTERY_ICON,
|
|
ATTR_FAN_SPEED, ATTR_FAN_SPEED_LIST, DOMAIN,
|
|
SERVICE_CLEAN_SPOT, SERVICE_LOCATE, SERVICE_RETURN_TO_BASE,
|
|
SERVICE_SEND_COMMAND, SERVICE_SET_FAN_SPEED, SERVICE_START_PAUSE,
|
|
SERVICE_STOP, SERVICE_TOGGLE, SERVICE_TURN_OFF, SERVICE_TURN_ON)
|
|
from homeassistant.components.vacuum.xiaomi import (
|
|
ATTR_CLEANED_AREA, ATTR_CLEANING_TIME, ATTR_DO_NOT_DISTURB, ATTR_ERROR,
|
|
CONF_HOST, CONF_NAME, CONF_TOKEN, PLATFORM,
|
|
SERVICE_MOVE_REMOTE_CONTROL, SERVICE_MOVE_REMOTE_CONTROL_STEP,
|
|
SERVICE_START_REMOTE_CONTROL, SERVICE_STOP_REMOTE_CONTROL)
|
|
from homeassistant.const import (
|
|
ATTR_ENTITY_ID, ATTR_SUPPORTED_FEATURES, CONF_PLATFORM, STATE_OFF,
|
|
STATE_ON)
|
|
from homeassistant.setup import async_setup_component
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_mirobo_is_off():
|
|
"""Mock mock_mirobo."""
|
|
mock_vacuum = mock.MagicMock()
|
|
mock_vacuum.Vacuum().status().data = {'test': 'raw'}
|
|
mock_vacuum.Vacuum().status().is_on = False
|
|
mock_vacuum.Vacuum().status().fanspeed = 38
|
|
mock_vacuum.Vacuum().status().got_error = True
|
|
mock_vacuum.Vacuum().status().error = 'Error message'
|
|
mock_vacuum.Vacuum().status().dnd = True
|
|
mock_vacuum.Vacuum().status().battery = 82
|
|
mock_vacuum.Vacuum().status().clean_area = 123.43218
|
|
mock_vacuum.Vacuum().status().clean_time = timedelta(
|
|
hours=2, minutes=35, seconds=34)
|
|
mock_vacuum.Vacuum().status().state = 'Test Xiaomi Charging'
|
|
|
|
with mock.patch.dict('sys.modules', {
|
|
'mirobo': mock_vacuum,
|
|
}):
|
|
yield mock_vacuum
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_mirobo_is_on():
|
|
"""Mock mock_mirobo."""
|
|
mock_vacuum = mock.MagicMock()
|
|
mock_vacuum.Vacuum().status().data = {'test': 'raw'}
|
|
mock_vacuum.Vacuum().status().is_on = True
|
|
mock_vacuum.Vacuum().status().fanspeed = 99
|
|
mock_vacuum.Vacuum().status().got_error = False
|
|
mock_vacuum.Vacuum().status().dnd = False
|
|
mock_vacuum.Vacuum().status().battery = 32
|
|
mock_vacuum.Vacuum().status().clean_area = 133.43218
|
|
mock_vacuum.Vacuum().status().clean_time = timedelta(
|
|
hours=2, minutes=55, seconds=34)
|
|
mock_vacuum.Vacuum().status().state = 'Test Xiaomi Cleaning'
|
|
|
|
with mock.patch.dict('sys.modules', {
|
|
'mirobo': mock_vacuum,
|
|
}):
|
|
yield mock_vacuum
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_mirobo_errors():
|
|
"""Mock mock_mirobo_errors to simulate a bad vacuum status request."""
|
|
mock_vacuum = mock.MagicMock()
|
|
mock_vacuum.Vacuum().status.side_effect = OSError()
|
|
with mock.patch.dict('sys.modules', {
|
|
'mirobo': mock_vacuum,
|
|
}):
|
|
yield mock_vacuum
|
|
|
|
|
|
@asyncio.coroutine
|
|
def test_xiaomi_exceptions(hass, caplog, mock_mirobo_errors):
|
|
"""Test vacuum supported features."""
|
|
entity_name = 'test_vacuum_cleaner_error'
|
|
yield from async_setup_component(
|
|
hass, DOMAIN,
|
|
{DOMAIN: {CONF_PLATFORM: PLATFORM,
|
|
CONF_HOST: '127.0.0.1',
|
|
CONF_NAME: entity_name,
|
|
CONF_TOKEN: '12345678901234567890123456789012'}})
|
|
|
|
assert 'Initializing with host 127.0.0.1 (token 12345...)' in caplog.text
|
|
assert str(mock_mirobo_errors.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
assert 'ERROR' in caplog.text
|
|
assert 'Got OSError while fetching the state' in caplog.text
|
|
|
|
|
|
@asyncio.coroutine
|
|
def test_xiaomi_vacuum_services(hass, caplog, mock_mirobo_is_off):
|
|
"""Test vacuum supported features."""
|
|
entity_name = 'test_vacuum_cleaner_1'
|
|
entity_id = '{}.{}'.format(DOMAIN, entity_name)
|
|
|
|
yield from async_setup_component(
|
|
hass, DOMAIN,
|
|
{DOMAIN: {CONF_PLATFORM: PLATFORM,
|
|
CONF_HOST: '127.0.0.1',
|
|
CONF_NAME: entity_name,
|
|
CONF_TOKEN: '12345678901234567890123456789012'}})
|
|
|
|
assert 'Initializing with host 127.0.0.1 (token 12345...)' in caplog.text
|
|
|
|
# Check state attributes
|
|
state = hass.states.get(entity_id)
|
|
|
|
assert state.state == STATE_OFF
|
|
assert state.attributes.get(ATTR_SUPPORTED_FEATURES) == 2047
|
|
assert state.attributes.get(ATTR_DO_NOT_DISTURB) == STATE_ON
|
|
assert state.attributes.get(ATTR_ERROR) == 'Error message'
|
|
assert (state.attributes.get(ATTR_BATTERY_ICON)
|
|
== 'mdi:battery-charging-80')
|
|
assert state.attributes.get(ATTR_CLEANING_TIME) == '2:35:34'
|
|
assert state.attributes.get(ATTR_CLEANED_AREA) == 123.43
|
|
assert state.attributes.get(ATTR_FAN_SPEED) == 'Quiet'
|
|
assert (state.attributes.get(ATTR_FAN_SPEED_LIST)
|
|
== ['Quiet', 'Balanced', 'Turbo', 'Max'])
|
|
|
|
# Call services
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_TURN_ON, blocking=True)
|
|
assert str(mock_mirobo_is_off.mock_calls[-2]) == 'call.Vacuum().start()'
|
|
assert str(mock_mirobo_is_off.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_TURN_OFF, blocking=True)
|
|
assert str(mock_mirobo_is_off.mock_calls[-2]) == 'call.Vacuum().home()'
|
|
assert str(mock_mirobo_is_off.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_TOGGLE, blocking=True)
|
|
assert str(mock_mirobo_is_off.mock_calls[-2]) == 'call.Vacuum().start()'
|
|
assert str(mock_mirobo_is_off.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_STOP, blocking=True)
|
|
assert str(mock_mirobo_is_off.mock_calls[-2]) == 'call.Vacuum().stop()'
|
|
assert str(mock_mirobo_is_off.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_START_PAUSE, blocking=True)
|
|
assert str(mock_mirobo_is_off.mock_calls[-2]) == 'call.Vacuum().start()'
|
|
assert str(mock_mirobo_is_off.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_RETURN_TO_BASE, blocking=True)
|
|
assert str(mock_mirobo_is_off.mock_calls[-2]) == 'call.Vacuum().home()'
|
|
assert str(mock_mirobo_is_off.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_LOCATE, blocking=True)
|
|
assert str(mock_mirobo_is_off.mock_calls[-2]) == 'call.Vacuum().find()'
|
|
assert str(mock_mirobo_is_off.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_CLEAN_SPOT, {}, blocking=True)
|
|
assert str(mock_mirobo_is_off.mock_calls[-2]) == 'call.Vacuum().spot()'
|
|
assert str(mock_mirobo_is_off.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
# Set speed service:
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_SET_FAN_SPEED, {"fan_speed": 60}, blocking=True)
|
|
assert (str(mock_mirobo_is_off.mock_calls[-2])
|
|
== 'call.Vacuum().set_fan_speed(60)')
|
|
assert str(mock_mirobo_is_off.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_SET_FAN_SPEED, {"fan_speed": "turbo"}, blocking=True)
|
|
assert (str(mock_mirobo_is_off.mock_calls[-2])
|
|
== 'call.Vacuum().set_fan_speed(77)')
|
|
assert str(mock_mirobo_is_off.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
assert 'ERROR' not in caplog.text
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_SET_FAN_SPEED, {"fan_speed": "invent"}, blocking=True)
|
|
assert 'ERROR' in caplog.text
|
|
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_SEND_COMMAND,
|
|
{"command": "raw"}, blocking=True)
|
|
assert (str(mock_mirobo_is_off.mock_calls[-2])
|
|
== "call.Vacuum().raw_command('raw', None)")
|
|
assert str(mock_mirobo_is_off.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_SEND_COMMAND,
|
|
{"command": "raw", "params": {"k1": 2}}, blocking=True)
|
|
assert (str(mock_mirobo_is_off.mock_calls[-2])
|
|
== "call.Vacuum().raw_command('raw', {'k1': 2})")
|
|
assert str(mock_mirobo_is_off.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
|
|
@asyncio.coroutine
|
|
def test_xiaomi_specific_services(hass, caplog, mock_mirobo_is_on):
|
|
"""Test vacuum supported features."""
|
|
entity_name = 'test_vacuum_cleaner_2'
|
|
entity_id = '{}.{}'.format(DOMAIN, entity_name)
|
|
|
|
yield from async_setup_component(
|
|
hass, DOMAIN,
|
|
{DOMAIN: {CONF_PLATFORM: PLATFORM,
|
|
CONF_HOST: '192.168.1.100',
|
|
CONF_NAME: entity_name,
|
|
CONF_TOKEN: '12345678901234567890123456789012'}})
|
|
|
|
assert 'Initializing with host 192.168.1.100 (token 12345' in caplog.text
|
|
|
|
# Check state attributes
|
|
state = hass.states.get(entity_id)
|
|
assert state.state == STATE_ON
|
|
assert state.attributes.get(ATTR_SUPPORTED_FEATURES) == 2047
|
|
assert state.attributes.get(ATTR_DO_NOT_DISTURB) == STATE_OFF
|
|
assert state.attributes.get(ATTR_ERROR) is None
|
|
assert (state.attributes.get(ATTR_BATTERY_ICON)
|
|
== 'mdi:battery-30')
|
|
assert state.attributes.get(ATTR_CLEANING_TIME) == '2:55:34'
|
|
assert state.attributes.get(ATTR_CLEANED_AREA) == 133.43
|
|
assert state.attributes.get(ATTR_FAN_SPEED) == 99
|
|
assert (state.attributes.get(ATTR_FAN_SPEED_LIST)
|
|
== ['Quiet', 'Balanced', 'Turbo', 'Max'])
|
|
|
|
# Check setting pause
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_START_PAUSE, blocking=True)
|
|
assert str(mock_mirobo_is_on.mock_calls[-2]) == 'call.Vacuum().pause()'
|
|
assert str(mock_mirobo_is_on.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
# Xiaomi vacuum specific services:
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_START_REMOTE_CONTROL,
|
|
{ATTR_ENTITY_ID: entity_id}, blocking=True)
|
|
assert (str(mock_mirobo_is_on.mock_calls[-2])
|
|
== "call.Vacuum().manual_start()")
|
|
assert str(mock_mirobo_is_on.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_MOVE_REMOTE_CONTROL,
|
|
{"duration": 1000, "rotation": -40, "velocity": -0.1}, blocking=True)
|
|
assert ('call.Vacuum().manual_control('
|
|
in str(mock_mirobo_is_on.mock_calls[-2]))
|
|
assert 'duration=1000' in str(mock_mirobo_is_on.mock_calls[-2])
|
|
assert 'rotation=-40' in str(mock_mirobo_is_on.mock_calls[-2])
|
|
assert 'velocity=-0.1' in str(mock_mirobo_is_on.mock_calls[-2])
|
|
assert str(mock_mirobo_is_on.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_STOP_REMOTE_CONTROL, {}, blocking=True)
|
|
assert (str(mock_mirobo_is_on.mock_calls[-2])
|
|
== "call.Vacuum().manual_stop()")
|
|
assert str(mock_mirobo_is_on.mock_calls[-1]) == 'call.Vacuum().status()'
|
|
|
|
yield from hass.services.async_call(
|
|
DOMAIN, SERVICE_MOVE_REMOTE_CONTROL_STEP,
|
|
{"duration": 2000, "rotation": 120, "velocity": 0.1}, blocking=True)
|
|
assert ('call.Vacuum().manual_control_once('
|
|
in str(mock_mirobo_is_on.mock_calls[-2]))
|
|
assert 'duration=2000' in str(mock_mirobo_is_on.mock_calls[-2])
|
|
assert 'rotation=120' in str(mock_mirobo_is_on.mock_calls[-2])
|
|
assert 'velocity=0.1' in str(mock_mirobo_is_on.mock_calls[-2])
|
|
assert str(mock_mirobo_is_on.mock_calls[-1]) == 'call.Vacuum().status()'
|