forked from Mirrors/opensbi
		
	lib: tests: Add sbi_console test
Add the test suite covering some of the functions from lib/sbi/sbi_console.c: putc, puts and printf. The test covers a variety of format specifiers for printf and different strings and characters for putc and puts. In order to do that, the test "mocks" the sbi_console_device structure by setting the 'console_dev' variable to the virtual console. Signed-off-by: Ivan Orlov <ivan.orlov0322@gmail.com> Reviewed-by: Andrew Jones <ajones@ventanamicro.com>
This commit is contained in:
		@@ -16,6 +16,7 @@ libsbi-objs-$(CONFIG_SBIUNIT) += sbi_unit_tests.o
 | 
			
		||||
 | 
			
		||||
libsbi-objs-$(CONFIG_SBIUNIT) += sbi_bitmap_test.o
 | 
			
		||||
carray-sbi_unit_tests-$(CONFIG_SBIUNIT) += bitmap_test_suite
 | 
			
		||||
carray-sbi_unit_tests-$(CONFIG_SBIUNIT) += console_test_suite
 | 
			
		||||
 | 
			
		||||
libsbi-objs-y += sbi_ecall.o
 | 
			
		||||
libsbi-objs-y += sbi_ecall_exts.o
 | 
			
		||||
 
 | 
			
		||||
@@ -488,3 +488,7 @@ int sbi_console_init(struct sbi_scratch *scratch)
 | 
			
		||||
 | 
			
		||||
	return rc;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#ifdef CONFIG_SBIUNIT
 | 
			
		||||
#include "sbi_console_test.c"
 | 
			
		||||
#endif
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										105
									
								
								lib/sbi/sbi_console_test.c
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										105
									
								
								lib/sbi/sbi_console_test.c
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,105 @@
 | 
			
		||||
/*
 | 
			
		||||
 * SPDX-License-Identifier: BSD-2-Clause
 | 
			
		||||
 *
 | 
			
		||||
 * Author: Ivan Orlov <ivan.orlov0322@gmail.com>
 | 
			
		||||
 */
 | 
			
		||||
#include <sbi/sbi_unit_test.h>
 | 
			
		||||
 | 
			
		||||
#define TEST_CONSOLE_BUF_LEN 1024
 | 
			
		||||
 | 
			
		||||
static const struct sbi_console_device *old_dev;
 | 
			
		||||
static char test_console_buf[TEST_CONSOLE_BUF_LEN];
 | 
			
		||||
static u32 test_console_buf_pos;
 | 
			
		||||
static spinlock_t test_console_lock = SPIN_LOCK_INITIALIZER;
 | 
			
		||||
 | 
			
		||||
