From a7ceba371094c89dce2a60525fe6a91a8df6d6f9 Mon Sep 17 00:00:00 2001
From: Yuval Peress <peress@google.com>
Date: Tue, 19 Apr 2022 11:54:42 -0600
Subject: [PATCH] testing: add zephyr/ prefix to testing include path

Continuation of issue #41543 to add prefix scope for Zephyr's include
files.

Signed-off-by: Yuval Peress <peress@google.com>
---
 cmake/modules/unittest.cmake                              | 3 ++-
 subsys/testsuite/CMakeLists.txt                           | 8 +++++---
 subsys/testsuite/include/{ => zephyr}/busy_sim.h          | 0
 subsys/testsuite/include/{ => zephyr}/fff.h               | 0
 subsys/testsuite/include/{ => zephyr}/interrupt_util.h    | 0
 subsys/testsuite/include/{ => zephyr}/tc_util.h           | 0
 .../testsuite/include/{ => zephyr}/test_asm_inline_gcc.h  | 0
 subsys/testsuite/include/{ => zephyr}/test_utils.h        | 0
 subsys/testsuite/include/{ => zephyr}/timestamp.h         | 0
 subsys/testsuite/include/{ => zephyr}/ztest_unittest.ld   | 0
 subsys/testsuite/ztest/CMakeLists.txt                     | 4 ++++
 subsys/testsuite/ztest/include/{ => zephyr}/offsets.h     | 0
 .../testsuite/ztest/include/{ => zephyr}/syscall_list.h   | 0
 .../testsuite/ztest/include/{ => zephyr}/syscall_macros.h | 0
 .../ztest/include/{ => zephyr}/syscalls/kernel.h          | 0
 .../ztest/include/{ => zephyr}/syscalls/kobject.h         | 0
 .../ztest/include/{ => zephyr}/syscalls/log_core.h        | 0
 .../ztest/include/{ => zephyr}/syscalls/log_ctrl.h        | 0
 .../ztest/include/{ => zephyr}/syscalls/log_msg.h         | 0
 .../ztest/include/{ => zephyr}/syscalls/sys_clock.h       | 0
 subsys/testsuite/ztest/include/{ => zephyr}/ztest.h       | 0
 .../testsuite/ztest/include/{ => zephyr}/ztest_assert.h   | 0
 .../ztest/include/{ => zephyr}/ztest_error_hook.h         | 0
 subsys/testsuite/ztest/include/{ => zephyr}/ztest_mock.h  | 0
 subsys/testsuite/ztest/include/{ => zephyr}/ztest_test.h  | 0
 .../ztest/include/{ => zephyr}/ztest_test_deprecated.h    | 0
 .../testsuite/ztest/include/{ => zephyr}/ztest_test_new.h | 0
 subsys/testsuite/ztest/include/{ => zephyr}/ztress.h      | 0
 subsys/testsuite/ztest/src/ztest.c                        | 4 +++-
 subsys/testsuite/ztest/src/ztest_mock.c                   | 2 +-
 tests/unit/base64/main.c                                  | 3 +--
 tests/ztest/automain/src/test_feature.c                   | 2 +-
 tests/ztest/base/src/main.c                               | 2 +-
 tests/ztest/base/src/main_deprecated.c                    | 2 +-
 tests/ztest/busy_sim/src/main.c                           | 4 ++--
 tests/ztest/custom_output/src/main.c                      | 2 +-
 tests/ztest/mock/src/main.c                               | 2 +-
 tests/ztest/mock_fff/src/main.c                           | 4 ++--
 38 files changed, 25 insertions(+), 17 deletions(-)
 rename subsys/testsuite/include/{ => zephyr}/busy_sim.h (100%)
 rename subsys/testsuite/include/{ => zephyr}/fff.h (100%)
 rename subsys/testsuite/include/{ => zephyr}/interrupt_util.h (100%)
 rename subsys/testsuite/include/{ => zephyr}/tc_util.h (100%)
 rename subsys/testsuite/include/{ => zephyr}/test_asm_inline_gcc.h (100%)
 rename subsys/testsuite/include/{ => zephyr}/test_utils.h (100%)
 rename subsys/testsuite/include/{ => zephyr}/timestamp.h (100%)
 rename subsys/testsuite/include/{ => zephyr}/ztest_unittest.ld (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/offsets.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/syscall_list.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/syscall_macros.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/syscalls/kernel.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/syscalls/kobject.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/syscalls/log_core.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/syscalls/log_ctrl.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/syscalls/log_msg.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/syscalls/sys_clock.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/ztest.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/ztest_assert.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/ztest_error_hook.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/ztest_mock.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/ztest_test.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/ztest_test_deprecated.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/ztest_test_new.h (100%)
 rename subsys/testsuite/ztest/include/{ => zephyr}/ztress.h (100%)

diff --git a/cmake/modules/unittest.cmake b/cmake/modules/unittest.cmake
index c25f75413d3..56dfc64d20b 100644
--- a/cmake/modules/unittest.cmake
+++ b/cmake/modules/unittest.cmake
@@ -33,6 +33,7 @@ gen_kobj(KOBJ_GEN_DIR)
 
 list(APPEND INCLUDE
   subsys/testsuite/ztest/include/zephyr
+  subsys/testsuite/include/zephyr
   subsys/testsuite/ztest/include
   subsys/testsuite/include
   include/zephyr
@@ -63,7 +64,7 @@ target_compile_options(testbinary PRIVATE
   )
 
 target_link_options(testbinary PRIVATE
-  -T "${ZEPHYR_BASE}/subsys/testsuite/include/ztest_unittest.ld"
+  -T "${ZEPHYR_BASE}/subsys/testsuite/include/zephyr/ztest_unittest.ld"
   )
 
 target_link_libraries(testbinary PRIVATE
diff --git a/subsys/testsuite/CMakeLists.txt b/subsys/testsuite/CMakeLists.txt
index b7bed7047c8..c6777fb78b6 100644
--- a/subsys/testsuite/CMakeLists.txt
+++ b/subsys/testsuite/CMakeLists.txt
@@ -2,9 +2,11 @@
 
 add_subdirectory_ifdef(CONFIG_ZTEST ztest)
 
-zephyr_include_directories_ifdef(CONFIG_TEST
-  ${ZEPHYR_BASE}/subsys/testsuite/include
-  )
+if(CONFIG_TEST)
+  zephyr_include_directories(${ZEPHYR_BASE}/subsys/testsuite/include)
+  zephyr_include_directories_ifdef(
+      CONFIG_LEGACY_INCLUDE_PATH ${ZEPHYR_BASE}/subsys/testsuite/include/zephyr)
+endif()
 add_subdirectory_ifdef(CONFIG_COVERAGE_GCOV coverage)
 
 zephyr_library_sources_ifdef(CONFIG_TEST_BUSY_SIM busy_sim/busy_sim.c)
diff --git a/subsys/testsuite/include/busy_sim.h b/subsys/testsuite/include/zephyr/busy_sim.h
similarity index 100%
rename from subsys/testsuite/include/busy_sim.h
rename to subsys/testsuite/include/zephyr/busy_sim.h
diff --git a/subsys/testsuite/include/fff.h b/subsys/testsuite/include/zephyr/fff.h
similarity index 100%
rename from subsys/testsuite/include/fff.h
rename to subsys/testsuite/include/zephyr/fff.h
diff --git a/subsys/testsuite/include/interrupt_util.h b/subsys/testsuite/include/zephyr/interrupt_util.h
similarity index 100%
rename from subsys/testsuite/include/interrupt_util.h
rename to subsys/testsuite/include/zephyr/interrupt_util.h
diff --git a/subsys/testsuite/include/tc_util.h b/subsys/testsuite/include/zephyr/tc_util.h
similarity index 100%
rename from subsys/testsuite/include/tc_util.h
rename to subsys/testsuite/include/zephyr/tc_util.h
diff --git a/subsys/testsuite/include/test_asm_inline_gcc.h b/subsys/testsuite/include/zephyr/test_asm_inline_gcc.h
similarity index 100%
rename from subsys/testsuite/include/test_asm_inline_gcc.h
rename to subsys/testsuite/include/zephyr/test_asm_inline_gcc.h
diff --git a/subsys/testsuite/include/test_utils.h b/subsys/testsuite/include/zephyr/test_utils.h
similarity index 100%
rename from subsys/testsuite/include/test_utils.h
rename to subsys/testsuite/include/zephyr/test_utils.h
diff --git a/subsys/testsuite/include/timestamp.h b/subsys/testsuite/include/zephyr/timestamp.h
similarity index 100%
rename from subsys/testsuite/include/timestamp.h
rename to subsys/testsuite/include/zephyr/timestamp.h
diff --git a/subsys/testsuite/include/ztest_unittest.ld b/subsys/testsuite/include/zephyr/ztest_unittest.ld
similarity index 100%
rename from subsys/testsuite/include/ztest_unittest.ld
rename to subsys/testsuite/include/zephyr/ztest_unittest.ld
diff --git a/subsys/testsuite/ztest/CMakeLists.txt b/subsys/testsuite/ztest/CMakeLists.txt
index 9ebac5ecbc9..b99cf07fd8a 100644
--- a/subsys/testsuite/ztest/CMakeLists.txt
+++ b/subsys/testsuite/ztest/CMakeLists.txt
@@ -4,6 +4,10 @@ zephyr_include_directories(
   ${ZEPHYR_BASE}/subsys/testsuite/include
   ${ZEPHYR_BASE}/subsys/testsuite/ztest/include
   )
+zephyr_include_directories_ifdef(
+    CONFIG_LEGACY_INCLUDE_PATH ${ZEPHYR_BASE}/subsys/testsuite/include/zephyr)
+zephyr_include_directories_ifdef(
+    CONFIG_LEGACY_INCLUDE_PATH ${ZEPHYR_BASE}/subsys/testsuite/ztest/include/zephyr)
 
 if(DEFINED TC_RUNID)
   zephyr_compile_definitions(TC_RUNID=${TC_RUNID})
diff --git a/subsys/testsuite/ztest/include/offsets.h b/subsys/testsuite/ztest/include/zephyr/offsets.h
similarity index 100%
rename from subsys/testsuite/ztest/include/offsets.h
rename to subsys/testsuite/ztest/include/zephyr/offsets.h
diff --git a/subsys/testsuite/ztest/include/syscall_list.h b/subsys/testsuite/ztest/include/zephyr/syscall_list.h
similarity index 100%
rename from subsys/testsuite/ztest/include/syscall_list.h
rename to subsys/testsuite/ztest/include/zephyr/syscall_list.h
diff --git a/subsys/testsuite/ztest/include/syscall_macros.h b/subsys/testsuite/ztest/include/zephyr/syscall_macros.h
similarity index 100%
rename from subsys/testsuite/ztest/include/syscall_macros.h
rename to subsys/testsuite/ztest/include/zephyr/syscall_macros.h
diff --git a/subsys/testsuite/ztest/include/syscalls/kernel.h b/subsys/testsuite/ztest/include/zephyr/syscalls/kernel.h
similarity index 100%
rename from subsys/testsuite/ztest/include/syscalls/kernel.h
rename to subsys/testsuite/ztest/include/zephyr/syscalls/kernel.h
diff --git a/subsys/testsuite/ztest/include/syscalls/kobject.h b/subsys/testsuite/ztest/include/zephyr/syscalls/kobject.h
similarity index 100%
rename from subsys/testsuite/ztest/include/syscalls/kobject.h
rename to subsys/testsuite/ztest/include/zephyr/syscalls/kobject.h
diff --git a/subsys/testsuite/ztest/include/syscalls/log_core.h b/subsys/testsuite/ztest/include/zephyr/syscalls/log_core.h
similarity index 100%
rename from subsys/testsuite/ztest/include/syscalls/log_core.h
rename to subsys/testsuite/ztest/include/zephyr/syscalls/log_core.h
diff --git a/subsys/testsuite/ztest/include/syscalls/log_ctrl.h b/subsys/testsuite/ztest/include/zephyr/syscalls/log_ctrl.h
similarity index 100%
rename from subsys/testsuite/ztest/include/syscalls/log_ctrl.h
rename to subsys/testsuite/ztest/include/zephyr/syscalls/log_ctrl.h
diff --git a/subsys/testsuite/ztest/include/syscalls/log_msg.h b/subsys/testsuite/ztest/include/zephyr/syscalls/log_msg.h
similarity index 100%
rename from subsys/testsuite/ztest/include/syscalls/log_msg.h
rename to subsys/testsuite/ztest/include/zephyr/syscalls/log_msg.h
diff --git a/subsys/testsuite/ztest/include/syscalls/sys_clock.h b/subsys/testsuite/ztest/include/zephyr/syscalls/sys_clock.h
similarity index 100%
rename from subsys/testsuite/ztest/include/syscalls/sys_clock.h
rename to subsys/testsuite/ztest/include/zephyr/syscalls/sys_clock.h
diff --git a/subsys/testsuite/ztest/include/ztest.h b/subsys/testsuite/ztest/include/zephyr/ztest.h
similarity index 100%
rename from subsys/testsuite/ztest/include/ztest.h
rename to subsys/testsuite/ztest/include/zephyr/ztest.h
diff --git a/subsys/testsuite/ztest/include/ztest_assert.h b/subsys/testsuite/ztest/include/zephyr/ztest_assert.h
similarity index 100%
rename from subsys/testsuite/ztest/include/ztest_assert.h
rename to subsys/testsuite/ztest/include/zephyr/ztest_assert.h
diff --git a/subsys/testsuite/ztest/include/ztest_error_hook.h b/subsys/testsuite/ztest/include/zephyr/ztest_error_hook.h
similarity index 100%
rename from subsys/testsuite/ztest/include/ztest_error_hook.h
rename to subsys/testsuite/ztest/include/zephyr/ztest_error_hook.h
diff --git a/subsys/testsuite/ztest/include/ztest_mock.h b/subsys/testsuite/ztest/include/zephyr/ztest_mock.h
similarity index 100%
rename from subsys/testsuite/ztest/include/ztest_mock.h
rename to subsys/testsuite/ztest/include/zephyr/ztest_mock.h
diff --git a/subsys/testsuite/ztest/include/ztest_test.h b/subsys/testsuite/ztest/include/zephyr/ztest_test.h
similarity index 100%
rename from subsys/testsuite/ztest/include/ztest_test.h
rename to subsys/testsuite/ztest/include/zephyr/ztest_test.h
diff --git a/subsys/testsuite/ztest/include/ztest_test_deprecated.h b/subsys/testsuite/ztest/include/zephyr/ztest_test_deprecated.h
similarity index 100%
rename from subsys/testsuite/ztest/include/ztest_test_deprecated.h
rename to subsys/testsuite/ztest/include/zephyr/ztest_test_deprecated.h
diff --git a/subsys/testsuite/ztest/include/ztest_test_new.h b/subsys/testsuite/ztest/include/zephyr/ztest_test_new.h
similarity index 100%
rename from subsys/testsuite/ztest/include/ztest_test_new.h
rename to subsys/testsuite/ztest/include/zephyr/ztest_test_new.h
diff --git a/subsys/testsuite/ztest/include/ztress.h b/subsys/testsuite/ztest/include/zephyr/ztress.h
similarity index 100%
rename from subsys/testsuite/ztest/include/ztress.h
rename to subsys/testsuite/ztest/include/zephyr/ztress.h
diff --git a/subsys/testsuite/ztest/src/ztest.c b/subsys/testsuite/ztest/src/ztest.c
index 7910e3ecd60..66646d9d3e2 100644
--- a/subsys/testsuite/ztest/src/ztest.c
+++ b/subsys/testsuite/ztest/src/ztest.c
@@ -4,8 +4,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <ztest.h>
 #include <stdio.h>
+
+
+#include <zephyr/ztest.h>
 #include <zephyr/app_memory/app_memdomain.h>
 #ifdef CONFIG_USERSPACE
 #include <zephyr/sys/libc-hooks.h>
diff --git a/subsys/testsuite/ztest/src/ztest_mock.c b/subsys/testsuite/ztest/src/ztest_mock.c
index 692540284e1..6f2fbdd91db 100644
--- a/subsys/testsuite/ztest/src/ztest_mock.c
+++ b/subsys/testsuite/ztest/src/ztest_mock.c
@@ -4,8 +4,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <ztest.h>
 #include <zephyr/types.h>
+#include <zephyr/ztest.h>
 #include <string.h>
 #include <stdio.h>
 
diff --git a/tests/unit/base64/main.c b/tests/unit/base64/main.c
index f4afd7192a3..0b39e68ade4 100644
--- a/tests/unit/base64/main.c
+++ b/tests/unit/base64/main.c
@@ -23,10 +23,9 @@
  */
 
 #include <string.h>
-#include <zephyr/types.h>
 #include <stdbool.h>
-#include <ztest.h>
 #include <zephyr/sys/base64.h>
+#include <zephyr/ztest.h>
 
 #include "../../../lib/os/base64.c"
 
diff --git a/tests/ztest/automain/src/test_feature.c b/tests/ztest/automain/src/test_feature.c
index 83dcdbc0fa4..9e091cf5cdd 100644
--- a/tests/ztest/automain/src/test_feature.c
+++ b/tests/ztest/automain/src/test_feature.c
@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <ztest.h>
+#include <zephyr/ztest.h>
 
 /**
  * @brief A stub unit test.
diff --git a/tests/ztest/base/src/main.c b/tests/ztest/base/src/main.c
index 4e5b70004e5..bd9ee8c0e92 100644
--- a/tests/ztest/base/src/main.c
+++ b/tests/ztest/base/src/main.c
@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <ztest.h>
+#include <zephyr/ztest.h>
 
 ZTEST_SUITE(framework_tests, NULL, NULL, NULL, NULL, NULL);
 
diff --git a/tests/ztest/base/src/main_deprecated.c b/tests/ztest/base/src/main_deprecated.c
index 6ae589f5880..e433c00a18a 100644
--- a/tests/ztest/base/src/main_deprecated.c
+++ b/tests/ztest/base/src/main_deprecated.c
@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <ztest.h>
+#include <zephyr/ztest.h>
 
 static void test_empty_test(void)
 {
diff --git a/tests/ztest/busy_sim/src/main.c b/tests/ztest/busy_sim/src/main.c
index 441a24498c8..192b73239da 100644
--- a/tests/ztest/busy_sim/src/main.c
+++ b/tests/ztest/busy_sim/src/main.c
@@ -4,8 +4,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <ztest.h>
-#include <busy_sim.h>
+#include <zephyr/ztest.h>
+#include <zephyr/busy_sim.h>
 
 static void test_busy_sim(void)
 {
diff --git a/tests/ztest/custom_output/src/main.c b/tests/ztest/custom_output/src/main.c
index 64db8017a22..d7092f63d3d 100644
--- a/tests/ztest/custom_output/src/main.c
+++ b/tests/ztest/custom_output/src/main.c
@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <ztest.h>
+#include <zephyr/ztest.h>
 
 static void test_assert_pass(void)
 {
diff --git a/tests/ztest/mock/src/main.c b/tests/ztest/mock/src/main.c
index 1192dd9ce67..d59aada0635 100644
--- a/tests/ztest/mock/src/main.c
+++ b/tests/ztest/mock/src/main.c
@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <ztest.h>
+#include <zephyr/ztest.h>
 
 static void expect_one_parameter(int a)
 {
diff --git a/tests/ztest/mock_fff/src/main.c b/tests/ztest/mock_fff/src/main.c
index 58303ab30a2..908018a0ca6 100644
--- a/tests/ztest/mock_fff/src/main.c
+++ b/tests/ztest/mock_fff/src/main.c
@@ -3,8 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include <ztest.h>
-#include <fff.h>
+#include <zephyr/ztest.h>
+#include <zephyr/fff.h>
 
 #include <c_test_framework.h>