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