123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233 |
- /* SPDX-License-Identifier: GPL-2.0+ */
- /*
- * Simple unit test library
- *
- * Copyright (c) 2013 Google, Inc
- */
- #ifndef __TEST_UT_H
- #define __TEST_UT_H
- #include <linux/err.h>
- struct unit_test_state;
- /**
- * ut_fail() - Record failure of a unit test
- *
- * @uts: Test state
- * @fname: Filename where the error occurred
- * @line: Line number where the error occurred
- * @func: Function name where the error occurred
- * @cond: The condition that failed
- */
- void ut_fail(struct unit_test_state *uts, const char *fname, int line,
- const char *func, const char *cond);
- /**
- * ut_failf() - Record failure of a unit test
- *
- * @uts: Test state
- * @fname: Filename where the error occurred
- * @line: Line number where the error occurred
- * @func: Function name where the error occurred
- * @cond: The condition that failed
- * @fmt: printf() format string for the error, followed by args
- */
- void ut_failf(struct unit_test_state *uts, const char *fname, int line,
- const char *func, const char *cond, const char *fmt, ...)
- __attribute__ ((format (__printf__, 6, 7)));
- /**
- * ut_check_console_line() - Check the next console line against expectations
- *
- * This creates a string and then checks it against the next line of console
- * output obtained with console_record_readline().
- *
- * After the function returns, uts->expect_str holds the expected string and
- * uts->actual_str holds the actual string read from the console.
- *
- * @uts: Test state
- * @fmt: printf() format string for the error, followed by args
- * @return 0 if OK, other value on error
- */
- int ut_check_console_line(struct unit_test_state *uts, const char *fmt, ...)
- __attribute__ ((format (__printf__, 2, 3)));
- /**
- * ut_check_console_end() - Check there is no more console output
- *
- * After the function returns, uts->actual_str holds the actual string read
- * from the console
- *
- * @uts: Test state
- * @return 0 if OK (console has no output), other value on error
- */
- int ut_check_console_end(struct unit_test_state *uts);
- /**
- * ut_check_console_dump() - Check that next lines have a print_buffer() dump
- *
- * This only supports a byte dump.
- *
- * @total_bytes: Size of the expected dump in bytes`
- * @return 0 if OK (looks like a dump and the length matches), other value on
- * error
- */
- int ut_check_console_dump(struct unit_test_state *uts, int total_bytes);
- /* Assert that a condition is non-zero */
- #define ut_assert(cond) \
- if (!(cond)) { \
- ut_fail(uts, __FILE__, __LINE__, __func__, #cond); \
- return CMD_RET_FAILURE; \
- }
- /* Assert that a condition is non-zero, with printf() string */
- #define ut_assertf(cond, fmt, args...) \
- if (!(cond)) { \
- ut_failf(uts, __FILE__, __LINE__, __func__, #cond, \
- fmt, ##args); \
- return CMD_RET_FAILURE; \
- }
- /* Assert that two int expressions are equal */
- #define ut_asserteq(expr1, expr2) { \
- unsigned int _val1 = (expr1), _val2 = (expr2); \
- \
- if (_val1 != _val2) { \
- ut_failf(uts, __FILE__, __LINE__, __func__, \
- #expr1 " == " #expr2, \
- "Expected %#x (%d), got %#x (%d)", \
- _val1, _val1, _val2, _val2); \
- return CMD_RET_FAILURE; \
- } \
- }
- /* Assert that two string expressions are equal */
- #define ut_asserteq_str(expr1, expr2) { \
- const char *_val1 = (expr1), *_val2 = (expr2); \
- \
- if (strcmp(_val1, _val2)) { \
- ut_failf(uts, __FILE__, __LINE__, __func__, \
- #expr1 " = " #expr2, \
- "Expected \"%s\", got \"%s\"", _val1, _val2); \
- return CMD_RET_FAILURE; \
- } \
- }
- /* Assert that two memory areas are equal */
- #define ut_asserteq_mem(expr1, expr2, len) { \
- const u8 *_val1 = (u8 *)(expr1), *_val2 = (u8 *)(expr2); \
- const uint __len = len; \
- \
- if (memcmp(_val1, _val2, __len)) { \
- char __buf1[64 + 1] = "\0"; \
- char __buf2[64 + 1] = "\0"; \
- bin2hex(__buf1, _val1, min(__len, (uint)32)); \
- bin2hex(__buf2, _val2, min(__len, (uint)32)); \
- ut_failf(uts, __FILE__, __LINE__, __func__, \
- #expr1 " = " #expr2, \
- "Expected \"%s\", got \"%s\"", \
- __buf1, __buf2); \
- return CMD_RET_FAILURE; \
- } \
- }
- /* Assert that two pointers are equal */
- #define ut_asserteq_ptr(expr1, expr2) { \
- const void *_val1 = (expr1), *_val2 = (expr2); \
- \
- if (_val1 != _val2) { \
- ut_failf(uts, __FILE__, __LINE__, __func__, \
- #expr1 " = " #expr2, \
- "Expected %p, got %p", _val1, _val2); \
- return CMD_RET_FAILURE; \
- } \
- }
- /* Assert that a pointer is NULL */
- #define ut_assertnull(expr) { \
- const void *_val = (expr); \
- \
- if (_val) { \
- ut_failf(uts, __FILE__, __LINE__, __func__, \
- #expr " != NULL", \
- "Expected NULL, got %p", _val); \
- return CMD_RET_FAILURE; \
- } \
- }
- /* Assert that a pointer is not NULL */
- #define ut_assertnonnull(expr) { \
- const void *_val = (expr); \
- \
- if (!_val) { \
- ut_failf(uts, __FILE__, __LINE__, __func__, \
- #expr " = NULL", \
- "Expected non-null, got NULL"); \
- return CMD_RET_FAILURE; \
- } \
- }
- /* Assert that a pointer is not an error pointer */
- #define ut_assertok_ptr(expr) { \
- const void *_val = (expr); \
- \
- if (IS_ERR(_val)) { \
- ut_failf(uts, __FILE__, __LINE__, __func__, \
- #expr " = NULL", \
- "Expected pointer, got error %ld", \
- PTR_ERR(_val)); \
- return CMD_RET_FAILURE; \
- } \
- }
- /* Assert that an operation succeeds (returns 0) */
- #define ut_assertok(cond) ut_asserteq(0, cond)
- /* Assert that the next console output line matches */
- #define ut_assert_nextline(fmt, args...) \
- if (ut_check_console_line(uts, fmt, ##args)) { \
- ut_failf(uts, __FILE__, __LINE__, __func__, \
- "console", "\nExpected '%s',\n got '%s'", \
- uts->expect_str, uts->actual_str); \
- return CMD_RET_FAILURE; \
- } \
- /* Assert that there is no more console output */
- #define ut_assert_console_end() \
- if (ut_check_console_end(uts)) { \
- ut_failf(uts, __FILE__, __LINE__, __func__, \
- "console", "Expected no more output, got '%s'",\
- uts->actual_str); \
- return CMD_RET_FAILURE; \
- } \
- /* Assert that the next lines are print_buffer() dump at an address */
- #define ut_assert_nextlines_are_dump(total_bytes) \
- if (ut_check_console_dump(uts, total_bytes)) { \
- ut_failf(uts, __FILE__, __LINE__, __func__, \
- "console", \
- "Expected dump of length %x bytes, got '%s'", \
- total_bytes, uts->actual_str); \
- return CMD_RET_FAILURE; \
- } \
- /**
- * ut_check_free() - Return the number of bytes free in the malloc() pool
- *
- * @return bytes free
- */
- ulong ut_check_free(void);
- /**
- * ut_check_delta() - Return the number of bytes allocated/freed
- *
- * @last: Last value from ut_check_free
- * @return free memory delta from @last; positive means more memory has been
- * allocated, negative means less has been allocated (i.e. some is freed)
- */
- long ut_check_delta(ulong last);
- #endif
|