src/testing.h

   1 /**
   2  * collectd - src/tests/macros.h
   3  * Copyright (C) 2013-2015  Florian octo Forster
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *   Florian octo Forster <octo at collectd.org>
  25  */
  26
  27 #ifndef TESTING_H
  28 #define TESTING_H 1
  29
  30 #include <inttypes.h>
  31
  32 static int fail_count__;
  33 static int check_count__;
  34
  35 #ifndef DBL_PRECISION
  36 #define DBL_PRECISION 1e-12
  37 #endif
  38
  39 #define DEF_TEST(func) static int test_##func(void)
  40
  41 #define RUN_TEST(func)                                                         \
  42   do {                                                                         \
  43     int status;                                                                \
  44     printf("Testing %s ...\n", #func);                                         \
  45     status = test_##func();                                                    \
  46     printf("%s.\n", (status == 0) ? "Success" : "FAILURE");                    \
  47     if (status != 0) {                                                         \
  48       fail_count__++;                                                          \
  49     }                                                                          \
  50   } while (0)
  51
  52 #define END_TEST exit((fail_count__ == 0) ? 0 : 1);
  53
  54 #define LOG(result, text)                                                      \
  55   printf("%s %i - %s\n", result ? "ok" : "not ok", ++check_count__, text)
  56
  57 #define OK1(cond, text)                                                        \
  58   do {                                                                         \
  59     bool result = (cond);                                                      \
  60     LOG(result, text);                                                         \
  61     if (!result) {                                                             \
  62       return -1;                                                               \
  63     }                                                                          \
  64   } while (0)
  65 #define OK(cond) OK1(cond, #cond)
  66
  67 #define EXPECT_EQ_STR(expect, actual)                                          \
  68   do {                                                                         \
  69     /* Evaluate 'actual' only once. */                                         \
  70     const char *got__ = actual;                                                \
  71     if (strcmp(expect, got__) != 0) {                                          \
  72       printf("not ok %i - %s = \"%s\", want \"%s\"\n", ++check_count__,        \
  73              #actual, got__, expect);                                          \
  74       return -1;                                                               \
  75     }                                                                          \
  76     printf("ok %i - %s = \"%s\"\n", ++check_count__, #actual, got__);          \
  77   } while (0)
  78
  79 #define EXPECT_EQ_INT(expect, actual)                                          \
  80   do {                                                                         \
  81     int want__ = (int)expect;                                                  \
  82     int got__ = (int)actual;                                                   \
  83     if (got__ != want__) {                                                     \
  84       printf("not ok %i - %s = %d, want %d\n", ++check_count__, #actual,       \
  85              got__, want__);                                                   \
  86       return -1;                                                               \
  87     }                                                                          \
  88     printf("ok %i - %s = %d\n", ++check_count__, #actual, got__);              \
  89   } while (0)
  90
  91 #define EXPECT_EQ_UINT64(expect, actual)                                       \
  92   do {                                                                         \
  93     uint64_t want__ = (uint64_t)expect;                                        \
  94     uint64_t got__ = (uint64_t)actual;                                         \
  95     if (got__ != want__) {                                                     \
  96       printf("not ok %i - %s = %" PRIu64 ", want %" PRIu64 "\n",               \
  97              ++check_count__, #actual, got__, want__);                         \
  98       return -1;                                                               \
  99     }                                                                          \
 100     printf("ok %i - %s = %" PRIu64 "\n", ++check_count__, #actual, got__);     \
 101   } while (0)
 102
 103 #define EXPECT_EQ_PTR(expect, actual)                                          \
 104   do {                                                                         \
 105     void *want__ = expect;                                                     \
 106     void *got__ = actual;                                                      \
 107     if (got__ != want__) {                                                     \
 108       printf("not ok %i - %s = %p, want %p\n", ++check_count__, #actual,       \
 109              got__, want__);                                                   \
 110       return -1;                                                               \
 111     }                                                                          \
 112     printf("ok %i - %s = %p\n", ++check_count__, #actual, got__);              \
 113   } while (0)
 114
 115 #define EXPECT_EQ_DOUBLE(expect, actual)                                       \
 116   do {                                                                         \
 117     double want__ = (double)expect;                                            \
 118     double got__ = (double)actual;                                             \
 119     if ((isnan(want__) && !isnan(got__)) ||                                    \
 120         (!isnan(want__) && isnan(got__))) {                                    \
 121       printf("not ok %i - %s = %.15g, want %.15g\n", ++check_count__, #actual, \
 122              got__, want__);                                                   \
 123       return -1;                                                               \
 124     } else if (!isnan(want__) && (((want__ - got__) < -DBL_PRECISION) ||       \
 125                                   ((want__ - got__) > DBL_PRECISION))) {       \
 126       printf("not ok %i - %s = %.15g, want %.15g\n", ++check_count__, #actual, \
 127              got__, want__);                                                   \
 128       return -1;                                                               \
 129     }                                                                          \
 130     printf("ok %i - %s = %.15g\n", ++check_count__, #actual, got__);           \
 131   } while (0)
 132
 133 #define CHECK_NOT_NULL(expr)                                                   \
 134   do {                                                                         \
 135     void *ptr_;                                                                \
 136     ptr_ = (expr);                                                             \
 137     OK1(ptr_ != NULL, #expr);                                                  \
 138   } while (0)
 139
 140 #define CHECK_ZERO(expr)                                                       \
 141   do {                                                                         \
 142     long status_;                                                              \
 143     status_ = (long)(expr);                                                    \
 144     OK1(status_ == 0L, #expr);                                                 \
 145   } while (0)
 146
 147 #endif /* TESTING_H */