command: Remove the cmd_tbl_t typedef
[oweals/u-boot.git] / include / test / ut.h
index fbfde10719f90f14dd7d714d5bfaa51c7204c251..7ddd6e8872414e768b1449e58e09d33a2a774e04 100644 (file)
@@ -8,6 +8,8 @@
 #ifndef __TEST_UT_H
 #define __TEST_UT_H
 
+#include <command.h>
+#include <hexdump.h>
 #include <linux/err.h>
 
 struct unit_test_state;
@@ -38,6 +40,43 @@ 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)                                                        \
@@ -56,39 +95,55 @@ void ut_failf(struct unit_test_state *uts, const char *fname, int line,
 
 /* Assert that two int expressions are equal */
 #define ut_asserteq(expr1, expr2) {                                    \
-       unsigned int val1 = (expr1), val2 = (expr2);                    \
+       unsigned int _val1 = (expr1), _val2 = (expr2);                  \
                                                                        \
-       if (val1 != val2) {                                             \
+       if (_val1 != _val2) {                                           \
                ut_failf(uts, __FILE__, __LINE__, __func__,             \
                         #expr1 " == " #expr2,                          \
-                        "Expected %#x (%d), got %#x (%d)", val1, val1, \
-                        val2, val2);                                   \
+                        "Expected %#x (%d), got %#x (%d)",             \
+                        _val1, _val1, _val2, _val2);                   \
+               return CMD_RET_FAILURE;                                 \
+       }                                                               \
+}
+
+/* Assert that two 64 int expressions are equal */
+#define ut_asserteq_64(expr1, expr2) {                                 \
+       u64 _val1 = (expr1), _val2 = (expr2);                           \
+                                                                       \
+       if (_val1 != _val2) {                                           \
+               ut_failf(uts, __FILE__, __LINE__, __func__,             \
+                        #expr1 " == " #expr2,                          \
+                        "Expected %#llx (%lld), got %#llx (%lld)",     \
+                        (unsigned long long)_val1,                     \
+                        (unsigned long long)_val1,                     \
+                        (unsigned long long)_val2,                     \
+                        (unsigned long long)_val2);                    \
                return CMD_RET_FAILURE;                                 \
        }                                                               \
 }
 
 /* Assert that two string expressions are equal */
 #define ut_asserteq_str(expr1, expr2) {                                        \
-       const char *val1 = (expr1), *val2 = (expr2);                    \
+       const char *_val1 = (expr1), *_val2 = (expr2);                  \
                                                                        \
-       if (strcmp(val1, val2)) {                                       \
+       if (strcmp(_val1, _val2)) {                                     \
                ut_failf(uts, __FILE__, __LINE__, __func__,             \
                         #expr1 " = " #expr2,                           \
-                        "Expected \"%s\", got \"%s\"", val1, val2);    \
+                        "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 u8 *_val1 = (u8 *)(expr1), *_val2 = (u8 *)(expr2);        \
        const uint __len = len;                                         \
                                                                        \
-       if (memcmp(val1, val2, __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));            \
+               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\"",                 \
@@ -99,33 +154,33 @@ void ut_failf(struct unit_test_state *uts, const char *fname, int line,
 
 /* Assert that two pointers are equal */
 #define ut_asserteq_ptr(expr1, expr2) {                                        \
-       const void *val1 = (expr1), *val2 = (expr2);                    \
+       const void *_val1 = (expr1), *_val2 = (expr2);                  \
                                                                        \
-       if (val1 != val2) {                                             \
+       if (_val1 != _val2) {                                           \
                ut_failf(uts, __FILE__, __LINE__, __func__,             \
                         #expr1 " = " #expr2,                           \
-                        "Expected %p, got %p", val1, val2);            \
+                        "Expected %p, got %p", _val1, _val2);          \
                return CMD_RET_FAILURE;                                 \
        }                                                               \
 }
 
 /* Assert that a pointer is NULL */
 #define ut_assertnull(expr) {                                  \
-       const void *val = (expr);                                       \
+       const void *_val = (expr);                                      \
                                                                        \
-       if (val != NULL) {                                              \
+       if (_val) {                                             \
                ut_failf(uts, __FILE__, __LINE__, __func__,             \
                         #expr " != NULL",                              \
-                        "Expected NULL, got %p", val);         \
+                        "Expected NULL, got %p", _val);                \
                return CMD_RET_FAILURE;                                 \
        }                                                               \
 }
 
 /* Assert that a pointer is not NULL */
 #define ut_assertnonnull(expr) {                                       \
-       const void *val = (expr);                                       \
+       const void *_val = (expr);                                      \
                                                                        \
-       if (val == NULL) {                                              \
+       if (!_val) {                                            \
                ut_failf(uts, __FILE__, __LINE__, __func__,             \
                         #expr " = NULL",                               \
                         "Expected non-null, got NULL");                \
@@ -135,13 +190,13 @@ void ut_failf(struct unit_test_state *uts, const char *fname, int line,
 
 /* Assert that a pointer is not an error pointer */
 #define ut_assertok_ptr(expr) {                                                \
-       const void *val = (expr);                                       \
+       const void *_val = (expr);                                      \
                                                                        \
-       if (IS_ERR(val)) {                                              \
+       if (IS_ERR(_val)) {                                             \
                ut_failf(uts, __FILE__, __LINE__, __func__,             \
                         #expr " = NULL",                               \
                         "Expected pointer, got error %ld",             \
-                        PTR_ERR(val));                                 \
+                        PTR_ERR(_val));                                \
                return CMD_RET_FAILURE;                                 \
        }                                                               \
 }
@@ -149,4 +204,48 @@ void ut_failf(struct unit_test_state *uts, const char *fname, int line,
 /* 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