blob: da7c1a9d265b4820582315ebbe04eddfb1172c6b [file] [log] [blame]
Simon Glass2e7d35d2014-02-26 15:59:21 -07001/*
Joe Hershbergere721b882015-05-20 14:27:27 -05002 * Simple unit test library
Simon Glass2e7d35d2014-02-26 15:59:21 -07003 *
4 * Copyright (c) 2013 Google, Inc
5 *
6 * SPDX-License-Identifier: GPL-2.0+
7 */
8
Joe Hershbergere721b882015-05-20 14:27:27 -05009#ifndef __TEST_UT_H
10#define __TEST_UT_H
Simon Glass2e7d35d2014-02-26 15:59:21 -070011
Simon Glass85aeda42015-07-06 12:54:37 -060012#include <linux/err.h>
13
Joe Hershbergere721b882015-05-20 14:27:27 -050014struct unit_test_state;
Simon Glass2e7d35d2014-02-26 15:59:21 -070015
16/**
17 * ut_fail() - Record failure of a unit test
18 *
Joe Hershbergere721b882015-05-20 14:27:27 -050019 * @uts: Test state
Simon Glass2e7d35d2014-02-26 15:59:21 -070020 * @fname: Filename where the error occured
21 * @line: Line number where the error occured
22 * @func: Function name where the error occured
23 * @cond: The condition that failed
24 */
Joe Hershbergere721b882015-05-20 14:27:27 -050025void ut_fail(struct unit_test_state *uts, const char *fname, int line,
Simon Glass2e7d35d2014-02-26 15:59:21 -070026 const char *func, const char *cond);
27
28/**
29 * ut_failf() - Record failure of a unit test
30 *
Joe Hershbergere721b882015-05-20 14:27:27 -050031 * @uts: Test state
Simon Glass2e7d35d2014-02-26 15:59:21 -070032 * @fname: Filename where the error occured
33 * @line: Line number where the error occured
34 * @func: Function name where the error occured
35 * @cond: The condition that failed
36 * @fmt: printf() format string for the error, followed by args
37 */
Joe Hershbergere721b882015-05-20 14:27:27 -050038void ut_failf(struct unit_test_state *uts, const char *fname, int line,
Simon Glass2e7d35d2014-02-26 15:59:21 -070039 const char *func, const char *cond, const char *fmt, ...)
40 __attribute__ ((format (__printf__, 6, 7)));
41
42
43/* Assert that a condition is non-zero */
44#define ut_assert(cond) \
45 if (!(cond)) { \
Joe Hershbergere721b882015-05-20 14:27:27 -050046 ut_fail(uts, __FILE__, __LINE__, __func__, #cond); \
Joe Hershbergerfe3f6a62015-05-20 14:27:34 -050047 return CMD_RET_FAILURE; \
Simon Glass2e7d35d2014-02-26 15:59:21 -070048 }
49
50/* Assert that a condition is non-zero, with printf() string */
51#define ut_assertf(cond, fmt, args...) \
52 if (!(cond)) { \
Joe Hershbergere721b882015-05-20 14:27:27 -050053 ut_failf(uts, __FILE__, __LINE__, __func__, #cond, \
Simon Glass2e7d35d2014-02-26 15:59:21 -070054 fmt, ##args); \
Joe Hershbergerfe3f6a62015-05-20 14:27:34 -050055 return CMD_RET_FAILURE; \
Simon Glass2e7d35d2014-02-26 15:59:21 -070056 }
57
58/* Assert that two int expressions are equal */
59#define ut_asserteq(expr1, expr2) { \
60 unsigned int val1 = (expr1), val2 = (expr2); \
61 \
62 if (val1 != val2) { \
Joe Hershbergere721b882015-05-20 14:27:27 -050063 ut_failf(uts, __FILE__, __LINE__, __func__, \
Simon Glass2e7d35d2014-02-26 15:59:21 -070064 #expr1 " == " #expr2, \
65 "Expected %d, got %d", val1, val2); \
Joe Hershbergerfe3f6a62015-05-20 14:27:34 -050066 return CMD_RET_FAILURE; \
Simon Glass2e7d35d2014-02-26 15:59:21 -070067 } \
68}
69
70/* Assert that two string expressions are equal */
71#define ut_asserteq_str(expr1, expr2) { \
72 const char *val1 = (expr1), *val2 = (expr2); \
73 \
74 if (strcmp(val1, val2)) { \
Joe Hershbergere721b882015-05-20 14:27:27 -050075 ut_failf(uts, __FILE__, __LINE__, __func__, \
Simon Glass2e7d35d2014-02-26 15:59:21 -070076 #expr1 " = " #expr2, \
77 "Expected \"%s\", got \"%s\"", val1, val2); \
Joe Hershbergerfe3f6a62015-05-20 14:27:34 -050078 return CMD_RET_FAILURE; \
Simon Glass2e7d35d2014-02-26 15:59:21 -070079 } \
80}
81
82/* Assert that two pointers are equal */
83#define ut_asserteq_ptr(expr1, expr2) { \
84 const void *val1 = (expr1), *val2 = (expr2); \
85 \
86 if (val1 != val2) { \
Joe Hershbergere721b882015-05-20 14:27:27 -050087 ut_failf(uts, __FILE__, __LINE__, __func__, \
Simon Glass2e7d35d2014-02-26 15:59:21 -070088 #expr1 " = " #expr2, \
89 "Expected %p, got %p", val1, val2); \
Joe Hershbergerfe3f6a62015-05-20 14:27:34 -050090 return CMD_RET_FAILURE; \
Simon Glass2e7d35d2014-02-26 15:59:21 -070091 } \
92}
93
Simon Glassecc2ed52014-12-10 08:55:55 -070094/* Assert that a pointer is not NULL */
95#define ut_assertnonnull(expr) { \
96 const void *val = (expr); \
97 \
98 if (val == NULL) { \
Joe Hershbergere721b882015-05-20 14:27:27 -050099 ut_failf(uts, __FILE__, __LINE__, __func__, \
Simon Glassecc2ed52014-12-10 08:55:55 -0700100 #expr " = NULL", \
101 "Expected non-null, got NULL"); \
Joe Hershbergerfe3f6a62015-05-20 14:27:34 -0500102 return CMD_RET_FAILURE; \
Simon Glassecc2ed52014-12-10 08:55:55 -0700103 } \
104}
105
Simon Glass85aeda42015-07-06 12:54:37 -0600106/* Assert that a pointer is not an error pointer */
107#define ut_assertok_ptr(expr) { \
108 const void *val = (expr); \
109 \
110 if (IS_ERR(val)) { \
111 ut_failf(uts, __FILE__, __LINE__, __func__, \
112 #expr " = NULL", \
113 "Expected pointer, got error %ld", \
114 PTR_ERR(val)); \
115 return CMD_RET_FAILURE; \
116 } \
117}
118
Simon Glass2e7d35d2014-02-26 15:59:21 -0700119/* Assert that an operation succeeds (returns 0) */
120#define ut_assertok(cond) ut_asserteq(0, cond)
121
122#endif