u-boot/test/ut.c

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

#include <console.h>
#include <errno.h>
#include <malloc.h>
#include <membuf.h>
#include <slre.h>
#include <vsprintf.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)
{
	ut_unsilence_console(uts);
	printf("%s:%d, %s(): %s\n", fname, line, func, cond);
	uts->cur.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;

	ut_unsilence_console(uts);
	printf("%s:%d, %s(): %s: ", fname, line, func, cond);
	va_start(args, fmt);
	vprintf(fmt, args);
	va_end(args);
	putc('\n');
	uts->cur.fail_count++;
}

int ut_check_regex(const char *pattern, const char *str, char *err)
{
	struct slre slre;

	if (!pattern || !str) {
		snprintf(err, UT_REGEX_ERR_SIZE,
			 "NULL value: pattern=%s, str=%s",
			 pattern ? pattern : "(null)",
			 str ? str : "(null)");
		return -EINVAL;
	}

	if (!slre_compile(&slre, pattern)) {
		snprintf(err, UT_REGEX_ERR_SIZE,
			 "Invalid regex '%s': %s", pattern, slre.err_str);
		return -EINVAL;
	}

	if (!slre_match(&slre, str, strlen(str), NULL)) {
		snprintf(err, UT_REGEX_ERR_SIZE,
			 "No match: pattern '%s', str '%s'", pattern, str);
		return -ENOENT;
	}

	return 0;
}

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) {
		if (IS_ENABLED(CONFIG_CONSOLE_RECORD)) {
			int cur_size = membuf_size(gd_console_out());

			ut_failf(uts, __FILE__, __LINE__, __func__,
				 "Console record buffer too small",
				 "CONFIG_CONSOLE_RECORD_OUT_SIZE=%#x, need %#x",
				 cur_size, cur_size + gd_console_out_ovf());
		} else {
			ut_fail(uts, __FILE__, __LINE__, __func__,
				"Console record buffer too small - increase "
				"CONFIG_CONSOLE_RECORD_OUT_SIZE");
		}
		return ret;
	} else if (ret == -ENOENT) {
		strcpy(uts->actual_str, "<no-more-output>");
	}

	return ret;
}

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 == -ENOENT)
		return 1;

	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_console_line_regex(struct unit_test_state *uts, const char *regex)
{
	char err[UT_REGEX_ERR_SIZE];
	int len;
	int ret;

	len = strlcpy(uts->expect_str, regex, sizeof(uts->expect_str));
	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 == -ENOENT)
		return 1;

	ret = ut_check_regex(regex, uts->actual_str, err);

	return ret;
}

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_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;
	}
	while (1) {
		if (!console_record_avail())
			return -ENOENT;
		ret = readline_check(uts);
		if (ret < 0)
			return ret;

		if (!strncmp(uts->expect_str, uts->actual_str,
			     strlen(uts->expect_str)))
			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)
{
	if (!uts->keep_record)
		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
}

const char *ut_get_str(struct unit_test_state *uts, int n, const char *file,
		       int line, const char *func)
{
	if (n < 0 || n >= uts->arg_count) {
		if (!uts->arg_error)
			ut_failf(uts, file, line, func, "ut_str() arg check",
				 "arg %d is invalid (arg_count=%d)", n,
				 uts->arg_count);
		uts->arg_error = true;
		return NULL;
	}
	if (uts->args[n].type != UT_ARG_STR) {
		if (!uts->arg_error)
			ut_failf(uts, file, line, func, "ut_str() type check",
				 "arg %d is not a string", n);
		uts->arg_error = true;
		return NULL;
	}

	return uts->args[n].vstr;
}

long ut_get_int(struct unit_test_state *uts, int n, const char *file,
		int line, const char *func)
{
	if (n < 0 || n >= uts->arg_count) {
		if (!uts->arg_error)
			ut_failf(uts, file, line, func, "ut_int() arg check",
				 "arg %d is invalid (arg_count=%d)", n,
				 uts->arg_count);
		uts->arg_error = true;
		return 0;
	}
	if (uts->args[n].type != UT_ARG_INT) {
		if (!uts->arg_error)
			ut_failf(uts, file, line, func, "ut_int() type check",
				 "arg %d is not an int", n);
		uts->arg_error = true;
		return 0;
	}

	return uts->args[n].vint;
}

bool ut_get_bool(struct unit_test_state *uts, int n, const char *file,
		 int line, const char *func)
{
	if (n < 0 || n >= uts->arg_count) {
		if (!uts->arg_error)
			ut_failf(uts, file, line, func, "ut_bool() arg check",
				 "arg %d is invalid (arg_count=%d)", n,
				 uts->arg_count);
		uts->arg_error = true;
		return false;
	}
	if (uts->args[n].type != UT_ARG_BOOL) {
		if (!uts->arg_error)
			ut_failf(uts, file, line, func, "ut_bool() type check",
				 "arg %d is not a bool", n);
		uts->arg_error = true;
		return false;
	}

	return uts->args[n].vbool;
}