Merge pull request #1834 from jacmet/feature/mqtt-optional-username-password

resource/mqtt: add optional username/password for MQTT authentication

Author: Emantor

doc/configuration.rst

@@ -416,6 +416,8 @@ Arguments:
     "OFF"
   - avail_topic (str): topic that signals the availability of the Tasmota power
     outlet
+  - username (str): Optional, MQTT username to authenticate as
+  - password (str): Optional, MQTT password to authenticate with
 
 Used by:
   - `TasmotaPowerDriver`_

labgrid/resource/mqtt.py

@@ -16,20 +16,24 @@ class MQTTManager(ResourceManager):
     _topic_lock = attr.ib(default=threading.Lock())
     _last = attr.ib(default=0.0, validator=attr.validators.instance_of(float))
 
-    def _create_mqtt_connection(self, host):
+    def _create_mqtt_connection(self, host, username, password):
         import paho.mqtt.client as mqtt
 
         client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2)
+        client.username_pw_set(username, password)
         client.connect(host)
         client.on_message = self._on_message
         client.loop_start()
         return client
 
     def on_resource_added(self, resource):
         host = resource.host
-        if host not in self._clients:
-            self._clients[host] = self._create_mqtt_connection(host)
-        self._clients[host].subscribe(resource.avail_topic)
+        username = resource.username
+        password = resource.password
+        key = f"{host}:{username or ''}:{password or ''}"
+        if key not in self._clients:
+            self._clients[key] = self._create_mqtt_connection(host, username, password)
+        self._clients[key].subscribe(resource.avail_topic)
 
     def _on_message(self, client, userdata, msg):
         payload = msg.payload.decode("utf-8")
@@ -57,6 +61,8 @@ class MQTTResource(ManagedResource):
 
     host = attr.ib(validator=attr.validators.instance_of(str))
     avail_topic = attr.ib(validator=attr.validators.instance_of(str))
+    username = attr.ib(default=None, validator=attr.validators.optional(attr.validators.instance_of(str)))
+    password = attr.ib(default=None, validator=attr.validators.optional(attr.validators.instance_of(str)))
 
     def __attrs_post_init__(self):
         self.timeout = 30.0

tests/test_tasmota.py

@@ -9,15 +9,26 @@
 def test_tasmota_resource(target, mocker):
     mocker.patch("paho.mqtt.client.Client.connect", return_value=None)
     mocker.patch("paho.mqtt.client.Client.loop_start", return_value=None)
+    pw_set = mocker.patch("paho.mqtt.client.Client.username_pw_set", return_value=None)
     TasmotaPowerPort(target, name=None, host="localhost", avail_topic="test", power_topic="test", status_topic="test")
+    pw_set.assert_called_once_with(None, None)
 
 
 def test_tasmota_driver(target, mocker):
     mocker.patch("paho.mqtt.client.Client.connect", return_value=None)
     mocker.patch("paho.mqtt.client.Client.loop_start", return_value=None)
+    pw_set = mocker.patch("paho.mqtt.client.Client.username_pw_set", return_value=None)
     res = TasmotaPowerPort(
-        target, name=None, host="localhost", avail_topic="test", power_topic="test", status_topic="test"
+        target,
+        name=None,
+        host="localhost",
+        avail_topic="test",
+        power_topic="test",
+        status_topic="test",
+        username="foo",
+        password="bar",
     )
     res.manager._available.add("test")
     driver = TasmotaPowerDriver(target, name=None)
     target.activate(driver)
+    pw_set.assert_called_once_with("foo", "bar")