unit test: move gpio, dedicated_gpio, sigmadelta unit test from unit-test-app to components/driver/test_apps/gpio

components/driver/test_apps/gpio/CMakeLists.txt

@@ -0,0 +1,18 @@
+# This is the project CMakeLists.txt file for the test subproject
+cmake_minimum_required(VERSION 3.5)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(gpio_test)
+
+if(CONFIG_COMPILER_DUMP_RTL_FILES)
+    add_custom_target(check_test_app_sections ALL
+                      COMMAND ${PYTHON} $ENV{IDF_PATH}/tools/ci/check_callgraph.py
+                      --rtl-dir ${CMAKE_BINARY_DIR}/esp-idf/driver/
+                      --elf-file ${CMAKE_BINARY_DIR}/gpio_test.elf
+                      find-refs
+                      --from-sections=.iram0.text
+                      --to-sections=.flash.text,.flash.rodata
+                      --exit-code
+                      DEPENDS ${elf}
+                      )
+endif()

components/driver/test_apps/gpio/main/CMakeLists.txt

@@ -0,0 +1,18 @@
+set(srcs "test_app_main.c"
+         "test_gpio.c")
+
+set(include_tests "-u test_app_include_gpio")
+
+if(CONFIG_SOC_DEDICATED_GPIO_SUPPORTED)
+    list(APPEND srcs "test_dedicated_gpio.c")
+    list(APPEND include_tests "-u test_app_include_dedicated_gpio")
+endif()
+
+if(CONFIG_SOC_SIGMADELTA_SUPPORTED)
+    list(APPEND srcs "test_sigmadelta.c")
+    list(APPEND include_tests "-u test_app_include_sigmadelta")
+endif()
+
+idf_component_register(SRCS ${srcs})
+
+target_link_libraries(${COMPONENT_LIB} INTERFACE ${include_tests})

components/driver/test_apps/gpio/main/test_app_main.c

