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