tests: cmake: overlays: Add soc_folder_kconfig test

Adds a testcase for the new ``socs`` folder using Kconfig fragments

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>

tests/cmake/overlays/soc_folder_kconfig/CMakeLists.txt

@@ -0,0 +1,9 @@
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.20.0)
+
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+project(overlays_soc_folder_kconfig)
+
+FILE(GLOB app_sources src/*.c)
+target_sources(app PRIVATE ${app_sources})

tests/cmake/overlays/soc_folder_kconfig/Kconfig

@@ -0,0 +1,32 @@
+# Copyright (c) 2024 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+
+config SOC_FOLDER_TEST_STRING
+	string "Test string"
+	default "one"
+
+config SOC_FOLDER_TEST_INCLUDE_BOARD
+	bool "Included board Kconfig fragment"
+
+config SOC_FOLDER_TEST_INCLUDE_BOARD_SUFFIX
+	bool "Included board Kconfig fragment with suffix"
+
+config SOC_FOLDER_TEST_INCLUDE_BOARD_QUALIFIERS
+	bool "Included board with qualifiers Kconfig fragment"
+
+config SOC_FOLDER_TEST_INCLUDE_BOARD_OTHER
+	bool "Included other board Kconfig fragment"
+
+config SOC_FOLDER_TEST_INCLUDE_SOC
+	bool "Included soc Kconfig fragment"
+
+config SOC_FOLDER_TEST_INCLUDE_SOC_SUFFIX
+	bool "Included soc overlay Kconfig fragment"
+
+config SOC_FOLDER_TEST_INCLUDE_SOC_OTHER
+	bool "Included other soc overlay Kconfig fragment"
+
+config TEST_TYPE
+	int "Test type"
+
+source "Kconfig.zephyr"

tests/cmake/overlays/soc_folder_kconfig/boards/native_sim_native.conf

@@ -0,0 +1,2 @@
+CONFIG_SOC_FOLDER_TEST_INCLUDE_BOARD=y
+CONFIG_SOC_FOLDER_TEST_STRING="two"

tests/cmake/overlays/soc_folder_kconfig/boards/native_sim_native_64.conf

@@ -0,0 +1,2 @@
+CONFIG_SOC_FOLDER_TEST_INCLUDE_BOARD_QUALIFIERS=y
+CONFIG_SOC_FOLDER_TEST_STRING="five"

tests/cmake/overlays/soc_folder_kconfig/boards/native_sim_native_64_somesuffix.conf

@@ -0,0 +1,2 @@
+CONFIG_SOC_FOLDER_TEST_INCLUDE_BOARD_SUFFIX=y
+CONFIG_SOC_FOLDER_TEST_STRING="four"

tests/cmake/overlays/soc_folder_kconfig/boards/native_sim_native_somesuffix.conf

@@ -0,0 +1,2 @@
+CONFIG_SOC_FOLDER_TEST_INCLUDE_BOARD_SUFFIX=y
+CONFIG_SOC_FOLDER_TEST_STRING="four"

tests/cmake/overlays/soc_folder_kconfig/boards/other.conf

@@ -0,0 +1,3 @@
+CONFIG_SOC_FOLDER_TEST_INCLUDE_BOARD_OTHER=y
+CONFIG_SOC_FOLDER_TEST_STRING="three"
+CONFIG_ZTEST=y

tests/cmake/overlays/soc_folder_kconfig/prj.conf

@@ -0,0 +1 @@
+CONFIG_ZTEST=y

tests/cmake/overlays/soc_folder_kconfig/socs/native.conf

@@ -0,0 +1,2 @@
+CONFIG_SOC_FOLDER_TEST_INCLUDE_SOC=y
+CONFIG_SOC_FOLDER_TEST_STRING="seven"

tests/cmake/overlays/soc_folder_kconfig/socs/native_64.conf

@@ -0,0 +1,2 @@
+CONFIG_SOC_FOLDER_TEST_INCLUDE_SOC=y
+CONFIG_SOC_FOLDER_TEST_STRING="six"

tests/cmake/overlays/soc_folder_kconfig/socs/native_64_somesuffix.conf

@@ -0,0 +1,2 @@
+CONFIG_SOC_FOLDER_TEST_INCLUDE_SOC_SUFFIX=y
+CONFIG_SOC_FOLDER_TEST_STRING="eight"

tests/cmake/overlays/soc_folder_kconfig/socs/native_somesuffix.conf

@@ -0,0 +1,2 @@
+CONFIG_SOC_FOLDER_TEST_INCLUDE_SOC_SUFFIX=y
+CONFIG_SOC_FOLDER_TEST_STRING="eight"

tests/cmake/overlays/soc_folder_kconfig/socs/other.conf

@@ -0,0 +1,2 @@
+CONFIG_SOC_FOLDER_TEST_INCLUDE_SOC_OTHER=y
+CONFIG_SOC_FOLDER_TEST_STRING="nine"

tests/cmake/overlays/soc_folder_kconfig/src/main.c

@@ -0,0 +1,139 @@
+/*
+ * Copyright (c) 2024 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/ztest.h>
+
+#ifdef CONFIG_SOC_FOLDER_TEST_STRING
+#define STRING_OUTPUT CONFIG_SOC_FOLDER_TEST_STRING
+#else
+#error "Invalid test configuration"
+#endif
+
+#ifndef CONFIG_TEST_TYPE
+#error "Invalid test configuration"
+#endif
+
+#ifdef CONFIG_SOC_FOLDER_TEST_INCLUDE_BOARD
+#define INCLUDED_BOARD 1
+#else
+#define INCLUDED_BOARD 0
+#endif
+
+#ifdef CONFIG_SOC_FOLDER_TEST_INCLUDE_BOARD_SUFFIX
+#define INCLUDED_BOARD_SUFFIX 1
+#else
+#define INCLUDED_BOARD_SUFFIX 0
+#endif
+
+#ifdef CONFIG_SOC_FOLDER_TEST_INCLUDE_BOARD_QUALIFIERS
+#define INCLUDED_BOARD_QUALIFIERS 1
+#else
+#define INCLUDED_BOARD_QUALIFIERS 0
+#endif
+
+#ifdef CONFIG_SOC_FOLDER_TEST_INCLUDE_BOARD_OTHER
+#define INCLUDED_BOARD_OTHER 1
+#else
+#define INCLUDED_BOARD_OTHER 0
+#endif
+
+#ifdef CONFIG_SOC_FOLDER_TEST_INCLUDE_SOC
+#define INCLUDED_SOC 1
+#else
+#define INCLUDED_SOC 0
+#endif
+
+#ifdef CONFIG_SOC_FOLDER_TEST_INCLUDE_SOC_SUFFIX
+#define INCLUDED_SOC_SUFFIX 1
+#else
+#define INCLUDED_SOC_SUFFIX 0
+#endif
+
+#ifdef CONFIG_SOC_FOLDER_TEST_INCLUDE_SOC_OTHER
+#define INCLUDED_SOC_OTHER 1
+#else
+#define INCLUDED_SOC_OTHER 0
+#endif
+
+#if CONFIG_TEST_TYPE == 0
+/* Default test */
+ZTEST(soc_folder_kconfig, test_default)
+{
+	zassert_false(INCLUDED_BOARD_SUFFIX, "Did not expect board suffix config to be present");
+
+#ifdef CONFIG_BOARD_NATIVE_SIM_NATIVE_64
+	zassert_false(INCLUDED_BOARD, "Did not expect board config to be present");
+	zassert_true(INCLUDED_BOARD_QUALIFIERS, "Expected board qualifier config to be present");
+	zassert_mem_equal(STRING_OUTPUT, "five", strlen("five"), "Expected string to match");
+#else
+	zassert_true(INCLUDED_BOARD, "Expected board config to be present");
+	zassert_false(INCLUDED_BOARD_QUALIFIERS,
+		      "Did not expect board qualifier config to be present");
+	zassert_mem_equal(STRING_OUTPUT, "two", strlen("two"), "Expected string to match");
+#endif
+
+	zassert_false(INCLUDED_BOARD_OTHER, "Did not expect board other config to be present");
+	zassert_true(INCLUDED_SOC, "Expect soc config to be present");
+	zassert_false(INCLUDED_SOC_SUFFIX, "Did not expect soc suffix config to be present");
+	zassert_false(INCLUDED_SOC_OTHER, "Did not expect soc other config to be present");
+}
+#elif CONFIG_TEST_TYPE == 1
+/* File suffix test */
+ZTEST(soc_folder_kconfig, test_suffix)
+{
+	zassert_true(INCLUDED_BOARD_SUFFIX, "Expected board suffix config to be present");
+
+	zassert_false(INCLUDED_BOARD, "Did not expect board config to be present");
+	zassert_false(INCLUDED_BOARD_QUALIFIERS,
+		      "Did not expect board qualifier config to be present");
+	zassert_mem_equal(STRING_OUTPUT, "four", strlen("four"), "Expected string to match");
+	zassert_false(INCLUDED_BOARD_OTHER, "Did not expect board other config to be present");
+	zassert_false(INCLUDED_SOC, "Did not expect soc config to be present");
+	zassert_true(INCLUDED_SOC_SUFFIX, "Expected soc suffix config to be present");
+	zassert_false(INCLUDED_SOC_OTHER, "Did not expect soc other config to be present");
+}
+#elif CONFIG_TEST_TYPE == 2
+/* Conf file test */
+ZTEST(soc_folder_kconfig, test_conf)
+{
+	zassert_false(INCLUDED_BOARD_SUFFIX, "Did not expect board suffix config to be present");
+
+#ifdef CONFIG_BOARD_NATIVE_SIM_NATIVE_64
+	zassert_false(INCLUDED_BOARD, "Did not expect board config to be present");
+	zassert_true(INCLUDED_BOARD_QUALIFIERS,
+		     "Expected board qualifier config to be present");
+#else
+	zassert_true(INCLUDED_BOARD, "Expected board config to be present");
+	zassert_false(INCLUDED_BOARD_QUALIFIERS,
+		     "Did not expect board qualifier config to be present");
+#endif
+
+	zassert_mem_equal(STRING_OUTPUT, "three", strlen("three"), "Expected string to match");
+
+	zassert_true(INCLUDED_BOARD_OTHER, "Expected board other config to be present");
+	zassert_true(INCLUDED_SOC, "Expected soc config to be present");
+	zassert_false(INCLUDED_SOC_SUFFIX, "Did not expect soc suffix config to be present");
+	zassert_false(INCLUDED_SOC_OTHER, "Did not expect soc other config to be present");
+}
+#elif CONFIG_TEST_TYPE == 3
+/* File suffix and conf file test */
+ZTEST(soc_folder_kconfig, test_suffix_conf)
+{
+	zassert_true(INCLUDED_BOARD_SUFFIX, "Expected board suffix config to be present");
+	zassert_false(INCLUDED_BOARD, "Did not expect board config to be present");
+	zassert_false(INCLUDED_BOARD_QUALIFIERS,
+		      "Did not expect board qualifier config to be present");
+	zassert_mem_equal(STRING_OUTPUT, "three", strlen("three"), "Expected string to match");
+	zassert_true(INCLUDED_BOARD_OTHER, "Expected board other config to be present");
+	zassert_false(INCLUDED_SOC, "Did not expect soc config to be present");
+	zassert_true(INCLUDED_SOC_SUFFIX, "Expected soc suffix config to be present");
+	zassert_false(INCLUDED_SOC_OTHER, "Did not expect soc other config to be present");
+}
+#else
+#error "Invalid test type"
+#endif
+
+ZTEST_SUITE(soc_folder_kconfig, NULL, NULL, NULL, NULL, NULL);

tests/cmake/overlays/soc_folder_kconfig/testcase.yaml

@@ -0,0 +1,26 @@
+common:
+  tags:
+    - cmake
+  platform_allow:
+    - native_sim
+    - native_sim/native/64
+  integration_platforms:
+    - native_sim
+    - native_sim/native/64
+tests:
+  cmake.overlays.soc_folder_kconfig.default:
+    extra_args:
+      - CONFIG_TEST_TYPE=0
+  cmake.overlays.soc_folder_kconfig.suffix:
+    extra_args:
+      - CONFIG_TEST_TYPE=1
+      - FILE_SUFFIX=somesuffix
+  cmake.overlays.soc_folder_kconfig.conf:
+    extra_args:
+      - CONFIG_TEST_TYPE=2
+      - EXTRA_CONF_FILE=boards/other.conf
+  cmake.overlays.soc_folder_kconfig.suffix.conf:
+    extra_args:
+      - CONFIG_TEST_TYPE=3
+      - FILE_SUFFIX=somesuffix
+      - EXTRA_CONF_FILE=boards/other.conf