lwip: Migrate unit tests to test_apps

components/lwip/test_apps/.build-test-rules.yml

@@ -0,0 +1,6 @@
+# Documentation: .gitlab/ci/README.md#manifest-file-to-control-the-buildtest-apps
+
+components/lwip/test_apps:
+  disable_test:
+    - if: IDF_TARGET != "esp32"
+      reason: running this test for one target only is enough to be sufficiently confident about no regression in lwip

components/lwip/test_apps/CMakeLists.txt

@@ -0,0 +1,7 @@
+# This is the project CMakeLists.txt file for the test subproject
+cmake_minimum_required(VERSION 3.16)
+
+set(EXTRA_COMPONENT_DIRS "$ENV{IDF_PATH}/tools/unit-test-app/components")
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(lwip_test)

components/lwip/test_apps/README.md

@@ -0,0 +1,2 @@
+| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-S2 | ESP32-S3 |
+| ----------------- | ----- | -------- | -------- | -------- | -------- |

components/lwip/test_apps/main/CMakeLists.txt

@@ -0,0 +1,4 @@
+idf_component_register(SRCS "lwip_test.c"
+                       REQUIRES test_utils
+                       INCLUDE_DIRS "."
+                       PRIV_REQUIRES unity lwip test_utils)

components/lwip/test_apps/main/lwip_test.c

