tests: Improve test output readability

When running multiple tests, e.g. by using unit-tests target, it is hard
to differentiate, which output comes from which file and/or
configuration. This patch makes the output easier to analyze and
understand by using new wrapper macro cb_run_group_tests(). This macro
uses __TEST_NAME__ value (containing test path and Makefile test name)
as a group name when calling cmocka group runner.

Example:
 Test path: tests/lib/
 Makefile test name: cbmem_stage_cache-test
 Test group array name: tests
 Result: tests/lib/cbmem_stage_cache-test(tests)

Signed-off-by: Jakub Czapiga <jacz@semihalf.com>
Change-Id: I4fd936d00d77cbe2637b857ba03b4a208428ea0d
Reviewed-on: https://review.coreboot.org/c/coreboot/+/57144
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Paul Fagerburg <pfagerburg@chromium.org>
Reviewed-by: Julius Werner <jwerner@chromium.org>

Documentation/tutorial/part3.md

@@ -381,6 +381,6 @@ invoking Cmocka test are described
                      cmocka_unit_test(i2c_read_field_test),
              };
 
-             return cmocka_run_group_tests(tests, NULL, NULL);
+             return cb_run_group_tests(tests, NULL, NULL);
      }
 ```

tests/Makefile.inc

@@ -136,7 +136,8 @@ $$($(1)-config-file): $(TEST_KCONFIG_AUTOHEADER)
 	printf '#endif\n' >> $$@;
 
 $($(1)-objs): TEST_CFLAGS += -I$$(dir $$($(1)-config-file)) \
-	-D__$$(shell echo $$($(1)-stage) | tr '[:lower:]' '[:upper:]')__
+	-D__$$(shell echo $$($(1)-stage) | tr '[:lower:]' '[:upper:]')__ \
+	-D__TEST_NAME__=\"$(1)\"
 
 # Give us a way to distinguish between coreboot source files and test files in code.
 $($(1)-srcobjs): TEST_CFLAGS += -D__TEST_SRCOBJ__

tests/acpi/acpigen-test.c

@@ -213,5 +213,5 @@ int main(void)
 						setup_acpigen, teardown_acpigen),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/commonlib/bsd/helpers-test.c

@@ -51,5 +51,5 @@ int main(void)
 		cmocka_unit_test(test_retry),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/commonlib/region-test.c

@@ -404,5 +404,5 @@ int main(void)
 		cmocka_unit_test(test_mem_rdev),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/console/routing-test.c

@@ -66,5 +66,5 @@ int main(void)
 						teardown_console_log_level),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/device/ddr4-test.c

@@ -37,5 +37,5 @@ int main(void)
 		cmocka_unit_test(ddr4_speed_mhz_to_mts_test)
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/device/i2c-test.c

@@ -164,5 +164,5 @@ int main(void)
 		cmocka_unit_test(i2c_write_field_test)
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/include/tests/test.h

@@ -36,4 +36,11 @@
 	TEST_SYMBOL(_e##region, _##region + size); \
 	TEST_SYMBOL(_##region##_size, size)
 
+/* Wrapper for running cmocka test groups using name provided by build system in __TEST_NAME__
+   This should be used instead of cmocka_run_group_tests(). If there is a need to use custom
+   group name, then please use cmocka_run_group_tests_name(). */
+#define cb_run_group_tests(group_tests, group_setup, group_teardown)                           \
+	cmocka_run_group_tests_name((__TEST_NAME__ "(" #group_tests ")"), group_tests,         \
+				    group_setup, group_teardown)
+
 #endif /* _TESTS_TEST_H */

tests/lib/b64_decode-test.c

@@ -57,5 +57,5 @@ int main(void)
 		cmocka_unit_test(test_b64_decode),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/bootmem-test.c

@@ -411,5 +411,5 @@ int main(void)
 		cmocka_unit_test(test_bootmem_region_targets_type)
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/cbmem_console-test.c

@@ -118,12 +118,6 @@ void test_cbmemc_tx_byte_overflow(void **state)
 
 int main(void)
 {
-#if ENV_ROMSTAGE_OR_BEFORE
-	const char *test_name = "cbmem_console-test-romstage";
-#else
-	const char *test_name = "cbmem_console-test-ramstage";
-#endif
-
 	const struct CMUnitTest tests[] = {
 		cmocka_unit_test_teardown(test_cbmemc_init, teardown_cbmemc),
 		cmocka_unit_test_setup_teardown(test_cbmemc_tx_byte,
@@ -132,5 +126,5 @@ int main(void)
 						setup_cbmemc, teardown_cbmemc),
 	};
 
-	return cmocka_run_group_tests_name(test_name, tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/cbmem_stage_cache-test.c

@@ -190,5 +190,5 @@ int main(void)
 						setup_test, teardown_test),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/compute_ip_checksum-test.c

@@ -98,5 +98,5 @@ int main(void)
 		cmocka_unit_test(test_add_ip_checksums),
 	};
 
-	return cmocka_run_group_tests(tests, setup_test_group, NULL);
+	return cb_run_group_tests(tests, setup_test_group, NULL);
 }

tests/lib/coreboot_table-test.c

@@ -493,5 +493,5 @@ int main(void)
 						teardown_write_tables_test),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/crc_byte-test.c

@@ -296,5 +296,5 @@ int main(void)
 		cmocka_unit_test(test_crc32_byte_static_data),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/dimm_info_util-test.c

@@ -108,5 +108,5 @@ int main(void)
 		cmocka_unit_test(test_smbios_form_factor_to_spd_mod_type),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/edid-test.c

@@ -1267,6 +1267,6 @@ int main(void)
 						teardown_edid_test),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }
 

tests/lib/fmap-test.c

@@ -302,5 +302,5 @@ int main(void)
 						setup_fmap, teardown_fmap),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/hexstrtobin-test.c

@@ -44,5 +44,5 @@ int main(void)
 		cmocka_unit_test(test_hexstrtobin),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/imd-test.c

@@ -759,6 +759,6 @@ int main(void)
 		cmocka_unit_test(test_imd_cursor_next),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }
 

tests/lib/imd_cbmem-test.c

@@ -626,5 +626,5 @@ int main(void)
 				setup_teardown_test_imd_cbmem),
 	};
 
-	return cmocka_run_group_tests(tests, setup_group_imd_cbmem, teardown_group_imd_cbmem);
+	return cb_run_group_tests(tests, setup_group_imd_cbmem, teardown_group_imd_cbmem);
 }

tests/lib/libgcc-test.c

@@ -128,5 +128,5 @@ int main(void)
 		cmocka_unit_test(test_clzsi2_with_data),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/list-test.c

@@ -125,5 +125,5 @@ int main(void)
 	};
 
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/malloc-test.c

@@ -164,5 +164,5 @@ int main(void)
 		cmocka_unit_test_setup(test_calloc_memory_is_zeroed, setup_calloc_test),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/memchr-test.c

@@ -101,5 +101,5 @@ int main(void)
 		cmocka_unit_test(test_memchr_zero_size),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/memcmp-test.c

@@ -69,5 +69,5 @@ int main(void)
 		cmocka_unit_test(test_memcmp_zero_size),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/memcpy-test.c

@@ -192,5 +192,5 @@ int main(void)
 						setup_test, teardown_test),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/memmove-test.c

@@ -245,6 +245,6 @@ int main(void)
 						setup_test, teardown_test),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }
 

tests/lib/memrange-test.c

@@ -629,10 +629,10 @@ int main(void)
 		cmocka_unit_test(test_memrange_add_resources_filter),
 	};
 
-	return cmocka_run_group_tests_name("Boundary on 4GiB",
+	return cmocka_run_group_tests_name(__TEST_NAME__"(Boundary on 4GiB)",
 						tests, setup_test_1, NULL) +
-		cmocka_run_group_tests_name("Boundaries 1 byte from 4GiB",
+		cmocka_run_group_tests_name(__TEST_NAME__"(Boundaries 1 byte from 4GiB)",
 						tests, setup_test_2, NULL) +
-		cmocka_run_group_tests_name("Range over 4GiB boundary",
+		cmocka_run_group_tests_name(__TEST_NAME__"(Range over 4GiB boundary)",
 						tests, setup_test_3, NULL);
 }

tests/lib/memset-test.c

@@ -116,5 +116,5 @@ int main(void)
 				setup_test, teardown_test),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/region_file-test.c

@@ -325,7 +325,6 @@ int main(void)
 				setup_teardown_region_file_test),
 	};
 
-	return cmocka_run_group_tests(tests,
-					setup_region_file_test_group,
+	return cb_run_group_tests(tests, setup_region_file_test_group,
 				  teardown_region_file_test_group);
 }

tests/lib/rtc-test.c

@@ -308,5 +308,5 @@ int main(void)
 		cmocka_unit_test(test_leap_day_secday),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/spd_cache-test.c

@@ -253,5 +253,5 @@ int main(void)
 #endif
 	};
 
-	return cmocka_run_group_tests(tests, setup_spd_cache, teardown_spd_cache);
+	return cb_run_group_tests(tests, setup_spd_cache, teardown_spd_cache);
 }

tests/lib/stack-test.c

@@ -129,5 +129,5 @@ int main(void)
 		cmocka_unit_test_setup(test_incorrectly_initialized_stack, setup_stack_test),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/string-test.c

@@ -267,5 +267,5 @@ int main(void)
 		cmocka_unit_test(test_atol),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }

tests/lib/timestamp-test.c

@@ -131,7 +131,7 @@ int main(void)
 	};
 
 #if CONFIG(COLLECT_TIMESTAMPS)
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 #else
 	return 0;
 #endif

tests/lib/uuid-test.c

@@ -91,5 +91,5 @@ int main(void)
 		cmocka_unit_test(test_guid),
 	};
 
-	return cmocka_run_group_tests(tests, NULL, NULL);
+	return cb_run_group_tests(tests, NULL, NULL);
 }