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_tk.h>
  35
  36 #define EC_REGISTER_TEST(t)                                             \
  37         static void ec_init_##t(void);                                  \
  38         static void __attribute__((constructor, used)) ec_init_##t(void) \
  39         {                                                               \
  40                  ec_test_register(&t);                                  \
  41         }
  42
  43 /**
  44  * Type of test function. Return 0 on success, -1 on error.
  45  */
  46 typedef int (ec_test_t)(void);
  47
  48 TAILQ_HEAD(ec_test_list, ec_test);
  49
  50 /**
  51  * A structure describing a test case.
  52  */
  53 struct ec_test {
  54         TAILQ_ENTRY(ec_test) next;  /**< Next in list. */
  55         const char *name;           /**< Test name. */
  56         ec_test_t *test;            /**< Test function. */
  57 };
  58
  59 /**
  60  * Register a test case.
  61  *
  62  * @param test
  63  *   A pointer to a ec_test structure describing the test
  64  *   to be registered.
  65  */
  66 void ec_test_register(struct ec_test *test);
  67
  68 int ec_test_all(void);
  69
  70 /* expected == -1 means no match */
  71 int ec_test_check_tk_parse(const struct ec_tk *tk, int expected, ...);
  72
  73 #define EC_TEST_ERR(fmt, ...)                                           \
  74         ec_log(EC_LOG_ERR, "%s:%d: error: " fmt "\n",                   \
  75                 __FILE__, __LINE__, ##__VA_ARGS__);                     \
  76
  77 #define EC_TEST_ASSERT(cond, args...)                                   \
  78         do {                                                            \
  79                 if (!(cond))                                            \
  80                         EC_TEST_ERR("assertion failure: " #cond);       \
  81         } while (0)
  82
  83 #define EC_TEST_CHECK_TK_PARSE(tk, input, expected...) ({               \
  84         int ret_ = ec_test_check_tk_parse(tk, input, expected);         \
  85         if (ret_)                                                       \
  86                 EC_TEST_ERR("parse test failed");                       \
  87         ret_;                                                           \
  88 })
  89
  90 int ec_test_check_tk_complete(const struct ec_tk *tk, ...);
  91
  92 #define EC_TEST_CHECK_TK_COMPLETE(tk, args...) ({                       \
  93         int ret_ = ec_test_check_tk_complete(tk, args);                 \
  94         if (ret_)                                                       \
  95                 EC_TEST_ERR("complete test failed");                    \
  96         ret_;                                                           \
  97 })
  98
  99 #endif