Add some MQTT tests

homeassistant/components/mqtt/__init__.py

@@ -158,7 +158,7 @@ class FmtParser(object):
 # This is based on one of the paho-mqtt examples:
 # http://git.eclipse.org/c/paho/org.eclipse.paho.mqtt.python.git/tree/examples/sub-class.py
 # pylint: disable=too-many-arguments
-class MQTT(object):  # pragma: no cover
+class MQTT(object):
     """ Implements messaging service for MQTT. """
     def __init__(self, hass, broker, port, client_id, keepalive, username,
                  password, certificate):
@@ -194,12 +194,6 @@ class MQTT(object):  # pragma: no cover
         """ Publish a MQTT message. """
         self._mqttc.publish(topic, payload, qos)
 
-    def unsubscribe(self, topic):
-        """ Unsubscribe from topic. """
-        result, mid = self._mqttc.unsubscribe(topic)
-        _raise_on_error(result)
-        self.userdata['progress'][mid] = topic
-
     def start(self):
         """ Run the MQTT client. """
         self._mqttc.loop_start()
@@ -217,6 +211,12 @@ class MQTT(object):  # pragma: no cover
         self.userdata['progress'][mid] = topic
         self.userdata['topics'][topic] = None
 
+    def unsubscribe(self, topic):
+        """ Unsubscribe from topic. """
+        result, mid = self._mqttc.unsubscribe(topic)
+        _raise_on_error(result)
+        self.userdata['progress'][mid] = topic
+
 
 def _mqtt_on_message(mqttc, userdata, msg):
     """ Message callback """
@@ -236,7 +236,7 @@ def _mqtt_on_connect(mqttc, userdata, flags, result_code):
             3: 'Server unavailable',
             4: 'Bad username or password',
             5: 'Not authorised'
-        }.get(result_code))
+        }.get(result_code, 'Unknown reason'))
         mqttc.disconnect()
         return
 
@@ -293,7 +293,7 @@ def _mqtt_on_disconnect(mqttc, userdata, result_code):
         tries += 1
 
 
-def _raise_on_error(result):  # pragma: no cover
+def _raise_on_error(result):
     """ Raise error if error result. """
     if result != 0:
         raise HomeAssistantError('Error talking to MQTT: {}'.format(result))

tests/components/test_mqtt.py

@@ -4,6 +4,7 @@ tests.test_component_mqtt
 
 Tests MQTT component.
 """
+from collections import namedtuple
 import unittest
 from unittest import mock
 import socket
@@ -17,8 +18,8 @@ from tests.common import (
     get_test_home_assistant, mock_mqtt_component, fire_mqtt_message)
 
 
-class TestDemo(unittest.TestCase):
+class TestMQTT(unittest.TestCase):
-    """ Test the demo module. """
+    """ Test the MQTT module. """
 
     def setUp(self):  # pylint: disable=invalid-name
         self.hass = get_test_home_assistant(1)
@@ -136,3 +137,72 @@ class TestDemo(unittest.TestCase):
 
         self.hass.pool.block_till_done()
         self.assertEqual(0, len(self.calls))
+
+
+class TestMQTTCallbacks(unittest.TestCase):
+    """ Test the MQTT callbacks. """
+
+    def setUp(self):  # pylint: disable=invalid-name
+        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. """
+        self.hass.stop()
+
+    def test_receiving_mqtt_message_fires_hass_event(self):
+        calls = []
+
+        def record(event):
+            calls.append(event)
+
+        self.hass.bus.listen_once(mqtt.EVENT_MQTT_MESSAGE_RECEIVED, record)
+
+        MQTTMessage = namedtuple('MQTTMessage', ['topic', 'qos', 'payload'])
+        message = MQTTMessage('test_topic', 1, 'Hello World!'.encode('utf-8'))
+
+        mqtt._mqtt_on_message(None, {'hass': self.hass}, message)
+        self.hass.pool.block_till_done()
+
+        self.assertEqual(1, len(calls))
+        last_event = calls[0]
+        self.assertEqual('Hello World!', last_event.data['payload'])
+        self.assertEqual(message.topic, last_event.data['topic'])
+        self.assertEqual(message.qos, last_event.data['qos'])
+
+    def test_mqtt_failed_connection_results_in_disconnect(self):
+        for result_code in range(1, 6):
+            mqttc = mock.MagicMock()
+            mqtt._mqtt_on_connect(mqttc, {'topics': {}}, 0, result_code)
+            self.assertTrue(mqttc.disconnect.called)
+
+    def test_mqtt_subscribes_topics_on_connect(self):
+        prev_topics = {
+            'topic/test': 1,
+            'home/sensor': 2,
+            'still/pending': None
+        }
+        mqttc = mock.MagicMock()
+        mqtt._mqtt_on_connect(mqttc, {'topics': prev_topics}, 0, 0)
+        self.assertFalse(mqttc.disconnect.called)
+
+        expected = [(topic, qos) for topic, qos in prev_topics.items()
+                    if qos is not None]
+        self.assertEqual(expected, [call[1] for call
+                                    in mqttc.subscribe.mock_calls])
+
+    def test_mqtt_disconnect_tries_no_reconnect_on_stop(self):
+        mqttc = mock.MagicMock()
+        mqtt._mqtt_on_disconnect(mqttc, {}, 0)
+        self.assertFalse(mqttc.reconnect.called)
+
+    @mock.patch('homeassistant.components.mqtt.time.sleep')
+    def test_mqtt_disconnect_tries_reconnect(self, mock_sleep):
+        mqttc = mock.MagicMock()
+        mqttc.reconnect.side_effect = [1, 1, 1, 0]
+        mqtt._mqtt_on_disconnect(mqttc, {}, 1)
+        self.assertTrue(mqttc.reconnect.called)
+        self.assertEqual(4, len(mqttc.reconnect.mock_calls))
+        self.assertEqual([1, 2, 4],
+                         [call[1][0] for call in mock_sleep.mock_calls])