1 /* libMemcached Functions Test
2 * Copyright (C) 2006-2009 Brian Aker
5 * Use and distribution licensed under the BSD license. See
6 * the COPYING file in the parent directory for full text.
10 Sample test application.
15 #include "libmemcached/common.h"
23 #include <sys/types.h>
29 #include <libtest/server.h>
30 #include <libtest/test.h>
32 #define SERVERS_TO_CREATE 5
34 #ifndef __INTEL_COMPILER
35 #pragma GCC diagnostic ignored "-Wstrict-aliasing"
39 @note This should be testing to see if the server really supports the binary protocol.
41 static test_return_t
pre_binary(memcached_st
*memc
)
43 memcached_return_t rc
= MEMCACHED_FAILURE
;
44 memcached_st
*memc_clone
;
45 memcached_server_instance_st instance
;
47 memc_clone
= memcached_clone(NULL
, memc
);
48 test_true(memc_clone
);
49 // The memcached_version needs to be done on a clone, because the server
50 // will not toggle protocol on an connection.
51 memcached_version(memc_clone
);
53 instance
= memcached_server_instance_by_position(memc_clone
, 0);
55 if (instance
->major_version
>= 1 && instance
->minor_version
> 2)
57 rc
= memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
, 1);
58 test_true(rc
== MEMCACHED_SUCCESS
);
59 test_true(memcached_behavior_get(memc
, MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
) == 1);
62 memcached_free(memc_clone
);
64 return rc
== MEMCACHED_SUCCESS
? TEST_SUCCESS
: TEST_SKIPPED
;
67 static void increment_request_id(uint16_t *id
)
70 if ((*id
& UDP_REQUEST_ID_THREAD_MASK
) != 0)
74 static uint16_t *get_udp_request_ids(memcached_st
*memc
)
76 uint16_t *ids
= (uint16_t*)malloc(sizeof(uint16_t) * memcached_server_count(memc
));
79 for (uint32_t x
= 0; x
< memcached_server_count(memc
); x
++)
81 memcached_server_instance_st instance
=
82 memcached_server_instance_by_position(memc
, x
);
84 ids
[x
]= get_udp_datagram_request_id((struct udp_datagram_header_st
*) ((memcached_server_instance_st
)instance
)->write_buffer
);
90 static test_return_t
post_udp_op_check(memcached_st
*memc
, uint16_t *expected_req_ids
)
93 (void)expected_req_ids
;
95 memcached_server_st
*cur_server
= memcached_server_list(memc
);
96 uint16_t *cur_req_ids
= get_udp_request_ids(memc
);
98 for (size_t x
= 0; x
< memcached_server_count(memc
); x
++)
100 test_true(cur_server
[x
].cursor_active
== 0);
101 test_true(cur_req_ids
[x
] == expected_req_ids
[x
]);
103 free(expected_req_ids
);
111 ** There is a little bit of a hack here, instead of removing
112 ** the servers, I just set num host to 0 and them add then new udp servers
114 static test_return_t
init_udp(memcached_st
*memc
)
116 memcached_version(memc
);
118 memcached_server_instance_st instance
=
119 memcached_server_instance_by_position(memc
, 0);
121 /* For the time being, only support udp test for >= 1.2.6 && < 1.3 */
122 if (instance
->major_version
!= 1 || instance
->minor_version
!= 2
123 || instance
->micro_version
< 6)
126 uint32_t num_hosts
= memcached_server_count(memc
);
127 memcached_server_st servers
[num_hosts
];
128 memcpy(servers
, memcached_server_list(memc
), sizeof(memcached_server_st
) * num_hosts
);
129 for (uint32_t x
= 0; x
< num_hosts
; x
++)
131 memcached_server_instance_st set_instance
=
132 memcached_server_instance_by_position(memc
, x
);
134 memcached_server_free(((memcached_server_write_instance_st
)set_instance
));
137 memc
->number_of_hosts
= 0;
138 memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_USE_UDP
, 1);
139 for (uint32_t x
= 0; x
< num_hosts
; x
++)
141 memcached_server_instance_st set_instance
=
142 memcached_server_instance_by_position(memc
, x
);
144 test_true(memcached_server_add_udp(memc
, servers
[x
].hostname
, servers
[x
].port
) == MEMCACHED_SUCCESS
);
145 test_true(set_instance
->write_buffer_offset
== UDP_DATAGRAM_HEADER_LENGTH
);
152 static test_return_t
binary_init_udp(memcached_st
*memc
)
154 test_return_t test_rc
;
155 test_rc
= pre_binary(memc
);
157 if (test_rc
!= TEST_SUCCESS
)
160 return init_udp(memc
);
163 /* Make sure that I cant add a tcp server to a udp client */
164 static test_return_t
add_tcp_server_udp_client_test(memcached_st
*memc
)
168 memcached_server_st server
;
169 memcached_server_instance_st instance
=
170 memcached_server_instance_by_position(memc
, 0);
171 memcached_server_clone(&server
, &memc
->hosts
[0]);
172 test_true(memcached_server_remove(&(memc
->hosts
[0])) == MEMCACHED_SUCCESS
);
173 test_true(memcached_server_add(memc
, server
.hostname
, server
.port
) == MEMCACHED_INVALID_HOST_PROTOCOL
);
178 /* Make sure that I cant add a udp server to a tcp client */
179 static test_return_t
add_udp_server_tcp_client_test(memcached_st
*memc
)
183 memcached_server_st server
;
184 memcached_server_instance_st instance
=
185 memcached_server_instance_by_position(memc
, 0);
186 memcached_server_clone(&server
, &memc
->hosts
[0]);
187 test_true(memcached_server_remove(&(memc
->hosts
[0])) == MEMCACHED_SUCCESS
);
189 memcached_st tcp_client
;
190 memcached_create(&tcp_client
);
191 test_true(memcached_server_add_udp(&tcp_client
, server
.hostname
, server
.port
) == MEMCACHED_INVALID_HOST_PROTOCOL
);
197 static test_return_t
set_udp_behavior_test(memcached_st
*memc
)
200 memcached_quit(memc
);
201 memc
->number_of_hosts
= 0;
202 memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_DISTRIBUTION
, memc
->distribution
);
203 test_true(memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_USE_UDP
, 1) == MEMCACHED_SUCCESS
);
204 test_true(memc
->flags
.use_udp
);
205 test_true(memc
->flags
.no_reply
);
207 test_true(memcached_server_count(memc
) == 0);
209 memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_USE_UDP
,0);
210 test_true(! (memc
->flags
.use_udp
));
211 memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_NOREPLY
,0);
212 test_true(! (memc
->flags
.no_reply
));
217 static test_return_t
udp_set_test(memcached_st
*memc
)
219 unsigned int num_iters
= 1025; //request id rolls over at 1024
221 for (size_t x
= 0; x
< num_iters
;x
++)
223 memcached_return_t rc
;
224 const char *key
= "foo";
225 const char *value
= "when we sanitize";
226 uint16_t *expected_ids
= get_udp_request_ids(memc
);
227 unsigned int server_key
= memcached_generate_hash(memc
, key
, strlen(key
));
228 memcached_server_instance_st instance
=
229 memcached_server_instance_by_position(memc
, server_key
);
230 size_t init_offset
= instance
->write_buffer_offset
;
232 rc
= memcached_set(memc
, key
, strlen(key
),
233 value
, strlen(value
),
234 (time_t)0, (uint32_t)0);
235 test_true(rc
== MEMCACHED_SUCCESS
|| rc
== MEMCACHED_BUFFERED
);
236 /** NB, the check below assumes that if new write_ptr is less than
237 * the original write_ptr that we have flushed. For large payloads, this
238 * maybe an invalid assumption, but for the small payload we have it is OK
240 if (rc
== MEMCACHED_SUCCESS
||
241 instance
->write_buffer_offset
< init_offset
)
242 increment_request_id(&expected_ids
[server_key
]);
244 if (rc
== MEMCACHED_SUCCESS
)
246 test_true(instance
->write_buffer_offset
== UDP_DATAGRAM_HEADER_LENGTH
);
250 test_true(instance
->write_buffer_offset
!= UDP_DATAGRAM_HEADER_LENGTH
);
251 test_true(instance
->write_buffer_offset
<= MAX_UDP_DATAGRAM_LENGTH
);
253 test_true(post_udp_op_check(memc
, expected_ids
) == TEST_SUCCESS
);
258 static test_return_t
udp_buffered_set_test(memcached_st
*memc
)
260 memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
, 1);
261 return udp_set_test(memc
);
264 static test_return_t
udp_set_too_big_test(memcached_st
*memc
)
266 memcached_return_t rc
;
267 const char *key
= "bar";
268 char value
[MAX_UDP_DATAGRAM_LENGTH
];
269 uint16_t *expected_ids
= get_udp_request_ids(memc
);
270 rc
= memcached_set(memc
, key
, strlen(key
),
271 value
, MAX_UDP_DATAGRAM_LENGTH
,
272 (time_t)0, (uint32_t)0);
273 test_true(rc
== MEMCACHED_WRITE_FAILURE
);
275 return post_udp_op_check(memc
,expected_ids
);
278 static test_return_t
udp_delete_test(memcached_st
*memc
)
280 unsigned int num_iters
= 1025; //request id rolls over at 1024
282 for (size_t x
= 0; x
< num_iters
;x
++)
284 memcached_return_t rc
;
285 const char *key
= "foo";
286 uint16_t *expected_ids
=get_udp_request_ids(memc
);
287 unsigned int server_key
= memcached_generate_hash(memc
, key
, strlen(key
));
288 memcached_server_instance_st instance
=
289 memcached_server_instance_by_position(memc
, server_key
);
290 size_t init_offset
= instance
->write_buffer_offset
;
292 rc
= memcached_delete(memc
, key
, strlen(key
), 0);
293 test_true(rc
== MEMCACHED_SUCCESS
|| rc
== MEMCACHED_BUFFERED
);
295 if (rc
== MEMCACHED_SUCCESS
|| instance
->write_buffer_offset
< init_offset
)
296 increment_request_id(&expected_ids
[server_key
]);
297 if (rc
== MEMCACHED_SUCCESS
)
299 test_true(instance
->write_buffer_offset
== UDP_DATAGRAM_HEADER_LENGTH
);
303 test_true(instance
->write_buffer_offset
!= UDP_DATAGRAM_HEADER_LENGTH
);
304 test_true(instance
->write_buffer_offset
<= MAX_UDP_DATAGRAM_LENGTH
);
306 test_true(post_udp_op_check(memc
,expected_ids
) == TEST_SUCCESS
);
311 static test_return_t
udp_buffered_delete_test(memcached_st
*memc
)
313 memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
, 1);
314 return udp_delete_test(memc
);
317 static test_return_t
udp_verbosity_test(memcached_st
*memc
)
319 memcached_return_t rc
;
320 uint16_t *expected_ids
= get_udp_request_ids(memc
);
322 for (size_t x
= 0; x
< memcached_server_count(memc
); x
++)
324 increment_request_id(&expected_ids
[x
]);
327 rc
= memcached_verbosity(memc
,3);
328 test_true(rc
== MEMCACHED_SUCCESS
);
329 return post_udp_op_check(memc
,expected_ids
);
332 static test_return_t
udp_quit_test(memcached_st
*memc
)
334 uint16_t *expected_ids
= get_udp_request_ids(memc
);
335 memcached_quit(memc
);
336 return post_udp_op_check(memc
, expected_ids
);
339 static test_return_t
udp_flush_test(memcached_st
*memc
)
341 memcached_return_t rc
;
342 uint16_t *expected_ids
= get_udp_request_ids(memc
);
344 for (size_t x
= 0; x
< memcached_server_count(memc
); x
++)
346 increment_request_id(&expected_ids
[x
]);
349 rc
= memcached_flush(memc
,0);
350 test_true(rc
== MEMCACHED_SUCCESS
);
351 return post_udp_op_check(memc
,expected_ids
);
354 static test_return_t
udp_incr_test(memcached_st
*memc
)
356 memcached_return_t rc
;
357 const char *key
= "incr";
358 const char *value
= "1";
359 rc
= memcached_set(memc
, key
, strlen(key
),
360 value
, strlen(value
),
361 (time_t)0, (uint32_t)0);
363 test_true(rc
== MEMCACHED_SUCCESS
);
364 uint16_t *expected_ids
= get_udp_request_ids(memc
);
365 unsigned int server_key
= memcached_generate_hash(memc
, key
, strlen(key
));
366 increment_request_id(&expected_ids
[server_key
]);
368 rc
= memcached_increment(memc
, key
, strlen(key
), 1, &newvalue
);
369 test_true(rc
== MEMCACHED_SUCCESS
);
370 return post_udp_op_check(memc
, expected_ids
);
373 static test_return_t
udp_decr_test(memcached_st
*memc
)
375 memcached_return_t rc
;
376 const char *key
= "decr";
377 const char *value
= "1";
378 rc
= memcached_set(memc
, key
, strlen(key
),
379 value
, strlen(value
),
380 (time_t)0, (uint32_t)0);
382 test_true(rc
== MEMCACHED_SUCCESS
);
383 uint16_t *expected_ids
= get_udp_request_ids(memc
);
384 unsigned int server_key
= memcached_generate_hash(memc
, key
, strlen(key
));
385 increment_request_id(&expected_ids
[server_key
]);
387 rc
= memcached_decrement(memc
, key
, strlen(key
), 1, &newvalue
);
388 test_true(rc
== MEMCACHED_SUCCESS
);
389 return post_udp_op_check(memc
, expected_ids
);
393 static test_return_t
udp_stat_test(memcached_st
*memc
)
395 memcached_stat_st
* rv
= NULL
;
396 memcached_return_t rc
;
398 uint16_t *expected_ids
= get_udp_request_ids(memc
);
399 rv
= memcached_stat(memc
, args
, &rc
);
401 test_true(rc
== MEMCACHED_NOT_SUPPORTED
);
402 return post_udp_op_check(memc
, expected_ids
);
405 static test_return_t
udp_version_test(memcached_st
*memc
)
407 memcached_return_t rc
;
408 uint16_t *expected_ids
= get_udp_request_ids(memc
);
409 rc
= memcached_version(memc
);
410 test_true(rc
== MEMCACHED_NOT_SUPPORTED
);
411 return post_udp_op_check(memc
, expected_ids
);
414 static test_return_t
udp_get_test(memcached_st
*memc
)
416 memcached_return_t rc
;
417 const char *key
= "foo";
419 uint16_t *expected_ids
= get_udp_request_ids(memc
);
420 char *val
= memcached_get(memc
, key
, strlen(key
), &vlen
, (uint32_t)0, &rc
);
421 test_true(rc
== MEMCACHED_NOT_SUPPORTED
);
422 test_true(val
== NULL
);
423 return post_udp_op_check(memc
, expected_ids
);
426 static test_return_t
udp_mixed_io_test(memcached_st
*memc
)
429 test_st mixed_io_ops
[] ={
431 (test_callback_fn
*)udp_set_test
},
432 {"udp_set_too_big_test", 0,
433 (test_callback_fn
*)udp_set_too_big_test
},
434 {"udp_delete_test", 0,
435 (test_callback_fn
*)udp_delete_test
},
436 {"udp_verbosity_test", 0,
437 (test_callback_fn
*)udp_verbosity_test
},
439 (test_callback_fn
*)udp_quit_test
},
440 {"udp_flush_test", 0,
441 (test_callback_fn
*)udp_flush_test
},
443 (test_callback_fn
*)udp_incr_test
},
445 (test_callback_fn
*)udp_decr_test
},
446 {"udp_version_test", 0,
447 (test_callback_fn
*)udp_version_test
}
450 for (size_t x
= 0; x
< 500; x
++)
452 current_op
= mixed_io_ops
[random() % 9];
453 test_true(current_op
.test_fn(memc
) == TEST_SUCCESS
);
458 test_st udp_setup_server_tests
[] ={
459 {"set_udp_behavior_test", 0, (test_callback_fn
*)set_udp_behavior_test
},
460 {"add_tcp_server_udp_client_test", 0, (test_callback_fn
*)add_tcp_server_udp_client_test
},
461 {"add_udp_server_tcp_client_test", 0, (test_callback_fn
*)add_udp_server_tcp_client_test
},
465 test_st upd_io_tests
[] ={
466 {"udp_set_test", 0, (test_callback_fn
*)udp_set_test
},
467 {"udp_buffered_set_test", 0, (test_callback_fn
*)udp_buffered_set_test
},
468 {"udp_set_too_big_test", 0, (test_callback_fn
*)udp_set_too_big_test
},
469 {"udp_delete_test", 0, (test_callback_fn
*)udp_delete_test
},
470 {"udp_buffered_delete_test", 0, (test_callback_fn
*)udp_buffered_delete_test
},
471 {"udp_verbosity_test", 0, (test_callback_fn
*)udp_verbosity_test
},
472 {"udp_quit_test", 0, (test_callback_fn
*)udp_quit_test
},
473 {"udp_flush_test", 0, (test_callback_fn
*)udp_flush_test
},
474 {"udp_incr_test", 0, (test_callback_fn
*)udp_incr_test
},
475 {"udp_decr_test", 0, (test_callback_fn
*)udp_decr_test
},
476 {"udp_stat_test", 0, (test_callback_fn
*)udp_stat_test
},
477 {"udp_version_test", 0, (test_callback_fn
*)udp_version_test
},
478 {"udp_get_test", 0, (test_callback_fn
*)udp_get_test
},
479 {"udp_mixed_io_test", 0, (test_callback_fn
*)udp_mixed_io_test
},
483 collection_st collection
[] ={
484 {"udp_setup", (test_callback_fn
*)init_udp
, 0, udp_setup_server_tests
},
485 {"udp_io", (test_callback_fn
*)init_udp
, 0, upd_io_tests
},
486 {"udp_binary_io", (test_callback_fn
*)binary_init_udp
, 0, upd_io_tests
},
490 #define SERVERS_TO_CREATE 5
492 #include "libmemcached_world.h"
494 void get_world(world_st
*world
)
496 world
->collections
= collection
;
498 world
->create
= (test_callback_create_fn
*)world_create
;
499 world
->destroy
= (test_callback_fn
*)world_destroy
;
501 world
->run_startup
= (test_callback_fn
*)world_test_startup
;
502 world
->flush
= (test_callback_fn
*)world_flush
;
503 world
->pre_run
= (test_callback_fn
*)world_pre_run
;
504 world
->post_run
= (test_callback_fn
*)world_post_run
;
505 world
->on_error
= (test_callback_error_fn
*)world_on_error
;
507 world
->collection_startup
= (test_callback_fn
*)world_container_startup
;
508 world
->collection_shutdown
= (test_callback_fn
*)world_container_shutdown
;
510 world
->runner
= &defualt_libmemcached_runner
;