when: always
paths:
- build_examples/*/*/*/build/*.bin
+ - build_examples/*/*/*/sdkconfig
- build_examples/*/*/*/build/*.elf
- build_examples/*/*/*/build/*.map
- build_examples/*/*/*/build/download.config
when: always
paths:
- build_examples_cmake/*/*/*/build/*.bin
+ - build_examples_cmake/*/*/*/sdkconfig
- build_examples_cmake/*/*/*/build/*.elf
- build_examples_cmake/*/*/*/build/*.map
- build_examples_cmake/*/*/*/build/download.config
help
WiFi password (WPA or WPA2) for the example to use.
+config BROKER_URI
+ string "Broker URL"
+ default "mqtts://iot.eclipse.org:8883"
+ help
+ URL of an mqtt broker which this example connects to.
+
+config BROKER_CERTIFICATE_OVERRIDE
+ string "Broker certificate override"
+ default ""
+ help
+ Please leave empty if broker certificate included from a textfile; otherwise fill in a base64 part of PEM format certificate
+
+config BROKER_CERTIFICATE_OVERRIDDEN
+ bool
+ default y if BROKER_CERTIFICATE_OVERRIDE != ""
+
endmenu
xEventGroupWaitBits(wifi_event_group, CONNECTED_BIT, false, true, portMAX_DELAY);
}
-extern const uint8_t iot_eclipse_org_pem_start[] asm("_binary_iot_eclipse_org_pem_start");
+#if CONFIG_BROKER_CERTIFICATE_OVERRIDDEN == 1
+static const uint8_t iot_eclipse_org_pem_start[] = "-----BEGIN CERTIFICATE-----\n" CONFIG_BROKER_CERTIFICATE_OVERRIDE "\n-----END CERTIFICATE-----";
+#else
+extern const uint8_t iot_eclipse_org_pem_start[] asm("_binary_iot_eclipse_org_pem_start");
+#endif
extern const uint8_t iot_eclipse_org_pem_end[] asm("_binary_iot_eclipse_org_pem_end");
static esp_err_t mqtt_event_handler(esp_mqtt_event_handle_t event)
return ESP_OK;
}
+
static void mqtt_app_start(void)
{
const esp_mqtt_client_config_t mqtt_cfg = {
- .uri = "mqtts://iot.eclipse.org:8883",
+ .uri = CONFIG_BROKER_URI,
.event_handle = mqtt_event_handler,
.cert_pem = (const char *)iot_eclipse_org_pem_start,
};
+from __future__ import print_function
+from __future__ import unicode_literals
+from builtins import str
import re
import os
import sys
-import time
import ssl
import paho.mqtt.client as mqtt
+from threading import Thread, Event
+
try:
import IDF
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 + " " + str(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_ssl(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 ssl broker
# check and log bin size
binary_file = os.path.join(dut1.app.binary_path, "mqtt_ssl.bin")
bin_size = os.path.getsize(binary_file)
- IDF.log_performance("mqtt_ssl_bin_size", "{}KB".format(bin_size // 1024))
+ IDF.log_performance("mqtt_ssl_bin_size", "{}KB"
+ .format(bin_size // 1024))
IDF.check_performance("mqtt_ssl_size", bin_size // 1024)
- # 1. start test (and check the environment is healthy)
- dut1.start_app()
+ # 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
- # 2. Test connects to a broker
+ # 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()
client.on_connect = on_connect
client.on_message = on_message
None, cert_reqs=ssl.CERT_NONE, tls_version=ssl.PROTOCOL_TLSv1, ciphers=None)
client.tls_insecure_set(True)
print("Connecting...")
- client.connect(broker_url, 8883, 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__':
--- /dev/null
+CONFIG_BROKER_URI="mqtts://${EXAMPLE_MQTT_BROKER_SSL}"
+CONFIG_BROKER_CERTIFICATE_OVERRIDE="${EXAMPLE_MQTT_BROKER_CERTIFICATE}"
URL of the broker to connect to
config BROKER_URL_FROM_STDIN
- bool
- default y if BROKER_URL = "FROM_STDIN"
+ bool
+ default y if BROKER_URL = "FROM_STDIN"
endmenu
help
WiFi password (WPA or WPA2) for the example to use.
+config BROKER_URI
+ string "Broker URL"
+ default "ws://iot.eclipse.org:80/ws"
+ help
+ URL of an mqtt broker which this example connects to.
+
endmenu
static void mqtt_app_start(void)
{
const esp_mqtt_client_config_t mqtt_cfg = {
- .uri = "ws://iot.eclipse.org:80/ws",
+ .uri = CONFIG_BROKER_URI,
.event_handle = mqtt_event_handler,
// .user_context = (void *)your_context
};
import re
import os
import sys
-import time
import paho.mqtt.client as mqtt
+from threading import Thread, Event
+
try:
import IDF
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
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()
+ # 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
- # 2. Test connects to a broker
+ # 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__':
--- /dev/null
+CONFIG_BROKER_URI="ws://${EXAMPLE_MQTT_BROKER_WS}/ws"
help
WiFi password (WPA or WPA2) for the example to use.
+config BROKER_URI
+ string "Broker URL"
+ default "wss://iot.eclipse.org:443/ws"
+ help
+ URL of an mqtt broker which this example connects to.
+
+config BROKER_CERTIFICATE_OVERRIDE
+ string "Server certificate override"
+ default ""
+ help
+ Please leave empty if server certificate included from a textfile; otherwise fill in a base64 part of PEM format certificate
+
+config BROKER_CERTIFICATE_OVERRIDDEN
+ bool
+ default y if BROKER_CERTIFICATE_OVERRIDE != ""
+
endmenu
xEventGroupWaitBits(wifi_event_group, CONNECTED_BIT, false, true, portMAX_DELAY);
}
-extern const uint8_t iot_eclipse_org_pem_start[] asm("_binary_iot_eclipse_org_pem_start");
+#if CONFIG_BROKER_CERTIFICATE_OVERRIDDEN == 1
+static const uint8_t iot_eclipse_org_pem_start[] = "-----BEGIN CERTIFICATE-----\n" CONFIG_BROKER_CERTIFICATE_OVERRIDE "\n-----END CERTIFICATE-----";
+#else
+extern const uint8_t iot_eclipse_org_pem_start[] asm("_binary_iot_eclipse_org_pem_start");
+#endif
extern const uint8_t iot_eclipse_org_pem_end[] asm("_binary_iot_eclipse_org_pem_end");
static esp_err_t mqtt_event_handler(esp_mqtt_event_handle_t event)
static void mqtt_app_start(void)
{
const esp_mqtt_client_config_t mqtt_cfg = {
- .uri = "wss://iot.eclipse.org:443/ws",
+ .uri = CONFIG_BROKER_URI,
.event_handle = mqtt_event_handler,
.cert_pem = (const char *)iot_eclipse_org_pem_start,
};
from __future__ import unicode_literals
+from __future__ import unicode_literals
+from builtins import str
import re
import os
import sys
-import time
import ssl
import paho.mqtt.client as mqtt
+from threading import Thread, Event
+
try:
import IDF
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 + " " + str(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_wss(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 wss broker
bin_size = os.path.getsize(binary_file)
IDF.log_performance("mqtt_websocket_secure_bin_size", "{}KB".format(bin_size // 1024))
IDF.check_performance("mqtt_websocket_secure_size", bin_size // 1024)
- # 1. start test (and check the environment is healthy)
- dut1.start_app()
+ # 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
- # 2. Test connects to a broker
+ # 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
None,
None, cert_reqs=ssl.CERT_NONE, tls_version=ssl.PROTOCOL_TLSv1, ciphers=None)
print("Connecting...")
- client.connect(broker_url, 443, 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__':
--- /dev/null
+CONFIG_BROKER_URI="wss://${EXAMPLE_MQTT_BROKER_WSS}/ws"
+CONFIG_BROKER_CERTIFICATE_OVERRIDE="${EXAMPLE_MQTT_BROKER_CERTIFICATE}"
+
def main():
# Sanitize environment variables
vars_to_remove = []
- for var_name in os.environ.iterkeys():
+ for var_name in os.environ.keys():
if var_name.startswith('CI_'):
vars_to_remove.append(var_name)
for var_name in vars_to_remove:
assert os.path.exists(idf_path)
return idf_path
+ def _get_sdkconfig_paths(self):
+ """
+ returns list of possible paths where sdkconfig could be found
+
+ Note: could be overwritten by a derived class to provide other locations or order
+ """
+ return [os.path.join(self.binary_path, "sdkconfig"), os.path.join(self.binary_path, "..", "sdkconfig")]
+
+ def get_sdkconfig(self):
+ """
+ reads sdkconfig and returns a dictionary with all configuredvariables
+
+ :param sdkconfig_file: location of sdkconfig
+ :raise: AssertionError: if sdkconfig file does not exist in defined paths
+ """
+ d = {}
+ sdkconfig_file = None
+ for i in self._get_sdkconfig_paths():
+ if os.path.exists(i):
+ sdkconfig_file = i
+ break
+ assert sdkconfig_file is not None
+ with open(sdkconfig_file) as f:
+ for line in f:
+ configs = line.split('=')
+ if len(configs) == 2:
+ d[configs[0]] = configs[1]
+ return d
+
def get_binary_path(self, app_path):
"""
get binary path according to input app_path.
class Example(IDFApp):
+ def _get_sdkconfig_paths(self):
+ """
+ overrides the parent method to provide exact path of sdkconfig for example tests
+ """
+ return [os.path.join(self.binary_path, "..", "sdkconfig")]
+
def get_binary_path(self, app_path):
# build folder of example path
path = os.path.join(self.idf_path, app_path, "build")
projects / esp-idf / commitdiff