static void test_console_putc(char c)
 | 
			
		||||
{
 | 
			
		||||
	test_console_buf[test_console_buf_pos] = c;
 | 
			
		||||
	test_console_buf_pos = (test_console_buf_pos + 1) % TEST_CONSOLE_BUF_LEN;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
static void clear_test_console_buf(void)
 | 
			
		||||
{
 | 
			
		||||
	test_console_buf_pos = 0;
 | 
			
		||||
	test_console_buf[0] = '\0';
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
static const struct sbi_console_device test_console_dev = {
 | 
			
		||||
	.name = "Test console device",
 | 
			
		||||
	.console_putc = test_console_putc,
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
/* Mock the console device */
 | 
			
		||||
static inline void test_console_begin(const struct sbi_console_device *device)
 | 
			
		||||
{
 | 
			
		||||
	old_dev = console_dev;
 | 
			
		||||
	console_dev = device;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
static inline void test_console_end(void)
 | 
			
		||||
{
 | 
			
		||||
	console_dev = old_dev;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
static void putc_test(struct sbiunit_test_case *test)
 | 
			
		||||
{
 | 
			
		||||
	clear_test_console_buf();
 | 
			
		||||
	test_console_begin(&test_console_dev);
 | 
			
		||||
	sbi_putc('a');
 | 
			
		||||
	test_console_end();
 | 
			
		||||
	SBIUNIT_ASSERT_EQ(test, test_console_buf[0], 'a');
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#define PUTS_TEST(test, expected, str) do {			\
 | 
			
		||||
	spin_lock(&test_console_lock);				\
 | 
			
		||||
	clear_test_console_buf();				\
 | 
			
		||||
	test_console_begin(&test_console_dev);			\
 | 
			
		||||
	sbi_puts(str);						\
 | 
			
		||||
	test_console_end();					\
 | 
			
		||||
	SBIUNIT_ASSERT_STREQ(test, test_console_buf, expected,	\
 | 
			
		||||
			     sbi_strlen(expected));		\
 | 
			
		||||
	spin_unlock(&test_console_lock);			\
 | 
			
		||||
} while (0)
 | 
			
		||||
 | 
			
		||||
static void puts_test(struct sbiunit_test_case *test)
 | 
			
		||||
{
 | 
			
		||||
	PUTS_TEST(test, "Hello, OpenSBI!", "Hello, OpenSBI!");
 | 
			
		||||
	PUTS_TEST(test, "Hello,\r\nOpenSBI!", "Hello,\nOpenSBI!");
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#define PRINTF_TEST(test, expected, format, ...) do {		\
 | 
			
		||||
	spin_lock(&test_console_lock);				\
 | 
			
		||||
	clear_test_console_buf();				\
 | 
			
		||||
	test_console_begin(&test_console_dev);			\
 | 
			
		||||
	size_t __res = sbi_printf(format, ##__VA_ARGS__);	\
 | 
			
		||||
	test_console_end();					\
 | 
			
		||||
	SBIUNIT_ASSERT_EQ(test, __res, sbi_strlen(expected));	\
 | 
			
		||||
	SBIUNIT_ASSERT_STREQ(test, test_console_buf, expected,	\
 | 
			
		||||
			     sbi_strlen(expected));		\
 | 
			
		||||
	spin_unlock(&test_console_lock);			\
 | 
			
		||||
} while (0)
 | 
			
		||||
 | 
			
		||||
static void printf_test(struct sbiunit_test_case *test)
 | 
			
		||||
{
 | 
			
		||||
	PRINTF_TEST(test, "Hello", "Hello");
 | 
			
		||||
	PRINTF_TEST(test, "3 5 7", "%d %d %d", 3, 5, 7);
 | 
			
		||||
	PRINTF_TEST(test, "Hello", "%s", "Hello");
 | 
			
		||||
	PRINTF_TEST(test, "-1", "%d", -1);
 | 
			
		||||
	PRINTF_TEST(test, "FF", "%X", 255);
 | 
			
		||||
	PRINTF_TEST(test, "ff", "%x", 255);
 | 
			
		||||
	PRINTF_TEST(test, "A", "%c", 'A');
 | 
			
		||||
	PRINTF_TEST(test, "1fe", "%p", (void *)0x1fe);
 | 
			
		||||
	PRINTF_TEST(test, "4294967295", "%u", 4294967295U);
 | 
			
		||||
	PRINTF_TEST(test, "-2147483647", "%ld", -2147483647l);
 | 
			
		||||
	PRINTF_TEST(test, "-9223372036854775807", "%lld", -9223372036854775807LL);
 | 
			
		||||
	PRINTF_TEST(test, "18446744073709551615", "%llu", 18446744073709551615ULL);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
static struct sbiunit_test_case console_test_cases[] = {
 | 
			
		||||
	SBIUNIT_TEST_CASE(putc_test),
 | 
			
		||||
	SBIUNIT_TEST_CASE(puts_test),
 | 
			
		||||
	SBIUNIT_TEST_CASE(printf_test),
 | 
			
		||||
	SBIUNIT_END_CASE,
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
SBIUNIT_TEST_SUITE(console_test_suite, console_test_cases);
 | 
			
		||||
		Reference in New Issue
	
	Block a user