git.m6w6.name Git - m6w6/libmemcached/blob - tests/test.h

   1 /* uTest
   2  * Copyright (C) 2006-2009 Brian Aker
   3  * All rights reserved.
   4  *
   5  * Use and distribution licensed under the BSD license.  See
   6  * the COPYING file in the parent directory for full text.
   7  */
   8
   9 /*
  10   Structures for generic tests.
  11 */
  12
  13 #ifdef  __cplusplus
  14 extern "C" {
  15 #endif
  16
  17 #include <stdio.h>
  18 #include <stdlib.h>
  19 #include <stdbool.h>
  20 #include <stdint.h>
  21
  22 typedef struct world_st world_st;
  23 typedef struct collection_st collection_st;
  24 typedef struct test_st test_st;
  25
  26 typedef enum {
  27   TEST_SUCCESS= 0, /* Backwards compatibility */
  28   TEST_FAILURE,
  29   TEST_MEMORY_ALLOCATION_FAILURE,
  30   TEST_SKIPPED,
  31   TEST_MAXIMUM_RETURN /* Always add new error code before */
  32 } test_return_t;
  33
  34 typedef void *(*test_callback_create_fn)(test_return_t *error);
  35 typedef test_return_t (*test_callback_fn)(void *);
  36 typedef test_return_t (*test_callback_runner_fn)(test_callback_fn, void *);
  37 typedef test_return_t (*test_callback_error_fn)(test_return_t, void *);
  38
  39
  40 /**
  41   A structure describing the test case.
  42 */
  43 struct test_st {
  44   const char *name;
  45   bool requires_flush;
  46   test_callback_fn test_fn;
  47 };
  48
  49
  50 /**
  51   A structure which describes a collection of test cases.
  52 */
  53 struct collection_st {
  54   const char *name;
  55   test_callback_fn pre;
  56   test_callback_fn post;
  57   test_st *tests;
  58 };
  59
  60
  61 /**
  62   Structure which houses the actual callers for the test cases contained in
  63   the collections.
  64 */
  65 typedef struct {
  66   test_callback_runner_fn pre;
  67   test_callback_runner_fn run;
  68   test_callback_runner_fn post;
  69 } world_runner_st;
  70
  71
  72 /**
  73   world_st is the structure which is passed to the test implementation to be filled.
  74   This must be implemented in order for the test framework to load the tests. We call
  75   get_world() in order to fill this structure.
  76 */
  77
  78 struct world_st {
  79   collection_st *collections;
  80
  81   /* These methods are called outside of any collection call. */
  82   test_callback_create_fn create;
  83   test_callback_fn destroy;
  84
  85   struct {
  86     /* This is called a the beginning of any test run. */
  87     test_callback_fn startup;
  88
  89     /* This called on a test if the test requires a flush call (the bool is from test_st) */
  90     test_callback_fn flush;
  91
  92     /**
  93       These are run before/after the test. If implemented. Their execution is not controlled
  94       by the test.
  95     */
  96     test_callback_fn pre_run;
  97     test_callback_fn post_run;
  98
  99     /**
 100       If an error occurs during the test, this is called.
 101     */
 102     test_callback_error_fn on_error;
 103   } test;
 104
 105   struct {
 106     /* This is called a the beginning of any collection run. */
 107     test_callback_fn startup;
 108
 109     /* This is called at the end of any collection run. */
 110     test_callback_fn shutdown;
 111   } collection;
 112
 113
 114   /**
 115     Runner represents the callers for the tests. If not implemented we will use
 116     a set of default implementations.
 117   */
 118   world_runner_st *runner;
 119 };
 120
 121
 122
 123 /**
 124   @note world_stats_st is a simple structure for tracking test successes.
 125 */
 126 typedef struct {
 127   uint32_t collection_success;
 128   uint32_t collection_skipped;
 129   uint32_t collection_failed;
 130   uint32_t collection_total;
 131   uint32_t success;
 132   uint32_t skipped;
 133   uint32_t failed;
 134   uint32_t total;
 135 } world_stats_st;
 136
 137 /* How we make all of this work :) */
 138 void get_world(world_st *world);
 139
 140 void create_core(void);
 141
 142 /**
 143   @note Friendly print function for errors.
 144 */
 145 const char *test_strerror(test_return_t code);
 146
 147 #define test_truth(A) \
 148 do \
 149 { \
 150   if (! (A)) { \
 151     fprintf(stderr, "\nAssertion failed in %s:%d: %s\n", __FILE__, __LINE__, #A);\
 152     create_core(); \
 153     return TEST_FAILURE; \
 154   } \
 155 } while (0)
 156
 157 #define test_false(A) \
 158 do \
 159 { \
 160   if ((A)) { \
 161     fprintf(stderr, "\nAssertion failed in %s:%d: %s\n", __FILE__, __LINE__, #A);\
 162     create_core(); \
 163     return TEST_FAILURE; \
 164   } \
 165 } while (0)
 166
 167 #define test_strcmp(A,B) \
 168 do \
 169 { \
 170   if (strcmp((A), (B))) \
 171   { \
 172     fprintf(stderr, "\n%s:%d: %s -> %s\n", __FILE__, __LINE__, (A), (B)); \
 173     create_core(); \
 174     return TEST_FAILURE; \
 175   } \
 176 } while (0)
 177
 178 #ifdef  __cplusplus
 179 }
 180 #endif