coreboot-kgpe-d16/tests/include/tests/test.h
Jakub Czapiga 7c6081e02b 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>
2021-09-01 19:38:09 +00:00

46 lines
1.6 KiB
C

/* SPDX-License-Identifier: GPL-2.0-only */
#ifndef _TESTS_TEST_H
#define _TESTS_TEST_H
/*
* Standard test header that should be included in all tests. For now it just encapsulates the
* include dependencies for Cmocka. Test-specific APIs that are so generic we would want them
* available everywhere could also be added here.
*/
#include <stdarg.h>
#include <stddef.h>
#include <setjmp.h>
#include <cmocka.h>
/*
* Set symbol value and make it global.
*/
#define TEST_SYMBOL(symbol, value) asm(".set " #symbol ", " #value "\n\t.globl " #symbol)
/*
* Define memory region for testing purpose.
*
* Create buffer with specified name and size.
* Create end symbol for it.
*/
#define TEST_REGION(region, size) uint8_t _##region[size]; \
TEST_SYMBOL(_e##region, _##region + size); \
TEST_SYMBOL(_##region##_size, size)
/*
* Set start, end and size symbols describing region without allocating memory for it.
*/
#define TEST_REGION_UNALLOCATED(region, start, size) TEST_SYMBOL(_##region, start); \
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 */