Configure project for code coverage.

Reviewed-on: #30

README.md

@@ -38,7 +38,7 @@ dependencies:
   # Add as a custom component from git repository
   relay_chn:
     git: https://git.kozmotronik.com.tr/KozmotronikTech/relay_chn.git
-    version: '>=0.4.0'
+    version: '>=0.5.0'
 ```
 
 ## Usage

idf_component.yml

@@ -1,6 +1,6 @@
 name: relay_chn
-version: "0.4.0"
+version: "0.5.0"
 description: "Custom component for relay channel control"
 license: "MIT"
-url: "https://git.kozmotronik.com.tr/KozmotronikTech/relay_chn_component"
-repository: "https://git.kozmotronik.com.tr/KozmotronikTech/relay_chn_component.git"
+url: "https://git.kozmotronik.com.tr/KozmotronikTech/relay_chn"
+repository: "https://git.kozmotronik.com.tr/KozmotronikTech/relay_chn.git"

src/relay_chn.c

@@ -1268,8 +1268,11 @@ static uint32_t relay_chn_tilt_count_update(relay_chn_t *relay_chn)
             return ++relay_chn->tilt_control.tilt_counter.tilt_forward_count;
         }
         else if (relay_chn->tilt_control.cmd == RELAY_CHN_TILT_CMD_REVERSE) {
-            if (relay_chn->tilt_control.tilt_counter.tilt_forward_count > 0)
-                return --relay_chn->tilt_control.tilt_counter.tilt_forward_count;
+            if (relay_chn->tilt_control.tilt_counter.tilt_forward_count > 0) {
+                --relay_chn->tilt_control.tilt_counter.tilt_forward_count;
+                // Still should do one more move, return non-zero value
+                return 1;
+            }
             else
                 return 0;
         }
@@ -1283,8 +1286,11 @@ static uint32_t relay_chn_tilt_count_update(relay_chn_t *relay_chn)
             return ++relay_chn->tilt_control.tilt_counter.tilt_reverse_count;
         }
         else if (relay_chn->tilt_control.cmd == RELAY_CHN_TILT_CMD_FORWARD) {
-            if (relay_chn->tilt_control.tilt_counter.tilt_reverse_count > 0)
-                return --relay_chn->tilt_control.tilt_counter.tilt_reverse_count;
+            if (relay_chn->tilt_control.tilt_counter.tilt_reverse_count > 0) {
+                --relay_chn->tilt_control.tilt_counter.tilt_reverse_count;
+                // Still should do one more move, return non-zero value
+                return 1;
+            }
             else
                 return 0;
         }

test_apps/CMakeLists.txt

@@ -11,10 +11,19 @@ set(EXTRA_COMPONENT_DIRS "../")
 set(COMPONENTS main)
 
 # Include ESP-IDF project build system
-include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+# include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+
+file(TO_NATIVE_PATH "$ENV{IDF_PATH}/tools/cmake/project.cmake" _project_path)
 
 # Inject the test tag into the build
 add_compile_definitions(RELAY_CHN_UNITY_TEST_GROUP_TAG=\"$ENV{RELAY_CHN_UNITY_TEST_GROUP_TAG}\")
 
+include(${_project_path})
+
 # Define the name of this project
 project(relay_chn_test)
+
+file(TO_NATIVE_PATH "${CMAKE_CURRENT_BINARY_DIR}/coverage_report" _coverage_path)
+
+idf_create_coverage_report(${_coverage_path})
+idf_clean_coverage_report(${_coverage_path})

test_apps/main/CMakeLists.txt

@@ -15,6 +15,13 @@ message(STATUS "srcs=${srcs}")
 idf_component_register(
     SRCS ${srcs}
     INCLUDE_DIRS "."
-    REQUIRES unity relay_chn
+    REQUIRES unity relay_chn app_trace
     WHOLE_ARCHIVE
 )
+
+set_source_files_properties(
+    "test_common.c"
+    "test_app_main.c"
+    "test_relay_chn_core.c"
+    "test_relay_chn_listener.c"
+    PROPERTIES COMPILE_FLAGS --coverage)

test_apps/main/test_app_main.c

@@ -44,4 +44,6 @@ void app_main(void)
 
     UNITY_END();
     ESP_LOGI(TEST_TAG, "All tests complete.");
+    
+    esp_restart(); // Restart to invoke qemu exit
 }

test_apps/main/test_relay_chn_tilt.c

@@ -283,3 +283,107 @@ TEST_CASE("tilt_auto with ID_ALL tilts channels based on last run direction", "[
     TEST_ASSERT_EQUAL(RELAY_CHN_STATE_TILT_FORWARD, relay_chn_get_state(0));
     TEST_ASSERT_EQUAL(RELAY_CHN_STATE_TILT_REVERSE, relay_chn_get_state(1));
 }
+
+// Test relay_chn_tilt_auto() chooses correct tilt direction
+TEST_CASE("relay_chn_tilt_auto chooses correct direction", "[relay_chn][tilt][auto]") {
+    uint8_t ch = 0;
+    TEST_ESP_OK(relay_chn_create(gpio_map, gpio_count));
+    g_is_component_initialized = true;
+
+    // Prepare FORWARD
+    prepare_channel_for_tilt(ch, RELAY_CHN_CMD_FORWARD);
+    relay_chn_tilt_auto(ch);
+    vTaskDelay(pdMS_TO_TICKS(test_delay_margin_ms));
+    TEST_ASSERT_EQUAL(RELAY_CHN_STATE_TILT_FORWARD, relay_chn_get_state(ch));
+    relay_chn_tilt_stop(ch);
+    vTaskDelay(pdMS_TO_TICKS(test_delay_margin_ms));
+
+    // Prepare REVERSE
+    prepare_channel_for_tilt(ch, RELAY_CHN_CMD_REVERSE);
+    relay_chn_tilt_auto(ch);
+    vTaskDelay(pdMS_TO_TICKS(test_delay_margin_ms));
+    TEST_ASSERT_EQUAL(RELAY_CHN_STATE_TILT_REVERSE, relay_chn_get_state(ch));
+}
+
+// Test sensitivity set/get
+TEST_CASE("relay_chn_tilt_sensitivity_set and get", "[relay_chn][tilt][sensitivity]") {
+    uint8_t ch = 0;
+    uint8_t val = 0;
+    TEST_ESP_OK(relay_chn_create(gpio_map, gpio_count));
+    g_is_component_initialized = true;
+
+    relay_chn_tilt_sensitivity_set(ch, 0);
+    TEST_ESP_OK(relay_chn_tilt_sensitivity_get(ch, &val, 1));
+    TEST_ASSERT_EQUAL_UINT8(0, val);
+
+    relay_chn_tilt_sensitivity_set(ch, 50);
+    TEST_ESP_OK(relay_chn_tilt_sensitivity_get(ch, &val, 1));
+    TEST_ASSERT_EQUAL_UINT8(50, val);
+
+    relay_chn_tilt_sensitivity_set(ch, 100);
+    TEST_ESP_OK(relay_chn_tilt_sensitivity_get(ch, &val, 1));
+    TEST_ASSERT_EQUAL_UINT8(100, val);
+
+    // Set all channels
+    relay_chn_tilt_sensitivity_set(RELAY_CHN_ID_ALL, 42);
+    uint8_t vals[CONFIG_RELAY_CHN_COUNT] = {0};
+    TEST_ESP_OK(relay_chn_tilt_sensitivity_get(RELAY_CHN_ID_ALL, vals, relay_chn_count));
+    for (int i = 0; i < relay_chn_count; ++i) {
+        TEST_ASSERT_EQUAL_UINT8(42, vals[i]);
+    }
+}
+
+// Test tilt counter logic: forward x3, reverse x3, extra reverse fails
+TEST_CASE("tilt counter logic: forward and reverse consumption", "[relay_chn][tilt][counter]") {
+    uint8_t ch = 0;
+    TEST_ESP_OK(relay_chn_create(gpio_map, gpio_count));
+    g_is_component_initialized = true;
+
+    prepare_channel_for_tilt(ch, RELAY_CHN_CMD_FORWARD);
+
+    // Tilt forward 3 times
+    for (int i = 0; i < 3; ++i) {
+        relay_chn_tilt_forward(ch);
+        vTaskDelay(pdMS_TO_TICKS(test_delay_margin_ms));
+        TEST_ASSERT_EQUAL(RELAY_CHN_STATE_TILT_FORWARD, relay_chn_get_state(ch));
+        relay_chn_tilt_stop(ch);
+        vTaskDelay(pdMS_TO_TICKS(test_delay_margin_ms));
+    }
+
+    // Now tilt reverse 3 times (should succeed)
+    for (int i = 0; i < 3; ++i) {
+        relay_chn_tilt_reverse(ch);
+        vTaskDelay(pdMS_TO_TICKS(test_delay_margin_ms));
+        if (i < 3) {
+            TEST_ASSERT_EQUAL(RELAY_CHN_STATE_TILT_REVERSE, relay_chn_get_state(ch));
+            relay_chn_tilt_stop(ch);
+            vTaskDelay(pdMS_TO_TICKS(test_delay_margin_ms));
+        }
+    }
+
+    // Extra reverse tilt should fail (counter exhausted)
+    relay_chn_tilt_reverse(ch);
+    vTaskDelay(pdMS_TO_TICKS(test_delay_margin_ms));
+    // Should not enter TILT_REVERSE, should remain FREE or STOPPED
+    relay_chn_state_t state = relay_chn_get_state(ch);
+    TEST_ASSERT(state != RELAY_CHN_STATE_TILT_REVERSE);
+}
+
+// Test run command during TILT state
+TEST_CASE("run command during TILT state transitions correctly", "[relay_chn][tilt][run-during-tilt]") {
+    uint8_t ch = 0;
+    TEST_ESP_OK(relay_chn_create(gpio_map, gpio_count));
+    g_is_component_initialized = true;
+
+    prepare_channel_for_tilt(ch, RELAY_CHN_CMD_FORWARD);
+    relay_chn_tilt_forward(ch);
+    vTaskDelay(pdMS_TO_TICKS(opposite_inertia_ms + test_delay_margin_ms));
+    TEST_ASSERT_EQUAL(RELAY_CHN_STATE_TILT_FORWARD, relay_chn_get_state(ch));
+
+    // Issue run reverse while in TILT_FORWARD
+    relay_chn_run_reverse(ch);
+    vTaskDelay(pdMS_TO_TICKS(test_delay_margin_ms));
+    // Should transition to REVERSE or REVERSE_PENDING depending on inertia logic
+    relay_chn_state_t state = relay_chn_get_state(ch);
+    TEST_ASSERT(state == RELAY_CHN_STATE_REVERSE || state == RELAY_CHN_STATE_REVERSE_PENDING);
+}

test_apps/sdkconfig

@@ -445,6 +445,33 @@ CONFIG_COMPILER_ORPHAN_SECTIONS_WARNING=y
 # Component config
 #
 
+#
+# Application Level Tracing
+#
+CONFIG_APPTRACE_DEST_JTAG=y
+# CONFIG_APPTRACE_DEST_NONE is not set
+# CONFIG_APPTRACE_DEST_UART1 is not set
+# CONFIG_APPTRACE_DEST_UART2 is not set
+CONFIG_APPTRACE_DEST_UART_NONE=y
+CONFIG_APPTRACE_UART_TASK_PRIO=1
+CONFIG_APPTRACE_DEST_TRAX=y
+CONFIG_APPTRACE_MEMBUFS_APPTRACE_PROTO_ENABLE=y
+CONFIG_APPTRACE_ENABLE=y
+CONFIG_APPTRACE_LOCK_ENABLE=y
+CONFIG_APPTRACE_ONPANIC_HOST_FLUSH_TMO=-1
+CONFIG_APPTRACE_POSTMORTEM_FLUSH_THRESH=0
+CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX=0
+
+#
+# FreeRTOS SystemView Tracing
+#
+# CONFIG_APPTRACE_SV_ENABLE is not set
+# end of FreeRTOS SystemView Tracing
+
+CONFIG_APPTRACE_GCOV_ENABLE=y
+CONFIG_APPTRACE_GCOV_DUMP_TASK_STACK_SIZE=2048
+# end of Application Level Tracing
+
 #
 # Driver Configurations
 #
@@ -791,8 +818,10 @@ CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ=160
 #
 # Trace memory
 #
+CONFIG_ESP32_MEMMAP_TRACEMEM=y
+CONFIG_ESP32_MEMMAP_TRACEMEM_TWOBANKS=y
 # CONFIG_ESP32_TRAX is not set
-CONFIG_ESP32_TRACEMEM_RESERVE_DRAM=0x0
+CONFIG_ESP32_TRACEMEM_RESERVE_DRAM=0x8000
 # end of Trace memory
 
 # CONFIG_ESP_SYSTEM_PANIC_PRINT_HALT is not set
@@ -826,7 +855,7 @@ CONFIG_ESP_INT_WDT_CHECK_CPU1=y
 CONFIG_ESP_TASK_WDT_EN=y
 # CONFIG_ESP_TASK_WDT_INIT is not set
 # CONFIG_ESP_PANIC_HANDLER_IRAM is not set
-# CONFIG_ESP_DEBUG_STUBS_ENABLE is not set
+CONFIG_ESP_DEBUG_STUBS_ENABLE=y
 CONFIG_ESP_DEBUG_OCDAWARE=y
 # CONFIG_ESP_SYSTEM_CHECK_INT_LEVEL_5 is not set
 CONFIG_ESP_SYSTEM_CHECK_INT_LEVEL_4=y
@@ -853,7 +882,7 @@ CONFIG_ESP_SYSTEM_BROWNOUT_INTR=y
 #
 # IPC (Inter-Processor Call)
 #
-CONFIG_ESP_IPC_TASK_STACK_SIZE=1024
+CONFIG_ESP_IPC_TASK_STACK_SIZE=2048
 CONFIG_ESP_IPC_USES_CALLERS_PRIORITY=y
 CONFIG_ESP_IPC_ISR_ENABLE=y
 # end of IPC (Inter-Processor Call)
@@ -1303,6 +1332,15 @@ CONFIG_STACK_CHECK_NONE=y
 # CONFIG_STACK_CHECK_STRONG is not set
 # CONFIG_STACK_CHECK_ALL is not set
 # CONFIG_WARN_WRITE_STRINGS is not set
+CONFIG_ESP32_APPTRACE_DEST_TRAX=y
+# CONFIG_ESP32_APPTRACE_DEST_NONE is not set
+CONFIG_ESP32_APPTRACE_ENABLE=y
+CONFIG_ESP32_APPTRACE_LOCK_ENABLE=y
+CONFIG_ESP32_APPTRACE_ONPANIC_HOST_FLUSH_TMO=-1
+CONFIG_ESP32_APPTRACE_POSTMORTEM_FLUSH_TRAX_THRESH=0
+CONFIG_ESP32_APPTRACE_PENDING_DATA_SIZE_MAX=0
+# CONFIG_SYSVIEW_ENABLE is not set
+CONFIG_ESP32_GCOV_ENABLE=y
 CONFIG_ADC2_DISABLE_DAC=y
 # CONFIG_MCPWM_ISR_IN_IRAM is not set
 # CONFIG_EVENT_LOOP_PROFILING is not set
@@ -1331,7 +1369,9 @@ CONFIG_ESP32_XTAL_FREQ=40
 CONFIG_ESP32_DEFAULT_CPU_FREQ_160=y
 # CONFIG_ESP32_DEFAULT_CPU_FREQ_240 is not set
 CONFIG_ESP32_DEFAULT_CPU_FREQ_MHZ=160
-CONFIG_TRACEMEM_RESERVE_DRAM=0x0
+CONFIG_MEMMAP_TRACEMEM=y
+CONFIG_MEMMAP_TRACEMEM_TWOBANKS=y
+CONFIG_TRACEMEM_RESERVE_DRAM=0x8000
 # CONFIG_ESP32_PANIC_PRINT_HALT is not set
 CONFIG_ESP32_PANIC_PRINT_REBOOT=y
 # CONFIG_ESP32_PANIC_SILENT_REBOOT is not set
@@ -1350,7 +1390,7 @@ CONFIG_INT_WDT_TIMEOUT_MS=300
 CONFIG_INT_WDT_CHECK_CPU1=y
 # CONFIG_TASK_WDT is not set
 # CONFIG_ESP_TASK_WDT is not set
-# CONFIG_ESP32_DEBUG_STUBS_ENABLE is not set
+CONFIG_ESP32_DEBUG_STUBS_ENABLE=y
 CONFIG_ESP32_DEBUG_OCDAWARE=y
 CONFIG_BROWNOUT_DET=y
 CONFIG_ESP32_BROWNOUT_DET=y
@@ -1373,7 +1413,7 @@ CONFIG_ESP32_BROWNOUT_DET_LVL_SEL_0=y
 CONFIG_BROWNOUT_DET_LVL=0
 CONFIG_ESP32_BROWNOUT_DET_LVL=0
 # CONFIG_DISABLE_BASIC_ROM_CONSOLE is not set
-CONFIG_IPC_TASK_STACK_SIZE=1024
+CONFIG_IPC_TASK_STACK_SIZE=2048
 CONFIG_TIMER_TASK_STACK_SIZE=3584
 CONFIG_TIMER_TASK_PRIORITY=1
 CONFIG_TIMER_TASK_STACK_DEPTH=2048

test_apps/sdkconfig.defaults

@@ -6,3 +6,12 @@ CONFIG_ESP_TASK_WDT_INIT=n
 CONFIG_RELAY_CHN_OPPOSITE_INERTIA_MS=200
 CONFIG_RELAY_CHN_COUNT=2
 CONFIG_RELAY_CHN_ENABLE_TILTING=y
+
+# App Trace config
+CONFIG_APPTRACE_DEST_JTAG=y
+CONFIG_APPTRACE_ENABLE=y
+CONFIG_APPTRACE_LOCK_ENABLE=y
+CONFIG_APPTRACE_ONPANIC_HOST_FLUSH_TMO=-1
+CONFIG_APPTRACE_POSTMORTEM_FLUSH_THRESH=0
+CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX=0
+CONFIG_APPTRACE_GCOV_ENABLE=y

test_apps/sdkconfig.old

@@ -445,6 +445,18 @@ CONFIG_COMPILER_ORPHAN_SECTIONS_WARNING=y
 # Component config
 #
 
+#
+# Application Level Tracing
+#
+# CONFIG_APPTRACE_DEST_JTAG is not set
+CONFIG_APPTRACE_DEST_NONE=y
+# CONFIG_APPTRACE_DEST_UART1 is not set
+# CONFIG_APPTRACE_DEST_UART2 is not set
+CONFIG_APPTRACE_DEST_UART_NONE=y
+CONFIG_APPTRACE_UART_TASK_PRIO=1
+CONFIG_APPTRACE_LOCK_ENABLE=y
+# end of Application Level Tracing
+
 #
 # Driver Configurations
 #
@@ -1303,6 +1315,9 @@ CONFIG_STACK_CHECK_NONE=y
 # CONFIG_STACK_CHECK_STRONG is not set
 # CONFIG_STACK_CHECK_ALL is not set
 # CONFIG_WARN_WRITE_STRINGS is not set
+# CONFIG_ESP32_APPTRACE_DEST_TRAX is not set
+CONFIG_ESP32_APPTRACE_DEST_NONE=y
+CONFIG_ESP32_APPTRACE_LOCK_ENABLE=y
 CONFIG_ADC2_DISABLE_DAC=y
 # CONFIG_MCPWM_ISR_IN_IRAM is not set
 # CONFIG_EVENT_LOOP_PROFILING is not set