MQTTLibrary is a Robot Framework library that provides keywords for testing on MQTT brokers. MQTT is a lightweight protocol for machine-to-machine communication, typically used for IoT messaging. This library uses the paho client library published by eclipse project.
MQTTLibrary can be installed using pip:
pip install robotframework-mqttlibrary
To install from a clone of this repository, run this in its root directory:
pip install .
Import the library:
*** Settings ***
Library MQTTLibraryConnect to the broker, publish and disconnect:
*** Test Cases ***
Publish
Connect 127.0.0.1
Publish topic=test/mqtt_test message=test message
[Teardown] DisconnectConnect to the broker, subscribe and validate that a message is received:
*** Test Cases ***
Subscribe and Validate
Connect 127.0.0.1
Subscribe and Validate topic=test/mqtt_test qos=1 payload=test
[Teardown] DisconnectKeyword documentation is available at: http://randomsync.github.io/robotframework-mqttlibrary.
Also look at tests folder for examples.
For general information about using test libraries with Robot Framework, see Robot Framework User Guide.
The keywords in this library are based on some of the methods available in eclipse paho client library. If you'd like to add keywords, see instructions on creating/updating libraries for Robot Framework.
The tests are in tests folder and make use of Robot Framework itself. They need two local MQTT brokers: one without authentication, used by most tests, and one that requires a username and password. Both are defined in docker-compose.yml. They need Docker Engine 25 or later. Start them, run the tests, and stop them when you are done:
docker compose up --wait robot -P src tests docker compose down
The test credentials live in mosquitto/passwd_file. To regenerate it, run scripts/gen-passwd.sh.
MQTTLibrary is open source software provided under the Apache License 2.0.