fix(mdns): Add receiver unit tests

Author: david-cermak

.github/workflows/mdns__host-tests.yml

@@ -72,6 +72,33 @@ jobs:
             echo "OK"
           done
 
+  host_unit_test:
+    if: contains(github.event.pull_request.labels.*.name, 'mdns') || github.event_name == 'push'
+    name: Unit tests on host
+    strategy:
+      matrix:
+        idf_ver: ["latest"]
+
+    runs-on: ubuntu-22.04
+    container: espressif/idf:${{ matrix.idf_ver }}
+    steps:
+      - name: Checkout esp-protocols
+        uses: actions/checkout@v4
+      - name: Install bsdlib and ruby
+        run: |
+          apt-get update -y
+          apt-get install -y libbsd-dev ruby
+      - name: Build and run unit tests
+        shell: bash
+        run: |
+          . ${IDF_PATH}/export.sh
+          cd components/mdns/tests/host_unit_test/
+          idf.py reconfigure
+          mkdir build2 && cd build2
+          cmake -DUNIT_TESTS=test_receiver ..
+          cmake --build .
+          ctest --extra-verbose
+
 
   fuzz_test:
     if: contains(github.event.pull_request.labels.*.name, 'mdns-fuzz') || github.event_name == 'push'

components/mdns/tests/host_unit_test/CMakeLists.txt

@@ -1,28 +1,35 @@
 cmake_minimum_required(VERSION 3.5)
 if(ESP_PLATFORM)
+    # Used for reconfiguration of the project
+    # Executed by idf.py reconfigure
     set(EXTRA_COMPONENT_DIRS ../../)
     include($ENV{IDF_PATH}/tools/cmake/project.cmake)
     project(mdns_host_unit_test_config)
     return()
-endif ()
+endif()
 
 project(mdns_host_unit_test C)
 
+# Set ENABLE_UNIT_TESTS with a default of OFF
+if(NOT DEFINED UNIT_TESTS)
+    set(UNIT_TESTS "OFF" CACHE STRING "Unit tests: OFF, test_receiver, test_sender")
+else()
+    set(ENABLE_UNIT_TESTS 1)
+    message(STATUS "Unit testing enabled with UNIT_TESTS=${UNIT_TESTS}")
+endif()
+
 # Set variables for directories
 set(TEST_DIR ${CMAKE_CURRENT_SOURCE_DIR})
+set(STUB_DIR ${TEST_DIR}/stubs)
+set(MDNS_DIR ${TEST_DIR}/../../)
 set(COMPONENT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/../../)
 set(ESP_NETIF_LINUX_DIR ${CMAKE_CURRENT_SOURCE_DIR}/../host_test/components/esp_netif_linux/include)
 set(COMMON_COMPONENTS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/../../../../common_components/linux_compat/)
 set(IDF_COMPONENTS_DIR "$ENV{IDF_PATH}/components")
 
