[u-boot.git] / test / ut.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * Simple unit test library
 *
 * Copyright (c) 2013 Google, Inc
 */

#include <common.h>
#include <console.h>
#include <malloc.h>
#ifdef CONFIG_SANDBOX
#include <asm/state.h>
#endif
#include <asm/global_data.h>
#include <test/test.h>
#include <test/ut.h>

DECLARE_GLOBAL_DATA_PTR;

void ut_fail(struct unit_test_state *uts, const char *fname, int line,
	     const char *func, const char *cond)
{
	gd->flags &= ~(GD_FLG_SILENT | GD_FLG_RECORD);
	printf("%s:%d, %s(): %s\n", fname, line, func, cond);
	uts->fail_count++;
}

void ut_failf(struct unit_test_state *uts, const char *fname, int line,
	      const char *func, const char *cond, const char *fmt, ...)
{
	va_list args;

	gd->flags &= ~(GD_FLG_SILENT | GD_FLG_RECORD);
	printf("%s:%d, %s(): %s: ", fname, line, func, cond);
	va_start(args, fmt);
	vprintf(fmt, args);
	va_end(args);
	putc('\n');
	uts->fail_count++;
}

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

	return info.uordblks;
}

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

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;
}

int ut_check_console_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;
	}
	ret = readline_check(uts);
	if (ret < 0)
		return ret;

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

int ut_check_console_linen(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;
	}
	ret = readline_check(uts);
	if (ret < 0)
		return ret;

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

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

	if (!console_record_avail())
		return -ENFILE;
	ret = readline_check(uts);
	if (ret < 0)
		return ret;

	return 0;
}

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;
	}
}

int ut_check_console_end(struct unit_test_state *uts)
{
	int ret;

	if (!console_record_avail())
		return 0;
	ret = readline_check(uts);
	if (ret < 0)
		return ret;

	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;

		bytes = len - 8 - 2 - 3 * 16 - 2;
		upto += bytes;
	}

	return upto == total_bytes ? 0 : 1;
}

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);
}

void ut_set_skip_delays(struct unit_test_state *uts, bool skip_delays)
{
#ifdef CONFIG_SANDBOX
	state_set_skip_delays(skip_delays);
#endif
}
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: GPL-2.0+
2e7d35d2	2	/*
e721b882	3	* Simple unit test library
2e7d35d2 SG	4	*
2e7d35d2 SG	5	* Copyright (c) 2013 Google, Inc
2e7d35d2 SG	6	*/
	7
	8	#include <common.h>
400175b0	9	#include <console.h>
8109863f	10	#include <malloc.h>
ef7e2649 SG	11	#ifdef CONFIG_SANDBOX
	12	#include <asm/state.h>
	13	#endif
401d1c4f	14	#include <asm/global_data.h>
e721b882 JH	15	#include <test/test.h>
e721b882 JH	16	#include <test/ut.h>
2e7d35d2	17
9ce8b402 SG	18	DECLARE_GLOBAL_DATA_PTR;
9ce8b402 SG	19
e721b882	20	void ut_fail(struct unit_test_state uts, const char fname, int line,
2e7d35d2 SG	21	const char func, const char cond)
2e7d35d2 SG	22	{
9ce8b402	23	gd->flags &= ~(GD_FLG_SILENT \| GD_FLG_RECORD);
2e7d35d2	24	printf("%s:%d, %s(): %s\n", fname, line, func, cond);
e721b882	25	uts->fail_count++;
2e7d35d2 SG	26	}
2e7d35d2 SG	27
e721b882	28	void ut_failf(struct unit_test_state uts, const char fname, int line,
2e7d35d2 SG	29	const char func, const char cond, const char *fmt, ...)
	30	{
	31	va_list args;
	32
9ce8b402	33	gd->flags &= ~(GD_FLG_SILENT \| GD_FLG_RECORD);
2e7d35d2 SG	34	printf("%s:%d, %s(): %s: ", fname, line, func, cond);
	35	va_start(args, fmt);
	36	vprintf(fmt, args);
	37	va_end(args);
	38	putc('\n');
e721b882	39	uts->fail_count++;
2e7d35d2	40	}
8109863f SG	41
	42	ulong ut_check_free(void)
	43	{
	44	struct mallinfo info = mallinfo();
	45
	46	return info.uordblks;
	47	}
	48
	49	long ut_check_delta(ulong last)
	50	{
	51	return ut_check_free() - last;
	52	}
	53
c1a2bb4f SG	54	static int readline_check(struct unit_test_state *uts)
	55	{
	56	int ret;
	57
	58	ret = console_record_readline(uts->actual_str, sizeof(uts->actual_str));
	59	if (ret == -ENOSPC) {
	60	ut_fail(uts, __FILE__, __LINE__, __func__,
	61	"Console record buffer too small - increase CONFIG_CONSOLE_RECORD_OUT_SIZE");
	62	return ret;
	63	}
	64
	65	return 0;
	66	}
	67
