Split all mem_function out so that we can reuse the bulk of the tests at will.
[m6w6/libmemcached] / tests / libmemcached_world.h
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * Libmemcached Client and Server
4 *
5 * Copyright (C) 2012 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2006-2009 Brian Aker
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are
11 * met:
12 *
13 * * Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * * Redistributions in binary form must reproduce the above
17 * copyright notice, this list of conditions and the following disclaimer
18 * in the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * * The names of its contributors may not be used to endorse or
22 * promote products derived from this software without specific prior
23 * written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 */
38
39
40 #pragma once
41
42 #include <cassert>
43
44 /* The structure we use for the test system */
45 struct libmemcached_test_container_st
46 {
47 libtest::server_startup_st& construct;
48 memcached_st *parent;
49 memcached_st *memc;
50
51 libmemcached_test_container_st(libtest::server_startup_st &construct_arg) :
52 construct(construct_arg),
53 parent(NULL),
54 memc(NULL)
55 { }
56 };
57
58 static void *world_create(libtest::server_startup_st& servers, test_return_t& error)
59 {
60 if (HAVE_MEMCACHED_BINARY == 0)
61 {
62 error= TEST_SKIPPED;
63 return NULL;
64 }
65
66 if (servers.sasl() and (LIBMEMCACHED_WITH_SASL_SUPPORT == 0 or MEMCACHED_SASL_BINARY == 0))
67 {
68 error= TEST_SKIPPED;
69 return NULL;
70 }
71
72 // Assume we are running under valgrind, and bail
73 if (servers.sasl() and getenv("TESTS_ENVIRONMENT"))
74 {
75 error= TEST_SKIPPED;
76 return NULL;
77 }
78
79 in_port_t max_port= TEST_PORT_BASE;
80 for (uint32_t x= 0; x < servers.count(); x++)
81 {
82 in_port_t port;
83
84 char variable_buffer[1024];
85 snprintf(variable_buffer, sizeof(variable_buffer), "LIBMEMCACHED_PORT_%u", x);
86
87 char *var;
88 if ((var= getenv(variable_buffer)))
89 {
90 port= in_port_t(atoi(var));
91 }
92 else
93 {
94 port= in_port_t(TEST_PORT_BASE +x);
95 }
96
97 max_port= port;
98 const char *argv[1]= { "memcached" };
99 if (servers.sasl())
100 {
101 if (not server_startup(servers, "memcached-sasl", port, 1, argv))
102 {
103 error= TEST_FATAL;
104 return NULL;
105 }
106 }
107 else
108 {
109 if (not server_startup(servers, "memcached", port, 1, argv))
110 {
111 error= TEST_FATAL;
112 return NULL;
113 }
114 }
115 }
116
117 if (servers.socket())
118 {
119 if (servers.sasl())
120 {
121 const char *argv[1]= { "memcached" };
122 if (not servers.start_socket_server("memcached-sasl", max_port +1, 1, argv))
123 {
124 error= TEST_FATAL;
125 return NULL;
126 }
127 }
128 else
129 {
130 const char *argv[1]= { "memcached" };
131 if (not servers.start_socket_server("memcached", max_port +1, 1, argv))
132 {
133 error= TEST_FATAL;
134 return NULL;
135 }
136 }
137 }
138
139
140 libmemcached_test_container_st *global_container= new libmemcached_test_container_st(servers);
141 if (global_container == NULL)
142 {
143 error= TEST_MEMORY_ALLOCATION_FAILURE;
144 return NULL;
145 }
146
147 error= TEST_SUCCESS;
148
149 return global_container;
150 }
151
152 static test_return_t world_container_startup(libmemcached_test_container_st *container)
153 {
154 char buffer[BUFSIZ];
155
156 test_compare_got(MEMCACHED_SUCCESS,
157 libmemcached_check_configuration(container->construct.option_string().c_str(), container->construct.option_string().size(),
158 buffer, sizeof(buffer)),
159 container->construct.option_string().c_str());
160
161 test_null(container->parent);
162 container->parent= memcached(container->construct.option_string().c_str(), container->construct.option_string().size());
163 test_true(container->parent);
164 test_compare(MEMCACHED_SUCCESS, memcached_version(container->parent));
165
166 if (container->construct.sasl())
167 {
168 if (memcached_failed(memcached_behavior_set(container->parent, MEMCACHED_BEHAVIOR_BINARY_PROTOCOL, 1)))
169 {
170 memcached_free(container->parent);
171 return TEST_FAILURE;
172 }
173
174 if (memcached_failed(memcached_set_sasl_auth_data(container->parent, container->construct.username().c_str(), container->construct.password().c_str())))
175 {
176 memcached_free(container->parent);
177 return TEST_FAILURE;
178 }
179 }
180
181 for (uint32_t host= 0; host < memcached_server_count(container->parent); ++host)
182 {
183 memcached_server_instance_st instance=
184 memcached_server_instance_by_position(container->parent, host);
185
186 if (instance->type == MEMCACHED_CONNECTION_TCP)
187 {
188 test_true_got(memcached_server_port(instance) >= TEST_PORT_BASE, memcached_server_port(instance));
189 }
190 }
191
192 return TEST_SUCCESS;
193 }
194
195 static test_return_t world_container_shutdown(libmemcached_test_container_st *container)
196 {
197 memcached_free(container->parent);
198 container->parent= NULL;
199
200 return TEST_SUCCESS;
201 }
202
203 static test_return_t world_test_startup(libmemcached_test_container_st *container)
204 {
205 test_true(container);
206 test_null(container->memc);
207 test_true(container->parent);
208 container->memc= memcached_clone(NULL, container->parent);
209 test_true(container->memc);
210
211 return TEST_SUCCESS;
212 }
213
214 test_return_t world_flush(libmemcached_test_container_st *container);
215 test_return_t world_flush(libmemcached_test_container_st *container)
216 {
217 test_true(container->memc);
218 memcached_flush(container->memc, 0);
219 memcached_quit(container->memc);
220
221 return TEST_SUCCESS;
222 }
223
224 static test_return_t world_pre_run(libmemcached_test_container_st *container)
225 {
226 test_true(container->memc);
227 for (uint32_t loop= 0; loop < memcached_server_list_count(container->memc->servers); loop++)
228 {
229 memcached_server_instance_st instance=
230 memcached_server_instance_by_position(container->memc, loop);
231
232 test_compare(-1, instance->fd);
233 test_compare(0U, instance->cursor_active);
234 }
235
236 return TEST_SUCCESS;
237 }
238
239
240 static test_return_t world_post_run(libmemcached_test_container_st *container)
241 {
242 test_true(container->memc);
243
244 return TEST_SUCCESS;
245 }
246
247 static test_return_t world_on_error(test_return_t , libmemcached_test_container_st *container)
248 {
249 test_true(container->memc);
250 memcached_free(container->memc);
251 container->memc= NULL;
252
253 return TEST_SUCCESS;
254 }
255
256 static bool world_destroy(void *object)
257 {
258 libmemcached_test_container_st *container= (libmemcached_test_container_st *)object;
259 #if defined(LIBMEMCACHED_WITH_SASL_SUPPORT) && LIBMEMCACHED_WITH_SASL_SUPPORT
260 if (LIBMEMCACHED_WITH_SASL_SUPPORT)
261 {
262 sasl_done();
263 }
264 #endif
265
266 delete container;
267
268 return TEST_SUCCESS;
269 }
270
271 typedef test_return_t (*libmemcached_test_callback_fn)(memcached_st *);
272
273 static test_return_t _runner_default(libmemcached_test_callback_fn func, libmemcached_test_container_st *container)
274 {
275 if (func)
276 {
277 test_true(container);
278 test_true(container->memc);
279 test_return_t ret;
280 try {
281 ret= func(container->memc);
282 }
283 catch (std::exception& e)
284 {
285 libtest::Error << e.what();
286 return TEST_FAILURE;
287 }
288
289 return ret;
290 }
291
292 return TEST_SUCCESS;
293 }
294
295 static test_return_t _pre_runner_default(libmemcached_test_callback_fn func, libmemcached_test_container_st *container)
296 {
297 if (func)
298 {
299 return func(container->parent);
300 }
301
302 return TEST_SUCCESS;
303 }
304
305 static test_return_t _post_runner_default(libmemcached_test_callback_fn func, libmemcached_test_container_st *container)
306 {
307 if (func)
308 {
309 return func(container->parent);
310 }
311
312 return TEST_SUCCESS;
313 }
314
315 class LibmemcachedRunner : public libtest::Runner {
316 public:
317 test_return_t run(test_callback_fn* func, void *object)
318 {
319 return _runner_default(libmemcached_test_callback_fn(func), (libmemcached_test_container_st*)object);
320 }
321
322 test_return_t pre(test_callback_fn* func, void *object)
323 {
324 return _pre_runner_default(libmemcached_test_callback_fn(func), (libmemcached_test_container_st*)object);
325 }
326
327 test_return_t post(test_callback_fn* func, void *object)
328 {
329 return _post_runner_default(libmemcached_test_callback_fn(func), (libmemcached_test_container_st*)object);
330 }
331 };
332
333 static LibmemcachedRunner defualt_libmemcached_runner;