ci(nvs_flash): upgrade to Catch2 as a component, fix warnings

2025-10-03 18:40:59 +02:00 · 2023-11-27 14:33:38 +01:00
parent 683212f41e
commit 95e169b5f2
10 changed files with 21 additions and 31 deletions
--- a/components/nvs_flash/host_test/nvs_host_test/CMakeLists.txt
+++ b/components/nvs_flash/host_test/nvs_host_test/CMakeLists.txt
@@ -2,9 +2,7 @@ cmake_minimum_required(VERSION 3.16)

 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 set(COMPONENTS main)
-# Freertos is included via common components. However, CATCH isn't compatible with the FreeRTOS component yet, hence
-# using the FreeRTOS mock component.
-# target.
+# This test app doesn't require FreeRTOS, using mock instead
 list(APPEND EXTRA_COMPONENT_DIRS "$ENV{IDF_PATH}/tools/mocks/freertos/")

 project(nvs_host_test)
--- a/components/nvs_flash/host_test/nvs_host_test/main/CMakeLists.txt
+++ b/components/nvs_flash/host_test/nvs_host_test/main/CMakeLists.txt
@@ -1,5 +1,4 @@
-idf_component_register(SRCS "main.cpp"
-                            "test_nvs.cpp"
+idf_component_register(SRCS "test_nvs.cpp"
                            "test_partition_manager.cpp"
                            "test_nvs_cxx_api.cpp"
                            "test_nvs_handle.cpp"
@@ -9,6 +8,13 @@ idf_component_register(SRCS "main.cpp"
                            "../../../src"
                            "../../../private_include"
                            "../../../../mbedtls/mbedtls/include"
-                            "../../../../../tools/catch"
                       WHOLE_ARCHIVE
                       REQUIRES nvs_flash)
+
+if(CMAKE_C_COMPILER_ID MATCHES "Clang")
+    target_compile_options(${COMPONENT_LIB} PRIVATE -std=gnu++20)
+endif()
+
+# Currently 'main' for IDF_TARGET=linux is defined in freertos component.
+# Since we are using a freertos mock here, need to let Catch2 provide 'main'.
+target_link_libraries(${COMPONENT_LIB} PRIVATE Catch2WithMain)
--- a/components/nvs_flash/host_test/nvs_host_test/main/idf_component.yml
+++ b/components/nvs_flash/host_test/nvs_host_test/main/idf_component.yml
@@ -0,0 +1,2 @@
+dependencies:
+  espressif/catch2: "^3.4.0"
--- a/components/nvs_flash/host_test/nvs_host_test/main/main.cpp
+++ b/components/nvs_flash/host_test/nvs_host_test/main/main.cpp
@@ -1,7 +0,0 @@
-/*
- * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-#define CATCH_CONFIG_MAIN
-#include "catch.hpp"
--- a/components/nvs_flash/host_test/nvs_host_test/main/test_nvs.cpp
+++ b/components/nvs_flash/host_test/nvs_host_test/main/test_nvs.cpp
@@ -3,7 +3,7 @@
 *
 * SPDX-License-Identifier: Apache-2.0
 */
-#include "catch.hpp"
+#include <catch2/catch_test_macros.hpp>
 #include "nvs.hpp"
 #include "sdkconfig.h"
 #include "nvs_partition_manager.hpp"
@@ -381,8 +381,7 @@ TEST_CASE("storage can find items on second page if first is not fully written a
 {
    PartitionEmulationFixture f(0, 3);
    nvs::Storage storage(f.part());
-    CHECK(storage.init(0, 3) == ESP_OK);
-    int bar = 0;
+    TEST_ESP_OK(storage.init(0, 3));
    uint8_t bigdata[(nvs::Page::CHUNK_MAX_SIZE - nvs::Page::ENTRY_SIZE) / 2] = {0};
    // write one big chunk of data
    ESP_ERROR_CHECK(storage.writeItem(0, nvs::ItemType::BLOB, "1", bigdata, sizeof(bigdata)));
@@ -632,8 +631,6 @@ TEST_CASE("deinit partition doesn't affect other partition's open handles", "[nv
    const char *OTHER_PARTITION_NAME = "other_part";
    PartitionEmulationFixture f(0, 10);
    PartitionEmulationFixture f_other(0, 10, OTHER_PARTITION_NAME);
-    const char *str = "value 0123456789abcdef0123456789abcdef";
-    const uint8_t blob[8] = {0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7};

    nvs_handle_t handle_1;
    const uint32_t NVS_FLASH_SECTOR = 6;
@@ -693,7 +690,6 @@ TEST_CASE("nvs_entry_info fails with ESP_ERR_INVALID_ARG if a parameter is NULL"
 TEST_CASE("nvs_entry_info doesn't change iterator on parameter error", "[nvs]")
 {
    nvs_iterator_t it = reinterpret_cast<nvs_iterator_t>(0xbeef);
-    nvs_entry_info_t info;
    REQUIRE(nvs_entry_info(it, nullptr) == ESP_ERR_INVALID_ARG);
    CHECK(it == reinterpret_cast<nvs_iterator_t>(0xbeef));

@@ -972,8 +968,8 @@ TEST_CASE("wifi test", "[nvs]")
    TEST_ESP_OK(nvs_set_u8(net80211_handle, "wifi.opmode", opmode));

    uint8_t country = 0;
-    TEST_ESP_ERR(nvs_get_u8(net80211_handle, "wifi.country", &opmode), ESP_ERR_NVS_NOT_FOUND);
-    TEST_ESP_OK(nvs_set_u8(net80211_handle, "wifi.country", opmode));
+    TEST_ESP_ERR(nvs_get_u8(net80211_handle, "wifi.country", &country), ESP_ERR_NVS_NOT_FOUND);
+    TEST_ESP_OK(nvs_set_u8(net80211_handle, "wifi.country", country));

    char ssid[36];
    size_t size = sizeof(ssid);
@@ -1239,7 +1235,6 @@ public:

            case nvs::ItemType::SZ: {
                char buf[strBufLen];
-                size_t len = strBufLen;

                size_t strLen = gen() % (strBufLen - 1);
                std::generate_n(buf, strLen, [&]() -> char {
@@ -1751,8 +1746,6 @@ TEST_CASE("Check that orphaned blobs are erased during init", "[nvs]")
 {
    const size_t blob_size = nvs::Page::CHUNK_MAX_SIZE * 3 ;
    uint8_t blob[blob_size] = {0x11};
-    uint8_t blob2[blob_size] = {0x22};
-    uint8_t blob3[blob_size] = {0x33};
    PartitionEmulationFixture f(0, 5);
    nvs::Storage storage(f.part());

--- a/components/nvs_flash/host_test/nvs_host_test/main/test_nvs_cxx_api.cpp
+++ b/components/nvs_flash/host_test/nvs_host_test/main/test_nvs_cxx_api.cpp
@@ -3,7 +3,7 @@
 *
 * SPDX-License-Identifier: Apache-2.0
 */
-#include "catch.hpp"
+#include <catch2/catch_test_macros.hpp>
 #include <algorithm>
 #include <cstring>
 #include "nvs_handle_simple.hpp"
--- a/components/nvs_flash/host_test/nvs_host_test/main/test_nvs_handle.cpp
+++ b/components/nvs_flash/host_test/nvs_host_test/main/test_nvs_handle.cpp
@@ -3,7 +3,7 @@
 *
 * SPDX-License-Identifier: Apache-2.0
 */
-#include "catch.hpp"
+#include <catch2/catch_test_macros.hpp>
 #include <algorithm>
 #include <cstring>
 #include "nvs_handle_simple.hpp"
--- a/components/nvs_flash/host_test/nvs_host_test/main/test_nvs_initialization.cpp
+++ b/components/nvs_flash/host_test/nvs_host_test/main/test_nvs_initialization.cpp
@@ -3,7 +3,7 @@
 *
 * SPDX-License-Identifier: Apache-2.0
 */
-#include "catch.hpp"
+#include <catch2/catch_test_macros.hpp>
 #include "nvs.hpp"
 #include "nvs_partition_manager.hpp"
 #include "nvs_partition.hpp"
@@ -12,8 +12,6 @@

 TEST_CASE("nvs_flash_init_partition_ptr fails due to nullptr arg", "[nvs_custom_part]")
 {
-    const uint32_t NVS_FLASH_SECTOR = 6;
-    const uint32_t NVS_FLASH_SECTOR_COUNT_MIN = 3;
    uint8_t *p_part_desc_addr_start;
    CHECK(esp_partition_file_mmap((const uint8_t **)&p_part_desc_addr_start) == ESP_OK);

--- a/components/nvs_flash/host_test/nvs_host_test/main/test_nvs_storage.cpp
+++ b/components/nvs_flash/host_test/nvs_host_test/main/test_nvs_storage.cpp
@@ -3,7 +3,7 @@
 *
 * SPDX-License-Identifier: Apache-2.0
 */
-#include "catch.hpp"
+#include <catch2/catch_test_macros.hpp>
 #include <cstring>
 #include "nvs_storage.hpp"
 #include "nvs_partition_manager.hpp"
--- a/components/nvs_flash/host_test/nvs_host_test/main/test_partition_manager.cpp
+++ b/components/nvs_flash/host_test/nvs_host_test/main/test_partition_manager.cpp
@@ -3,7 +3,7 @@
 *
 * SPDX-License-Identifier: Apache-2.0
 */
-#include "catch.hpp"
+#include <catch2/catch_test_macros.hpp>
 #include <algorithm>
 #include <cstring>
 #include "nvs_handle_simple.hpp"