ktx/ktx.h at master · Revimal/ktx · GitHub

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
/**
 * @file ktx.h
 * @brief Kernel Test eXpressions
 *
 * A simple, header-only, testing framework for kernel projects.
 * Inspired by 'Catch2'.
 *
 * @author Hyeonho Seo (Revimal)
 * @bug No Known Bugs
 */

#ifndef _KTX_H
#define _KTX_H

#include <linux/printk.h>

/**
 * @def KTX_VERSION
 * 	KTX's version string
 */
#define KTX_VERSION "1.0.1"

/**
 * @def KTX_EQUAL
 * 	Same as 0
 */
#define KTX_EQUAL 0

/**
 * @def KTX_EQUAL
 * 	Same as 1
 */
#define KTX_NOTEQ 1

/**
 * @def KTX_LOGGER(...)
 * 	Same as printk(KERN_INFO ...)
 */
#define KTX_LOGGER(...) \
	printk(KERN_INFO __VA_ARGS__)

struct ktx_internal_testcase
{
	const char *name;
	unsigned long test_cnt;
	unsigned long eval_cnt;
	unsigned long fail_cnt;
	int skip_next;
};
typedef struct ktx_internal_testcase ktx_tc_t;

static inline int ktx_internal_assert(ktx_tc_t *tc, const char *expr, unsigned long value1, unsigned long value2)
{
	const int eval = !!(value1 == value2);
	int ret = KTX_EQUAL;
	tc->test_cnt++;
	if (!(tc->skip_next))
	{
		KTX_LOGGER("%s: %s\n", tc->name, !!eval ? "PASS" : "FAILED");
		KTX_LOGGER("\tEvaluation: %lu == %lu\n", value1, value2);
		KTX_LOGGER("\tExpression: %s\n", expr);
		if (!eval)
		{
			tc->fail_cnt++;
			ret = KTX_NOTEQ;
		}
		tc->eval_cnt++;
	}
	return ret;
}

static inline void ktx_internal_report(ktx_tc_t *tc)
{
	KTX_LOGGER("[*] TESTCASE Report\n");
	KTX_LOGGER(" | TC Name   : %s\n", tc->name);
	KTX_LOGGER(" | Testnum   : %lu\n", tc->test_cnt);
	KTX_LOGGER(" | Result    : %s\n", !!(tc->fail_cnt) ? "FAILED" : "PASS");
	KTX_LOGGER(" | Tested    : %lu\n", tc->eval_cnt);
	KTX_LOGGER(" | Passed    : %lu\n", tc->eval_cnt - tc->fail_cnt);
	KTX_LOGGER(" | Failed    : %lu\n", tc->fail_cnt);
	KTX_LOGGER("[*]\n");
}

#define KTX_INTERNAL_STRINGIFY( expr )                 #expr
#define KTX_INTERNAL_TESTEQ_EXPR( expr1, expr2 )       expr1 == expr2
#define KTX_INTERNAL_STRC(tc) \
	ktx_tc_t ktx_strc_ ## tc
#define KTX_INTERNAL_INIT(tc) \
	KTX_INTERNAL_STRC(tc) = { \
		.name = KTX_INTERNAL_STRINGIFY(tc), \
		.test_cnt = 0, \
		.eval_cnt = 0, \
		.fail_cnt = 0, \
		.skip_next = 0 \
	}
#define KTX_INTERNAL_ACCESS(tc) \
	(&( ktx_strc_ ## tc ))
#define KTX_INTERNAL_FUNC(tc) \
	void ktx_func_ ## tc (void)
#define KTX_INTERNAL_ASSERT(tc, expr, value1, value2) \
	ktx_internal_assert((tc), KTX_INTERNAL_STRINGIFY(expr), (value1), (value2))

/**
 * @def KTX_DECLARE(tc)
 * 	Macro function to declare test-cases.
 * 	Place in header files.
 */
#define KTX_DECLARE(tc) \
	extern KTX_INTERNAL_STRC(tc); \
	extern KTX_INTERNAL_FUNC(tc)

/**
 * @def KTX_DEFINE(tc)
 * 	Macro function to define test-cases.
 * 	Place in a source file.
 */
#define KTX_DEFINE(tc) \
	KTX_INTERNAL_INIT(tc); \
	KTX_INTERNAL_FUNC(tc)

/**
 * @def KTX_CHECK(tc)
 * 	Macro function to write check-expressions.
 * 	If two expressions are the same, will return KTX_EQUAL.
 * 	If not, will return KTX_NOTEQ.
 */
#define KTX_CHECK(tc, expr1, expr2) \
	KTX_INTERNAL_ASSERT(KTX_INTERNAL_ACCESS(tc), \
		KTX_INTERNAL_TESTEQ_EXPR(expr1, expr2), \
		(unsigned long)(expr1), (unsigned long)(expr2))

/**
 * @def KTX_REQUIRE(tc)
 * 	Macro function to write check-expressions.
 * 	If two expressions are not the same, the test-case will return immediately.
 */
#define KTX_REQUIRE(tc, expr1, expr2) \
	if (KTX_CHECK(tc, expr1, expr2) == KTX_NOTEQ) \
	{ \
		KTX_INTERNAL_ACCESS(tc)->skip_next = 1; \
	}

/**
 * @def KTX_RUN(tc)
 * 	Macro function to run test-cases.
 */
#define KTX_RUN(tc) \
	ktx_func_ ## tc ()

/**
 * @def KTX_RUN_RESULT(tc)
 * 	Macro function to get results.
 * 	Will return fail counts.
 */
#define KTX_RESULT(tc) \
	(KTX_INTERNAL_ACCESS(tc)->fail_cnt)

/**
 * @def KTX_REPORT(tc)
 * 	Macro function to print statistics.
 */
#define KTX_REPORT(tc) \
	ktx_internal_report(KTX_INTERNAL_ACCESS(tc))

#endif