-# Debug prints to see directory values
-message(STATUS "TEST_DIR: ${TEST_DIR}")
-message(STATUS "COMPONENT_DIR: ${COMPONENT_DIR}")
-
-# Include directories for the test files and other required files
 include_directories(
     ${TEST_DIR}
-    ${TEST_DIR}/stubs
+    ${STUB_DIR}
     ${TEST_DIR}/build/config
     ${COMMON_COMPONENTS_DIR}/freertos/include
     ${COMMON_COMPONENTS_DIR}/esp_timer/include
@@ -40,175 +47,39 @@ include_directories(
     ${COMPONENT_DIR}/private_include
 )
 
-# Unity testing framework
-set(UNITY_DIR "$ENV{IDF_PATH}/components/unity")
-include_directories(${UNITY_DIR}/unity/src)
-
-# Add option to enable unit testing
-option(ENABLE_UNIT_TESTS "Enable Unity-based unit tests" OFF)
-
-# Add preprocessor definition based on the option
-if(ENABLE_UNIT_TESTS)
-    add_definitions(-DENABLE_UNIT_TESTS)
-endif()
-
-# Add CMock options
-if(ENABLE_UNIT_TESTS)
-    # CMock paths
-    set(CMOCK_DIR "$ENV{IDF_PATH}/components/cmock")
-
-    # Use ruby command directly instead of looking for ruby.exe
-    find_program(RUBY_EXECUTABLE ruby)
-    if(NOT RUBY_EXECUTABLE)
-        message(FATAL_ERROR "Ruby is required for CMock but was not found!")
-    endif()
-
-    # Define list of files to mock
-    set(MOCK_FILES
-        "mdns_pcb"
-        "mdns_send"
-        # Add more files here as needed, without .h extension
-    )
-
-    # Verify headers exist and create mock commands for each
-    foreach(mock_file ${MOCK_FILES})
-        set(header_path "${COMPONENT_DIR}/private_include/${mock_file}.h")
-        if(NOT EXISTS ${header_path})
-            message(FATAL_ERROR "Cannot find ${mock_file}.h at ${header_path}")
-        endif()
-
-        list(APPEND MOCK_OUTPUTS
-            ${CMAKE_CURRENT_BINARY_DIR}/mocks/mock_${mock_file}.c
-            ${CMAKE_CURRENT_BINARY_DIR}/mocks/mock_${mock_file}.h
-        )
-
-        add_custom_command(
-            OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/mocks/mock_${mock_file}.c
-                   ${CMAKE_CURRENT_BINARY_DIR}/mocks/mock_${mock_file}.h
-            COMMAND ${RUBY_EXECUTABLE}
-                    ${CMOCK_DIR}/CMock/lib/cmock.rb
-                    -o${CMAKE_CURRENT_SOURCE_DIR}/cmock_config.yml
-                    ${header_path}
-            DEPENDS ${header_path}
-            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-            COMMENT "Generating mock for ${mock_file}.h"
-        )
-    endforeach()
-
-    # Include CMock headers
-    include_directories(
-        ${CMOCK_DIR}/CMock/src
-        ${CMAKE_CURRENT_BINARY_DIR}/mocks
-        ${UNITY_DIR}/unity/src
-        ${UNITY_DIR}/include
-    )
-
-    # Create directory for generated mocks
-    file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/mocks)
-
-    # Create CMock config file if it doesn't exist
-    if(NOT EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/cmock_config.yml)
-        file(WRITE ${CMAKE_CURRENT_SOURCE_DIR}/cmock_config.yml
-"---
-:cmock:
-  :mock_prefix: mock_
-  :plugins:
-    - :callback
-    - :ignore
-    - :expect_any_args
-    - :array
-    - :return_thru_ptr
-  :strippables:
-    - '(?:extern|static)\\s+'
-  :treat_as:
-    uint8_t: HEX8
-    uint16_t: HEX16
-    uint32_t: UINT32
-    int8_t: INT8
-    bool: UINT8"
-        )
-    endif()
-endif()
-
 # Source files
 set(SOURCES
-    ${CMAKE_CURRENT_SOURCE_DIR}/main.c
-    ${CMAKE_CURRENT_SOURCE_DIR}/stubs/mdns_mem_caps.c
-    ${CMAKE_CURRENT_SOURCE_DIR}/stubs/esp_idf.c
-    ${CMAKE_CURRENT_SOURCE_DIR}/stubs/mdns_networking.c
-    ${CMAKE_CURRENT_SOURCE_DIR}/stubs/mdns_engine.c
-    ${CMAKE_CURRENT_SOURCE_DIR}/../../mdns_receive.c
-    ${CMAKE_CURRENT_SOURCE_DIR}/../../mdns_utils.c
-    ${CMAKE_CURRENT_SOURCE_DIR}/../../mdns_browser.c
-    ${CMAKE_CURRENT_SOURCE_DIR}/../../mdns_querier.c
-    ${CMAKE_CURRENT_SOURCE_DIR}/../../mdns_responder.c
-    ${CMAKE_CURRENT_SOURCE_DIR}/../../mdns_send.c
-    ${CMAKE_CURRENT_SOURCE_DIR}/../../mdns_pcb.c
-    ${CMAKE_CURRENT_SOURCE_DIR}/../../mdns_netif.c
+    ${STUB_DIR}/mdns_mem_caps.c
+    ${STUB_DIR}/esp_idf.c
+    ${STUB_DIR}/mdns_networking.c
+    ${STUB_DIR}/mdns_engine.c
+    ${MDNS_DIR}/mdns_receive.c
+    ${MDNS_DIR}/mdns_utils.c
+    ${MDNS_DIR}/mdns_browser.c
+    ${MDNS_DIR}/mdns_querier.c
+    ${MDNS_DIR}/mdns_responder.c
+    ${MDNS_DIR}/mdns_send.c
+    ${MDNS_DIR}/mdns_pcb.c
+    ${MDNS_DIR}/mdns_netif.c
 )
 
 if(ENABLE_UNIT_TESTS)
