include/ecoli_test.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2016, Olivier MATZ <zer0@droids-corp.org>
   3  */
   4
   5 /**
   6  * @defgroup test Test
   7  * @{
   8  *
   9  * @brief Helpers for unit tests
  10  */
  11
  12 #ifndef ECOLI_TEST_
  13 #define ECOLI_TEST_
  14
  15 #include <sys/queue.h>
  16
  17 #include <ecoli_log.h>
  18 #include <ecoli_utils.h>
  19
  20 struct ec_node;
  21 enum ec_comp_type;
  22
  23 #define EC_TEST_REGISTER(t)                                             \
  24         static void ec_test_init_##t(void);                             \
  25         static void __attribute__((constructor, used))                  \
  26         ec_test_init_##t(void)                                          \
  27         {                                                               \
  28                 if (ec_test_register(&t) < 0)                           \
  29                         fprintf(stderr, "cannot register test %s\n",    \
  30                                 t.name);                                \
  31         }
  32
  33 /**
  34  * Type of test function. Return 0 on success, -1 on error.
  35  */
  36 typedef int (ec_test_t)(void);
  37
  38 TAILQ_HEAD(ec_test_list, ec_test);
  39
  40 /**
  41  * A structure describing a test case.
  42  */
  43 struct ec_test {
  44         TAILQ_ENTRY(ec_test) next;  /**< Next in list. */
  45         const char *name;           /**< Test name. */
  46         ec_test_t *test;            /**< Test function. */
  47 };
  48
  49 /**
  50  * Register a test case.
  51  *
  52  * @param test
  53  *   A pointer to a ec_test structure describing the test
  54  *   to be registered.
  55  * @return
  56  *   0 on success, -1 on error (errno is set).
  57  */
  58 int ec_test_register(struct ec_test *test);
  59
  60 int ec_test_all(void);
  61 int ec_test_one(const char *name);
  62
  63 /* expected == -1 means no match */
  64 int ec_test_check_parse(struct ec_node *node, int expected, ...);
  65
  66 #define EC_TEST_ERR(fmt, ...)                                           \
  67         EC_LOG(EC_LOG_ERR, "%s:%d: error: " fmt "\n",                   \
  68                 __FILE__, __LINE__, ##__VA_ARGS__);                     \
  69
  70 #define EC_TEST_CHECK(cond, fmt, ...) ({                                \
  71         int ret_ = 0;                                                   \
  72         if (!(cond)) {                                                  \
  73                 EC_TEST_ERR("(" #cond ") is wrong. " fmt                \
  74                         ##__VA_ARGS__);                                 \
  75                 ret_ = -1;                                              \
  76         }                                                               \
  77         ret_;                                                           \
  78 })
  79
  80 /* node, input, [expected1, expected2, ...] */
  81 #define EC_TEST_CHECK_PARSE(node, args...) ({                           \
  82         int ret_ = ec_test_check_parse(node, args, EC_VA_END);  \
  83         if (ret_)                                                       \
  84                 EC_TEST_ERR("parse test failed");                       \
  85         ret_;                                                           \
  86 })
  87
  88 int ec_test_check_complete(struct ec_node *node,
  89                         enum ec_comp_type type, ...);
  90
  91 #define EC_TEST_CHECK_COMPLETE(node, args...) ({                        \
  92         int ret_ = ec_test_check_complete(node, EC_COMP_FULL, args);    \
  93         if (ret_)                                                       \
  94                 EC_TEST_ERR("complete test failed");                    \
  95         ret_;                                                           \
  96 })
  97
  98 #define EC_TEST_CHECK_COMPLETE_PARTIAL(node, args...) ({                \
  99         int ret_ = ec_test_check_complete(node, EC_COMP_PARTIAL, args); \
 100         if (ret_)                                                       \
 101                 EC_TEST_ERR("complete test failed");                    \
 102         ret_;                                                           \
 103 })
 104
 105 #endif
 106
 107 /** @} */