Made the memcached_string stuff private, but still testable.
[m6w6/libmemcached] / 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 /* This is called a the beginning of any collection run. */
86 test_callback_fn collection_startup;
87
88 /* This called on a test if the test requires a flush call (the bool is from test_st) */
89 test_callback_fn flush;
90
91 /**
92 These are run before/after the test. If implemented. Their execution is not controlled
93 by the test.
94 */
95 test_callback_fn pre_run;
96 test_callback_fn post_run;
97
98 /**
99 If an error occurs during the test, this is called.
100 */
101 test_callback_error_fn on_error;
102
103 /**
104 Runner represents the callers for the tests. If not implemented we will use
105 a set of default implementations.
106 */
107 world_runner_st *runner;
108 };
109
110
111
112 /**
113 @note world_stats_st is a simple structure for tracking test successes.
114 */
115 typedef struct {
116 uint32_t success;
117 uint32_t skipped;
118 uint32_t failed;
119 uint32_t total;
120 } world_stats_st;
121
122 /* How we make all of this work :) */
123 void get_world(world_st *world);
124
125 void create_core(void);
126
127 /**
128 @note Friendly print function for errors.
129 */
130 const char *test_strerror(test_return_t code);
131
132 #define test_truth(A) \
133 do \
134 { \
135 if (! (A)) { \
136 fprintf(stderr, "\nAssertion failed in %s:%d: %s\n", __FILE__, __LINE__, #A);\
137 create_core(); \
138 return TEST_FAILURE; \
139 } \
140 } while (0)
141
142 #define test_false(A) \
143 do \
144 { \
145 if ((A)) { \
146 fprintf(stderr, "\nAssertion failed in %s:%d: %s\n", __FILE__, __LINE__, #A);\
147 create_core(); \
148 return TEST_FAILURE; \
149 } \
150 } while (0)
151
152 #define test_strcmp(A,B) \
153 do \
154 { \
155 if (strcmp((A), (B))) \
156 { \
157 fprintf(stderr, "\n%s:%d: %s -> %s\n", __FILE__, __LINE__, (A), (B)); \
158 create_core(); \
159 return TEST_FAILURE; \
160 } \
161 } while (0)
162
163 #ifdef __cplusplus
164 }
165 #endif