400175b0 SG	68	int ut_check_console_line(struct unit_test_state uts, const char fmt, ...)
	69	{
	70	va_list args;
090d664e	71	int len;
c1a2bb4f	72	int ret;
400175b0 SG	73
400175b0 SG	74	va_start(args, fmt);
090d664e	75	len = vsnprintf(uts->expect_str, sizeof(uts->expect_str), fmt, args);
400175b0	76	va_end(args);
090d664e SG	77	if (len >= sizeof(uts->expect_str)) {
	78	ut_fail(uts, __FILE__, __LINE__, __func__,
	79	"unit_test_state->expect_str too small");
	80	return -EOVERFLOW;
	81	}
c1a2bb4f SG	82	ret = readline_check(uts);
	83	if (ret < 0)
	84	return ret;
400175b0 SG	85
	86	return strcmp(uts->expect_str, uts->actual_str);
	87	}
	88
33d7edfd SG	89	int ut_check_console_linen(struct unit_test_state uts, const char fmt, ...)
	90	{
	91	va_list args;
090d664e	92	int len;
c1a2bb4f	93	int ret;
33d7edfd SG	94
33d7edfd SG	95	va_start(args, fmt);
090d664e	96	len = vsnprintf(uts->expect_str, sizeof(uts->expect_str), fmt, args);
33d7edfd	97	va_end(args);
090d664e SG	98	if (len >= sizeof(uts->expect_str)) {
	99	ut_fail(uts, __FILE__, __LINE__, __func__,
	100	"unit_test_state->expect_str too small");
	101	return -EOVERFLOW;
	102	}
c1a2bb4f SG	103	ret = readline_check(uts);
	104	if (ret < 0)
	105	return ret;
33d7edfd SG	106
	107	return strncmp(uts->expect_str, uts->actual_str,
	108	strlen(uts->expect_str));
	109	}
	110
	111	int ut_check_skipline(struct unit_test_state *uts)
	112	{
c1a2bb4f SG	113	int ret;
c1a2bb4f SG	114
33d7edfd SG	115	if (!console_record_avail())
33d7edfd SG	116	return -ENFILE;
c1a2bb4f SG	117	ret = readline_check(uts);
	118	if (ret < 0)
	119	return ret;
33d7edfd SG	120
	121	return 0;
	122	}
	123
2e09008c SG	124	int ut_check_skip_to_line(struct unit_test_state uts, const char fmt, ...)
	125	{
	126	va_list args;
	127	int len;
	128	int ret;
	129
	130	va_start(args, fmt);
	131	len = vsnprintf(uts->expect_str, sizeof(uts->expect_str), fmt, args);
	132	va_end(args);
	133	if (len >= sizeof(uts->expect_str)) {
	134	ut_fail(uts, __FILE__, __LINE__, __func__,
	135	"unit_test_state->expect_str too small");
	136	return -EOVERFLOW;
	137	}
	138	while (1) {
	139	if (!console_record_avail())
	140	return -ENOENT;
	141	ret = readline_check(uts);
	142	if (ret < 0)
	143	return ret;
	144
	145	if (!strcmp(uts->expect_str, uts->actual_str))
	146	return 0;
	147	}
	148	}
	149
400175b0 SG	150	int ut_check_console_end(struct unit_test_state *uts)
400175b0 SG	151	{
c1a2bb4f SG	152	int ret;
c1a2bb4f SG	153
400175b0 SG	154	if (!console_record_avail())
400175b0 SG	155	return 0;
c1a2bb4f SG	156	ret = readline_check(uts);
	157	if (ret < 0)
	158	return ret;
400175b0 SG	159
	160	return 1;
	161	}
	162
	163	int ut_check_console_dump(struct unit_test_state *uts, int total_bytes)
	164	{
	165	char *str = uts->actual_str;
	166	int upto;
	167
	168	/* Handle empty dump */
	169	if (!total_bytes)
	170	return 0;
	171
	172	for (upto = 0; upto < total_bytes;) {
	173	int len;
	174	int bytes;
	175
	176	len = console_record_readline(str, sizeof(uts->actual_str));
	177	if (str[8] != ':' \|\| str[9] != ' ')
	178	return 1;
	179
c7b16d83	180	bytes = len - 8 - 2 - 3 * 16 - 2;
400175b0 SG	181	upto += bytes;
	182	}
	183
	184	return upto == total_bytes ? 0 : 1;
	185	}
ef7e2649 SG	186
	187	void ut_silence_console(struct unit_test_state *uts)
	188	{
	189	#ifdef CONFIG_SANDBOX
	190	struct sandbox_state *state = state_get_current();
	191
	192	if (!state->show_test_output)
	193	gd->flags \|= GD_FLG_SILENT;
	194	#endif
	195	}
	196
	197	void ut_unsilence_console(struct unit_test_state *uts)
	198	{
	199	gd->flags &= ~(GD_FLG_SILENT \| GD_FLG_RECORD);
	200	}
47ec3ede SG	201
	202	void ut_set_skip_delays(struct unit_test_state *uts, bool skip_delays)
	203	{
	204	#ifdef CONFIG_SANDBOX
	205	state_set_skip_delays(skip_delays);
	206	#endif
	207	}