1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/* SPDX-License-Identifier: GPL-2.0-only */
/*
* Copyright (c) 2023 Meta Platforms, Inc. and affiliates.
*/
/**
* @file test.h
*
* Main file to include to perform tests. This header defines convenience macros
* to create tests and test results.
*/
#pragma once
// clang-format off
#include <stdarg.h> // NOLINT: required by cmocka.h
#include <stddef.h> // NOLINT: required by cmocka.h
#include <setjmp.h> // NOLINT: required by cmocka.h
#include <cmocka.h>
// clang-format on
#include <stdbool.h>
#include <stdint.h>
#include "core/dump.h"
#include "core/helper.h"
#include "core/list.h"
struct CMUnitTest;
/**
* Macro to use when checking if `NULL` parameters are properly asserted on:
*
* @code{.c}
* // Ensure path can't be NULL
* expect_assert_failure(bf_read_file(NULL, NOT_NULL, 0));
* // Ensure buf can't be NULL
* expect_assert_failure(bf_read_file(NOT_NULL, NULL, 0));
* @endcode
*/
#define NOT_NULL ((void *)0xdeadbeef)
/**
* Create a new test.
*
* Tests are defined in their section so they can be easily discovered at
* runtime time.
*
* @param group Test group, can be filtered on to run all the tests in a single
* group.
* @param name Name of the test.
*/
#define Test(group, name) \
void group##__##name(bf_unused void **state); \
bf_test __attribute__((section("bf_test"), \
used)) __##group##__##name##_test = { \
.group_name = BF_STR(group), \
.test_name = BF_STR(name), \
.cb = &group##__##name}; \
void __attribute__((used)) group##__##name(bf_unused void **state)
/**
* Fail a test with an error message.
*
* @param fmt Message format, similar to `printf()` format.
* @param ... Format arguments.
*/
#define bf_test_fail(fmt, ...) fail_msg(fmt, ##__VA_ARGS__)
/**
* Assert that @p x evaluates to a success.
*
* @param x Expression to evaluate. If the expression evaluates to `0`, it is
* considered succeeded, and the assertion succeeds.
*/
#define assert_success(x) assert_int_equal(0, (x))
/**
* Assert that @p x evaluates to an error.
*
* @param x Expression to evaluate. If the expression evaluates to `< 0`, it is
* considered failed, and the assertion succeeds.
*/
#define assert_error(x) assert_int_not_equal(0, (x))
#define _free_bf_test_group_ __attribute__((cleanup(bf_test_group_free)))
#define _free_bf_test_suite_ __attribute__((cleanup(bf_test_suite_free)))
#define _free_bf_test_filter_ __attribute__((cleanup(bf_test_filter_free)))
typedef void (*bf_test_cb)(void **state);
/**
* Test
*/
typedef struct
{
const char *group_name;
const char *test_name;
void *cb;
void *_res;
} bf_test;
void bf_test_dump(const bf_test *test, prefix_t *prefix);
/**
* Test group.
*
* A test group contains one or more tests.
*/
typedef struct
{
/// Name of the test group.
const char *name;
/// List of tests in the group.
bf_list tests;
/// CMocka test object, for CMocka's primitives to run the tests.
struct CMUnitTest *cmtests;
} bf_test_group;
int bf_test_group_new(bf_test_group **group, const char *name);
void bf_test_group_free(bf_test_group **group);
void bf_test_group_dump(const bf_test_group *group, prefix_t *prefix);
bf_test *bf_test_group_get_test(bf_test_group *group, const char *test_name);
int bf_test_group_make_cmtests(bf_test_group *group);
/**
* Test suite.
*
* A test suite contains one or more test groups.
*/
typedef struct
{
/// List of test groups.
bf_list groups;
} bf_test_suite;
int bf_test_suite_new(bf_test_suite **suite);
void bf_test_suite_free(bf_test_suite **suite);
void bf_test_suite_dump(const bf_test_suite *suite, prefix_t *prefix);
void bf_test_suite_print(const bf_test_suite *suite);
int bf_test_suite_add_test(bf_test_suite *suite, const char *group_name,
bf_test *test);
bf_test_group *bf_test_suite_get_group(bf_test_suite *suite,
const char *group_name);
int bf_test_suite_make_cmtests(const bf_test_suite *suite);
/**
* Discover the test suite in the current ELF file.
*
* Read all the tests stores in `tests` and add them to the suite.
*
* @param suite Discovered test suite. Can't be `NULL`. On success, this
* argument will be point to a valid test suite.
* @param tests Tests to process. Usually from the `bf_test` section of the
* ELF file. Can't be NULL.
* @param sentinel First address after the last test. Used to detect when the
* tests section ends. Can't be NULL.
* @return 0 on success, or a negative errno value on error.
*/
int bf_test_discover_test_suite(bf_test_suite **suite, bf_test *tests,
void *sentinel);
/**
* A filter to apply to the tests to run.
*/
typedef struct
{
bf_list patterns;
} bf_test_filter;
int bf_test_filter_new(bf_test_filter **filter);
void bf_test_filter_free(bf_test_filter **filter);
int bf_test_filter_add_pattern(bf_test_filter *filter, const char *pattern);
bool bf_test_filter_matches(bf_test_filter *filter, const char *str);
|
