pytest-mqtt 0.3.1

About

pytest-mqtt supports testing systems based on MQTT by providing test fixtures for pytest. It has been conceived for the fine terkin-datalogger and mqttwarn programs.

Usage

from pytest_mqtt.model import MqttMessage

@pytest.mark.capmqtt_decode_utf8
def test_mqtt_send_receive(mosquitto, capmqtt):
    """
    Basic send/receive roundtrip, using text payload (`str`).

    By using the `capmqtt_decode_utf8` marker, the message payloads
    will be recorded as `str`, after decoding them from `utf-8`.
    Otherwise, message payloads would be recorded as `bytes`.
    """

    # Submit a basic MQTT message.
    capmqtt.publish(topic="foo", payload="bar")

    # Demonstrate the "messages" property.
    # It returns a list of "MqttMessage" objects.
    assert capmqtt.messages == [
        MqttMessage(topic="foo", payload="bar", userdata=None),
    ]

    # Demonstrate the "records" property.
    # It returns tuples of "(topic, payload, userdata)".
    assert capmqtt.records == [
        ("foo", "bar", None),
    ]

The capmqtt_decode_utf8 setting can be enabled in three ways.

1. Session-wide, per pytestconfig option, for example within conftest.py:

   @pytest.fixture(scope="session", autouse=True)
   def configure_capmqtt_decode_utf8(pytestconfig):
       pytestconfig.option.capmqtt_decode_utf8 = True

2. On the module level, just say capmqtt_decode_utf8 = True on top of your file.

3. On individual test cases as a test case marker, using @pytest.mark.capmqtt_decode_utf8.

Issues

• Both fixtures currently do not support changing the MQTT broker hostname and port number differently than localhost:1883.

• The mosquitto fixture currently does not support either authentication or encryption.

• capmqtt should be able to capture messages only from specified topics.

Development

git clone https://github.com/mqtt-tools/pytest-mqtt
cd pytest-mqtt
python3 -m venv .venv
source .venv/bin/activate
pip install --editable=.[test,develop]
poe test

Project information