-    # Remove real implementations of mocked files
-    foreach(mock_file ${MOCK_FILES})
-        list(REMOVE_ITEM SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/../../${mock_file}.c)
-    endforeach()
-
-    # Add test-related sources
-    list(APPEND SOURCES
-        ${UNITY_DIR}/unity/src/unity.c
-        ${CMOCK_DIR}/CMock/src/cmock.c
-    )
-
-    # Add all generated mock files
-    foreach(mock_file ${MOCK_FILES})
-        list(APPEND SOURCES ${CMAKE_CURRENT_BINARY_DIR}/mocks/mock_${mock_file}.c)
-    endforeach()
+    include(unity/unit_test.cmake)
+else()
+    list(APPEND SOURCES main.c)
 endif()
 
-# Enable sanitizers
-#set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=address -fno-omit-frame-pointer")
-#set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fsanitize=address")
-
-# Setting C flags with debug symbols and disable optimization for better debugging
-set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -g -O0")
-
-# Create the test executable
 add_executable(${PROJECT_NAME} ${SOURCES})
 
+# Add libbsd if available
 find_library(LIB_BSD bsd)
 if(LIB_BSD)
     target_link_libraries(${PROJECT_NAME} PRIVATE ${LIB_BSD})
 elseif(NOT CMAKE_HOST_SYSTEM_NAME STREQUAL "Darwin")
     message(WARNING "Missing LIBBSD library. Install libbsd-dev package and/or check linker directories.")
 endif()
-# Setting C flags
-#set_target_properties(${PROJECT_NAME} PROPERTIES
-#    C_STANDARD 99
-#    COMPILE_FLAGS "-Wall -Werror"
-#)
 
 # Enable testing if unit tests are enabled
 if(ENABLE_UNIT_TESTS)
-    enable_testing()
-    add_test(NAME ${PROJECT_NAME} COMMAND ${PROJECT_NAME} --test)
-endif()
-
-# Add libbsd dependency
-#find_package(PkgConfig REQUIRED)
-#pkg_check_modules(LIBBSD REQUIRED libbsd-overlay)
-
-# Link against libbsd for strlcat
-#target_link_libraries(${PROJECT_NAME} PRIVATE ${LIBBSD_LIBRARIES})
-#target_link_options(${PROJECT_NAME} PRIVATE -fsanitize=address -fsanitize=undefined)
-#target_compile_options(${PROJECT_NAME} PRIVATE -fsanitize=address -fsanitize=undefined)
-
-# Add include directories if needed
-#target_include_directories(${PROJECT_NAME} PRIVATE ${LIBBSD_INCLUDE_DIRS})
-
-# Add mock generation as dependency
-if(ENABLE_UNIT_TESTS)
-    add_custom_target(generate_mocks
-        DEPENDS ${MOCK_OUTPUTS}
-    )
-    add_dependencies(${PROJECT_NAME} generate_mocks)
+    include(unity/enable_testing.cmake)
 endif()

components/mdns/tests/host_unit_test/main.c

@@ -8,32 +8,9 @@
 #include <stdint.h>
 #include <unistd.h>
 #include "esp_err.h"
-#include "unity.h"
 #include "mdns_receive.h"
 #include "mdns_responder.h"
 #include "mdns_mem_caps.h"
-#ifdef ENABLE_UNIT_TESTS
-#include "mock_mdns_pcb.h"
-#include "mock_mdns_send.h"
-
-void setUp(void)
-{
-}
-
-void tearDown(void)
-{
-}
-
-// Sample test case - update based on the actual functionality in mdns_receive.c
-void test_mdns_receive_initialization(void)
-{
-//    mdns_priv_probe_all_pcbs_ExpectAnyArgs();
-    // Example of using mocks
-    // mock_mdns_pcb_init_ExpectAndReturn(ESP_OK);
-    // Add more mock expectations as needed
-}
-
-#endif
 
 esp_err_t mdns_packet_push(esp_ip_addr_t *addr, int port, mdns_if_t tcpip_if, uint8_t*data, size_t len);
 
