app/test/test.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _TEST_H_
  35 #define _TEST_H_
  36
  37 #include <sys/queue.h>
  38
  39 #define TEST_ASSERT(cond, msg, ...) do {                                                \
  40                 if (!(cond)) {                                                                                  \
  41                         printf("TestCase %s() line %d failed: "                 \
  42                                 msg "\n", __func__, __LINE__, ##__VA_ARGS__);   \
  43                         return -1;                                                                                      \
  44                 }                                                                                                               \
  45 } while (0)
  46
  47 #define TEST_ASSERT_EQUAL(a, b, msg, ...)  {                                    \
  48                 if (!(a == b)) {                                                                                \
  49                         printf("TestCase %s() line %d failed: "                         \
  50                                 msg "\n", __func__, __LINE__, ##__VA_ARGS__);   \
  51                         return -1;                                                                                      \
  52                 }                                                                                                               \
  53 } while (0)
  54
  55 #define TEST_ASSERT_NOT_EQUAL(a, b, msg, ...) do {                              \
  56                 if (!(a != b)) {                                                                                \
  57                         printf("TestCase %s() line %d failed: "                 \
  58                                 msg "\n", __func__, __LINE__, ##__VA_ARGS__);   \
  59                         return -1;                                                                                      \
  60                 }                                                                                                               \
  61 } while (0)
  62
  63 #define TEST_ASSERT_SUCCESS(val, msg, ...) do {                                 \
  64                 if (!(val == 0)) {                                                                              \
  65                         printf("TestCase %s() line %d failed: "                 \
  66                                 msg "\n", __func__, __LINE__, ##__VA_ARGS__);   \
  67                         return -1;                                                                                      \
  68                 }                                                                                                               \
  69 } while (0)
  70
  71 #define TEST_ASSERT_FAIL(val, msg, ...) do {                                    \
  72                 if (!(val != -1)) {                                                                             \
  73                         printf("TestCase %s() line %d failed: "                 \
  74                                 msg "\n", __func__, __LINE__, ##__VA_ARGS__);   \
  75                         return -1;                                                                                      \
  76                 }                                                                                                               \
  77 } while (0)
  78
  79
  80 #define TEST_ASSERT_NULL(val, msg, ...) do {                                    \
  81                 if (!(val == NULL)) {                                                                   \
  82                         printf("TestCase %s() line %d failed: "                 \
  83                                 msg "\n", __func__, __LINE__, ##__VA_ARGS__);   \
  84                         return -1;                                                                                      \
  85                 }                                                                                                               \
  86 } while (0)
  87
  88 #define TEST_ASSERT_NOT_NULL(val, msg, ...) do {                                \
  89                 if (!(val != NULL)) {                                                                   \
  90                         printf("TestCase %s() line %d failed: "                 \
  91                                 msg "\n", __func__, __LINE__, ##__VA_ARGS__);   \
  92                         return -1;                                                                                      \
  93                 }                                                                                                               \
  94 } while (0)
  95
  96 struct unit_test_case {
  97         int (*setup)(void);
  98         int (*teardown)(void);
  99         int (*testcase)(void);
 100         const char *success_msg;
 101         const char *fail_msg;
 102 };
 103
 104 #define TEST_CASE(fn) { NULL, NULL, fn, #fn " succeeded", #fn " failed"}
 105
 106 #define TEST_CASE_ST(setup, teardown, testcase)                 \
 107                 { setup, teardown, testcase, #testcase " succeeded",    \
 108                 #testcase " failed "}
 109
 110 #define TEST_CASES_END() { NULL, NULL, NULL, NULL, NULL }
 111
 112 struct unit_test_suite {
 113         const char *suite_name;
 114         int (*setup)(void);
 115         int (*teardown)(void);
 116         struct unit_test_case unit_test_cases[];
 117 };
 118
 119 int unit_test_suite_runner(struct unit_test_suite *suite);
 120
 121 /* icc on baremetal gives us troubles with function named 'main' */
 122 #ifdef RTE_EXEC_ENV_BAREMETAL
 123 #define main _main
 124 #endif
 125
 126 #define RECURSIVE_ENV_VAR "RTE_TEST_RECURSIVE"
 127
 128 extern const char *prgname;
 129
 130 int commands_init(void);
 131
 132 int main(int argc, char **argv);
 133
 134 int test_pci(void);
 135 int test_pci_run;
 136
 137 int test_mp_secondary(void);
 138
 139 int test_ivshmem(void);
 140
 141 typedef int (test_callback)(void);
 142 TAILQ_HEAD(test_commands_list, test_command);
 143 struct test_command {
 144         TAILQ_ENTRY(test_command) next;
 145         const char *command;
 146         test_callback *callback;
 147 };
 148
 149 void add_test_command(struct test_command *t);
 150
 151 #define REGISTER_TEST_COMMAND(t) \
 152 static void testfn_##t(void);\
 153 void __attribute__((constructor, used)) testfn_##t(void)\
 154 {\
 155         add_test_command(&t);\
 156 }
 157
 158 #endif