Examples: migration mqtt examples to pytest

examples/protocols/mqtt/ssl/pytest_mqtt_ssl.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Unlicense OR CC0-1.0
+import logging
 import os
 import re
 import ssl
@@ -5,8 +8,9 @@ import sys
 from threading import Event, Thread
 
 import paho.mqtt.client as mqtt
-import ttfw_idf
-from tiny_test_fw import DUT
+import pexpect
+import pytest
+from pytest_embedded import Dut
 
 event_client_connected = Event()
 event_stop_client = Event()
@@ -16,19 +20,20 @@ message_log = ''
 
 
 # The callback for when the client receives a CONNACK response from the server.
-def on_connect(client, userdata, flags, rc):
+def on_connect(client, userdata, flags, rc):  # type: (mqtt.Client, str, bool, str) -> None
+    _ = (userdata, flags)
     print('Connected with result code ' + str(rc))
     event_client_connected.set()
     client.subscribe('/topic/qos0')
 
 
-def mqtt_client_task(client):
+def mqtt_client_task(client):  # type: (mqtt.Client) -> None
     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):
+def on_message(client, userdata, msg):  # type: (mqtt.Client, tuple, mqtt.client.MQTTMessage) -> None
     global message_log
     global event_client_received_correct
     global event_client_received_binary
@@ -55,8 +60,9 @@ def on_message(client, userdata, msg):
     message_log += 'Received data:' + msg.topic + ' ' + payload + '\n'
 
 
-@ttfw_idf.idf_example_test(env_tag='ethernet_router')
-def test_examples_protocol_mqtt_ssl(env, extra_data):
+@pytest.mark.esp32
+@pytest.mark.ethernet
+def test_examples_protocol_mqtt_ssl(dut):  # type: (Dut) -> None
     broker_url = ''
     broker_port = 0
     """
@@ -67,18 +73,17 @@ def test_examples_protocol_mqtt_ssl(env, extra_data):
       4. Test ESP32 client received correct qos0 message
       5. Test python client receives binary data from running partition and compares it with the binary
     """
-    dut1 = env.get_dut('mqtt_ssl', 'examples/protocols/mqtt/ssl', dut_class=ttfw_idf.ESP32DUT)
-    # check and log bin size
-    binary_file = os.path.join(dut1.app.binary_path, 'mqtt_ssl.bin')
+    binary_file = os.path.join(dut.app.binary_path, 'mqtt_ssl.bin')
     bin_size = os.path.getsize(binary_file)
