import asyncio import os import ssl import time from gmqtt import Client from gmqtt.mqtt.constants import MQTTv311 from testfixtures import LogCapture from bumper import MQTTServer, db from bumper.mqtt.helper_bot import HelperBot from tests import HOST, MQTT_PORT async def test_helperbot_message(mqtt_client: Client): with LogCapture() as l: # Test broadcast message mqtt_helperbot = HelperBot(HOST, MQTT_PORT) await mqtt_helperbot.start() assert mqtt_helperbot.is_connected msg_payload = "" msg_topic_name = "iot/atr/DustCaseST/bot_serial/ls1ok3/wC3g/x" mqtt_client.publish(msg_topic_name, msg_payload.encode()) await asyncio.sleep(0.1) l.check_present( ( "helperbot", "DEBUG", "Received Broadcast - Topic: iot/atr/DustCaseST/bot_serial/ls1ok3/wC3g/x - Message: ", ) ) # Check broadcast message was logged l.clear() await mqtt_helperbot.disconnect() # Send command to bot mqtt_helperbot = HelperBot(HOST, MQTT_PORT) await mqtt_helperbot.start() assert mqtt_helperbot.is_connected msg_payload = "{}" msg_topic_name = "iot/p2p/GetWKVer/helperbot/bumper/helperbot/bot_serial/ls1ok3/wC3g/q/iCmuqp/j" mqtt_client.publish(msg_topic_name, msg_payload.encode()) await asyncio.sleep(0.1) l.check_present( ( "helperbot", "DEBUG", "Send Command - Topic: iot/p2p/GetWKVer/helperbot/bumper/helperbot/bot_serial/ls1ok3/wC3g/q/iCmuqp/j - Message: {}", ) ) # Check send command message was logged l.clear() await mqtt_helperbot.disconnect() # Received response to command mqtt_helperbot = HelperBot(HOST, MQTT_PORT) await mqtt_helperbot.start() assert mqtt_helperbot.is_connected msg_payload = '{"ret":"ok","ver":"0.13.5"}' msg_topic_name = "iot/p2p/GetWKVer/bot_serial/ls1ok3/wC3g/helperbot/bumper/helperbot/p/iCmuqp/j" mqtt_client.publish(msg_topic_name, msg_payload.encode()) await asyncio.sleep(0.1) l.check_present( ( "helperbot", "DEBUG", 'Received Response - Topic: iot/p2p/GetWKVer/bot_serial/ls1ok3/wC3g/helperbot/bumper/helperbot/p/iCmuqp/j - Message: {"ret":"ok","ver":"0.13.5"}', ) ) # Check received response message was logged l.clear() await mqtt_helperbot.disconnect() # Received unknown message mqtt_helperbot = HelperBot(HOST, MQTT_PORT) await mqtt_helperbot.start() assert mqtt_helperbot.is_connected msg_payload = "test" msg_topic_name = "iot/p2p/GetWKVer/bot_serial/ls1ok3/wC3g/TESTBAD/bumper/helperbot/p/iCmuqp/j" mqtt_client.publish(msg_topic_name, msg_payload.encode()) await asyncio.sleep(0.1) l.check_present( ( "helperbot", "DEBUG", "Received Message - Topic: iot/p2p/GetWKVer/bot_serial/ls1ok3/wC3g/TESTBAD/bumper/helperbot/p/iCmuqp/j - Message: test", ) ) # Check received message was logged l.clear() await mqtt_helperbot.disconnect() # Received error message mqtt_helperbot = HelperBot(HOST, MQTT_PORT) await mqtt_helperbot.start() assert mqtt_helperbot.is_connected msg_payload = "" msg_topic_name = "iot/atr/errors/bot_serial/ls1ok3/wC3g/x" mqtt_client.publish(msg_topic_name, msg_payload.encode()) await asyncio.sleep(0.1) l.check_present( ( "boterror", "ERROR", "Received Error - Topic: iot/atr/errors/bot_serial/ls1ok3/wC3g/x - Message: ", ) ) # Check received message was logged l.clear() await mqtt_helperbot.disconnect() async def test_helperbot_expire_message(mqtt_client: Client, helper_bot: HelperBot): expire_msg_payload = '{"ret":"ok","ver":"0.13.5"}' expire_msg_topic_name = "iot/p2p/GetWKVer/bot_serial/ls1ok3/wC3g/helperbot/bumper/helperbot/p/testgood/j" currenttime = time.time() request_id = "ABC" data = { "time": currenttime, "topic": expire_msg_topic_name, "payload": expire_msg_payload, } helper_bot._commands[request_id] = data assert helper_bot._commands[request_id] == data await asyncio.sleep(0.1) msg_payload = "" msg_topic_name = "iot/atr/DustCaseST/bot_serial/ls1ok3/wC3g/x" mqtt_client.publish( msg_topic_name, msg_payload.encode() ) # Send another message to force get_msg await asyncio.sleep(0.1 * 2) assert helper_bot._commands.get(request_id, None) == None async def test_helperbot_sendcommand(mqtt_client: Client, helper_bot: HelperBot): cmdjson = { "toType": "ls1ok3", "payloadType": "j", "toRes": "wC3g", "payload": {}, "td": "q", "toId": "bot_serial", "cmdName": "GetWKVer", "auth": { "token": "us_52cb21fef8e547f38f4ec9a699a5d77e", "resource": "IOSF53D07BA", "userid": "fuid_tmpuser", "with": "users", "realm": "ecouser.net", }, } commandresult = await helper_bot.send_command(cmdjson, "testfail") # Don't send a response, ensure timeout assert commandresult == { "debug": "wait for response timed out", "errno": 500, "id": "testfail", "ret": "fail", } # Check timeout # Send response beforehand msg_payload = '{"ret":"ok","ver":"0.13.5"}' msg_topic_name = "iot/p2p/GetWKVer/bot_serial/ls1ok3/wC3g/helperbot/bumper/helperbot/p/testgood/j" loop = asyncio.get_event_loop() loop.call_soon(lambda: mqtt_client.publish(msg_topic_name, msg_payload.encode())) commandresult = await helper_bot.send_command(cmdjson, "testgood") assert commandresult == { "id": "testgood", "resp": {"ret": "ok", "ver": "0.13.5"}, "ret": "ok", } # await mqtt_helperbot.Client.disconnect() # Test GetLifeSpan (xml command) cmdjson = { "toType": "ls1ok3", "payloadType": "x", "toRes": "wC3g", "payload": '', "td": "q", "toId": "bot_serial", "cmdName": "GetLifeSpan", "auth": { "token": "us_52cb21fef8e547f38f4ec9a699a5d77e", "resource": "IOSF53D07BA", "userid": "fuid_tmpuser", "with": "users", "realm": "ecouser.net", }, } # Send response beforehand msg_payload = "" msg_topic_name = "iot/p2p/GetLifeSpan/bot_serial/ls1ok3/wC3g/helperbot/bumper/helperbot/p/testx/q" mqtt_client.publish(msg_topic_name, msg_payload.encode()) commandresult = await helper_bot.send_command(cmdjson, "testx") assert commandresult == { "id": "testx", "resp": "", "ret": "ok", } # Test json payload (OZMO950) cmdjson = { "toType": "ls1ok3", "payloadType": "j", "toRes": "wC3g", "payload": { "header": {"pri": 1, "ts": "1569380075887", "tzm": -240, "ver": "0.0.50"} }, "td": "q", "toId": "bot_serial", "cmdName": "getStats", "auth": { "token": "us_52cb21fef8e547f38f4ec9a699a5d77e", "resource": "IOSF53D07BA", "userid": "fuid_tmpuser", "with": "users", "realm": "ecouser.net", }, } # Send response beforehand msg_payload = '{"body":{"code":0,"data":{"area":0,"cid":"111","start":"1569378657","time":6,"type":"auto"},"msg":"ok"},"header":{"fwVer":"1.6.4","hwVer":"0.1.1","pri":1,"ts":"1569380074036","tzm":480,"ver":"0.0.1"}}' msg_topic_name = ( "iot/p2p/getStats/bot_serial/ls1ok3/wC3g/helperbot/bumper/helperbot/p/testj/j" ) mqtt_client.publish(msg_topic_name, msg_payload.encode()) commandresult = await helper_bot.send_command(cmdjson, "testj") assert commandresult == { "id": "testj", "resp": { "body": { "code": 0, "data": { "area": 0, "cid": "111", "start": "1569378657", "time": 6, "type": "auto", }, "msg": "ok", }, "header": { "fwVer": "1.6.4", "hwVer": "0.1.1", "pri": 1, "ts": "1569380074036", "tzm": 480, "ver": "0.0.1", }, }, "ret": "ok", } async def test_mqttserver(): if os.path.exists("tests/tmp.db"): os.remove("tests/tmp.db") # Remove existing db mqtt_server = MQTTServer( HOST, MQTT_PORT, password_file="tests/passwd", allow_anonymous=True ) await mqtt_server.start() try: # Test helperbot connect mqtt_helperbot = HelperBot(HOST, MQTT_PORT) await mqtt_helperbot.start() assert mqtt_helperbot.is_connected await mqtt_helperbot.disconnect() # Test client connect db.user_add("user_123") # Add user to db db.client_add("user_123", "ecouser.net", "resource_123") # Add client to db ssl_ctx = ssl.create_default_context() ssl_ctx.check_hostname = False ssl_ctx.verify_mode = ssl.CERT_NONE client = Client("user_123@ecouser.net/resource_123") await client.connect(HOST, MQTT_PORT, ssl=ssl_ctx, version=MQTTv311) assert client.is_connected await client.disconnect() assert not client.is_connected # Test fake_bot connect client = Client("bot_serial@ls1ok3/wC3g") await client.connect(HOST, MQTT_PORT, ssl=ssl_ctx, version=MQTTv311) assert client.is_connected await client.disconnect() # Test file auth client connect client = Client("test-file-auth") client.set_auth_credentials("test-client", "abc123!") await client.connect(HOST, MQTT_PORT, ssl=ssl_ctx, version=MQTTv311) assert client.is_connected await client.disconnect() assert not client.is_connected # bad password with LogCapture() as l: client.set_auth_credentials("test-client", "notvalid!") await client.connect(HOST, MQTT_PORT, ssl=ssl_ctx, version=MQTTv311) await client.disconnect() l.check_present( ( "mqttserver", "INFO", "File Authentication Failed - Username: test-client - ClientID: test-file-auth", ), order_matters=False, ) l.clear() # no username in file client.set_auth_credentials("test-client-noexist", "notvalid!") await client.connect(HOST, MQTT_PORT, ssl=ssl_ctx, version=MQTTv311) await client.disconnect() l.check_present( ( "mqttserver", "INFO", "File Authentication Failed - No Entry - Username: test-client-noexist - ClientID: test-file-auth", ), order_matters=False, ) finally: await mqtt_server.shutdown() async def test_nofileauth_mqttserver(): with LogCapture() as l: mqtt_server = MQTTServer(HOST, MQTT_PORT, password_file="tests/passwd-notfound") await mqtt_server.start() try: l.check_present( ( "amqtt.broker.plugins.bumper", "WARNING", "Password file tests/passwd-notfound not found", ), order_matters=False, ) finally: await mqtt_server.shutdown()