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
244 lines
8.6 KiB
Python
244 lines
8.6 KiB
Python
"""The tests for the MQTT switch platform."""
|
|
import unittest
|
|
|
|
from homeassistant.setup import setup_component
|
|
from homeassistant.const import STATE_ON, STATE_OFF, STATE_UNAVAILABLE,\
|
|
ATTR_ASSUMED_STATE
|
|
import homeassistant.components.switch as switch
|
|
from tests.common import (
|
|
mock_mqtt_component, fire_mqtt_message, get_test_home_assistant)
|
|
|
|
|
|
class TestSwitchMQTT(unittest.TestCase):
|
|
"""Test the MQTT switch."""
|
|
|
|
def setUp(self): # pylint: disable=invalid-name
|
|
"""Setup things to be run when tests are started."""
|
|
self.hass = get_test_home_assistant()
|
|
self.mock_publish = mock_mqtt_component(self.hass)
|
|
|
|
def tearDown(self): # pylint: disable=invalid-name
|
|
""""Stop everything that was started."""
|
|
self.hass.stop()
|
|
|
|
def test_controlling_state_via_topic(self):
|
|
"""Test the controlling state via topic."""
|
|
assert setup_component(self.hass, switch.DOMAIN, {
|
|
switch.DOMAIN: {
|
|
'platform': 'mqtt',
|
|
'name': 'test',
|
|
'state_topic': 'state-topic',
|
|
'command_topic': 'command-topic',
|
|
'payload_on': 1,
|
|
'payload_off': 0
|
|
}
|
|
})
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_OFF, state.state)
|
|
self.assertFalse(state.attributes.get(ATTR_ASSUMED_STATE))
|
|
|
|
fire_mqtt_message(self.hass, 'state-topic', '1')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_ON, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'state-topic', '0')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_OFF, state.state)
|
|
|
|
def test_sending_mqtt_commands_and_optimistic(self):
|
|
"""Test the sending MQTT commands in optimistic mode."""
|
|
assert setup_component(self.hass, switch.DOMAIN, {
|
|
switch.DOMAIN: {
|
|
'platform': 'mqtt',
|
|
'name': 'test',
|
|
'command_topic': 'command-topic',
|
|
'payload_on': 'beer on',
|
|
'payload_off': 'beer off',
|
|
'qos': '2'
|
|
}
|
|
})
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_OFF, state.state)
|
|
self.assertTrue(state.attributes.get(ATTR_ASSUMED_STATE))
|
|
|
|
switch.turn_on(self.hass, 'switch.test')
|
|
self.hass.block_till_done()
|
|
|
|
self.mock_publish.async_publish.assert_called_once_with(
|
|
'command-topic', 'beer on', 2, False)
|
|
self.mock_publish.async_publish.reset_mock()
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_ON, state.state)
|
|
|
|
switch.turn_off(self.hass, 'switch.test')
|
|
self.hass.block_till_done()
|
|
|
|
self.mock_publish.async_publish.assert_called_once_with(
|
|
'command-topic', 'beer off', 2, False)
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_OFF, state.state)
|
|
|
|
def test_controlling_state_via_topic_and_json_message(self):
|
|
"""Test the controlling state via topic and JSON message."""
|
|
assert setup_component(self.hass, switch.DOMAIN, {
|
|
switch.DOMAIN: {
|
|
'platform': 'mqtt',
|
|
'name': 'test',
|
|
'state_topic': 'state-topic',
|
|
'command_topic': 'command-topic',
|
|
'payload_on': 'beer on',
|
|
'payload_off': 'beer off',
|
|
'value_template': '{{ value_json.val }}'
|
|
}
|
|
})
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_OFF, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'state-topic', '{"val":"beer on"}')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_ON, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'state-topic', '{"val":"beer off"}')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_OFF, state.state)
|
|
|
|
def test_controlling_availability(self):
|
|
"""Test the controlling state via topic."""
|
|
assert setup_component(self.hass, switch.DOMAIN, {
|
|
switch.DOMAIN: {
|
|
'platform': 'mqtt',
|
|
'name': 'test',
|
|
'state_topic': 'state-topic',
|
|
'command_topic': 'command-topic',
|
|
'availability_topic': 'availability_topic',
|
|
'payload_on': 1,
|
|
'payload_off': 0,
|
|
'payload_available': 1,
|
|
'payload_not_available': 0
|
|
}
|
|
})
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_UNAVAILABLE, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'availability_topic', '1')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_OFF, state.state)
|
|
self.assertFalse(state.attributes.get(ATTR_ASSUMED_STATE))
|
|
|
|
fire_mqtt_message(self.hass, 'availability_topic', '0')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_UNAVAILABLE, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'state-topic', '1')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_UNAVAILABLE, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'availability_topic', '1')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_ON, state.state)
|
|
|
|
def test_default_availability_payload(self):
|
|
"""Test the availability payload."""
|
|
assert setup_component(self.hass, switch.DOMAIN, {
|
|
switch.DOMAIN: {
|
|
'platform': 'mqtt',
|
|
'name': 'test',
|
|
'state_topic': 'state-topic',
|
|
'command_topic': 'command-topic',
|
|
'availability_topic': 'availability_topic',
|
|
'payload_on': 1,
|
|
'payload_off': 0
|
|
}
|
|
})
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_UNAVAILABLE, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'availability_topic', 'online')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_OFF, state.state)
|
|
self.assertFalse(state.attributes.get(ATTR_ASSUMED_STATE))
|
|
|
|
fire_mqtt_message(self.hass, 'availability_topic', 'offline')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_UNAVAILABLE, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'state-topic', '1')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_UNAVAILABLE, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'availability_topic', 'online')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_ON, state.state)
|
|
|
|
def test_custom_availability_payload(self):
|
|
"""Test the availability payload."""
|
|
assert setup_component(self.hass, switch.DOMAIN, {
|
|
switch.DOMAIN: {
|
|
'platform': 'mqtt',
|
|
'name': 'test',
|
|
'state_topic': 'state-topic',
|
|
'command_topic': 'command-topic',
|
|
'availability_topic': 'availability_topic',
|
|
'payload_on': 1,
|
|
'payload_off': 0,
|
|
'payload_available': 'good',
|
|
'payload_not_available': 'nogood'
|
|
}
|
|
})
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_UNAVAILABLE, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'availability_topic', 'good')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_OFF, state.state)
|
|
self.assertFalse(state.attributes.get(ATTR_ASSUMED_STATE))
|
|
|
|
fire_mqtt_message(self.hass, 'availability_topic', 'nogood')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_UNAVAILABLE, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'state-topic', '1')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_UNAVAILABLE, state.state)
|
|
|
|
fire_mqtt_message(self.hass, 'availability_topic', 'good')
|
|
self.hass.block_till_done()
|
|
|
|
state = self.hass.states.get('switch.test')
|
|
self.assertEqual(STATE_ON, state.state)
|