include/test/ut.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Simple unit test library
   4  *
   5  * Copyright (c) 2013 Google, Inc
   6  */
   7
   8 #ifndef __TEST_UT_H
   9 #define __TEST_UT_H
  10
  11 #include <command.h>
  12 #include <hexdump.h>
  13 #include <linux/err.h>
  14
  15 struct unit_test_state;
  16
  17 /**
  18  * ut_fail() - Record failure of a unit test
  19  *
  20  * @uts: Test state
  21  * @fname: Filename where the error occurred
  22  * @line: Line number where the error occurred
  23  * @func: Function name where the error occurred
  24  * @cond: The condition that failed
  25  */
  26 void ut_fail(struct unit_test_state *uts, const char *fname, int line,
  27              const char *func, const char *cond);
  28
  29 /**
  30  * ut_failf() - Record failure of a unit test
  31  *
  32  * @uts: Test state
  33  * @fname: Filename where the error occurred
  34  * @line: Line number where the error occurred
  35  * @func: Function name where the error occurred
  36  * @cond: The condition that failed
  37  * @fmt: printf() format string for the error, followed by args
  38  */
  39 void ut_failf(struct unit_test_state *uts, const char *fname, int line,
  40               const char *func, const char *cond, const char *fmt, ...)
  41                         __attribute__ ((format (__printf__, 6, 7)));
  42
  43 /**
  44  * ut_check_console_line() - Check the next console line against expectations
  45  *
  46  * This creates a string and then checks it against the next line of console
  47  * output obtained with console_record_readline().
  48  *
  49  * After the function returns, uts->expect_str holds the expected string and
  50  * uts->actual_str holds the actual string read from the console.
  51  *
  52  * @uts: Test state
  53  * @fmt: printf() format string for the error, followed by args
  54  * @return 0 if OK, other value on error
  55  */
  56 int ut_check_console_line(struct unit_test_state *uts, const char *fmt, ...)
  57                         __attribute__ ((format (__printf__, 2, 3)));
  58
  59 /**
  60  * ut_check_console_end() - Check there is no more console output
  61  *
  62  * After the function returns, uts->actual_str holds the actual string read
  63  * from the console
  64  *
  65  * @uts: Test state
  66  * @return 0 if OK (console has no output), other value on error
  67  */
  68 int ut_check_console_end(struct unit_test_state *uts);
  69
  70 /**
  71  * ut_check_console_dump() - Check that next lines have a print_buffer() dump
  72  *
  73  * This only supports a byte dump.
  74  *
  75  * @total_bytes: Size of the expected dump in bytes`
  76  * @return 0 if OK (looks like a dump and the length matches), other value on
  77  *      error
  78  */
  79 int ut_check_console_dump(struct unit_test_state *uts, int total_bytes);
  80
  81 /* Assert that a condition is non-zero */
  82 #define ut_assert(cond)                                                 \
  83         if (!(cond)) {                                                  \
  84                 ut_fail(uts, __FILE__, __LINE__, __func__, #cond);      \
  85                 return CMD_RET_FAILURE;                                 \
  86         }
  87
  88 /* Assert that a condition is non-zero, with printf() string */
  89 #define ut_assertf(cond, fmt, args...)                                  \
  90         if (!(cond)) {                                                  \
  91                 ut_failf(uts, __FILE__, __LINE__, __func__, #cond,      \
  92                          fmt, ##args);                                  \
  93                 return CMD_RET_FAILURE;                                 \
  94         }
  95
  96 /* Assert that two int expressions are equal */
  97 #define ut_asserteq(expr1, expr2) {                                     \
  98         unsigned int _val1 = (expr1), _val2 = (expr2);                  \
  99                                                                         \
 100         if (_val1 != _val2) {                                           \
 101                 ut_failf(uts, __FILE__, __LINE__, __func__,             \
 102                          #expr1 " == " #expr2,                          \
 103                          "Expected %#x (%d), got %#x (%d)",             \
 104                          _val1, _val1, _val2, _val2);                   \
 105                 return CMD_RET_FAILURE;                                 \
 106         }                                                               \
 107 }
 108
 109 /* Assert that two 64 int expressions are equal */
 110 #define ut_asserteq_64(expr1, expr2) {                                  \
 111         u64 _val1 = (expr1), _val2 = (expr2);                           \
 112                                                                         \
 113         if (_val1 != _val2) {                                           \
 114                 ut_failf(uts, __FILE__, __LINE__, __func__,             \
 115                          #expr1 " == " #expr2,                          \
 116                          "Expected %#llx (%lld), got %#llx (%lld)",     \
 117                          (unsigned long long)_val1,                     \
 118                          (unsigned long long)_val1,                     \
 119                          (unsigned long long)_val2,                     \
 120                          (unsigned long long)_val2);                    \
 121                 return CMD_RET_FAILURE;                                 \
 122         }                                                               \
 123 }
 124
 125 /* Assert that two string expressions are equal */
 126 #define ut_asserteq_str(expr1, expr2) {                                 \
 127         const char *_val1 = (expr1), *_val2 = (expr2);                  \
 128                                                                         \
 129         if (strcmp(_val1, _val2)) {                                     \
 130                 ut_failf(uts, __FILE__, __LINE__, __func__,             \
 131                          #expr1 " = " #expr2,                           \
 132                          "Expected \"%s\", got \"%s\"", _val1, _val2);  \
 133                 return CMD_RET_FAILURE;                                 \
 134         }                                                               \
 135 }
 136
 137 /* Assert that two memory areas are equal */
 138 #define ut_asserteq_mem(expr1, expr2, len) {                            \
 139         const u8 *_val1 = (u8 *)(expr1), *_val2 = (u8 *)(expr2);        \
 140         const uint __len = len;                                         \
 141                                                                         \
 142         if (memcmp(_val1, _val2, __len)) {                              \
 143                 char __buf1[64 + 1] = "\0";                             \
 144                 char __buf2[64 + 1] = "\0";                             \
 145                 bin2hex(__buf1, _val1, min(__len, (uint)32));           \
 146                 bin2hex(__buf2, _val2, min(__len, (uint)32));           \
 147                 ut_failf(uts, __FILE__, __LINE__, __func__,             \
 148                          #expr1 " = " #expr2,                           \
 149                          "Expected \"%s\", got \"%s\"",                 \
 150                          __buf1, __buf2);                               \
 151                 return CMD_RET_FAILURE;                                 \
 152         }                                                               \
 153 }
 154
 155 /* Assert that two pointers are equal */
 156 #define ut_asserteq_ptr(expr1, expr2) {                                 \
 157         const void *_val1 = (expr1), *_val2 = (expr2);                  \
 158                                                                         \
 159         if (_val1 != _val2) {                                           \
 160                 ut_failf(uts, __FILE__, __LINE__, __func__,             \
 161                          #expr1 " = " #expr2,                           \
 162                          "Expected %p, got %p", _val1, _val2);          \
 163                 return CMD_RET_FAILURE;                                 \
 164         }                                                               \
 165 }
 166
 167 /* Assert that a pointer is NULL */
 168 #define ut_assertnull(expr) {                                   \
 169         const void *_val = (expr);                                      \
 170                                                                         \
 171         if (_val) {                                             \
 172                 ut_failf(uts, __FILE__, __LINE__, __func__,             \
 173                          #expr " != NULL",                              \
 174                          "Expected NULL, got %p", _val);                \
 175                 return CMD_RET_FAILURE;                                 \
 176         }                                                               \
 177 }
 178
 179 /* Assert that a pointer is not NULL */
 180 #define ut_assertnonnull(expr) {                                        \
 181         const void *_val = (expr);                                      \
 182                                                                         \
 183         if (!_val) {                                            \
 184                 ut_failf(uts, __FILE__, __LINE__, __func__,             \
 185                          #expr " = NULL",                               \
 186                          "Expected non-null, got NULL");                \
 187                 return CMD_RET_FAILURE;                                 \
 188         }                                                               \
 189 }
 190
 191 /* Assert that a pointer is not an error pointer */
 192 #define ut_assertok_ptr(expr) {                                         \
 193         const void *_val = (expr);                                      \
 194                                                                         \
 195         if (IS_ERR(_val)) {                                             \
 196                 ut_failf(uts, __FILE__, __LINE__, __func__,             \
 197                          #expr " = NULL",                               \
 198                          "Expected pointer, got error %ld",             \
 199                          PTR_ERR(_val));                                \
 200                 return CMD_RET_FAILURE;                                 \
 201         }                                                               \
 202 }
 203
 204 /* Assert that an operation succeeds (returns 0) */
 205 #define ut_assertok(cond)       ut_asserteq(0, cond)
 206
 207 /* Assert that the next console output line matches */
 208 #define ut_assert_nextline(fmt, args...)                                \
 209         if (ut_check_console_line(uts, fmt, ##args)) {                  \
 210                 ut_failf(uts, __FILE__, __LINE__, __func__,             \
 211                          "console", "\nExpected '%s',\n     got '%s'",  \
 212                          uts->expect_str, uts->actual_str);             \
 213                 return CMD_RET_FAILURE;                                 \
 214         }                                                               \
 215
 216 /* Assert that there is no more console output */
 217 #define ut_assert_console_end()                                         \
 218         if (ut_check_console_end(uts)) {                                \
 219                 ut_failf(uts, __FILE__, __LINE__, __func__,             \
 220                          "console", "Expected no more output, got '%s'",\
 221                          uts->actual_str);                              \
 222                 return CMD_RET_FAILURE;                                 \
 223         }                                                               \
 224
 225 /* Assert that the next lines are print_buffer() dump at an address */
 226 #define ut_assert_nextlines_are_dump(total_bytes)                       \
 227         if (ut_check_console_dump(uts, total_bytes)) {                  \
 228                 ut_failf(uts, __FILE__, __LINE__, __func__,             \
 229                          "console",                                     \
 230                         "Expected dump of length %x bytes, got '%s'",   \
 231                          total_bytes, uts->actual_str);                 \
 232                 return CMD_RET_FAILURE;                                 \
 233         }                                                               \
 234
 235 /**
 236  * ut_check_free() - Return the number of bytes free in the malloc() pool
 237  *
 238  * @return bytes free
 239  */
 240 ulong ut_check_free(void);
 241
 242 /**
 243  * ut_check_delta() - Return the number of bytes allocated/freed
 244  *
 245  * @last: Last value from ut_check_free
 246  * @return free memory delta from @last; positive means more memory has been
 247  *      allocated, negative means less has been allocated (i.e. some is freed)
 248  */
 249 long ut_check_delta(ulong last);
 250
 251 #endif