ztest: Update ztest with more powerful testing APIs

1. Test suites in prior ztest serve no purpose other than logical
ordering of tests into a named-group. Move the construct of setup and
teardown into the test suite and away from individual tests.
Additionally, add the constructs of before/after to the test suites.
This model more closely resembels other testing frameworks such as gTest
and Junit.
2. Test can be added to a suite by using ZTEST() or ZTEST_F() where _F
stands for fixture. In the case where _F is used, the argument `this`
will be provided with the type `struct suite_name##_fixture*`. Again,
this models other modern testing frameworks and allows the test to
directly access the already set up data related to the test suite.
3. Add the concept of test rules (from Junit). Rules are similar to the
before/after functions of the test suites but are global and run on all
suites. An example of a test rule can be to check that nothing was
logged to ERROR. The rule can cause the test to fail if anything was
logged to ERROR during an integration test. Another example would be a
rule that verifies that tests ran within some defined timeout.

Signed-off-by: Yuval Peress <[email protected]>

Author: Yuval Peress

include/linker/common-ram.ld

@@ -141,4 +141,8 @@
 
 #if defined(CONFIG_ZTEST)
 	ITERABLE_SECTION_RAM(ztest_suite_node, 4)
+#if defined(CONFIG_ZTEST_NEW_API)
+	ITERABLE_SECTION_RAM(ztest_unit_test, 4)
+	ITERABLE_SECTION_RAM(ztest_test_rule, 4)
+#endif /* CONFIG_ZTEST_NEW_API */
 #endif /* CONFIG_ZTEST */

samples/subsys/testsuite/integration/prj.conf

@@ -1 +1,2 @@
 CONFIG_ZTEST=y
+CONFIG_ZTEST_NEW_API=y

samples/subsys/testsuite/integration/src/main.c

@@ -6,13 +6,16 @@
 
 #include <ztest.h>
 
+
+ZTEST_SUITE(framework_tests, NULL, NULL, NULL, NULL, NULL);
+
 /**
  * @brief Test Asserts
  *
  * This test verifies various assert macros provided by ztest.
  *
  */
-static void test_assert(void)
+ZTEST(framework_tests, test_assert)
 {
 	zassert_true(1, "1 was false");
 	zassert_false(0, "0 was true");
@@ -21,12 +24,3 @@ static void test_assert(void)
 	zassert_equal(1, 1, "1 was not equal to 1");
 	zassert_equal_ptr(NULL, NULL, "NULL was not equal to NULL");
 }
-
-void test_main(void)
-{
-	ztest_test_suite(framework_tests,
-		ztest_unit_test(test_assert)
-	);
-
-	ztest_run_test_suite(framework_tests);
-}

samples/subsys/testsuite/pytest/prj.conf

@@ -1,2 +1,3 @@
 CONFIG_ZTEST=y
+CONFIG_ZTEST_NEW_API=y
 CONFIG_IDLE_STACK_SIZE=4096

samples/subsys/testsuite/pytest/src/main.c

@@ -4,16 +4,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 #include <ztest.h>
-void test_pytest(void)
-{
-	TC_PRINT("Hello world\n");
-}
 
-void test_main(void)
-{
-	ztest_test_suite(test_pytest,
-			 ztest_unit_test(test_pytest)
-			 );
+ZTEST_SUITE(test_pytest, NULL, NULL, NULL, NULL, NULL);
 
-	ztest_run_test_suite(test_pytest);
+ZTEST(test_pytest, test_pytest)
+{
+	TC_PRINT("Hello world\n");
 }

subsys/testsuite/include/ztest.ld

@@ -12,5 +12,17 @@ SECTIONS
 		KEEP(*(SORT_BY_NAME(._ztest_suite_node.static.*)))
 		_ztest_suite_node_list_end = .;
 	}
+	.data.ztest_unit_test_area : ALIGN(4)
+	{
+		_ztest_unit_test_list_start = .;
+		KEEP(*(SORT_BY_NAME(._ztest_unit_test.static.*)))
+		_ztest_unit_test_list_end = .;
+	}
+	.data.ztest_test_rule_area : ALIGN(4)
+	{
+		_ztest_test_rule_list_start = .;
+		KEEP(*(SORT_BY_NAME(._ztest_test_rule.static.*)))
+		_ztest_test_rule_list_end = .;
+	}
 }
 INSERT AFTER .data;

subsys/testsuite/ztest/CMakeLists.txt

@@ -6,7 +6,9 @@ zephyr_include_directories(
   )
 
 zephyr_library()
-zephyr_library_sources(                           src/ztest.c)
-zephyr_library_sources(                           src/ztest_error_hook.c)
-zephyr_library_sources_ifdef(CONFIG_ZTEST_MOCKING src/ztest_mock.c)
-zephyr_library_sources_ifdef(CONFIG_ZTRESS        src/ztress.c)
+zephyr_library_sources_ifndef(CONFIG_ZTEST_NEW_API src/ztest.c)
+zephyr_library_sources_ifdef(CONFIG_ZTEST_NEW_API  src/ztest_new.c)
+zephyr_library_sources(                            src/ztest_error_hook.c)
+zephyr_library_sources_ifdef(CONFIG_ZTEST_NEW_API  src/ztest_rules.c)
+zephyr_library_sources_ifdef(CONFIG_ZTEST_MOCKING  src/ztest_mock.c)
+zephyr_library_sources_ifdef(CONFIG_ZTRESS         src/ztress.c)

subsys/testsuite/ztest/Kconfig

@@ -10,6 +10,12 @@ config ZTEST
 
 if ZTEST
 
+config ZTEST_NEW_API
+	bool "Use the new Ztest API"
+	help
+	  Enables the new Ztest APIs for creating suites and unit tests in
+	  separate compilational units as well as the new 'rules' API.
+
 config ZTEST_STACKSIZE
 	int "Test function thread stack size"
 	default 2048 if COVERAGE_GCOV
@@ -73,6 +79,20 @@ config ZTEST_ASSERT_HOOK
 	  error test case. Remember to add ignore_fault tag in yaml file when
 	  using twister to run testing.
 
+if ZTEST_NEW_API
+
+menu "ztest provided rules"
+
+config ZTEST_RULE_1CPU
+	bool "Run all the tests on a single CPU"
+	help
+	  This rule will call z_test_1cpu_start before each unit test and
+	  ztest_1cpu_stop after each test.
+
+endmenu
+
+endif # ZTEST_NEW_API
+
 endif # ZTEST
 
 config ZTEST_MOCKING