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