/
test_vacuum.py
445 lines (353 loc) · 13.2 KB
/
test_vacuum.py
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
"""The tests for the Template vacuum platform."""
import logging
import pytest
from homeassistant import setup
from homeassistant.const import (STATE_ON, STATE_UNKNOWN)
from homeassistant.components.vacuum import (
ATTR_BATTERY_LEVEL, STATE_CLEANING, STATE_DOCKED, STATE_IDLE,
STATE_PAUSED, STATE_RETURNING)
from tests.common import (
async_mock_service, assert_setup_component)
from tests.components.vacuum import common
_LOGGER = logging.getLogger(__name__)
_TEST_VACUUM = 'vacuum.test_vacuum'
_STATE_INPUT_SELECT = 'input_select.state'
_SPOT_CLEANING_INPUT_BOOLEAN = 'input_boolean.spot_cleaning'
_LOCATING_INPUT_BOOLEAN = 'input_boolean.locating'
_FAN_SPEED_INPUT_SELECT = 'input_select.fan_speed'
_BATTERY_LEVEL_INPUT_NUMBER = 'input_number.battery_level'
@pytest.fixture
def calls(hass):
"""Track calls to a mock service."""
return async_mock_service(hass, 'test', 'automation')
# Configuration tests #
async def test_missing_optional_config(hass, calls):
"""Test: missing optional template is ok."""
with assert_setup_component(1, 'vacuum'):
assert await setup.async_setup_component(hass, 'vacuum', {
'vacuum': {
'platform': 'template',
'vacuums': {
'test_vacuum': {
'start': {
'service': 'script.vacuum_start'
}
}
}
}
})
await hass.async_start()
await hass.async_block_till_done()
_verify(hass, STATE_UNKNOWN, None)
async def test_missing_start_config(hass, calls):
"""Test: missing 'start' will fail."""
with assert_setup_component(0, 'vacuum'):
assert await setup.async_setup_component(hass, 'vacuum', {
'vacuum': {
'platform': 'template',
'vacuums': {
'test_vacuum': {
'value_template': "{{ 'on' }}"
}
}
}
})
await hass.async_start()
await hass.async_block_till_done()
assert hass.states.async_all() == []
async def test_invalid_config(hass, calls):
"""Test: invalid config structure will fail."""
with assert_setup_component(0, 'vacuum'):
assert await setup.async_setup_component(hass, 'vacuum', {
'platform': 'template',
'vacuums': {
'test_vacuum': {
'start': {
'service': 'script.vacuum_start'
}
}
}
})
await hass.async_start()
await hass.async_block_till_done()
assert hass.states.async_all() == []
# End of configuration tests #
# Template tests #
async def test_templates_with_entities(hass, calls):
"""Test templates with values from other entities."""
with assert_setup_component(1, 'vacuum'):
assert await setup.async_setup_component(hass, 'vacuum', {
'vacuum': {
'platform': 'template',
'vacuums': {
'test_vacuum': {
'value_template': "{{ states('input_select.state') }}",
'battery_level_template':
"{{ states('input_number.battery_level') }}",
'start': {
'service': 'script.vacuum_start'
}
}
}
}
})
await hass.async_start()
await hass.async_block_till_done()
_verify(hass, STATE_UNKNOWN, None)
hass.states.async_set(_STATE_INPUT_SELECT, STATE_CLEANING)
hass.states.async_set(_BATTERY_LEVEL_INPUT_NUMBER, 100)
await hass.async_block_till_done()
_verify(hass, STATE_CLEANING, 100)
async def test_templates_with_valid_values(hass, calls):
"""Test templates with valid values."""
with assert_setup_component(1, 'vacuum'):
assert await setup.async_setup_component(hass, 'vacuum', {
'vacuum': {
'platform': 'template',
'vacuums': {
'test_vacuum': {
'value_template': "{{ 'cleaning' }}",
'battery_level_template':
"{{ 100 }}",
'start': {
'service': 'script.vacuum_start'
}
}
}
}
})
await hass.async_start()
await hass.async_block_till_done()
_verify(hass, STATE_CLEANING, 100)
async def test_templates_invalid_values(hass, calls):
"""Test templates with invalid values."""
with assert_setup_component(1, 'vacuum'):
assert await setup.async_setup_component(hass, 'vacuum', {
'vacuum': {
'platform': 'template',
'vacuums': {
'test_vacuum': {
'value_template': "{{ 'abc' }}",
'battery_level_template':
"{{ 101 }}",
'start': {
'service': 'script.vacuum_start'
}
}
}
}
})
await hass.async_start()
await hass.async_block_till_done()
_verify(hass, STATE_UNKNOWN, None)
# End of template tests #
# Function tests #
async def test_state_services(hass, calls):
"""Test state services."""
await _register_components(hass)
# Start vacuum
common.async_start(hass, _TEST_VACUUM)
await hass.async_block_till_done()
# verify
assert hass.states.get(_STATE_INPUT_SELECT).state == STATE_CLEANING
_verify(hass, STATE_CLEANING, None)
# Pause vacuum
common.async_pause(hass, _TEST_VACUUM)
await hass.async_block_till_done()
# verify
assert hass.states.get(_STATE_INPUT_SELECT).state == STATE_PAUSED
_verify(hass, STATE_PAUSED, None)
# Stop vacuum
common.async_stop(hass, _TEST_VACUUM)
await hass.async_block_till_done()
# verify
assert hass.states.get(_STATE_INPUT_SELECT).state == STATE_IDLE
_verify(hass, STATE_IDLE, None)
# Return vacuum to base
common.async_return_to_base(hass, _TEST_VACUUM)
await hass.async_block_till_done()
# verify
assert hass.states.get(_STATE_INPUT_SELECT).state == STATE_RETURNING
_verify(hass, STATE_RETURNING, None)
async def test_unused_services(hass, calls):
"""Test calling unused services should not crash."""
await _register_basic_vacuum(hass)
# Pause vacuum
common.async_pause(hass, _TEST_VACUUM)
await hass.async_block_till_done()
# Stop vacuum
common.async_stop(hass, _TEST_VACUUM)
await hass.async_block_till_done()
# Return vacuum to base
common.async_return_to_base(hass, _TEST_VACUUM)
await hass.async_block_till_done()
# Spot cleaning
common.async_clean_spot(hass, _TEST_VACUUM)
await hass.async_block_till_done()
# Locate vacuum
common.async_locate(hass, _TEST_VACUUM)
await hass.async_block_till_done()
# Set fan's speed
common.async_set_fan_speed(hass, 'medium', _TEST_VACUUM)
await hass.async_block_till_done()
async def test_clean_spot_service(hass, calls):
"""Test clean spot service."""
await _register_components(hass)
# Clean spot
common.async_clean_spot(hass, _TEST_VACUUM)
await hass.async_block_till_done()
# verify
assert hass.states.get(_SPOT_CLEANING_INPUT_BOOLEAN).state == STATE_ON
async def test_locate_service(hass, calls):
"""Test locate service."""
await _register_components(hass)
# Locate vacuum
common.async_locate(hass, _TEST_VACUUM)
await hass.async_block_till_done()
# verify
assert hass.states.get(_LOCATING_INPUT_BOOLEAN).state == STATE_ON
async def test_set_fan_speed(hass, calls):
"""Test set valid fan speed."""
await _register_components(hass)
# Set vacuum's fan speed to high
common.async_set_fan_speed(hass, 'high', _TEST_VACUUM)
await hass.async_block_till_done()
# verify
assert hass.states.get(_FAN_SPEED_INPUT_SELECT).state == 'high'
# Set fan's speed to medium
common.async_set_fan_speed(hass, 'medium', _TEST_VACUUM)
await hass.async_block_till_done()
# verify
assert hass.states.get(_FAN_SPEED_INPUT_SELECT).state == 'medium'
async def test_set_invalid_fan_speed(hass, calls):
"""Test set invalid fan speed when fan has valid speed."""
await _register_components(hass)
# Set vacuum's fan speed to high
common.async_set_fan_speed(hass, 'high', _TEST_VACUUM)
await hass.async_block_till_done()
# verify
assert hass.states.get(_FAN_SPEED_INPUT_SELECT).state == 'high'
# Set vacuum's fan speed to 'invalid'
common.async_set_fan_speed(hass, 'invalid', _TEST_VACUUM)
await hass.async_block_till_done()
# verify fan speed is unchanged
assert hass.states.get(_FAN_SPEED_INPUT_SELECT).state == 'high'
def _verify(hass, expected_state, expected_battery_level):
"""Verify vacuum's state and speed."""
state = hass.states.get(_TEST_VACUUM)
attributes = state.attributes
assert state.state == expected_state
assert attributes.get(ATTR_BATTERY_LEVEL) == expected_battery_level
async def _register_basic_vacuum(hass):
"""Register basic vacuum with only required options for testing."""
with assert_setup_component(1, 'input_select'):
assert await setup.async_setup_component(hass, 'input_select', {
'input_select': {
'state': {
'name': 'State',
'options': [STATE_CLEANING]
}
}
})
with assert_setup_component(1, 'vacuum'):
assert await setup.async_setup_component(hass, 'vacuum', {
'vacuum': {
'platform': 'template',
'vacuums': {
'test_vacuum': {
'start': {
'service': 'input_select.select_option',
'data': {
'entity_id': _STATE_INPUT_SELECT,
'option': STATE_CLEANING
}
}
}
}
}
})
await hass.async_start()
await hass.async_block_till_done()
async def _register_components(hass):
"""Register basic components for testing."""
with assert_setup_component(2, 'input_boolean'):
assert await setup.async_setup_component(hass, 'input_boolean', {
'input_boolean': {
'spot_cleaning': None,
'locating': None
}
})
with assert_setup_component(2, 'input_select'):
assert await setup.async_setup_component(hass, 'input_select', {
'input_select': {
'state': {
'name': 'State',
'options': [STATE_CLEANING, STATE_DOCKED, STATE_IDLE,
STATE_PAUSED, STATE_RETURNING]
},
'fan_speed': {
'name': 'Fan speed',
'options': ['', 'low', 'medium', 'high']
}
}
})
with assert_setup_component(1, 'vacuum'):
test_vacuum_config = {
'value_template': "{{ states('input_select.state') }}",
'fan_speed_template':
"{{ states('input_select.fan_speed') }}",
'start': {
'service': 'input_select.select_option',
'data': {
'entity_id': _STATE_INPUT_SELECT,
'option': STATE_CLEANING
}
},
'pause': {
'service': 'input_select.select_option',
'data': {
'entity_id': _STATE_INPUT_SELECT,
'option': STATE_PAUSED
}
},
'stop': {
'service': 'input_select.select_option',
'data': {
'entity_id': _STATE_INPUT_SELECT,
'option': STATE_IDLE
}
},
'return_to_base': {
'service': 'input_select.select_option',
'data': {
'entity_id': _STATE_INPUT_SELECT,
'option': STATE_RETURNING
}
},
'clean_spot': {
'service': 'input_boolean.turn_on',
'entity_id': _SPOT_CLEANING_INPUT_BOOLEAN
},
'locate': {
'service': 'input_boolean.turn_on',
'entity_id': _LOCATING_INPUT_BOOLEAN
},
'set_fan_speed': {
'service': 'input_select.select_option',
'data_template': {
'entity_id': _FAN_SPEED_INPUT_SELECT,
'option': '{{ fan_speed }}'
}
},
'fan_speeds': ['low', 'medium', 'high']
}
assert await setup.async_setup_component(hass, 'vacuum', {
'vacuum': {
'platform': 'template',
'vacuums': {
'test_vacuum': test_vacuum_config
}
}
})
await hass.async_start()
await hass.async_block_till_done()