-    ttfw_idf.log_performance('mqtt_ssl_bin_size', '{}KB'
-                             .format(bin_size // 1024))
+    logging.info('[Performance][mqtt_ssl_bin_size]: %s KB', bin_size // 1024)
+
     # Look for host:port in sdkconfig
     try:
-        value = re.search(r'\:\/\/([^:]+)\:([0-9]+)', dut1.app.get_sdkconfig()['CONFIG_BROKER_URI'])
+        value = re.search(r'\:\/\/([^:]+)\:([0-9]+)', dut.app.sdkconfig.get('BROKER_URI'))
+        assert value is not None
         broker_url = value.group(1)
         broker_port = int(value.group(2))
-        bin_size = min(int(dut1.app.get_sdkconfig()['CONFIG_BROKER_BIN_SIZE_TO_SEND']), bin_size)
+        bin_size = min(int(dut.app.sdkconfig.get('BROKER_BIN_SIZE_TO_SEND')), bin_size)
     except Exception:
         print('ENV_TEST_FAILURE: Cannot find broker url in sdkconfig')
         raise
@@ -105,25 +110,20 @@ def test_examples_protocol_mqtt_ssl(env, extra_data):
         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'IPv4 address: (\d+\.\d+\.\d+\.\d+)[^\d]'), timeout=30)[0]
+            ip_address = dut.expect(r'IPv4 address: (\d+\.\d+\.\d+\.\d+)[^\d]', timeout=30)[0]
             print('Connected to AP with IP: {}'.format(ip_address))
-        except DUT.ExpectTimeout:
+        except pexpect.TIMEOUT:
             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=send binary please'), timeout=30)
+        dut.expect(r'DATA=send binary please', timeout=30)
         print('Receiving binary data from running partition...')
         if not event_client_received_binary.wait(timeout=30):
             raise ValueError('Binary not received within timeout')
     finally:
         event_stop_client.set()
         thread1.join()
-
-
-if __name__ == '__main__':
-    test_examples_protocol_mqtt_ssl()

examples/protocols/mqtt/tcp/pytest_mqtt_tcp.py

@@ -1,19 +1,22 @@
+# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Unlicense OR CC0-1.0
+import logging
 import os
-import re
 import socket
 import struct
 import sys
 import time
 from threading import Thread
 
-import ttfw_idf
+import pexpect
+import pytest
 from common_test_methods import get_host_ip4_by_dest_ip
-from tiny_test_fw import DUT
+from pytest_embedded import Dut
 
 msgid = -1
 
 
-def mqqt_server_sketch(my_ip, port):
+def mqqt_server_sketch(my_ip, port):  # type: (str, str) -> None
     global msgid
     print('Starting the server on {}'.format(my_ip))
     s = None
@@ -32,13 +35,13 @@ def mqqt_server_sketch(my_ip, port):
         raise
     data = q.recv(1024)
     # check if received initial empty message
-    print('received from client {}'.format(data))
+    print('received from client {!r}'.format(data))
     data = bytearray([0x20, 0x02, 0x00, 0x00])
     q.send(data)
     # try to receive qos1
     data = q.recv(1024)
     msgid = struct.unpack('>H', data[15:17])[0]
-    print('received from client {}, msgid: {}'.format(data, msgid))
+    print('received from client {!r}, msgid: {}'.format(data, msgid))
     data = bytearray([0x40, 0x02, data[15], data[16]])
     q.send(data)
     time.sleep(5)
@@ -46,8 +49,9 @@ def mqqt_server_sketch(my_ip, port):
     print('server closed')
 
 
-@ttfw_idf.idf_example_test(env_tag='ethernet_router')
-def test_examples_protocol_mqtt_qos1(env, extra_data):
+@pytest.mark.esp32
+@pytest.mark.ethernet
+def test_examples_protocol_mqtt_qos1(dut: Dut) -> None:
     global msgid
     """
     steps: (QoS1: Happy flow)
@@ -56,18 +60,15 @@ def test_examples_protocol_mqtt_qos1(env, extra_data):
       3. Test evaluates that qos1 message is queued and removed from queued after ACK received
       4. Test the broker received the same message id evaluated in step 3
     """
-    dut1 = env.get_dut('mqtt_tcp', 'examples/protocols/mqtt/tcp', dut_class=ttfw_idf.ESP32DUT)
     # check and log bin size
-    binary_file = os.path.join(dut1.app.binary_path, 'mqtt_tcp.bin')
+    binary_file = os.path.join(dut.app.binary_path, 'mqtt_tcp.bin')
     bin_size = os.path.getsize(binary_file)
-    ttfw_idf.log_performance('mqtt_tcp_bin_size', '{}KB'.format(bin_size // 1024))
-    # 1. start the dut test and wait till client gets IP address
-    dut1.start_app()
+    logging.info('[Performance][mqtt_tcp_bin_size]: %s KB', bin_size // 1024)
     # waiting for getting the IP address
     try:
-        ip_address = dut1.expect(re.compile(r'IPv4 address: (\d+\.\d+\.\d+\.\d+)[^\d]'), timeout=30)[0]
+        ip_address = dut.expect(r'IPv4 address: (\d+\.\d+\.\d+\.\d+)', timeout=30).group(1).decode()
         print('Connected to AP/Ethernet with IP: {}'.format(ip_address))
-    except DUT.ExpectTimeout:
+    except pexpect.TIMEOUT:
         raise ValueError('ENV_TEST_FAILURE: Cannot connect to AP/Ethernet')
 
     # 2. start mqtt broker sketch
@@ -75,20 +76,17 @@ def test_examples_protocol_mqtt_qos1(env, extra_data):
     thread1 = Thread(target=mqqt_server_sketch, args=(host_ip,1883))
     thread1.start()
 
-    print('writing to device: {}'.format('mqtt://' + host_ip + '\n'))
-    dut1.write('mqtt://' + host_ip + '\n')
+    data_write = 'mqtt://' + host_ip
+    print('writing to device: {}'.format(data_write))
+    dut.write(data_write)
     thread1.join()
     print('Message id received from server: {}'.format(msgid))
     # 3. check the message id was enqueued and then deleted
-    msgid_enqueued = dut1.expect(re.compile(r'outbox: ENQUEUE msgid=([0-9]+)'), timeout=30)
-    msgid_deleted = dut1.expect(re.compile(r'outbox: DELETED msgid=([0-9]+)'), timeout=30)
+    msgid_enqueued = dut.expect(b'outbox: ENQUEUE msgid=([0-9]+)', timeout=30).group(1).decode()
+    msgid_deleted = dut.expect(b'outbox: DELETED msgid=([0-9]+)', timeout=30).group(1).decode()
     # 4. check the msgid of received data are the same as that of enqueued and deleted from outbox
-    if (msgid_enqueued[0] == str(msgid) and msgid_deleted[0] == str(msgid)):
+    if (msgid_enqueued == str(msgid) and msgid_deleted == str(msgid)):
         print('PASS: Received correct msg id')
     else:
         print('Failure!')
         raise ValueError('Mismatch of msgid: received: {}, enqueued {}, deleted {}'.format(msgid, msgid_enqueued, msgid_deleted))
-
-
-if __name__ == '__main__':
-    test_examples_protocol_mqtt_qos1()

examples/protocols/mqtt/ws/pytest_mqtt_ws_example.py

@@ -1,11 +1,16 @@
+#!/usr/bin/env python
+#
+# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Unlicense OR CC0-1.0
+import logging
 import os
 import re
 import sys
 from threading import Event, Thread
 
 import paho.mqtt.client as mqtt
-import ttfw_idf
-from tiny_test_fw import DUT
+import pytest
+from pytest_embedded import Dut
 
 event_client_connected = Event()
 event_stop_client = Event()
@@ -14,19 +19,21 @@ message_log = ''
 
 
 # The callback for when the client receives a CONNACK response from the server.
-def on_connect(client, userdata, flags, rc):
+def on_connect(client, userdata, flags, rc):  # type: (mqtt.Client, tuple, bool, str) -> None
+    _ = (userdata, flags)
     print('Connected with result code ' + str(rc))
     event_client_connected.set()
     client.subscribe('/topic/qos0')
 
 
-def mqtt_client_task(client):
+def mqtt_client_task(client):  # type: (mqtt.Client) -> None
     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):
+def on_message(client, userdata, msg):  # type: (mqtt.Client, tuple, mqtt.client.MQTTMessage) -> None
+    _ = userdata
     global message_log
     payload = msg.payload.decode()
     if not event_client_received_correct.is_set() and payload == 'data':
@@ -36,8 +43,9 @@ def on_message(client, userdata, msg):
     message_log += 'Received data:' + msg.topic + ' ' + payload + '\n'
 
 
-@ttfw_idf.idf_example_test(env_tag='ethernet_router')
-def test_examples_protocol_mqtt_ws(env, extra_data):
+@pytest.mark.esp32
+@pytest.mark.ethernet
+def test_examples_protocol_mqtt_ws(dut):  # type: (Dut) -> None
     broker_url = ''
     broker_port = 0
     """
@@ -47,14 +55,14 @@ def test_examples_protocol_mqtt_ws(env, extra_data):
       3. Test evaluates it received correct qos0 message
       4. Test ESP32 client received correct qos0 message
     """
-    dut1 = env.get_dut('mqtt_websocket', 'examples/protocols/mqtt/ws', dut_class=ttfw_idf.ESP32DUT)
     # check and log bin size
-    binary_file = os.path.join(dut1.app.binary_path, 'mqtt_websocket.bin')
+    binary_file = os.path.join(dut.app.binary_path, 'mqtt_websocket.bin')
     bin_size = os.path.getsize(binary_file)
-    ttfw_idf.log_performance('mqtt_websocket_bin_size', '{}KB'.format(bin_size // 1024))
+    logging.info('[Performance][mqtt_websocket_bin_size]: %s KB', bin_size // 1024)
     # Look for host:port in sdkconfig
     try:
-        value = re.search(r'\:\/\/([^:]+)\:([0-9]+)', dut1.app.get_sdkconfig()['CONFIG_BROKER_URI'])
+        value = re.search(r'\:\/\/([^:]+)\:([0-9]+)', dut.app.sdkconfig.get('BROKER_URI'))
+        assert value is not None
         broker_url = value.group(1)
         broker_port = int(value.group(2))
     except Exception:
@@ -78,22 +86,17 @@ def test_examples_protocol_mqtt_ws(env, extra_data):
         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'IPv4 address: (\d+\.\d+\.\d+\.\d+)[^\d]'), timeout=30)[0]
+            ip_address = dut.expect(r'IPv4 address: (\d+\.\d+\.\d+\.\d+)[^\d]', timeout=30)[0]
             print('Connected to AP with IP: {}'.format(ip_address))
-        except DUT.ExpectTimeout:
+        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)
+        dut.expect(r'DATA=data_to_esp32', timeout=30)
     finally:
         event_stop_client.set()
         thread1.join()
-
-
-if __name__ == '__main__':
-    test_examples_protocol_mqtt_ws()

examples/protocols/mqtt/wss/pytest_mqtt_wss_example.py

@@ -1,3 +1,8 @@
+#!/usr/bin/env python
+#
+# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Unlicense OR CC0-1.0
+import logging
 import os
 import re
 import ssl
@@ -5,8 +10,9 @@ import sys
 from threading import Event, Thread
 
 import paho.mqtt.client as mqtt
-import ttfw_idf
-from tiny_test_fw import DUT
+import pexpect
+import pytest
+from pytest_embedded import Dut
 
 event_client_connected = Event()
 event_stop_client = Event()
@@ -15,19 +21,21 @@ message_log = ''
 
 
 # The callback for when the client receives a CONNACK response from the server.
-def on_connect(client, userdata, flags, rc):
+def on_connect(client, userdata, flags, rc):  # type: (mqtt.Client, tuple, bool, str) -> None
+    _ = (userdata, flags)
     print('Connected with result code ' + str(rc))
     event_client_connected.set()
     client.subscribe('/topic/qos0')
 
 
-def mqtt_client_task(client):
+def mqtt_client_task(client):  # type: (mqtt.Client) -> None
     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):
+def on_message(client, userdata, msg):  # type: (mqtt.Client, tuple, mqtt.client.MQTTMessage) -> None
+    _ = userdata
     global message_log
     payload = msg.payload.decode()
     if not event_client_received_correct.is_set() and payload == 'data':
@@ -37,8 +45,9 @@ def on_message(client, userdata, msg):
     message_log += 'Received data:' + msg.topic + ' ' + payload + '\n'
 
 
-@ttfw_idf.idf_example_test(env_tag='ethernet_router')
-def test_examples_protocol_mqtt_wss(env, extra_data):
+@pytest.mark.esp32
+@pytest.mark.ethernet
+def test_examples_protocol_mqtt_wss(dut):  # type: (Dut) -> None
     broker_url = ''
     broker_port = 0
     """
@@ -48,14 +57,14 @@ def test_examples_protocol_mqtt_wss(env, extra_data):
       3. Test evaluates it received correct qos0 message
       4. Test ESP32 client received correct qos0 message
     """
-    dut1 = env.get_dut('mqtt_websocket_secure', 'examples/protocols/mqtt/wss', dut_class=ttfw_idf.ESP32DUT)
     # check and log bin size
-    binary_file = os.path.join(dut1.app.binary_path, 'mqtt_websocket_secure.bin')
+    binary_file = os.path.join(dut.app.binary_path, 'mqtt_websocket_secure.bin')
     bin_size = os.path.getsize(binary_file)
-    ttfw_idf.log_performance('mqtt_websocket_secure_bin_size', '{}KB'.format(bin_size // 1024))
+    logging.info('[Performance][mqtt_websocket_secure_bin_size]: %s KB', bin_size // 1024)
     # Look for host:port in sdkconfig
     try:
-        value = re.search(r'\:\/\/([^:]+)\:([0-9]+)', dut1.app.get_sdkconfig()['CONFIG_BROKER_URI'])
+        value = re.search(r'\:\/\/([^:]+)\:([0-9]+)', dut.app.sdkconfig.get('BROKER_URI'))
+        assert value is not None
         broker_url = value.group(1)
         broker_port = int(value.group(2))
     except Exception:
@@ -82,22 +91,17 @@ def test_examples_protocol_mqtt_wss(env, extra_data):
         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'IPv4 address: (\d+\.\d+\.\d+\.\d+)[^\d]'), timeout=30)[0]
+            ip_address = dut.expect(r'IPv4 address: (\d+\.\d+\.\d+\.\d+)[^\d]', timeout=30)[0]
             print('Connected to AP with IP: {}'.format(ip_address))
-        except DUT.ExpectTimeout:
+        except pexpect.TIMEOUT:
             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)
+        dut.expect(r'DATA=data_to_esp32', timeout=30)
     finally:
         event_stop_client.set()
         thread1.join()
-
-
-if __name__ == '__main__':
-    test_examples_protocol_mqtt_wss()