@@ -0,0 +1,41 @@
+/*
+ * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "unity.h"
+#include "unity_test_runner.h"
+#include "esp_heap_caps.h"
+
+// Some resources are lazy allocated in gpio/dedicated_gpio/delta_sigma driver, the threshold is left for that case
+#define TEST_MEMORY_LEAK_THRESHOLD (-400)
+
+static size_t before_free_8bit;
+static size_t before_free_32bit;
+
+static void check_leak(size_t before_free, size_t after_free, const char *type)
+{
+    ssize_t delta = after_free - before_free;
+    printf("MALLOC_CAP_%s: Before %u bytes free, After %u bytes free (delta %d)\n", type, before_free, after_free, delta);
+    TEST_ASSERT_MESSAGE(delta >= TEST_MEMORY_LEAK_THRESHOLD, "memory leak");
+}
+
+void setUp(void)
+{
+    before_free_8bit = heap_caps_get_free_size(MALLOC_CAP_8BIT);
+    before_free_32bit = heap_caps_get_free_size(MALLOC_CAP_32BIT);
+}
+
+void tearDown(void)
+{
+    size_t after_free_8bit = heap_caps_get_free_size(MALLOC_CAP_8BIT);
+    size_t after_free_32bit = heap_caps_get_free_size(MALLOC_CAP_32BIT);
+    check_leak(before_free_8bit, after_free_8bit, "8BIT");
+    check_leak(before_free_32bit, after_free_32bit, "32BIT");
+}
+
+void app_main(void)
+{
+    unity_run_menu();
+}

components/driver/test_apps/gpio/main/test_dedicated_gpio.c

@@ -1,20 +1,25 @@
 /*
- * SPDX-FileCopyrightText: 2021 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
+
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
 #include "freertos/semphr.h"
 #include "unity.h"
+#include "unity_test_utils.h"
 #include "esp_rom_sys.h"
 #include "soc/soc_caps.h"
 #include "hal/cpu_ll.h"
 #include "driver/gpio.h"
-#if SOC_DEDICATED_GPIO_SUPPORTED
 #include "driver/dedic_gpio.h"
 
-TEST_CASE("Dedicated GPIO bundle install/uninstall", "[dedic_gpio]")
+void test_app_include_dedicated_gpio(void)
+{
+}
+
+TEST_CASE("Dedicated_GPIO_bundle_install/uninstall", "[dedic_gpio]")
 {
     const int test_gpios[SOC_DEDIC_GPIO_OUT_CHANNELS_NUM / 2] = {0};
     const int test2_gpios[SOC_DEDIC_GPIO_OUT_CHANNELS_NUM / 2 + 1] = {0};
@@ -136,12 +141,13 @@ static void test_dedic_gpio_on_specific_core(void *args)
     TEST_ESP_OK(dedic_gpio_del_bundle(bundleB));
 
     xSemaphoreGive(ctx->sem);
-    vTaskDelete(NULL);
+    vTaskSuspend(NULL);
 }
 
-TEST_CASE("Dedicated GPIO run on multiple CPU core", "[dedic_gpio]")
+TEST_CASE("Dedicated_GPIO_run_on_multiple_CPU_cores", "[dedic_gpio]")
 {
     SemaphoreHandle_t sem = xSemaphoreCreateCounting(SOC_CPU_CORES_NUM, 0);
+    TaskHandle_t task_handle[SOC_CPU_CORES_NUM];
 
     for (int i = 0; i < SOC_CPU_CORES_NUM; i++) {
         int start_gpio = i * TEST_GPIO_GROUP_SIZE;
@@ -149,13 +155,18 @@ TEST_CASE("Dedicated GPIO run on multiple CPU core", "[dedic_gpio]")
             .sem = sem,
             .gpios = {start_gpio, start_gpio + 1, start_gpio + 2, start_gpio + 3}
         };
-        xTaskCreatePinnedToCore(test_dedic_gpio_on_specific_core, "dedic_gpio_test_tsk", 4096, &isr_ctx, 1, NULL, i);
+        xTaskCreatePinnedToCore(test_dedic_gpio_on_specific_core, "dedic_gpio_test_tsk", 4096, &isr_ctx, 1,
+                                &task_handle[i], i);
     }
 
     for (int i = 0; i < SOC_CPU_CORES_NUM; i++) {
         xSemaphoreTake(sem, pdMS_TO_TICKS(1000));
     }
+
     vSemaphoreDelete(sem);
+    for (int i = 0; i < SOC_CPU_CORES_NUM; i++) {
+        unity_utils_task_delete(task_handle[i]);
+    }
 }
 
 IRAM_ATTR static void test_dedic_gpio_isr_callback(void *args)
@@ -169,7 +180,7 @@ IRAM_ATTR static void test_dedic_gpio_isr_callback(void *args)
     }
 }
 
-TEST_CASE("Dedicated GPIO interrupt and callback", "[dedic_gpio]")
+TEST_CASE("Dedicated_GPIO_interrupt_and_callback", "[dedic_gpio]")
 {
     SemaphoreHandle_t sem = xSemaphoreCreateBinary();
 
@@ -214,5 +225,3 @@ TEST_CASE("Dedicated GPIO interrupt and callback", "[dedic_gpio]")
     TEST_ESP_OK(dedic_gpio_del_bundle(bundle));
     vSemaphoreDelete(sem);
 }
-
-#endif // #if SOC_DEDICATED_GPIO_SUPPORTED

components/driver/test_apps/gpio/main/test_gpio.c

@@ -3,13 +3,13 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
+
 /**
  * About test environment UT_T1_GPIO:
  * Please connect TEST_GPIO_EXT_OUT_IO and TEST_GPIO_EXT_IN_IO
  */
 #include <stdio.h>
 #include <string.h>
-
 #include "esp_system.h"
 #include "esp_sleep.h"
 #include "unity.h"
@@ -88,6 +88,10 @@
 #define TEST_IO_9 GPIO_NUM_9
 #define TEST_IO_10 GPIO_NUM_10
 
