ut.c 4.14 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0+
Simon Glass's avatar
Simon Glass committed
2
/*
3
 * Simple unit test library
Simon Glass's avatar
Simon Glass committed
4
5
6
7
8
 *
 * Copyright (c) 2013 Google, Inc
 */

#include <common.h>
9
#include <console.h>
10
#include <malloc.h>
11
12
13
#ifdef CONFIG_SANDBOX
#include <asm/state.h>
#endif
14
#include <asm/global_data.h>
15
16
#include <test/test.h>
#include <test/ut.h>
Simon Glass's avatar
Simon Glass committed
17

18
19
DECLARE_GLOBAL_DATA_PTR;

20
void ut_fail(struct unit_test_state *uts, const char *fname, int line,
Simon Glass's avatar
Simon Glass committed
21
22
	     const char *func, const char *cond)
{
23
	gd->flags &= ~(GD_FLG_SILENT | GD_FLG_RECORD);
Simon Glass's avatar
Simon Glass committed
24
	printf("%s:%d, %s(): %s\n", fname, line, func, cond);
25
	uts->fail_count++;
Simon Glass's avatar
Simon Glass committed
26
27
}

28
void ut_failf(struct unit_test_state *uts, const char *fname, int line,
Simon Glass's avatar
Simon Glass committed
29
30
31
32
	      const char *func, const char *cond, const char *fmt, ...)
{
	va_list args;

33
	gd->flags &= ~(GD_FLG_SILENT | GD_FLG_RECORD);
Simon Glass's avatar
Simon Glass committed
34
35
36
37
38
	printf("%s:%d, %s(): %s: ", fname, line, func, cond);
	va_start(args, fmt);
	vprintf(fmt, args);
	va_end(args);
	putc('\n');
39
	uts->fail_count++;
Simon Glass's avatar
Simon Glass committed
40
}
41
42
43
44
45
46
47
48
49
50
51
52
53

ulong ut_check_free(void)
{
	struct mallinfo info = mallinfo();

	return info.uordblks;
}

long ut_check_delta(ulong last)
{
	return ut_check_free() - last;
}

54
55
56
57
58
59
60
61
62
63
64
65
66
67
static int readline_check(struct unit_test_state *uts)
{
	int ret;

	ret = console_record_readline(uts->actual_str, sizeof(uts->actual_str));
	if (ret == -ENOSPC) {
		ut_fail(uts, __FILE__, __LINE__, __func__,
			"Console record buffer too small - increase CONFIG_CONSOLE_RECORD_OUT_SIZE");
		return ret;
	}

	return 0;
}

68
69
70
int ut_check_console_line(struct unit_test_state *uts, const char *fmt, ...)
{
	va_list args;
71
	int len;
72
	int ret;
73
74

	va_start(args, fmt);
75
	len = vsnprintf(uts->expect_str, sizeof(uts->expect_str), fmt, args);
76
	va_end(args);
77
78
79
80
81
	if (len >= sizeof(uts->expect_str)) {
		ut_fail(uts, __FILE__, __LINE__, __func__,
			"unit_test_state->expect_str too small");
		return -EOVERFLOW;
	}
82
83
84
	ret = readline_check(uts);
	if (ret < 0)
		return ret;
85
86
87
88

	return strcmp(uts->expect_str, uts->actual_str);
}

89
90
91
int ut_check_console_linen(struct unit_test_state *uts, const char *fmt, ...)
{
	va_list args;
92
	int len;
93
	int ret;
94
95

	va_start(args, fmt);
96
	len = vsnprintf(uts->expect_str, sizeof(uts->expect_str), fmt, args);
97
	va_end(args);
98
99
100
101
102
	if (len >= sizeof(uts->expect_str)) {
		ut_fail(uts, __FILE__, __LINE__, __func__,
			"unit_test_state->expect_str too small");
		return -EOVERFLOW;
	}
103
104
105
	ret = readline_check(uts);
	if (ret < 0)
		return ret;
106
107
108
109
110
111
112

	return strncmp(uts->expect_str, uts->actual_str,
		       strlen(uts->expect_str));
}

int ut_check_skipline(struct unit_test_state *uts)
{
113
114
	int ret;

115
116
	if (!console_record_avail())
		return -ENFILE;
117
118
119
	ret = readline_check(uts);
	if (ret < 0)
		return ret;
120
121
122
123

	return 0;
}

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
int ut_check_skip_to_line(struct unit_test_state *uts, const char *fmt, ...)
{
	va_list args;
	int len;
	int ret;

	va_start(args, fmt);
	len = vsnprintf(uts->expect_str, sizeof(uts->expect_str), fmt, args);
	va_end(args);
	if (len >= sizeof(uts->expect_str)) {
		ut_fail(uts, __FILE__, __LINE__, __func__,
			"unit_test_state->expect_str too small");
		return -EOVERFLOW;
	}
	while (1) {
		if (!console_record_avail())
			return -ENOENT;
		ret = readline_check(uts);
		if (ret < 0)
			return ret;

		if (!strcmp(uts->expect_str, uts->actual_str))
			return 0;
	}
}

150
151
int ut_check_console_end(struct unit_test_state *uts)
{
152
153
	int ret;

154
155
	if (!console_record_avail())
		return 0;
156
157
158
	ret = readline_check(uts);
	if (ret < 0)
		return ret;
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179

	return 1;
}

int ut_check_console_dump(struct unit_test_state *uts, int total_bytes)
{
	char *str = uts->actual_str;
	int upto;

	/* Handle empty dump */
	if (!total_bytes)
		return 0;

	for (upto = 0; upto < total_bytes;) {
		int len;
		int bytes;

		len = console_record_readline(str, sizeof(uts->actual_str));
		if (str[8] != ':' || str[9] != ' ')
			return 1;

180
		bytes = len - 8 - 2 - 3 * 16 - 2;
181
182
183
184
185
		upto += bytes;
	}

	return upto == total_bytes ? 0 : 1;
}
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200

void ut_silence_console(struct unit_test_state *uts)
{
#ifdef CONFIG_SANDBOX
	struct sandbox_state *state = state_get_current();

	if (!state->show_test_output)
		gd->flags |= GD_FLG_SILENT;
#endif
}

void ut_unsilence_console(struct unit_test_state *uts)
{
	gd->flags &= ~(GD_FLG_SILENT | GD_FLG_RECORD);
}
201
202
203
204
205
206
207

void ut_set_skip_delays(struct unit_test_state *uts, bool skip_delays)
{
#ifdef CONFIG_SANDBOX
	state_set_skip_delays(skip_delays);
#endif
}