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