Merge branch 'feature/storage_remove_nvs_test_host' into 'master'

remove(nvs_flash/test_nvs_host): Old make based host tests removed after complete migration

See merge request espressif/esp-idf!27853

Author: rrtandler

.gitlab/ci/host-test.yml

@@ -34,22 +34,16 @@ check_public_headers:
     - IDF_TARGET=esp32p4 python tools/ci/check_public_headers.py --jobs 4 --prefix riscv32-esp-elf-
     - IDF_TARGET=esp32c61 python tools/ci/check_public_headers.py --jobs 4 --prefix riscv32-esp-elf-
 
-test_nvs_on_host:
-  extends: .host_test_template
-  script:
-    - cd components/nvs_flash/test_nvs_host
-    - make test
-
 test_nvs_coverage:
   extends:
     - .host_test_template
     - .rules:labels:nvs_coverage
   artifacts:
     paths:
-      - components/nvs_flash/test_nvs_host/coverage_report
+      - components/nvs_flash/host_test/nvs_host_test/coverage_report
   script:
-    - cd components/nvs_flash/test_nvs_host
-    - make coverage_report
+    - cd components/nvs_flash/host_test/nvs_host_test
+    - idf.py build coverage
   # the 'long' host tests take approx 11 hours on our current runners. Adding some margin here for possible CPU contention
   timeout: 18 hours
 

components/nvs_flash/host_test/nvs_host_test/CMakeLists.txt

@@ -5,4 +5,19 @@ set(COMPONENTS main)
 # This test app doesn't require FreeRTOS, using mock instead
 list(APPEND EXTRA_COMPONENT_DIRS "$ENV{IDF_PATH}/tools/mocks/freertos/")
 
+idf_build_set_property(COMPILE_DEFINITIONS "NO_DEBUG_STORAGE" APPEND)
 project(nvs_host_test)
+
+add_custom_command(
+    OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/coverage_report/index.html"
+    WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
+    COMMAND gcovr --root $ENV{IDF_PATH}/components/nvs_flash --html-details
+    --exclude ${CMAKE_CURRENT_SOURCE_DIR}/managed_components/*
+    -o ${CMAKE_CURRENT_BINARY_DIR}/coverage_report/index.html ${CMAKE_CURRENT_BINARY_DIR}
+    COMMENT "Generate coverage report"
+    )
+
+add_custom_target(coverage
+    WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
+    DEPENDS "coverage_report/index.html"
+    )

components/nvs_flash/host_test/nvs_host_test/README.md

@@ -1,2 +1,31 @@
 | Supported Targets | Linux |
 | ----------------- | ----- |
+
+# To build 
+Navigate to the host test folder and run the IDF build command for linux target
+
+```
+cd $IDF_PATH
+. ./export.sh
+cd components/nvs_flash/host_test/nvs_host_test
+idf.py --preview set-target linux
+idf.py build
+```
+
+# To run tests locally
+Navigate to the IDF root directory and run the binary from there. This ensures all calls to relative paths from test cases are resolved correctly.
+This is limitation of ci pipeline as it was not possible to specify the working directory of the host tests.
+
+```
+cd $IDF_PATH
+./components/nvs_flash/host_test/nvs_host_test/build/nvs_host_test.elf
+```
+
+# To create coverage report
+After running the tests, the coverage report can be generated following way.
+
+```
+cd components/nvs_flash/host_test/nvs_host_test
+idf.py build coverage
+open ./build/coverage_report/index.html
+```

components/nvs_flash/host_test/nvs_host_test/main/CMakeLists.txt

@@ -12,6 +12,9 @@ idf_component_register(SRCS "test_nvs.cpp"
                        REQUIRES nvs_flash
                        PRIV_REQUIRES spi_flash)
 
+target_compile_options(${COMPONENT_LIB} PUBLIC --coverage)
+target_link_libraries(${COMPONENT_LIB} PUBLIC --coverage)
+
 if(CMAKE_C_COMPILER_ID MATCHES "Clang")
     target_compile_options(${COMPONENT_LIB} PRIVATE -std=gnu++20)
 endif()

components/nvs_flash/host_test/nvs_host_test/main/test_nvs.cpp

@@ -3742,7 +3742,7 @@ TEST_CASE("check and read data from partition generated via manufacturing utilit
     }
 }
 
-TEST_CASE("nvs multiple write with same key but different types", "[nvs][xxx]")
+TEST_CASE("nvs multiple write with same key but different types", "[nvs]")
 {
     PartitionEmulationFixture f(0, 10);