Merge branch 'feature/mqtt_unit_test' into 'master'

mqtt: basic set of unit tests, modify example tests to check ssl connect

See merge request espressif/esp-idf!7393

components/mqtt/test/CMakeLists.txt

@@ -0,0 +1,2 @@
+idf_component_register(SRC_DIRS "."
+                    PRIV_REQUIRES unity test_utils mqtt nvs_flash app_update)

components/mqtt/test/component.mk

@@ -0,0 +1,4 @@
+#
+#Component Makefile
+#
+COMPONENT_ADD_LDFLAGS = -Wl,--whole-archive -l$(COMPONENT_NAME) -Wl,--no-whole-archive

components/mqtt/test/test_mqtt.c

@@ -0,0 +1,70 @@
+#include "test_utils.h"
+#include "mqtt_client.h"
+#include "unity.h"
+#include <sys/time.h>
+#include "nvs_flash.h"
+#include "esp_ota_ops.h"
+
+static void test_leak_setup(const char * file, long line)
+{
+    uint8_t mac[6];
+    struct timeval te;
+    gettimeofday(&te, NULL); // get current time
+    esp_read_mac(mac, ESP_MAC_WIFI_STA);
+    printf("%s:%ld: time=%ld.%lds, mac:" MACSTR "\n", file, line, te.tv_sec, te.tv_usec, MAC2STR(mac));
+    unity_reset_leak_checks();
+}
+
+static const char* this_bin_addr(void)
+{
+    spi_flash_mmap_handle_t out_handle;
+    const void *binary_address;
+    const esp_partition_t* partition = esp_ota_get_running_partition();
+    esp_partition_mmap(partition, 0, partition->size, SPI_FLASH_MMAP_DATA, &binary_address, &out_handle);
+    return binary_address;
+}
+
+TEST_CASE("mqtt init with invalid url", "[mqtt][leaks=0]")
+{
+    test_leak_setup(__FILE__, __LINE__);
+    const esp_mqtt_client_config_t mqtt_cfg = {
+            .uri = "INVALID",
+    };
+    esp_mqtt_client_handle_t client = esp_mqtt_client_init(&mqtt_cfg);
+    TEST_ASSERT_EQUAL(NULL, client );
+}
+
+TEST_CASE("mqtt init and deinit", "[mqtt][leaks=0]")
+{
+    test_leak_setup(__FILE__, __LINE__);
+    const esp_mqtt_client_config_t mqtt_cfg = {
+            // no connection takes place, but the uri has to be valid for init() to succeed 
+            .uri = "mqtts://localhost:8883",
+    };
+    esp_mqtt_client_handle_t client = esp_mqtt_client_init(&mqtt_cfg);
+    TEST_ASSERT_NOT_EQUAL(NULL, client );
+    esp_mqtt_client_destroy(client);
+}
+
+TEST_CASE("mqtt enqueue and destroy outbox", "[mqtt][leaks=0]")
+{
+    const char * bin_addr = this_bin_addr();
+    test_leak_setup(__FILE__, __LINE__);
+    const int messages = 20;
+    const int size = 2000;
+    const esp_mqtt_client_config_t mqtt_cfg = {
+            // no connection takes place, but the uri has to be valid for init() to succeed 
+            .uri = "mqtts://localhost:8883",
+    };
+    esp_mqtt_client_handle_t client = esp_mqtt_client_init(&mqtt_cfg);
+    TEST_ASSERT_NOT_EQUAL(NULL, client );
+    int bytes_before = esp_get_free_heap_size();
+    for (int i=0; i<messages; ++i) {
+        esp_mqtt_client_publish(client, "test", bin_addr, size, 1, 0);
+    }
+    int bytes_after = esp_get_free_heap_size();
+    // check that outbox allocated all messages on heap
+    TEST_ASSERT_GREATER_OR_EQUAL(messages*size, bytes_before - bytes_after);
+
+    esp_mqtt_client_destroy(client);
+}

components/mqtt/weekend_test/mqtt_publish_test.py

@@ -2,7 +2,6 @@ from __future__ import print_function
 from __future__ import unicode_literals
 from builtins import str
 import re
-import os
 import sys
 import ssl
 import paho.mqtt.client as mqtt
@@ -128,12 +127,7 @@ def test_weekend_mqtt_publish(env, extra_data):
       3. Test evaluates python client received correct qos0 message
       4. Test ESP32 client received correct qos0 message
     """
-    dut1 = env.get_dut("mqtt_publish", "examples/protocols/mqtt/publish_test")
-    # check and log bin size
-    binary_file = os.path.join(dut1.app.binary_path, "mqtt_publish.bin")
-    bin_size = os.path.getsize(binary_file)
-    ttfw_idf.log_performance("mqtt_publish_bin_size", "{}KB".format(bin_size // 1024))
-    ttfw_idf.check_performance("mqtt_publish_size", bin_size // 1024)
+    dut1 = env.get_dut("mqtt_publish_connect_test", "examples/protocols/mqtt/publish_connect_test")
     # Look for host:port in sdkconfig
     try:
         # python client subscribes to the topic to which esp client publishes and vice versa