lib/ecoli_test.h

   1 /*
   2  * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of the University of California, Berkeley nor the
  13  *       names of its contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef ECOLI_TEST_
  29 #define ECOLI_TEST_
  30
  31 #include <sys/queue.h>
  32
  33 #include <ecoli_log.h>
  34
  35 struct ec_node;
  36 enum ec_completed_type;
  37
  38 #define EC_TEST_REGISTER(t)                                             \
  39         static void ec_test_init_##t(void);                             \
  40         static void __attribute__((constructor, used))                  \
  41         ec_test_init_##t(void)                                          \
  42         {                                                               \
  43                 if (ec_test_register(&t) < 0)                           \
  44                         fprintf(stderr, "cannot register test %s\n",    \
  45                                 t.name);                                \
  46         }
  47
  48 /**
  49  * Type of test function. Return 0 on success, -1 on error.
  50  */
  51 typedef int (ec_test_t)(void);
  52
  53 TAILQ_HEAD(ec_test_list, ec_test);
  54
  55 /**
  56  * A structure describing a test case.
  57  */
  58 struct ec_test {
  59         TAILQ_ENTRY(ec_test) next;  /**< Next in list. */
  60         const char *name;           /**< Test name. */
  61         ec_test_t *test;            /**< Test function. */
  62 };
  63
  64 /**
  65  * Register a test case.
  66  *
  67  * @param test
  68  *   A pointer to a ec_test structure describing the test
  69  *   to be registered.
  70  * @return
  71  *   0 on success, -1 on error (errno is set).
  72  */
  73 int ec_test_register(struct ec_test *test);
  74
  75 int ec_test_all(void);
  76 int ec_test_one(const char *name);
  77
  78 /* expected == -1 means no match */
  79 int ec_test_check_parse(struct ec_node *node, int expected, ...);
  80
  81 #define EC_TEST_ERR(fmt, ...)                                           \
  82         EC_LOG(EC_LOG_ERR, "%s:%d: error: " fmt "\n",                   \
  83                 __FILE__, __LINE__, ##__VA_ARGS__);                     \
  84
  85 #define EC_TEST_CHECK(cond, fmt, ...) ({                                \
  86         int ret_ = 0;                                                   \
  87         if (!(cond)) {                                                  \
  88                 EC_TEST_ERR("(" #cond ") is wrong. "                    \
  89                         ##__VA_ARGS__);                                 \
  90                 ret_ = -1;                                              \
  91         }                                                               \
  92         ret_;                                                           \
  93 })
  94
  95 /* node, input, [expected1, expected2, ...] */
  96 #define EC_TEST_CHECK_PARSE(node, args...) ({                           \
  97         int ret_ = ec_test_check_parse(node, args, EC_NODE_ENDLIST);    \
  98         if (ret_)                                                       \
  99                 EC_TEST_ERR("parse test failed");                       \
 100         ret_;                                                           \
 101 })
 102
 103 int ec_test_check_complete(struct ec_node *node,
 104                         enum ec_completed_type type, ...);
 105
 106 #define EC_TEST_CHECK_COMPLETE(node, args...) ({                        \
 107         int ret_ = ec_test_check_complete(node, EC_COMP_FULL, args);    \
 108         if (ret_)                                                       \
 109                 EC_TEST_ERR("complete test failed");                    \
 110         ret_;                                                           \
 111 })
 112
 113 #define EC_TEST_CHECK_COMPLETE_PARTIAL(node, args...) ({                \
 114         int ret_ = ec_test_check_complete(node, EC_COMP_PARTIAL, args); \
 115         if (ret_)                                                       \
 116                 EC_TEST_ERR("complete test failed");                    \
 117         ret_;                                                           \
 118 })
 119
 120 #endif