mirror of
				https://github.com/smaeul/u-boot.git
				synced 2025-11-04 05:50:17 +00:00 
			
		
		
		
	Strict naming conventions have to be followed for Python function generate_ut_subtest() to collect C unit tests to be executed via command 'ut'. Describe the requirements both on the C as well on the Python side. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Stephen Warren <swarren@nvidia.com> Reviewed-by: Simon Glass <sjg@chromium.org>
		
			
				
	
	
		
			87 lines
		
	
	
		
			2.5 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			87 lines
		
	
	
		
			2.5 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/* SPDX-License-Identifier: GPL-2.0+ */
 | 
						|
/*
 | 
						|
 * Copyright (c) 2013 Google, Inc.
 | 
						|
 */
 | 
						|
 | 
						|
#ifndef __TEST_TEST_H
 | 
						|
#define __TEST_TEST_H
 | 
						|
 | 
						|
#include <malloc.h>
 | 
						|
 | 
						|
/*
 | 
						|
 * struct unit_test_state - Entire state of test system
 | 
						|
 *
 | 
						|
 * @fail_count: Number of tests that failed
 | 
						|
 * @start: Store the starting mallinfo when doing leak test
 | 
						|
 * @priv: A pointer to some other info some suites want to track
 | 
						|
 * @of_root: Record of the livetree root node (used for setting up tests)
 | 
						|
 * @expect_str: Temporary string used to hold expected string value
 | 
						|
 * @actual_str: Temporary string used to hold actual string value
 | 
						|
 */
 | 
						|
struct unit_test_state {
 | 
						|
	int fail_count;
 | 
						|
	struct mallinfo start;
 | 
						|
	void *priv;
 | 
						|
	struct device_node *of_root;
 | 
						|
	char expect_str[256];
 | 
						|
	char actual_str[256];
 | 
						|
};
 | 
						|
 | 
						|
/**
 | 
						|
 * struct unit_test - Information about a unit test
 | 
						|
 *
 | 
						|
 * @name: Name of test
 | 
						|
 * @func: Function to call to perform test
 | 
						|
 * @flags: Flags indicated pre-conditions for test
 | 
						|
 */
 | 
						|
struct unit_test {
 | 
						|
	const char *file;
 | 
						|
	const char *name;
 | 
						|
	int (*func)(struct unit_test_state *state);
 | 
						|
	int flags;
 | 
						|
};
 | 
						|
 | 
						|
/**
 | 
						|
 * UNIT_TEST() - create linker generated list entry for unit a unit test
 | 
						|
 *
 | 
						|
 * The macro UNIT_TEST() is used to create a linker generated list entry. These
 | 
						|
 * list entries are enumerate tests that can be execute using the ut command.
 | 
						|
 * The list entries are used both by the implementation of the ut command as
 | 
						|
 * well as in a related Python test.
 | 
						|
 *
 | 
						|
 * For Python testing the subtests are collected in Python function
 | 
						|
 * generate_ut_subtest() by applying a regular expression to the lines of file
 | 
						|
 * u-boot.sym. The list entries have to follow strict naming conventions to be
 | 
						|
 * matched by the expression.
 | 
						|
 *
 | 
						|
 * Use UNIT_TEST(foo_test_bar, _flags, foo_test) for a test bar in test suite
 | 
						|
 * foo that can be executed via command 'ut foo bar' and is implemented in
 | 
						|
 * function foo_test_bar().
 | 
						|
 *
 | 
						|
 * @_name:	concatenation of name of the test suite, "_test_", and the name
 | 
						|
 *		of the test
 | 
						|
 * @_flags:	an integer field that can be evaluated by the test suite
 | 
						|
 *		implementation
 | 
						|
 * @_suite:	name of the test suite concatenated with "_test"
 | 
						|
 */
 | 
						|
#define UNIT_TEST(_name, _flags, _suite)				\
 | 
						|
	ll_entry_declare(struct unit_test, _name, _suite) = {		\
 | 
						|
		.file = __FILE__,					\
 | 
						|
		.name = #_name,						\
 | 
						|
		.flags = _flags,					\
 | 
						|
		.func = _name,						\
 | 
						|
	}
 | 
						|
 | 
						|
/* Sizes for devres tests */
 | 
						|
enum {
 | 
						|
	TEST_DEVRES_SIZE	= 100,
 | 
						|
	TEST_DEVRES_COUNT	= 10,
 | 
						|
	TEST_DEVRES_TOTAL	= TEST_DEVRES_SIZE * TEST_DEVRES_COUNT,
 | 
						|
 | 
						|
	/* A few different sizes */
 | 
						|
	TEST_DEVRES_SIZE2	= 15,
 | 
						|
	TEST_DEVRES_SIZE3	= 37,
 | 
						|
};
 | 
						|
 | 
						|
#endif /* __TEST_TEST_H */
 |