Fix PEP257 issues
This commit is contained in:
1 parent
d6eab03a61
commit
9838697d2b
120 files changed
+1447
-1297
No files matched your search
@@ -1,9 +1,4 @@
|
||||
"""
|
||||
tests.components.test_mqtt
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Tests MQTT component.
|
||||
"""
|
||||
"""The tests for the MQTT component."""
|
||||
from collections import namedtuple
|
||||
import unittest
|
||||
from unittest import mock
|
||||
@@ -19,26 +14,30 @@ from tests.common import (
|
||||
|
||||
|
||||
class TestMQTT(unittest.TestCase):
|
||||
""" Test the MQTT module. """
|
||||
"""Test the MQTT component."""
|
||||
|
||||
def setUp(self): # pylint: disable=invalid-name
|
||||
"""Setup things to be run when tests are started."""
|
||||
self.hass = get_test_home_assistant(1)
|
||||
mock_mqtt_component(self.hass)
|
||||
self.calls = []
|
||||
|
||||
def tearDown(self): # pylint: disable=invalid-name
|
||||
""" Stop down stuff we started. """
|
||||
"""Stop everything that was started."""
|
||||
self.hass.stop()
|
||||
|
||||
def record_calls(self, *args):
|
||||
"""Helper for recording calls."""
|
||||
self.calls.append(args)
|
||||
|
||||
def test_client_starts_on_home_assistant_start(self):
|
||||
""""Test if client start on HA launch."""
|
||||
self.hass.bus.fire(EVENT_HOMEASSISTANT_START)
|
||||
self.hass.pool.block_till_done()
|
||||
self.assertTrue(mqtt.MQTT_CLIENT.start.called)
|
||||
|
||||
def test_client_stops_on_home_assistant_start(self):
|
||||
"""Test if client stops on HA launch."""
|
||||
self.hass.bus.fire(EVENT_HOMEASSISTANT_START)
|
||||
self.hass.pool.block_till_done()
|
||||
self.hass.bus.fire(EVENT_HOMEASSISTANT_STOP)
|
||||
@@ -46,9 +45,11 @@ class TestMQTT(unittest.TestCase):
|
||||
self.assertTrue(mqtt.MQTT_CLIENT.stop.called)
|
||||
|
||||
def test_setup_fails_if_no_broker_config(self):
|
||||
"""Test for setup failure if broker configuration is missing."""
|
||||
self.assertFalse(mqtt.setup(self.hass, {mqtt.DOMAIN: {}}))
|
||||
|
||||
def test_setup_fails_if_no_connect_broker(self):
|
||||
"""Test for setup failure if connection to broker is missing."""
|
||||
with mock.patch('homeassistant.components.mqtt.MQTT',
|
||||
side_effect=socket.error()):
|
||||
self.assertFalse(mqtt.setup(self.hass, {mqtt.DOMAIN: {
|
||||
@@ -56,6 +57,7 @@ class TestMQTT(unittest.TestCase):
|
||||
}}))
|
||||
|
||||
def test_publish_calls_service(self):
|
||||
"""Test the publishing of call to services."""
|
||||
self.hass.bus.listen_once(EVENT_CALL_SERVICE, self.record_calls)
|
||||
|
||||
mqtt.publish(self.hass, 'test-topic', 'test-payload')
|
||||
@@ -71,6 +73,7 @@ class TestMQTT(unittest.TestCase):
|
||||
self.calls[0][0].data['service_data'][mqtt.ATTR_PAYLOAD])
|
||||
|
||||
def test_service_call_without_topic_does_not_publish(self):
|
||||
"""Test the service call if topic is missing."""
|
||||
self.hass.bus.fire(EVENT_CALL_SERVICE, {
|
||||
ATTR_DOMAIN: mqtt.DOMAIN,
|
||||
ATTR_SERVICE: mqtt.SERVICE_PUBLISH
|
||||
@@ -79,7 +82,8 @@ class TestMQTT(unittest.TestCase):
|
||||
self.assertTrue(not mqtt.MQTT_CLIENT.publish.called)
|
||||
|
||||
def test_service_call_with_template_payload_renders_template(self):
|
||||
"""
|
||||
"""Test the service call with rendered template.
|
||||
|
||||
If 'payload_template' is provided and 'payload' is not, then render it.
|
||||
"""
|
||||
mqtt.publish_template(self.hass, "test/topic", "{{ 1+1 }}")
|
||||
@@ -88,7 +92,8 @@ class TestMQTT(unittest.TestCase):
|
||||
self.assertEqual(mqtt.MQTT_CLIENT.publish.call_args[0][1], "2")
|
||||
|
||||
def test_service_call_with_payload_doesnt_render_template(self):
|
||||
"""
|
||||
"""Test the service call with unrendered template.
|
||||
|
||||
If a 'payload' is provided then use that instead of 'payload_template'.
|
||||
"""
|
||||
payload = "not a template"
|
||||
@@ -104,7 +109,8 @@ class TestMQTT(unittest.TestCase):
|
||||
self.assertEqual(mqtt.MQTT_CLIENT.publish.call_args[0][1], payload)
|
||||
|
||||
def test_service_call_without_payload_or_payload_template(self):
|
||||
"""
|
||||
"""Test the service call without payload or payload template.
|
||||
|
||||
If neither 'payload' or 'payload_template' is provided then fail.
|
||||
"""
|
||||
# Call the service directly because the helper functions require you to
|
||||
@@ -115,6 +121,7 @@ class TestMQTT(unittest.TestCase):
|
||||
self.assertFalse(mqtt.MQTT_CLIENT.publish.called)
|
||||
|
||||
def test_subscribe_topic(self):
|
||||
"""Test the subscription of a topic."""
|
||||
mqtt.subscribe(self.hass, 'test-topic', self.record_calls)
|
||||
|
||||
fire_mqtt_message(self.hass, 'test-topic', 'test-payload')
|
||||
@@ -125,6 +132,7 @@ class TestMQTT(unittest.TestCase):
|
||||
self.assertEqual('test-payload', self.calls[0][1])
|
||||
|
||||
def test_subscribe_topic_not_match(self):
|
||||
"""Test if subscribed topic is not a match."""
|
||||
mqtt.subscribe(self.hass, 'test-topic', self.record_calls)
|
||||
|
||||
fire_mqtt_message(self.hass, 'another-test-topic', 'test-payload')
|
||||
@@ -133,6 +141,7 @@ class TestMQTT(unittest.TestCase):
|
||||
self.assertEqual(0, len(self.calls))
|
||||
|
||||
def test_subscribe_topic_level_wildcard(self):
|
||||
"""Test the subscription of wildcard topics."""
|
||||
mqtt.subscribe(self.hass, 'test-topic/+/on', self.record_calls)
|
||||
|
||||
fire_mqtt_message(self.hass, 'test-topic/bier/on', 'test-payload')
|
||||
@@ -143,6 +152,7 @@ class TestMQTT(unittest.TestCase):
|
||||
self.assertEqual('test-payload', self.calls[0][1])
|
||||
|
||||
def test_subscribe_topic_level_wildcard_no_subtree_match(self):
|
||||
"""Test the subscription of wildcard topics."""
|
||||
mqtt.subscribe(self.hass, 'test-topic/+/on', self.record_calls)
|
||||
|
||||
fire_mqtt_message(self.hass, 'test-topic/bier', 'test-payload')
|
||||
@@ -151,6 +161,7 @@ class TestMQTT(unittest.TestCase):
|
||||
self.assertEqual(0, len(self.calls))
|
||||
|
||||
def test_subscribe_topic_subtree_wildcard_subtree_topic(self):
|
||||
"""Test the subscription of wildcard topics."""
|
||||
mqtt.subscribe(self.hass, 'test-topic/#', self.record_calls)
|
||||
|
||||
fire_mqtt_message(self.hass, 'test-topic/bier/on', 'test-payload')
|
||||
@@ -161,6 +172,7 @@ class TestMQTT(unittest.TestCase):
|
||||
self.assertEqual('test-payload', self.calls[0][1])
|
||||
|
||||
def test_subscribe_topic_subtree_wildcard_root_topic(self):
|
||||
"""Test the subscription of wildcard topics."""
|
||||
mqtt.subscribe(self.hass, 'test-topic/#', self.record_calls)
|
||||
|
||||
fire_mqtt_message(self.hass, 'test-topic', 'test-payload')
|
||||
@@ -171,6 +183,7 @@ class TestMQTT(unittest.TestCase):
|
||||
self.assertEqual('test-payload', self.calls[0][1])
|
||||
|
||||
def test_subscribe_topic_subtree_wildcard_no_match(self):
|
||||
"""Test the subscription of wildcard topics."""
|
||||
mqtt.subscribe(self.hass, 'test-topic/#', self.record_calls)
|
||||
|
||||
fire_mqtt_message(self.hass, 'another-test-topic', 'test-payload')
|
||||
@@ -180,9 +193,10 @@ class TestMQTT(unittest.TestCase):
|
||||
|
||||
|
||||
class TestMQTTCallbacks(unittest.TestCase):
|
||||
""" Test the MQTT callbacks. """
|
||||
"""Test the MQTT callbacks."""
|
||||
|
||||
def setUp(self): # pylint: disable=invalid-name
|
||||
"""Setup things to be run when tests are started."""
|
||||
self.hass = get_test_home_assistant(1)
|
||||
# mock_mqtt_component(self.hass)
|
||||
|
||||
@@ -195,13 +209,15 @@ class TestMQTTCallbacks(unittest.TestCase):
|
||||
self.hass.config.components.append(mqtt.DOMAIN)
|
||||
|
||||
def tearDown(self): # pylint: disable=invalid-name
|
||||
""" Stop down stuff we started. """
|
||||
"""Stop everything that was started."""
|
||||
self.hass.stop()
|
||||
|
||||
def test_receiving_mqtt_message_fires_hass_event(self):
|
||||
"""Test if receiving triggers an event."""
|
||||
calls = []
|
||||
|
||||
def record(event):
|
||||
"""Helper to record calls."""
|
||||
calls.append(event)
|
||||
|
||||
self.hass.bus.listen_once(mqtt.EVENT_MQTT_MESSAGE_RECEIVED, record)
|
||||
@@ -219,6 +235,7 @@ class TestMQTTCallbacks(unittest.TestCase):
|
||||
self.assertEqual(message.qos, last_event.data['qos'])
|
||||
|
||||
def test_mqtt_failed_connection_results_in_disconnect(self):
|
||||
"""Test if connection failure leads to disconnect."""
|
||||
for result_code in range(1, 6):
|
||||
mqtt.MQTT_CLIENT._mqttc = mock.MagicMock()
|
||||
mqtt.MQTT_CLIENT._mqtt_on_connect(None, {'topics': {}}, 0,
|
||||
@@ -226,6 +243,7 @@ class TestMQTTCallbacks(unittest.TestCase):
|
||||
self.assertTrue(mqtt.MQTT_CLIENT._mqttc.disconnect.called)
|
||||
|
||||
def test_mqtt_subscribes_topics_on_connect(self):
|
||||
"""Test subscription to topic on connect."""
|
||||
from collections import OrderedDict
|
||||
prev_topics = OrderedDict()
|
||||
prev_topics['topic/test'] = 1,
|
||||
@@ -251,11 +269,13 @@ class TestMQTTCallbacks(unittest.TestCase):
|
||||
}, mqtt.MQTT_CLIENT.progress)
|
||||
|
||||
def test_mqtt_disconnect_tries_no_reconnect_on_stop(self):
|
||||
"""Test the disconnect tries."""
|
||||
mqtt.MQTT_CLIENT._mqtt_on_disconnect(None, None, 0)
|
||||
self.assertFalse(mqtt.MQTT_CLIENT._mqttc.reconnect.called)
|
||||
|
||||
@mock.patch('homeassistant.components.mqtt.time.sleep')
|
||||
def test_mqtt_disconnect_tries_reconnect(self, mock_sleep):
|
||||
"""Test the re-connect tries."""
|
||||
mqtt.MQTT_CLIENT.topics = {
|
||||
'test/topic': 1,
|
||||
'test/progress': None
|
||||
|
||||
Reference in new issue
Block a user