1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
|
import asyncio
import logging
from importlib.metadata import EntryPoint
from unittest.mock import patch
import pytest
from amqtt.broker import Broker
from amqtt.client import MQTTClient
from amqtt.errors import ClientError, ConnectError, MQTTError
from amqtt.mqtt.constants import QOS_0, QOS_1, QOS_2
formatter = "[%(asctime)s] %(name)s {%(filename)s:%(lineno)d} %(levelname)s - %(message)s"
logging.basicConfig(level=logging.ERROR, format=formatter)
log = logging.getLogger(__name__)
@pytest.mark.asyncio
async def test_connect_tcp(broker_fixture):
client = MQTTClient()
await client.connect("mqtt://localhost:1883/")
assert client.session is not None
await client.disconnect()
@pytest.mark.asyncio
async def test_connect_tcp_secure(rsa_keys, broker_fixture):
certfile, _ = rsa_keys
client = MQTTClient(config={"check_hostname": False, "auto_reconnect": False})
# since we're using a self-signed certificate, need to provide the server's certificate to verify authenticity
await client.connect("mqtts://localhost:1884/", cafile=certfile)
assert client.session is not None
await client.disconnect()
@pytest.mark.asyncio
async def test_connect_tcp_failure():
config = {"auto_reconnect": False}
client = MQTTClient(config=config)
with pytest.raises(ConnectError):
await client.connect("mqtt://127.0.0.1/")
@pytest.mark.asyncio
async def test_connect_ws(broker_fixture):
client = MQTTClient()
await client.connect("ws://127.0.0.1:8080/")
assert client.session is not None
await client.disconnect()
@pytest.mark.asyncio
async def test_reconnect_ws_retain_username_password(broker_fixture):
client = MQTTClient()
await client.connect("ws://fred:password@127.0.0.1:8080/")
assert client.session is not None
assert client.session.username is not None
assert client.session.password is not None
await client.disconnect()
await client.reconnect()
assert client.session.username is not None
assert client.session.password is not None
@pytest.mark.asyncio
async def test_connect_ws_secure(rsa_keys, broker_fixture):
certfile, _ = rsa_keys
client = MQTTClient(config={"auto_reconnect": False})
# since we're using a self-signed certificate, need to provide the server's certificate to verify authenticity
await client.connect("wss://localhost:8081/", cafile=certfile)
assert client.session is not None
await client.disconnect()
@pytest.mark.asyncio
async def test_connect_username_without_password(broker_fixture):
client = MQTTClient()
await client.connect("mqtt://alice@127.0.0.1/")
assert client.session is not None
await client.disconnect()
@pytest.mark.asyncio
async def test_ping(broker_fixture):
client = MQTTClient()
await client.connect("mqtt://127.0.0.1/")
assert client.session is not None
await client.ping()
await client.disconnect()
@pytest.mark.asyncio
async def test_subscribe(broker_fixture):
client = MQTTClient()
await client.connect("mqtt://127.0.0.1/")
assert client.session is not None
ret = await client.subscribe(
[
("$SYS/broker/uptime", QOS_0),
("$SYS/broker/uptime", QOS_1),
("$SYS/broker/uptime", QOS_2),
],
)
assert ret[0] == QOS_0
assert ret[1] == QOS_1
assert ret[2] == QOS_2
await client.disconnect()
@pytest.mark.asyncio
async def test_unsubscribe(broker_fixture):
client = MQTTClient()
await client.connect("mqtt://127.0.0.1/")
assert client.session is not None
ret = await client.subscribe(
[
("$SYS/broker/uptime", QOS_0),
],
)
assert ret[0] == QOS_0
await client.unsubscribe(["$SYS/broker/uptime"])
await client.disconnect()
@pytest.mark.asyncio
async def test_deliver(broker_fixture):
data = b"data"
client = MQTTClient()
await client.connect("mqtt://127.0.0.1/")
assert client.session is not None
ret = await client.subscribe(
[
("test_topic", QOS_0),
],
)
assert ret[0] == QOS_0
client_pub = MQTTClient()
await client_pub.connect("mqtt://127.0.0.1/")
await client_pub.publish("test_topic", data, QOS_0)
await client_pub.disconnect()
message = await client.deliver_message()
assert message is not None
assert message.publish_packet is not None
assert message.data == data
await client.unsubscribe(["$SYS/broker/uptime"])
await client.disconnect()
@pytest.mark.asyncio
async def test_deliver_timeout(broker_fixture):
client = MQTTClient()
await client.connect("mqtt://127.0.0.1/")
assert client.session is not None
ret = await client.subscribe(
[
("test_topic", QOS_0),
],
)
assert ret[0] == QOS_0
with pytest.raises(asyncio.TimeoutError):
await client.deliver_message(timeout_duration=2)
await client.unsubscribe(["$SYS/broker/uptime"])
await client.disconnect()
@pytest.mark.asyncio
async def test_cancel_publish_qos1(broker_fixture):
"""Tests that timeouts on published messages will clean up in-flight messages."""
data = b"data"
client_pub = MQTTClient()
await client_pub.connect("mqtt://127.0.0.1/")
assert client_pub.session is not None
assert client_pub._handler is not None
assert client_pub.session.inflight_out_count == 0
fut = asyncio.create_task(client_pub.publish("test_topic", data, QOS_1))
assert len(client_pub._handler._puback_waiters) == 0
while len(client_pub._handler._puback_waiters) == 0 and not fut.done():
await asyncio.sleep(0)
assert len(client_pub._handler._puback_waiters) == 1
assert client_pub.session.inflight_out_count == 1
fut.cancel()
await asyncio.wait([fut])
assert len(client_pub._handler._puback_waiters) == 0
assert client_pub.session.inflight_out_count == 0
await asyncio.sleep(0.1)
await client_pub.disconnect()
@pytest.mark.asyncio
async def test_cancel_publish_qos2_pubrec(broker_fixture):
"""Tests that timeouts on published messages will clean up in-flight messages."""
data = b"data"
client_pub = MQTTClient()
await client_pub.connect("mqtt://127.0.0.1/")
assert client_pub.session is not None
assert client_pub._handler is not None
assert client_pub.session.inflight_out_count == 0
fut = asyncio.create_task(client_pub.publish("test_topic", data, QOS_2))
assert len(client_pub._handler._pubrec_waiters) == 0
while len(client_pub._handler._pubrec_waiters) == 0 or fut.done() or fut.cancelled():
await asyncio.sleep(0)
assert len(client_pub._handler._pubrec_waiters) == 1
assert client_pub.session.inflight_out_count == 1
fut.cancel()
await asyncio.sleep(1)
await asyncio.wait([fut])
assert len(client_pub._handler._pubrec_waiters) == 0
assert client_pub.session.inflight_out_count == 0
await asyncio.sleep(0.1)
await client_pub.disconnect()
@pytest.mark.asyncio
async def test_cancel_publish_qos2_pubcomp(broker_fixture):
"""Tests that timeouts on published messages will clean up in-flight messages."""
data = b"data"
client_pub = MQTTClient()
await client_pub.connect("mqtt://127.0.0.1/")
assert client_pub.session is not None
assert client_pub._handler is not None
assert client_pub.session.inflight_out_count == 0
fut = asyncio.create_task(client_pub.publish("test_topic", data, QOS_2))
assert len(client_pub._handler._pubcomp_waiters) == 0
while len(client_pub._handler._pubcomp_waiters) == 0 and not fut.done():
await asyncio.sleep(0)
assert len(client_pub._handler._pubcomp_waiters) == 1
fut.cancel()
await asyncio.wait([fut])
assert len(client_pub._handler._pubcomp_waiters) == 0
assert client_pub.session.inflight_out_count == 0
await asyncio.sleep(0.1)
await client_pub.disconnect()
@pytest.fixture
def client_config():
return {
"default_retain": False,
"topics": {
"test": {
"qos": 0
},
"some_topic": {
"retain": True,
"qos": 2
}
},
"keep_alive": 10,
"connection": {
"uri": "mqtt://localhost:1884"
},
"reconnect_max_interval": 5,
"will": {
"topic": "test/will/topic",
"retain": True,
"message": "client ABC has disconnected",
"qos": 1
},
"ping_delay": 1,
"default_qos": 0,
"auto_reconnect": True,
"reconnect_retries": 10
}
@pytest.mark.asyncio
async def test_client_will_with_clean_disconnect(broker_fixture):
config = {
"will": {
"topic": "test/will/topic",
"retain": False,
"message": "client ABC has disconnected",
"qos": 1
},
}
client1 = MQTTClient(client_id="client1", config=config)
await client1.connect("mqtt://localhost:1883")
client2 = MQTTClient(client_id="client2")
await client2.connect("mqtt://localhost:1883")
await client2.subscribe(
[
("test/will/topic", QOS_0),
]
)
await client1.disconnect()
await asyncio.sleep(1)
with pytest.raises(asyncio.TimeoutError):
message = await client2.deliver_message(timeout_duration=2)
# if we do get a message, make sure it's not a will message
assert message.topic != "test/will/topic"
await client2.disconnect()
@pytest.mark.asyncio
async def test_client_will_with_abrupt_disconnect(broker_fixture):
config = {
"will": {
"topic": "test/will/topic",
"retain": False,
"message": "client ABC has disconnected",
"qos": 1
},
}
client1 = MQTTClient(client_id="client1", config=config)
await client1.connect("mqtt://localhost:1883")
client2 = MQTTClient(client_id="client2")
await client2.connect("mqtt://localhost:1883")
await client2.subscribe(
[
("test/will/topic", QOS_0),
]
)
# instead of client.disconnect, call the necessary closing but without sending the disconnect packet
await client1.cancel_tasks()
if client1._disconnect_task and not client1._disconnect_task.done():
client1._disconnect_task.cancel()
client1._connected_state.clear()
await client1._handler.stop()
client1.session.transitions.disconnect()
await asyncio.sleep(1)
message = await client2.deliver_message(timeout_duration=1)
# make sure we receive the will message
assert message.topic == "test/will/topic"
assert message.data == b'client ABC has disconnected'
await client2.disconnect()
@pytest.mark.asyncio
async def test_client_retained_will_with_abrupt_disconnect(broker_fixture):
# verifying client functionality of retained will topic/message
config = {
"will": {
"topic": "test/will/topic",
"retain": True,
"message": "client ABC has disconnected",
"qos": 1
},
}
# first client, connect with retained will message
client1 = MQTTClient(client_id="client1", config=config)
await client1.connect('mqtt://localhost:1883')
client2 = MQTTClient(client_id="client2")
await client2.connect('mqtt://localhost:1883')
await client2.subscribe([
("test/will/topic", QOS_0)
])
# let's abruptly disconnect client1
await client1.cancel_tasks()
if client1._disconnect_task and not client1._disconnect_task.done():
client1._disconnect_task.cancel()
client1._connected_state.clear()
await client1._handler.stop()
client1.session.transitions.disconnect()
await asyncio.sleep(0.5)
# make sure the client which is still connected that we get the 'will' message
message = await client2.deliver_message(timeout_duration=1)
assert message.topic == 'test/will/topic'
assert message.data == b'client ABC has disconnected'
await client2.disconnect()
# make sure a client which is connected after client1 disconnected still receives the 'will' message from
client3 = MQTTClient(client_id="client3")
await client3.connect('mqtt://localhost:1883')
await client3.subscribe([
("test/will/topic", QOS_0)
])
message3 = await client3.deliver_message(timeout_duration=1)
assert message3.topic == 'test/will/topic'
assert message3.data == b'client ABC has disconnected'
await client3.disconnect()
@pytest.mark.asyncio
async def test_client_abruptly_disconnecting_with_empty_will_message(broker_fixture):
config = {
"will": {
"topic": "test/will/topic",
"retain": True,
"message": "",
"qos": 1
},
}
client1 = MQTTClient(client_id="client1", config=config)
await client1.connect('mqtt://localhost:1883')
client2 = MQTTClient(client_id="client2")
await client2.connect('mqtt://localhost:1883')
await client2.subscribe([
("test/will/topic", QOS_0)
])
# let's abruptly disconnect client1
await client1.cancel_tasks()
if client1._disconnect_task and not client1._disconnect_task.done():
client1._disconnect_task.cancel()
client1._connected_state.clear()
await client1._handler.stop()
client1.session.transitions.disconnect()
await asyncio.sleep(0.5)
message = await client2.deliver_message(timeout_duration=1)
assert message.topic == 'test/will/topic'
assert message.data == b''
await client2.disconnect()
async def test_connect_broken_uri():
config = {"auto_reconnect": False}
client = MQTTClient(config=config)
with pytest.raises(ClientError):
await client.connect('"mqtt://someplace')
@pytest.mark.asyncio
async def test_connect_incorrect_scheme():
config = {"auto_reconnect": False}
client = MQTTClient(config=config)
with pytest.raises(ClientError):
await client.connect('"mq://someplace')
@pytest.mark.asyncio
@pytest.mark.timeout(3)
async def test_connect_timeout():
config = {"auto_reconnect": False, "connection_timeout": 2}
client = MQTTClient(config=config)
with pytest.raises(ClientError):
await client.connect("mqtt://localhost:8888")
async def test_client_no_auth():
class MockEntryPoints:
def select(self, group) -> list[EntryPoint]:
match group:
case 'tests.mock_plugins':
return [
EntryPoint(name='auth_plugin', group='tests.mock_plugins', value='tests.plugins.mocks:TestNoAuthPlugin'),
]
case _:
return list()
with patch("amqtt.plugins.manager.entry_points", side_effect=MockEntryPoints) as mocked_mqtt_publish:
config = {
"listeners": {
"default": {"type": "tcp", "bind": "127.0.0.1:1883", "max_connections": 10},
},
'sys_interval': 1,
'auth': {
'plugins': ['auth_plugin', ]
}
}
client = MQTTClient(client_id="client1", config={'auto_reconnect': False})
with pytest.warns(DeprecationWarning):
broker = Broker(plugin_namespace='tests.mock_plugins', config=config)
await broker.start()
with pytest.raises(ConnectError):
await client.connect("mqtt://127.0.0.1:1883/")
await broker.shutdown()
@pytest.mark.asyncio
async def test_publish_to_incorrect_wildcard(broker_fixture):
client = MQTTClient(config={'auto_reconnect': False})
await client.connect("mqtt://127.0.0.1/")
with pytest.raises(MQTTError):
await client.publish("my/+/topic", b'plus-sign wildcard topic invalid publish')
with pytest.raises(MQTTError):
await client.publish("topic/#", b'hash wildcard topic invalid publish')
await client.publish("topic/*", b'asterisk topic normal publish')
await client.disconnect()
|