@@ -0,0 +1,173 @@
+/*
+ * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#include <stdio.h>
+#include <string.h>
+#include <esp_types.h>
+
+#include "freertos/FreeRTOS.h"
+#include "freertos/event_groups.h"
+#include "test_utils.h"
+#include "unity.h"
+#include "unity_fixture.h"
+
+#include "unity_test_utils.h"
+#include "soc/soc_caps.h"
+
+#include "lwip/inet.h"
+#include "lwip/netdb.h"
+#include "lwip/sockets.h"
+#include "ping/ping_sock.h"
+#include "dhcpserver/dhcpserver.h"
+
+#define ETH_PING_END_BIT BIT(1)
+#define ETH_PING_DURATION_MS (5000)
+#define ETH_PING_END_TIMEOUT_MS (ETH_PING_DURATION_MS * 2)
+#define TEST_ICMP_DESTINATION_DOMAIN_NAME "127.0.0.1"
+
+
+TEST_GROUP(lwip);
+
+TEST_SETUP(lwip)
+{
+}
+
+TEST_TEAR_DOWN(lwip)
+{
+}
+
+static void test_on_ping_success(esp_ping_handle_t hdl, void *args)
+{
+    uint8_t ttl;
+    uint16_t seqno;
+    uint32_t elapsed_time, recv_len;
+    ip_addr_t target_addr;
+    esp_ping_get_profile(hdl, ESP_PING_PROF_SEQNO, &seqno, sizeof(seqno));
+    esp_ping_get_profile(hdl, ESP_PING_PROF_TTL, &ttl, sizeof(ttl));
+    esp_ping_get_profile(hdl, ESP_PING_PROF_IPADDR, &target_addr, sizeof(target_addr));
+    esp_ping_get_profile(hdl, ESP_PING_PROF_SIZE, &recv_len, sizeof(recv_len));
+    esp_ping_get_profile(hdl, ESP_PING_PROF_TIMEGAP, &elapsed_time, sizeof(elapsed_time));
+    printf("%" PRId32 "bytes from %s icmp_seq=%d ttl=%d time=%" PRId32 " ms\n",
+           recv_len, inet_ntoa(target_addr.u_addr.ip4), seqno, ttl, elapsed_time);
+}
+
+static void test_on_ping_timeout(esp_ping_handle_t hdl, void *args)
+{
+    uint16_t seqno;
+    ip_addr_t target_addr;
+    esp_ping_get_profile(hdl, ESP_PING_PROF_SEQNO, &seqno, sizeof(seqno));
+    esp_ping_get_profile(hdl, ESP_PING_PROF_IPADDR, &target_addr, sizeof(target_addr));
+    printf("From %s icmp_seq=%d timeout\n", inet_ntoa(target_addr.u_addr.ip4), seqno);
+}
+
+static void test_on_ping_end(esp_ping_handle_t hdl, void *args)
+{
+    EventGroupHandle_t eth_event_group = (EventGroupHandle_t)args;
+    uint32_t transmitted;
+    uint32_t received;
+    uint32_t total_time_ms;
+
+    esp_ping_get_profile(hdl, ESP_PING_PROF_REQUEST, &transmitted, sizeof(transmitted));
+    esp_ping_get_profile(hdl, ESP_PING_PROF_REPLY, &received, sizeof(received));
+    esp_ping_get_profile(hdl, ESP_PING_PROF_DURATION, &total_time_ms, sizeof(total_time_ms));
+    printf("%" PRId32 " packets transmitted, %" PRId32 " received, time %" PRId32 "ms\n", transmitted, received, total_time_ms);
+    if (transmitted == received) {
+        xEventGroupSetBits(eth_event_group, ETH_PING_END_BIT);
+    }
+}
+
+TEST(lwip, localhost_ping_test)
+{
+    EventBits_t bits;
+    EventGroupHandle_t eth_event_group = xEventGroupCreate();
+    TEST_ASSERT(eth_event_group != NULL);
+    test_case_uses_tcpip();
+
+    // Parse IP address: Destination is a localhost address, so we don't need any interface (esp-netif/driver)
+    ip_addr_t target_addr;
+    struct addrinfo hint;
+    struct addrinfo *res = NULL;
+    memset(&hint, 0, sizeof(hint));
+    memset(&target_addr, 0, sizeof(target_addr));
+    /* convert URL to IP */
+    TEST_ASSERT(getaddrinfo(TEST_ICMP_DESTINATION_DOMAIN_NAME, NULL, &hint, &res) == 0);
+    struct in_addr addr4 = ((struct sockaddr_in *)(res->ai_addr))->sin_addr;
+    inet_addr_to_ip4addr(ip_2_ip4(&target_addr), &addr4);
+    freeaddrinfo(res);
+
+    esp_ping_config_t ping_config = ESP_PING_DEFAULT_CONFIG();
+    ping_config.timeout_ms = 2000;
+    ping_config.target_addr = target_addr;
+    ping_config.count = 0; // ping in infinite mode
+    /* set callback functions */
+    esp_ping_callbacks_t cbs;
+    cbs.on_ping_success = test_on_ping_success;
+    cbs.on_ping_timeout = test_on_ping_timeout;
+    cbs.on_ping_end = test_on_ping_end;
+    cbs.cb_args = eth_event_group;
+
+    esp_ping_handle_t ping;
+    TEST_ESP_OK(esp_ping_new_session(&ping_config, &cbs, &ping));
+    /* start ping */
+    TEST_ESP_OK(esp_ping_start(ping));
+    /* ping for a while */
+    vTaskDelay(pdMS_TO_TICKS(ETH_PING_DURATION_MS));
+    /* stop ping */
+    TEST_ESP_OK(esp_ping_stop(ping));
+    /* wait for end of ping */
+    bits = xEventGroupWaitBits(eth_event_group, ETH_PING_END_BIT, true, true, pdMS_TO_TICKS(ETH_PING_END_TIMEOUT_MS));
+    TEST_ASSERT((bits & ETH_PING_END_BIT) == ETH_PING_END_BIT);
+    /* restart ping */
+    TEST_ESP_OK(esp_ping_start(ping));
+    vTaskDelay(pdMS_TO_TICKS(ETH_PING_DURATION_MS));
+    TEST_ESP_OK(esp_ping_stop(ping));
+    bits = xEventGroupWaitBits(eth_event_group, ETH_PING_END_BIT, true, true, pdMS_TO_TICKS(ETH_PING_END_TIMEOUT_MS));
+    TEST_ASSERT((bits & ETH_PING_END_BIT) == ETH_PING_END_BIT);
+    /* de-initialize ping process */
+    TEST_ESP_OK(esp_ping_delete_session(ping));
+
+    vEventGroupDelete(eth_event_group);
+}
+
+TEST(lwip, dhcp_server_init_deinit)
+{
+    dhcps_t *dhcps = dhcps_new();
+    TEST_ASSERT_NOT_NULL(dhcps);
+    ip4_addr_t ip = { .addr = IPADDR_ANY };
+    TEST_ASSERT(dhcps_start(dhcps, NULL, ip) == ERR_ARG);
+    TEST_ASSERT(dhcps_stop(dhcps, NULL) == ERR_ARG);
+    dhcps_delete(dhcps);
+}
+
+TEST(lwip, dhcp_server_start_stop_localhost)
+{
+    test_case_uses_tcpip();
+    dhcps_t *dhcps = dhcps_new();
+    struct netif *netif;
+
+    NETIF_FOREACH(netif) {
+        if (netif->name[0] == 'l' && netif->name[1] == 'o') {
+            break;
+        }
+    }
+    TEST_ASSERT_NOT_NULL(netif);
+
+    ip4_addr_t ip = { .addr = 0x7f0001 };
+    TEST_ASSERT(dhcps_start(dhcps, netif, ip) == ERR_OK);
+    TEST_ASSERT(dhcps_stop(dhcps, netif) == ERR_OK);
+    dhcps_delete(dhcps);
+}
+
+TEST_GROUP_RUNNER(lwip)
+{
+    RUN_TEST_CASE(lwip, localhost_ping_test)
+    RUN_TEST_CASE(lwip, dhcp_server_init_deinit)
+    RUN_TEST_CASE(lwip, dhcp_server_start_stop_localhost)
+}
+
+void app_main(void)
+{
+    UNITY_MAIN(lwip);
+}

components/lwip/test_apps/pytest_lwip.py

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
+
+import pytest
+from pytest_embedded import Dut
+
+
+@pytest.mark.esp32
+@pytest.mark.generic
+def test_lwip(dut: Dut) -> None:
+    dut.expect_unity_test_output()

components/lwip/test_apps/sdkconfig.defaults

@@ -0,0 +1,2 @@
+CONFIG_UNITY_ENABLE_FIXTURE=y
+CONFIG_UNITY_ENABLE_IDF_TEST_RUNNER=n