+void test_app_include_gpio(void)
+{
+}
+
 static volatile int disable_intr_times = 0;  // use this to calculate how many times it go into interrupt
 static volatile int level_intr_times = 0;  // use this to get how many times the level interrupt happened
 static volatile int edge_intr_times = 0;   // use this to get how many times the edge interrupt happened
@@ -201,7 +205,7 @@ static void drive_capability_set_get(gpio_num_t num, gpio_drive_cap_t capability
 
 
 // test the basic configuration function with right parameters and error parameters
-TEST_CASE("GPIO config parameters test", "[gpio]")
+TEST_CASE("GPIO_config_parameters_test", "[gpio]")
 {
     //error param test
     //ESP32 test 41 bit, ESP32-S2 test 48 bit, ESP32-S3 test 50 bit
@@ -234,7 +238,7 @@ TEST_CASE("GPIO config parameters test", "[gpio]")
 
 #if !TEMPORARY_DISABLED_FOR_TARGETS(ESP32S2, ESP32S3, ESP32C3, ESP32C2, ESP32H2)
 //No runners
-TEST_CASE("GPIO rising edge interrupt test", "[gpio][test_env=UT_T1_GPIO]")
+TEST_CASE("GPIO_rising_edge_interrupt_test", "[gpio][test_env=UT_T1_GPIO]")
 {
     edge_intr_times = 0;  // set it as 0 prepare to test
     //init input and output gpio
@@ -258,7 +262,7 @@ TEST_CASE("GPIO rising edge interrupt test", "[gpio][test_env=UT_T1_GPIO]")
     gpio_uninstall_isr_service();
 }
 
-TEST_CASE("GPIO falling edge interrupt test", "[gpio][test_env=UT_T1_GPIO]")
+TEST_CASE("GPIO_falling_edge_interrupt_test", "[gpio][test_env=UT_T1_GPIO]")
 {
     edge_intr_times = 0;
     gpio_config_t output_io = init_io(TEST_GPIO_EXT_OUT_IO);
@@ -281,7 +285,7 @@ TEST_CASE("GPIO falling edge interrupt test", "[gpio][test_env=UT_T1_GPIO]")
     gpio_uninstall_isr_service();
 }
 
-TEST_CASE("GPIO both rising and falling edge interrupt test", "[gpio][test_env=UT_T1_GPIO]")
+TEST_CASE("GPIO_both_rising_and_falling_edge_interrupt_test", "[gpio][test_env=UT_T1_GPIO]")
 {
     edge_intr_times = 0;
     gpio_config_t output_io = init_io(TEST_GPIO_EXT_OUT_IO);
@@ -323,7 +327,7 @@ TEST_CASE("GPIO both rising and falling edge interrupt test", "[gpio][test_env=U
     gpio_uninstall_isr_service();
 }
 
-TEST_CASE("GPIO input high level trigger, cut the interrupt source exit interrupt test", "[gpio][test_env=UT_T1_GPIO]")
+TEST_CASE("GPIO_input_high_level_trigger_cut_the_interrupt_source_exit_interrupt_test", "[gpio][test_env=UT_T1_GPIO]")
 {
     level_intr_times = 0;
     gpio_config_t output_io = init_io(TEST_GPIO_EXT_OUT_IO);
@@ -346,7 +350,7 @@ TEST_CASE("GPIO input high level trigger, cut the interrupt source exit interrup
 
 }
 
-TEST_CASE("GPIO low level interrupt test", "[gpio][test_env=UT_T1_GPIO]")
+TEST_CASE("GPIO_low_level_interrupt_test", "[gpio][test_env=UT_T1_GPIO]")
 {
     disable_intr_times = 0;
     gpio_config_t output_io = init_io(TEST_GPIO_EXT_OUT_IO);
@@ -369,7 +373,7 @@ TEST_CASE("GPIO low level interrupt test", "[gpio][test_env=UT_T1_GPIO]")
     gpio_uninstall_isr_service();
 }
 
-TEST_CASE("GPIO multi-level interrupt test, to cut the interrupt source exit interrupt ", "[gpio][test_env=UT_T1_GPIO]")
+TEST_CASE("GPIO_multi-level_interrupt_test_to_cut_the_interrupt_source_exit_interrupt", "[gpio][test_env=UT_T1_GPIO]")
 {
     level_intr_times = 0;
     gpio_config_t output_io = init_io(TEST_GPIO_EXT_OUT_IO);
@@ -394,7 +398,7 @@ TEST_CASE("GPIO multi-level interrupt test, to cut the interrupt source exit int
     gpio_uninstall_isr_service();
 }
 
-TEST_CASE("GPIO enable and disable interrupt test", "[gpio][test_env=UT_T1_GPIO]")
+TEST_CASE("GPIO_enable_and_disable_interrupt_test", "[gpio][test_env=UT_T1_GPIO]")
 {
     disable_intr_times = 0;
     gpio_config_t output_io = init_io(TEST_GPIO_EXT_OUT_IO);
@@ -437,7 +441,7 @@ static void install_isr_service_task(void *arg)
     vTaskSuspend(NULL);
 }
 
-TEST_CASE("GPIO interrupt on other CPUs test", "[gpio]")
+TEST_CASE("GPIO_interrupt_on_other_CPUs_test", "[gpio]")
 {
     TaskHandle_t gpio_task_handle;
     gpio_config_t input_output_io = init_io(TEST_GPIO_EXT_OUT_IO);
@@ -465,7 +469,7 @@ TEST_CASE("GPIO interrupt on other CPUs test", "[gpio]")
 // ESP32 Connect GPIO18 with GPIO19, ESP32-S2 Connect GPIO17 with GPIO21,
 // ESP32-S3 Connect GPIO17 with GPIO21, ESP32C3 Connect GPIO2 with GPIO3
 // use multimeter to test the voltage, so it is ignored in CI
-TEST_CASE("GPIO set gpio output level test", "[gpio][ignore][UT_T1_GPIO]")
+TEST_CASE("GPIO_set_gpio_output_level_test", "[gpio][ignore][UT_T1_GPIO]")
 {
     gpio_config_t io_conf;
     io_conf.intr_type = GPIO_INTR_DISABLE;
@@ -498,7 +502,7 @@ TEST_CASE("GPIO set gpio output level test", "[gpio][ignore][UT_T1_GPIO]")
 
 // TEST_GPIO_INPUT_LEVEL_HIGH_PIN connects to 3.3v pin, TEST_GPIO_INPUT_LEVEL_LOW_PIN connects to the GND pin
 // use multimeter to test the voltage, so it is ignored in CI
-TEST_CASE("GPIO get input level test", "[gpio][ignore]")
+TEST_CASE("GPIO_get_input_level_test", "[gpio][ignore]")
 {
     gpio_num_t num1 = TEST_GPIO_INPUT_LEVEL_HIGH_PIN;
     int level1 = gpio_get_level(num1);
@@ -513,7 +517,7 @@ TEST_CASE("GPIO get input level test", "[gpio][ignore]")
     //when case finish, get the result from multimeter, the TEST_GPIO_INPUT_LEVEL_HIGH_PIN is 3.3v, the TEST_GPIO_INPUT_LEVEL_LOW_PIN is 0.00v
 }
 
-TEST_CASE("GPIO io pull up/down function", "[gpio]")
+TEST_CASE("GPIO_io_pull_up/down_function", "[gpio]")
 {
     // First, ensure that the output IO will not affect the level
     gpio_config_t  io_conf = init_io(TEST_GPIO_EXT_OUT_IO);
@@ -538,7 +542,7 @@ TEST_CASE("GPIO io pull up/down function", "[gpio]")
 
 #if !TEMPORARY_DISABLED_FOR_TARGETS(ESP32S2, ESP32S3, ESP32C3, ESP32C2, ESP32H2)
 //No runners
-TEST_CASE("GPIO output and input mode test", "[gpio][test_env=UT_T1_GPIO]")
+TEST_CASE("GPIO_output_and_input_mode_test", "[gpio][test_env=UT_T1_GPIO]")
 {
     //ESP32 connect io18 and io19, ESP32-S2 connect io17 and io21, ESP32-S3 connect io17 and io21, ESP32C3 Connect GPIO2 with GPIO3
     gpio_config_t output_io = init_io(TEST_GPIO_EXT_OUT_IO);
@@ -587,7 +591,7 @@ TEST_CASE("GPIO output and input mode test", "[gpio][test_env=UT_T1_GPIO]")
     TEST_ASSERT_EQUAL_INT_MESSAGE(gpio_get_level(TEST_GPIO_EXT_IN_IO), !level, "direction set error, it can't output");
 }
 
-TEST_CASE("GPIO repeate call service and isr has no memory leak test", "[gpio][test_env=UT_T1_GPIO][timeout=90]")
+TEST_CASE("GPIO_repeat_call_service_and_isr_has_no_memory_leak_test", "[gpio][test_env=UT_T1_GPIO][timeout=90]")
 {
     gpio_config_t output_io = init_io(TEST_GPIO_EXT_OUT_IO);
     gpio_config_t input_io = init_io(TEST_GPIO_EXT_IN_IO);
@@ -614,7 +618,7 @@ TEST_CASE("GPIO repeate call service and isr has no memory leak test", "[gpio][t
 
 #if !WAKE_UP_IGNORE
 //this function development is not completed yet, set it ignored
-TEST_CASE("GPIO wake up enable and disenable test", "[gpio][ignore]")
+TEST_CASE("GPIO_wake_up_enable_and_disable_test", "[gpio][ignore]")
 {
     xTaskCreate(sleep_wake_up, "sleep_wake_up", 4096, NULL, 5, NULL);
     xTaskCreate(trigger_wake_up, "trigger_wake_up", 4096, NULL, 5, NULL);
@@ -631,7 +635,7 @@ TEST_CASE("GPIO wake up enable and disenable test", "[gpio][ignore]")
 
 // this case need the resistance to pull up the voltage or pull down the voltage
 // ignored because the voltage needs to be tested with multimeter
-TEST_CASE("GPIO verify only the gpio with input ability can be set pull/down", "[gpio][ignore]")
+TEST_CASE("GPIO_verify_only_the_gpio_with_input_ability_can_be_set_pull/down", "[gpio][ignore]")
 {
     gpio_config_t  output_io = init_io(TEST_GPIO_EXT_OUT_IO);
     gpio_config_t  input_io = init_io(TEST_GPIO_EXT_IN_IO);
@@ -710,9 +714,7 @@ TEST_CASE("GPIO verify only the gpio with input ability can be set pull/down", "
  *
  * all of these cases should be ignored that it will not run in CI
  */
-
-// drive capability test
-TEST_CASE("GPIO drive capability test", "[gpio][ignore]")
+TEST_CASE("GPIO_drive_capability_test", "[gpio][ignore]")
 {
     printf("weak capability test! please view the current change!\n");
     drive_capability_set_get(TEST_GPIO_EXT_OUT_IO, GPIO_DRIVE_CAP_0);
@@ -754,7 +756,7 @@ void gpio_enable_task(void *param)
  *     2. Trigger the GPIO9 interrupt and check if the interrupt responds correctly.
  *
  */
-TEST_CASE("GPIO Enable/Disable interrupt on multiple cores", "[gpio][ignore]")
+TEST_CASE("GPIO_enable/disable_interrupt_on_multiple_cores", "[gpio][ignore]")
 {
     gpio_config_t io_conf;
     io_conf.intr_type = GPIO_INTR_NEGEDGE;
@@ -808,7 +810,7 @@ static void gpio_isr_handler(void *arg)
  *     4. Trigger GPIO10(ESP32, ESP32C3)/GPIO21(ESP32-S2) interrupt.
  * If the bug is not fixed, you will see, in the step 4, the interrupt of GPIO9 will also respond.
  */
-TEST_CASE("GPIO ISR service test", "[gpio][ignore]")
+TEST_CASE("GPIO_ISR_service_test", "[gpio][ignore]")
 {
     gpio_isr_param_t io9_param = {
         .gpio_num =  TEST_IO_9,
@@ -858,7 +860,7 @@ TEST_CASE("GPIO ISR service test", "[gpio][ignore]")
 }
 
 #if SOC_USB_SERIAL_JTAG_SUPPORTED
-TEST_CASE("GPIO input and output of USB pins test", "[gpio]")
+TEST_CASE("GPIO_input_and_output_of_USB_pins_test", "[gpio]")
 {
     const int test_pins[] = {TEST_GPIO_USB_DP_IO, TEST_GPIO_USB_DM_IO};
     gpio_config_t io_conf = {

components/driver/test_apps/gpio/main/test_sigmadelta.c

@@ -3,16 +3,18 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
+
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
 #include "unity.h"
-#include "test_utils.h"
 #include "soc/soc_caps.h"
-#if SOC_SIGMADELTA_SUPPORTED
 #include "driver/sigmadelta.h"
 
+void test_app_include_sigmadelta(void)
+{
+}
 
-TEST_CASE("SigmaDelta config test", "[sigma_delta]")
+TEST_CASE("SigmaDelta_config_test", "[sigma_delta]")
 {
     sigmadelta_config_t sigmadelta_cfg = {
         .sigmadelta_prescale = 80,
@@ -30,7 +32,7 @@ TEST_CASE("SigmaDelta config test", "[sigma_delta]")
 
 // connect GPIO4 with LED positive pin, and the GND pin connect LED negative pin
 // logic analyzer help also to see the wave form(more standard and accurate)
-TEST_CASE("SigmaDelta pin, duty, prescale set", "[sigma_delta][ignore]")
+TEST_CASE("SigmaDelta_pin_duty_prescale_set", "[sigma_delta][ignore]")
 {
     sigmadelta_config_t sigmadelta_cfg = {
         .channel = 0,
@@ -66,5 +68,3 @@ TEST_CASE("SigmaDelta pin, duty, prescale set", "[sigma_delta][ignore]")
     TEST_ESP_OK(sigmadelta_set_pin(sigmadelta_cfg.channel, 5));
     vTaskDelay(3000 / portTICK_PERIOD_MS);
 }
-
-#endif // SOC_SIGMADELTA_SUPPORTED

components/driver/test_apps/gpio/pytest_gpio.py

@@ -0,0 +1,21 @@
+# SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: CC0-1.0
+
+import pytest
+from pytest_embedded import Dut
+
+
+@pytest.mark.supported_targets
+@pytest.mark.generic
+@pytest.mark.parametrize(
+    'config',
+    [
+        'iram_safe',
+        'release',
+    ],
+    indirect=True,
+)
+def test_gpio(dut: Dut) -> None:
+    dut.expect_exact('Press ENTER to see the list of tests')
+    dut.write('*')
+    dut.expect_unity_test_output()

components/driver/test_apps/gpio/sdkconfig.ci.iram_safe

@@ -0,0 +1,4 @@
+CONFIG_COMPILER_DUMP_RTL_FILES=y
+
+# silent the error check, as the error string are stored in rodata, causing RTL check failure
+CONFIG_COMPILER_OPTIMIZATION_CHECKS_SILENT=y

components/driver/test_apps/gpio/sdkconfig.ci.release

@@ -0,0 +1,5 @@
+CONFIG_PM_ENABLE=y
+CONFIG_FREERTOS_USE_TICKLESS_IDLE=y
+CONFIG_COMPILER_OPTIMIZATION_SIZE=y
+CONFIG_BOOTLOADER_COMPILER_OPTIMIZATION_SIZE=y
+CONFIG_COMPILER_OPTIMIZATION_ASSERTIONS_SILENT=y

components/driver/test_apps/gpio/sdkconfig.defaults

@@ -0,0 +1,2 @@
+CONFIG_FREERTOS_HZ=1000
+CONFIG_ESP_TASK_WDT=n