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