@@ -71,7 +48,6 @@ void init_responder(void)
     s_ptr = mdns_query_async_new("minifritz", "_http", "_tcp", MDNS_TYPE_PTR, 1000, 1, NULL);
     s_srv = mdns_query_async_new("fritz", "_http", "_tcp", MDNS_TYPE_SRV, 1000, 1, NULL);
     s_txt = mdns_query_async_new("fritz", "_http", "_tcp", MDNS_TYPE_TXT, 1000, 1, NULL);
-
 }
 
 void deinit_responder(void)
@@ -97,80 +73,8 @@ static void send_packet(bool ip4, bool mdns_port, uint8_t*data, size_t len)
     }
 }
 
-#ifdef ENABLE_UNIT_TESTS
-// Add new test cases for mdns_receive
-void test_mdns_receive_from_file(const char* filename)
-{
-    uint8_t buf[1460];
-    FILE *file = fopen(filename, "r");
-    TEST_ASSERT_NOT_NULL_MESSAGE(file, "Failed to open test packet file");
-
-    size_t len = fread(buf, 1, 1460, file);
-    fclose(file);
-
-    // Test with different packet configurations
-    send_packet(true, true, buf, len);
-    send_packet(true, false, buf, len);
-    send_packet(false, true, buf, len);
-    send_packet(false, false, buf, len);
-
-    // Add assertions here based on expected behavior
-    // For example:
-    // TEST_ASSERT_EQUAL(expected_result, actual_result);
-}
-
-void run_unity_tests(int argc, char **argv)
-{
-    UNITY_BEGIN();
-
-    // Run basic initialization test
-    RUN_TEST(test_mdns_receive_initialization);
-
-    // If a packet file is provided as argument, run packet-based tests
-    if (argc > 2 && strcmp(argv[1], "--test") == 0) {
-        for (int i = 2; i < argc; i++) {
-            printf("Testing with packet file: %s\n", argv[i]);
-            test_mdns_receive_from_file(argv[i]);
-        }
-    }
-
-    UNITY_END();
-}
-
-void mdns_priv_probe_all_pcbs_Callback(mdns_srv_item_t** services, size_t len, bool probe_ip, bool clear_old_probe, int cmock_num_calls)
-{
-
-}
-
-void mdns_priv_create_answer_from_parsed_packet_Callback(mdns_parsed_packet_t* parsed_packet, int cmock_num_calls)
-{
-    printf("callback\n");
-}
-#endif
-
 int main(int argc, char **argv)
 {
-#ifdef ENABLE_UNIT_TESTS
-    if (argc >= 2 && strcmp(argv[1], "--test") == 0) {
-        mdns_priv_probe_all_pcbs_CMockIgnore();
-        mdns_priv_pcb_announce_CMockIgnore();
-        mdns_priv_pcb_send_bye_service_CMockIgnore();
-        mdns_priv_pcb_check_probing_services_CMockIgnore();
-        mdns_priv_pcb_is_after_probing_IgnoreAndReturn(true);
-
-        _mdns_clear_tx_queue_head_CMockIgnore();
-        _mdns_remove_scheduled_service_packets_CMockIgnore();
-        mdns_priv_create_answer_from_parsed_packet_Stub(mdns_priv_create_answer_from_parsed_packet_Callback);
-        //    mdns_priv_probe_all_pcbs_AddCallback(mdns_priv_probe_all_pcbs_Callback);
-        //    mdns_priv_probe_all_pcbs_ExpectAnyArgs();
-
-        init_responder();
-        run_unity_tests(argc, argv);
-        deinit_responder();
-        return 0;
-    }
-#endif
-
     init_responder();
 
     // Original fuzzing code
@@ -202,7 +106,5 @@ int main(int argc, char **argv)
     }
     deinit_responder();
 
-    // ... rest of the existing fuzzing code ...
-
     return 0;
 }