mqtt tests: connect to local broker when running in CI to make the tests more reliable

examples/protocols/mqtt/ws/mqtt_ws_example_test.py

@@ -4,8 +4,9 @@ from builtins import str
 import re
 import os
 import sys
-import time
 import paho.mqtt.client as mqtt
+from threading import Thread, Event
+
 
 try:
     import IDF
@@ -21,38 +22,39 @@ except Exception:
 
 import DUT
 
-
-g_recv_data = ""
-g_recv_topic = ""
-g_broker_connected = 0
+event_client_connected = Event()
+event_stop_client = Event()
+event_client_received_correct = Event()
+message_log = ""
 
 
 # The callback for when the client receives a CONNACK response from the server.
 def on_connect(client, userdata, flags, rc):
-    global g_broker_connected
     print("Connected with result code " + str(rc))
-    g_broker_connected = 1
+    event_client_connected.set()
     client.subscribe("/topic/qos0")
 
 
+def mqtt_client_task(client):
+    while not event_stop_client.is_set():
+        client.loop()
+
+
 # The callback for when a PUBLISH message is received from the server.
 def on_message(client, userdata, msg):
-    global g_recv_topic
-    global g_recv_data
+    global message_log
     payload = msg.payload.decode()
-    if g_recv_data == "" and payload == "data":
+    if not event_client_received_correct.is_set() and payload == "data":
         client.publish("/topic/qos0", "data_to_esp32")
-        g_recv_topic = msg.topic
-        g_recv_data = payload
-    print(msg.topic + " " + payload)
+        if msg.topic == "/topic/qos0" and payload == "data":
+            event_client_received_correct.set()
+    message_log += "Received data:" + msg.topic + " " + payload + "\n"
 
 
 @IDF.idf_example_test(env_tag="Example_WIFI")
 def test_examples_protocol_mqtt_ws(env, extra_data):
-    global g_recv_topic
-    global g_recv_data
-    global g_broker_connected
-    broker_url = "iot.eclipse.org"
+    broker_url = ""
+    broker_port = 0
     """
     steps: |
       1. join AP and connects to ws broker
@@ -66,40 +68,48 @@ def test_examples_protocol_mqtt_ws(env, extra_data):
     bin_size = os.path.getsize(binary_file)
     IDF.log_performance("mqtt_websocket_bin_size", "{}KB".format(bin_size // 1024))
     IDF.check_performance("mqtt_websocket_size", bin_size // 1024)
-    # 1. start test (and check the environment is healthy)
-    dut1.start_app()
-    client = None
-    # 2. Test connects to a broker
+    # Look for host:port in sdkconfig
+    try:
+        value = re.search(r'\:\/\/([^:]+)\:([0-9]+)', dut1.app.get_sdkconfig()["CONFIG_BROKER_URI"])
+        broker_url = value.group(1)
+        broker_port = int(value.group(2))
+    except Exception:
+        print('ENV_TEST_FAILURE: Cannot find broker url in sdkconfig')
+        raise
+    client = None
+    # 1. Test connects to a broker
     try:
-        ip_address = dut1.expect(re.compile(r" sta ip: ([^,]+),"), timeout=30)
-        print("Connected to AP with IP: {}".format(ip_address))
         client = mqtt.Client(transport="websockets")
         client.on_connect = on_connect
         client.on_message = on_message
         client.ws_set_options(path="/ws", headers=None)
         print("Connecting...")
-        client.connect(broker_url, 80, 60)
-        print("...done")
-    except DUT.ExpectTimeout:
-        raise ValueError('ENV_TEST_FAILURE: Cannot connect to AP')
+        client.connect(broker_url, broker_port, 60)
     except Exception:
         print("ENV_TEST_FAILURE: Unexpected error while connecting to broker {}: {}:".format(broker_url, sys.exc_info()[0]))
         raise
-    print("Start Looping...")
-    start = time.time()
-    while (time.time() - start) <= 20:
-        client.loop()
-    print("...done")
-    if g_broker_connected == 0:
-        raise ValueError('ENV_TEST_FAILURE: Test script cannot connect to broker: {}'.format(broker_url))
-    # 3. check the message received back from the server
-    if g_recv_topic == "/topic/qos0" and g_recv_data == "data":
-        print("PASS: Received correct message")
-    else:
-        print("Failure!")
-        raise ValueError('Wrong data received topic: {}, data:{}'.format(g_recv_topic, g_recv_data))
-    # 4. check that the esp32 client received data sent by this python client
-    dut1.expect(re.compile(r"DATA=data_to_esp32"), timeout=30)
+    # Starting a py-client in a separate thread
+    thread1 = Thread(target=mqtt_client_task, args=(client,))
+    thread1.start()
+    try:
+        print("Connecting py-client to broker {}:{}...".format(broker_url, broker_port))
+        if not event_client_connected.wait(timeout=30):
+            raise ValueError("ENV_TEST_FAILURE: Test script cannot connect to broker: {}".format(broker_url))
+        dut1.start_app()
+        try:
+            ip_address = dut1.expect(re.compile(r" sta ip: ([^,]+),"), timeout=30)
+            print("Connected to AP with IP: {}".format(ip_address))
+        except DUT.ExpectTimeout:
+            print('ENV_TEST_FAILURE: Cannot connect to AP')
+            raise
+        print("Checking py-client received msg published from esp...")
+        if not event_client_received_correct.wait(timeout=30):
+            raise ValueError('Wrong data received, msg log: {}'.format(message_log))
+        print("Checking esp-client received msg published from py-client...")
+        dut1.expect(re.compile(r"DATA=data_to_esp32"), timeout=30)
+    finally:
+        event_stop_client.set()
+        thread1.join()
 
 
 if __name__ == '__main__':