mirror of
https://github.com/home-assistant/core
synced 2024-09-18 19:55:20 +02:00
b1c0cabe6c
* Fix MQTT retained message not being re-dispatched * Fix tests * Use paho-mqtt for retained messages * Improve code style * Store list of subscribers * Fix lint error * Adhere to Home Assistant's logging standard "Try to avoid brackets and additional quotes around the output to make it easier for users to parse the log." - https://home-assistant.io/developers/development_guidelines/ * Add reconnect tests * Fix lint error * Introduce Subscription Tests still need to be updated * Use namedtuple for MQTT messages ... And fix issues Accessing the config manually at runtime isn't ideal * Fix MQTT __init__.py tests * Updated usage of Mocks * Moved tests that were testing subscriptions out of the MQTTComponent test, because of how mock.patch was used * Adjusted the remaining tests for the MQTT clients new behavior - e.g. self.progress was removed * Updated the async_fire_mqtt_message helper * ✅ Update MQTT tests * Re-introduce the MQTT subscriptions through the dispatcher for tests - quite ugly though... 🚧 * Update fixtures to use our new MQTT mock 🎨 * 📝 Update base code according to comments * 🔨 Adjust MQTT test base * 🔨 Update other MQTT tests * 🍎 Fix carriage return in source files Apparently test_mqtt_json.py and test_mqtt_template.py were written on Windows. In order to not mess up the diff, I'll just redo the carriage return. * 🎨 Remove unused import * 📝 Remove fire_mqtt_client_message * 🐛 Fix using python 3.6 method What's very interesting is that 3.4 didn't fail on travis... * 🐛 Fix using assert directly
257 lines
10 KiB
Python
257 lines
10 KiB
Python
"""The tests for the Demo vacuum platform."""
|
|
import unittest
|
|
|
|
from homeassistant.components import vacuum
|
|
from homeassistant.components.vacuum import (
|
|
ATTR_BATTERY_LEVEL, ATTR_BATTERY_ICON, ATTR_STATUS,
|
|
ATTR_FAN_SPEED, mqtt)
|
|
from homeassistant.components.mqtt import CONF_COMMAND_TOPIC
|
|
from homeassistant.const import (
|
|
CONF_PLATFORM, STATE_OFF, STATE_ON, STATE_UNAVAILABLE, CONF_NAME)
|
|
from homeassistant.setup import setup_component
|
|
from tests.common import (
|
|
fire_mqtt_message, get_test_home_assistant, mock_mqtt_component)
|
|
|
|
|
|
class TestVacuumMQTT(unittest.TestCase):
|
|
"""MQTT vacuum component test class."""
|
|
|
|
def setUp(self): # pylint: disable=invalid-name
|
|
"""Set up things to be run when tests are started."""
|
|
self.hass = get_test_home_assistant()
|
|
self.mock_publish = mock_mqtt_component(self.hass)
|
|
|
|
self.default_config = {
|
|
CONF_PLATFORM: 'mqtt',
|
|
CONF_NAME: 'mqtttest',
|
|
CONF_COMMAND_TOPIC: 'vacuum/command',
|
|
mqtt.CONF_SEND_COMMAND_TOPIC: 'vacuum/send_command',
|
|
mqtt.CONF_BATTERY_LEVEL_TOPIC: 'vacuum/state',
|
|
mqtt.CONF_BATTERY_LEVEL_TEMPLATE:
|
|
'{{ value_json.battery_level }}',
|
|
mqtt.CONF_CHARGING_TOPIC: 'vacuum/state',
|
|
mqtt.CONF_CHARGING_TEMPLATE: '{{ value_json.charging }}',
|
|
mqtt.CONF_CLEANING_TOPIC: 'vacuum/state',
|
|
mqtt.CONF_CLEANING_TEMPLATE: '{{ value_json.cleaning }}',
|
|
mqtt.CONF_DOCKED_TOPIC: 'vacuum/state',
|
|
mqtt.CONF_DOCKED_TEMPLATE: '{{ value_json.docked }}',
|
|
mqtt.CONF_STATE_TOPIC: 'vacuum/state',
|
|
mqtt.CONF_STATE_TEMPLATE: '{{ value_json.state }}',
|
|
mqtt.CONF_FAN_SPEED_TOPIC: 'vacuum/state',
|
|
mqtt.CONF_FAN_SPEED_TEMPLATE: '{{ value_json.fan_speed }}',
|
|
mqtt.CONF_SET_FAN_SPEED_TOPIC: 'vacuum/set_fan_speed',
|
|
mqtt.CONF_FAN_SPEED_LIST: ['min', 'medium', 'high', 'max'],
|
|
}
|
|
|
|
def tearDown(self): # pylint: disable=invalid-name
|
|
"""Stop down everything that was started."""
|
|
self.hass.stop()
|
|
|
|
def test_default_supported_features(self):
|
|
"""Test that the correct supported features."""
|
|
self.assertTrue(setup_component(self.hass, vacuum.DOMAIN, {
|
|
vacuum.DOMAIN: self.default_config,
|
|
}))
|
|
entity = self.hass.states.get('vacuum.mqtttest')
|
|
entity_features = \
|
|
entity.attributes.get(mqtt.CONF_SUPPORTED_FEATURES, 0)
|
|
self.assertListEqual(sorted(mqtt.services_to_strings(entity_features)),
|
|
sorted(['turn_on', 'turn_off', 'stop',
|
|
'return_home', 'battery', 'status',
|
|
'clean_spot']))
|
|
|
|
def test_all_commands(self):
|
|
"""Test simple commands to the vacuum."""
|
|
self.default_config[mqtt.CONF_SUPPORTED_FEATURES] = \
|
|
mqtt.services_to_strings(mqtt.ALL_SERVICES)
|
|
|
|
self.assertTrue(setup_component(self.hass, vacuum.DOMAIN, {
|
|
vacuum.DOMAIN: self.default_config,
|
|
}))
|
|
|
|
vacuum.turn_on(self.hass, 'vacuum.mqtttest')
|
|
self.hass.block_till_done()
|
|
self.mock_publish.async_publish.assert_called_once_with(
|
|
'vacuum/command', 'turn_on', 0, False)
|
|
self.mock_publish.async_publish.reset_mock()
|
|
|
|
vacuum.turn_off(self.hass, 'vacuum.mqtttest')
|
|
self.hass.block_till_done()
|
|
self.mock_publish.async_publish.assert_called_once_with(
|
|
'vacuum/command', 'turn_off', 0, False)
|
|
self.mock_publish.async_publish.reset_mock()
|
|
|
|
vacuum.stop(self.hass, 'vacuum.mqtttest')
|
|
self.hass.block_till_done()
|
|
self.mock_publish.async_publish.assert_called_once_with(
|
|
'vacuum/command', 'stop', 0, False)
|
|
self.mock_publish.async_publish.reset_mock()
|
|
|
|
vacuum.clean_spot(self.hass, 'vacuum.mqtttest')
|
|
self.hass.block_till_done()
|
|
self.mock_publish.async_publish.assert_called_once_with(
|
|
'vacuum/command', 'clean_spot', 0, False)
|
|
self.mock_publish.async_publish.reset_mock()
|
|
|
|
vacuum.locate(self.hass, 'vacuum.mqtttest')
|
|
self.hass.block_till_done()
|
|
self.mock_publish.async_publish.assert_called_once_with(
|
|
'vacuum/command', 'locate', 0, False)
|
|
self.mock_publish.async_publish.reset_mock()
|
|
|
|
vacuum.start_pause(self.hass, 'vacuum.mqtttest')
|
|
self.hass.block_till_done()
|
|
self.mock_publish.async_publish.assert_called_once_with(
|
|
'vacuum/command', 'start_pause', 0, False)
|
|
self.mock_publish.async_publish.reset_mock()
|
|
|
|
vacuum.return_to_base(self.hass, 'vacuum.mqtttest')
|
|
self.hass.block_till_done()
|
|
self.mock_publish.async_publish.assert_called_once_with(
|
|
'vacuum/command', 'return_to_base', 0, False)
|
|
self.mock_publish.async_publish.reset_mock()
|
|
|
|
vacuum.set_fan_speed(self.hass, 'high', 'vacuum.mqtttest')
|
|
self.hass.block_till_done()
|
|
self.mock_publish.async_publish.assert_called_once_with(
|
|
'vacuum/set_fan_speed', 'high', 0, False)
|
|
self.mock_publish.async_publish.reset_mock()
|
|
|
|
vacuum.send_command(self.hass, '44 FE 93', entity_id='vacuum.mqtttest')
|
|
self.hass.block_till_done()
|
|
self.mock_publish.async_publish.assert_called_once_with(
|
|
'vacuum/send_command', '44 FE 93', 0, False)
|
|
|
|
def test_status(self):
|
|
"""Test status updates from the vacuum."""
|
|
self.default_config[mqtt.CONF_SUPPORTED_FEATURES] = \
|
|
mqtt.services_to_strings(mqtt.ALL_SERVICES)
|
|
|
|
self.assertTrue(setup_component(self.hass, vacuum.DOMAIN, {
|
|
vacuum.DOMAIN: self.default_config,
|
|
}))
|
|
|
|
message = """{
|
|
"battery_level": 54,
|
|
"cleaning": true,
|
|
"docked": false,
|
|
"charging": false,
|
|
"fan_speed": "max"
|
|
}"""
|
|
fire_mqtt_message(self.hass, 'vacuum/state', message)
|
|
self.hass.block_till_done()
|
|
state = self.hass.states.get('vacuum.mqtttest')
|
|
self.assertEqual(STATE_ON, state.state)
|
|
self.assertEqual(
|
|
'mdi:battery-50',
|
|
state.attributes.get(ATTR_BATTERY_ICON)
|
|
)
|
|
self.assertEqual(54, state.attributes.get(ATTR_BATTERY_LEVEL))
|
|
self.assertEqual('max', state.attributes.get(ATTR_FAN_SPEED))
|
|
|
|
message = """{
|
|
"battery_level": 61,
|
|
"docked": true,
|
|
"cleaning": false,
|
|
"charging": true,
|
|
"fan_speed": "min"
|
|
}"""
|
|
|
|
fire_mqtt_message(self.hass, 'vacuum/state', message)
|
|
self.hass.block_till_done()
|
|
state = self.hass.states.get('vacuum.mqtttest')
|
|
self.assertEqual(STATE_OFF, state.state)
|
|
self.assertEqual(
|
|
'mdi:battery-charging-60',
|
|
state.attributes.get(ATTR_BATTERY_ICON)
|
|
)
|
|
self.assertEqual(61, state.attributes.get(ATTR_BATTERY_LEVEL))
|
|
self.assertEqual('min', state.attributes.get(ATTR_FAN_SPEED))
|
|
|
|
def test_battery_template(self):
|
|
"""Test that you can use non-default templates for battery_level."""
|
|
self.default_config.update({
|
|
mqtt.CONF_SUPPORTED_FEATURES:
|
|
mqtt.services_to_strings(mqtt.ALL_SERVICES),
|
|
mqtt.CONF_BATTERY_LEVEL_TOPIC: "retroroomba/battery_level",
|
|
mqtt.CONF_BATTERY_LEVEL_TEMPLATE: "{{ value }}"
|
|
})
|
|
|
|
self.assertTrue(setup_component(self.hass, vacuum.DOMAIN, {
|
|
vacuum.DOMAIN: self.default_config,
|
|
}))
|
|
|
|
fire_mqtt_message(self.hass, 'retroroomba/battery_level', '54')
|
|
self.hass.block_till_done()
|
|
state = self.hass.states.get('vacuum.mqtttest')
|
|
self.assertEqual(54, state.attributes.get(ATTR_BATTERY_LEVEL))
|
|
self.assertEqual(state.attributes.get(ATTR_BATTERY_ICON),
|
|
'mdi:battery-50')
|
|
|
|
def test_status_invalid_json(self):
|
|
"""Test to make sure nothing breaks if the vacuum sends bad JSON."""
|
|
self.default_config[mqtt.CONF_SUPPORTED_FEATURES] = \
|
|
mqtt.services_to_strings(mqtt.ALL_SERVICES)
|
|
|
|
self.assertTrue(setup_component(self.hass, vacuum.DOMAIN, {
|
|
vacuum.DOMAIN: self.default_config,
|
|
}))
|
|
|
|
fire_mqtt_message(self.hass, 'vacuum/state', '{"asdfasas false}')
|
|
self.hass.block_till_done()
|
|
state = self.hass.states.get('vacuum.mqtttest')
|
|
self.assertEqual(STATE_OFF, state.state)
|
|
self.assertEqual("Stopped", state.attributes.get(ATTR_STATUS))
|
|
|
|
def test_default_availability_payload(self):
|
|
"""Test availability by default payload with defined topic."""
|
|
self.default_config.update({
|
|
'availability_topic': 'availability-topic'
|
|
})
|
|
|
|
self.assertTrue(setup_component(self.hass, vacuum.DOMAIN, {
|
|
vacuum.DOMAIN: self.default_config,
|
|
}))
|
|
|
|
state = self.hass.states.get('vacuum.mqtttest')
|
|
self.assertEqual(STATE_UNAVAILABLE, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'availability-topic', 'online')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('vacuum.mqtttest')
|
|
self.assertNotEqual(STATE_UNAVAILABLE, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'availability-topic', 'offline')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('vacuum.mqtttest')
|
|
self.assertEqual(STATE_UNAVAILABLE, state.state)
|
|
|
|
def test_custom_availability_payload(self):
|
|
"""Test availability by custom payload with defined topic."""
|
|
self.default_config.update({
|
|
'availability_topic': 'availability-topic',
|
|
'payload_available': 'good',
|
|
'payload_not_available': 'nogood'
|
|
})
|
|
|
|
self.assertTrue(setup_component(self.hass, vacuum.DOMAIN, {
|
|
vacuum.DOMAIN: self.default_config,
|
|
}))
|
|
|
|
state = self.hass.states.get('vacuum.mqtttest')
|
|
self.assertEqual(STATE_UNAVAILABLE, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'availability-topic', 'good')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('vacuum.mqtttest')
|
|
self.assertNotEqual(STATE_UNAVAILABLE, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'availability-topic', 'nogood')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('vacuum.mqtttest')
|
|
self.assertEqual(STATE_UNAVAILABLE, state.state)
|