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.
14 #include <libtest/test.hpp>
16 using namespace libtest
;
18 #include <libmemcached/memcached.h>
19 #include <libmemcached/server_instance.h>
20 #include <libmemcached/io.h>
28 #include <sys/types.h>
34 #include <libtest/server.h>
36 #ifndef __INTEL_COMPILER
37 #pragma GCC diagnostic ignored "-Wstrict-aliasing"
41 @note This should be testing to see if the server really supports the binary protocol.
43 static test_return_t
pre_binary(memcached_st
*memc
)
45 memcached_return_t rc
= MEMCACHED_FAILURE
;
46 memcached_st
*memc_clone
;
47 memcached_server_instance_st instance
;
49 memc_clone
= memcached_clone(NULL
, memc
);
50 test_true(memc_clone
);
51 // The memcached_version needs to be done on a clone, because the server
52 // will not toggle protocol on an connection.
53 memcached_version(memc_clone
);
55 instance
= memcached_server_instance_by_position(memc_clone
, 0);
57 if (instance
->major_version
>= 1 && instance
->minor_version
> 2)
59 rc
= memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
, 1);
60 test_true(rc
== MEMCACHED_SUCCESS
);
61 test_true(memcached_behavior_get(memc
, MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
) == 1);
64 memcached_free(memc_clone
);
66 return rc
== MEMCACHED_SUCCESS
? TEST_SUCCESS
: TEST_SKIPPED
;
69 static void increment_request_id(uint16_t *id
)
72 if ((*id
& UDP_REQUEST_ID_THREAD_MASK
) != 0)
76 static uint16_t *get_udp_request_ids(memcached_st
*memc
)
78 uint16_t *ids
= (uint16_t*)malloc(sizeof(uint16_t) * memcached_server_count(memc
));
81 for (uint32_t x
= 0; x
< memcached_server_count(memc
); x
++)
83 memcached_server_instance_st instance
=
84 memcached_server_instance_by_position(memc
, x
);
86 ids
[x
]= get_udp_datagram_request_id((struct udp_datagram_header_st
*) ((memcached_server_instance_st
)instance
)->write_buffer
);
92 static test_return_t
post_udp_op_check(memcached_st
*memc
, uint16_t *expected_req_ids
)
95 (void)expected_req_ids
;
97 memcached_server_st
*cur_server
= memcached_server_list(memc
);
98 uint16_t *cur_req_ids
= get_udp_request_ids(memc
);
100 for (size_t x
= 0; x
< memcached_server_count(memc
); x
++)
102 test_true(cur_server
[x
].cursor_active
== 0);
103 test_true(cur_req_ids
[x
] == expected_req_ids
[x
]);
105 free(expected_req_ids
);
113 ** There is a little bit of a hack here, instead of removing
114 ** the servers, I just set num host to 0 and them add then new udp servers
116 static test_return_t
init_udp(memcached_st
*memc
)
118 memcached_version(memc
);
120 memcached_server_instance_st instance
=
121 memcached_server_instance_by_position(memc
, 0);
123 /* For the time being, only support udp test for >= 1.2.6 && < 1.3 */
124 if (instance
->major_version
!= 1 || instance
->minor_version
!= 2
125 || instance
->micro_version
< 6)
128 uint32_t num_hosts
= memcached_server_count(memc
);
129 memcached_server_st servers
[num_hosts
];
130 memcpy(servers
, memcached_server_list(memc
), sizeof(memcached_server_st
) * num_hosts
);
131 for (uint32_t x
= 0; x
< num_hosts
; x
++)
133 memcached_server_instance_st set_instance
=
134 memcached_server_instance_by_position(memc
, x
);
136 memcached_server_free(((memcached_server_write_instance_st
)set_instance
));
139 memc
->number_of_hosts
= 0;
140 memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_USE_UDP
, 1);
141 for (uint32_t x
= 0; x
< num_hosts
; x
++)
143 memcached_server_instance_st set_instance
=
144 memcached_server_instance_by_position(memc
, x
);
146 test_true(memcached_server_add_udp(memc
, servers
[x
].hostname
, servers
[x
].port
) == MEMCACHED_SUCCESS
);
147 test_true(set_instance
->write_buffer_offset
== UDP_DATAGRAM_HEADER_LENGTH
);
154 static test_return_t
binary_init_udp(memcached_st
*memc
)
156 test_return_t test_rc
;
157 test_rc
= pre_binary(memc
);
159 if (test_rc
!= TEST_SUCCESS
)
162 return init_udp(memc
);
165 /* Make sure that I cant add a tcp server to a udp client */
166 static test_return_t
add_tcp_server_udp_client_test(memcached_st
*memc
)
170 memcached_server_st server
;
171 memcached_server_instance_st instance
=
172 memcached_server_instance_by_position(memc
, 0);
173 memcached_server_clone(&server
, &memc
->hosts
[0]);
174 test_true(memcached_server_remove(&(memc
->hosts
[0])) == MEMCACHED_SUCCESS
);
175 test_true(memcached_server_add(memc
, server
.hostname
, server
.port
) == MEMCACHED_INVALID_HOST_PROTOCOL
);
180 /* Make sure that I cant add a udp server to a tcp client */
181 static test_return_t
add_udp_server_tcp_client_test(memcached_st
*memc
)
185 memcached_server_st server
;
186 memcached_server_instance_st instance
=
187 memcached_server_instance_by_position(memc
, 0);
188 memcached_server_clone(&server
, &memc
->hosts
[0]);
189 test_true(memcached_server_remove(&(memc
->hosts
[0])) == MEMCACHED_SUCCESS
);
191 memcached_st tcp_client
;
192 memcached_create(&tcp_client
);
193 test_true(memcached_server_add_udp(&tcp_client
, server
.hostname
, server
.port
) == MEMCACHED_INVALID_HOST_PROTOCOL
);
199 static test_return_t
set_udp_behavior_test(memcached_st
*memc
)
202 memcached_quit(memc
);
203 memc
->number_of_hosts
= 0;
204 memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_DISTRIBUTION
, memc
->distribution
);
205 test_true(memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_USE_UDP
, 1) == MEMCACHED_SUCCESS
);
206 test_true(memc
->flags
.use_udp
);
207 test_true(memc
->flags
.no_reply
);
209 test_true(memcached_server_count(memc
) == 0);
211 memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_USE_UDP
,0);
212 test_true(! (memc
->flags
.use_udp
));
213 memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_NOREPLY
,0);
214 test_true(! (memc
->flags
.no_reply
));
219 static test_return_t
udp_set_test(memcached_st
*memc
)
221 unsigned int num_iters
= 1025; //request id rolls over at 1024
223 for (size_t x
= 0; x
< num_iters
;x
++)
225 memcached_return_t rc
;
226 const char *key
= "foo";
227 const char *value
= "when we sanitize";
228 uint16_t *expected_ids
= get_udp_request_ids(memc
);
229 unsigned int server_key
= memcached_generate_hash(memc
, key
, strlen(key
));
230 memcached_server_instance_st instance
=
231 memcached_server_instance_by_position(memc
, server_key
);
232 size_t init_offset
= instance
->write_buffer_offset
;
234 rc
= memcached_set(memc
, key
, strlen(key
),
235 value
, strlen(value
),
236 (time_t)0, (uint32_t)0);
237 test_true(rc
== MEMCACHED_SUCCESS
|| rc
== MEMCACHED_BUFFERED
);
238 /** NB, the check below assumes that if new write_ptr is less than
239 * the original write_ptr that we have flushed. For large payloads, this
240 * maybe an invalid assumption, but for the small payload we have it is OK
242 if (rc
== MEMCACHED_SUCCESS
||
243 instance
->write_buffer_offset
< init_offset
)
244 increment_request_id(&expected_ids
[server_key
]);
246 if (rc
== MEMCACHED_SUCCESS
)
248 test_true(instance
->write_buffer_offset
== UDP_DATAGRAM_HEADER_LENGTH
);
252 test_true(instance
->write_buffer_offset
!= UDP_DATAGRAM_HEADER_LENGTH
);
253 test_true(instance
->write_buffer_offset
<= MAX_UDP_DATAGRAM_LENGTH
);
255 test_true(post_udp_op_check(memc
, expected_ids
) == TEST_SUCCESS
);
260 static test_return_t
udp_buffered_set_test(memcached_st
*memc
)
262 memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
, 1);
263 return udp_set_test(memc
);
266 static test_return_t
udp_set_too_big_test(memcached_st
*memc
)
268 memcached_return_t rc
;
269 const char *key
= "bar";
270 char value
[MAX_UDP_DATAGRAM_LENGTH
];
271 uint16_t *expected_ids
= get_udp_request_ids(memc
);
272 rc
= memcached_set(memc
, key
, strlen(key
),
273 value
, MAX_UDP_DATAGRAM_LENGTH
,
274 (time_t)0, (uint32_t)0);
275 test_true(rc
== MEMCACHED_WRITE_FAILURE
);
277 return post_udp_op_check(memc
,expected_ids
);
280 static test_return_t
udp_delete_test(memcached_st
*memc
)
282 unsigned int num_iters
= 1025; //request id rolls over at 1024
284 for (size_t x
= 0; x
< num_iters
;x
++)
286 memcached_return_t rc
;
287 const char *key
= "foo";
288 uint16_t *expected_ids
=get_udp_request_ids(memc
);
289 unsigned int server_key
= memcached_generate_hash(memc
, key
, strlen(key
));
290 memcached_server_instance_st instance
=
291 memcached_server_instance_by_position(memc
, server_key
);
292 size_t init_offset
= instance
->write_buffer_offset
;
294 rc
= memcached_delete(memc
, key
, strlen(key
), 0);
295 test_true(rc
== MEMCACHED_SUCCESS
|| rc
== MEMCACHED_BUFFERED
);
297 if (rc
== MEMCACHED_SUCCESS
|| instance
->write_buffer_offset
< init_offset
)
298 increment_request_id(&expected_ids
[server_key
]);
299 if (rc
== MEMCACHED_SUCCESS
)
301 test_true(instance
->write_buffer_offset
== UDP_DATAGRAM_HEADER_LENGTH
);
305 test_true(instance
->write_buffer_offset
!= UDP_DATAGRAM_HEADER_LENGTH
);
306 test_true(instance
->write_buffer_offset
<= MAX_UDP_DATAGRAM_LENGTH
);
308 test_true(post_udp_op_check(memc
,expected_ids
) == TEST_SUCCESS
);
313 static test_return_t
udp_buffered_delete_test(memcached_st
*memc
)
315 memcached_behavior_set(memc
, MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
, 1);
316 return udp_delete_test(memc
);
319 static test_return_t
udp_verbosity_test(memcached_st
*memc
)
321 memcached_return_t rc
;
322 uint16_t *expected_ids
= get_udp_request_ids(memc
);
324 for (size_t x
= 0; x
< memcached_server_count(memc
); x
++)
326 increment_request_id(&expected_ids
[x
]);
329 rc
= memcached_verbosity(memc
,3);
330 test_true(rc
== MEMCACHED_SUCCESS
);
331 return post_udp_op_check(memc
,expected_ids
);
334 static test_return_t
udp_quit_test(memcached_st
*memc
)
336 uint16_t *expected_ids
= get_udp_request_ids(memc
);
337 memcached_quit(memc
);
338 return post_udp_op_check(memc
, expected_ids
);
341 static test_return_t
udp_flush_test(memcached_st
*memc
)
343 memcached_return_t rc
;
344 uint16_t *expected_ids
= get_udp_request_ids(memc
);
346 for (size_t x
= 0; x
< memcached_server_count(memc
); x
++)
348 increment_request_id(&expected_ids
[x
]);
351 rc
= memcached_flush(memc
,0);
352 test_true(rc
== MEMCACHED_SUCCESS
);
353 return post_udp_op_check(memc
,expected_ids
);
356 static test_return_t
udp_incr_test(memcached_st
*memc
)
358 memcached_return_t rc
;
359 const char *key
= "incr";
360 const char *value
= "1";
361 rc
= memcached_set(memc
, key
, strlen(key
),
362 value
, strlen(value
),
363 (time_t)0, (uint32_t)0);
365 test_true(rc
== MEMCACHED_SUCCESS
);
366 uint16_t *expected_ids
= get_udp_request_ids(memc
);
367 unsigned int server_key
= memcached_generate_hash(memc
, key
, strlen(key
));
368 increment_request_id(&expected_ids
[server_key
]);
370 rc
= memcached_increment(memc
, key
, strlen(key
), 1, &newvalue
);
371 test_true(rc
== MEMCACHED_SUCCESS
);
372 return post_udp_op_check(memc
, expected_ids
);
375 static test_return_t
udp_decr_test(memcached_st
*memc
)
377 memcached_return_t rc
;
378 const char *key
= "decr";
379 const char *value
= "1";
380 rc
= memcached_set(memc
, key
, strlen(key
),
381 value
, strlen(value
),
382 (time_t)0, (uint32_t)0);
384 test_true(rc
== MEMCACHED_SUCCESS
);
385 uint16_t *expected_ids
= get_udp_request_ids(memc
);
386 unsigned int server_key
= memcached_generate_hash(memc
, key
, strlen(key
));
387 increment_request_id(&expected_ids
[server_key
]);
389 rc
= memcached_decrement(memc
, key
, strlen(key
), 1, &newvalue
);
390 test_true(rc
== MEMCACHED_SUCCESS
);
391 return post_udp_op_check(memc
, expected_ids
);
395 static test_return_t
udp_stat_test(memcached_st
*memc
)
397 memcached_stat_st
* rv
= NULL
;
398 memcached_return_t rc
;
400 uint16_t *expected_ids
= get_udp_request_ids(memc
);
401 rv
= memcached_stat(memc
, args
, &rc
);
403 test_true(rc
== MEMCACHED_NOT_SUPPORTED
);
404 return post_udp_op_check(memc
, expected_ids
);
407 static test_return_t
udp_version_test(memcached_st
*memc
)
409 memcached_return_t rc
;
410 uint16_t *expected_ids
= get_udp_request_ids(memc
);
411 rc
= memcached_version(memc
);
412 test_true(rc
== MEMCACHED_NOT_SUPPORTED
);
413 return post_udp_op_check(memc
, expected_ids
);
416 static test_return_t
udp_get_test(memcached_st
*memc
)
418 memcached_return_t rc
;
419 const char *key
= "foo";
421 uint16_t *expected_ids
= get_udp_request_ids(memc
);
422 char *val
= memcached_get(memc
, key
, strlen(key
), &vlen
, (uint32_t)0, &rc
);
423 test_true(rc
== MEMCACHED_NOT_SUPPORTED
);
424 test_true(val
== NULL
);
425 return post_udp_op_check(memc
, expected_ids
);
428 static test_return_t
udp_mixed_io_test(memcached_st
*memc
)
431 test_st mixed_io_ops
[] ={
433 (test_callback_fn
*)udp_set_test
},
434 {"udp_set_too_big_test", 0,
435 (test_callback_fn
*)udp_set_too_big_test
},
436 {"udp_delete_test", 0,
437 (test_callback_fn
*)udp_delete_test
},
438 {"udp_verbosity_test", 0,
439 (test_callback_fn
*)udp_verbosity_test
},
441 (test_callback_fn
*)udp_quit_test
},
442 {"udp_flush_test", 0,
443 (test_callback_fn
*)udp_flush_test
},
445 (test_callback_fn
*)udp_incr_test
},
447 (test_callback_fn
*)udp_decr_test
},
448 {"udp_version_test", 0,
449 (test_callback_fn
*)udp_version_test
}
452 for (size_t x
= 0; x
< 500; x
++)
454 current_op
= mixed_io_ops
[random() % 9];
455 test_true(current_op
.test_fn(memc
) == TEST_SUCCESS
);
460 test_st udp_setup_server_tests
[] ={
461 {"set_udp_behavior_test", 0, (test_callback_fn
*)set_udp_behavior_test
},
462 {"add_tcp_server_udp_client_test", 0, (test_callback_fn
*)add_tcp_server_udp_client_test
},
463 {"add_udp_server_tcp_client_test", 0, (test_callback_fn
*)add_udp_server_tcp_client_test
},
467 test_st upd_io_tests
[] ={
468 {"udp_set_test", 0, (test_callback_fn
*)udp_set_test
},
469 {"udp_buffered_set_test", 0, (test_callback_fn
*)udp_buffered_set_test
},
470 {"udp_set_too_big_test", 0, (test_callback_fn
*)udp_set_too_big_test
},
471 {"udp_delete_test", 0, (test_callback_fn
*)udp_delete_test
},
472 {"udp_buffered_delete_test", 0, (test_callback_fn
*)udp_buffered_delete_test
},
473 {"udp_verbosity_test", 0, (test_callback_fn
*)udp_verbosity_test
},
474 {"udp_quit_test", 0, (test_callback_fn
*)udp_quit_test
},
475 {"udp_flush_test", 0, (test_callback_fn
*)udp_flush_test
},
476 {"udp_incr_test", 0, (test_callback_fn
*)udp_incr_test
},
477 {"udp_decr_test", 0, (test_callback_fn
*)udp_decr_test
},
478 {"udp_stat_test", 0, (test_callback_fn
*)udp_stat_test
},
479 {"udp_version_test", 0, (test_callback_fn
*)udp_version_test
},
480 {"udp_get_test", 0, (test_callback_fn
*)udp_get_test
},
481 {"udp_mixed_io_test", 0, (test_callback_fn
*)udp_mixed_io_test
},
485 collection_st collection
[] ={
486 {"udp_setup", (test_callback_fn
*)init_udp
, 0, udp_setup_server_tests
},
487 {"udp_io", (test_callback_fn
*)init_udp
, 0, upd_io_tests
},
488 {"udp_binary_io", (test_callback_fn
*)binary_init_udp
, 0, upd_io_tests
},
492 #define TEST_PORT_BASE MEMCACHED_DEFAULT_PORT +10
493 #include "libmemcached_world.h"
495 void get_world(Framework
*world
)
497 world
->collections
= collection
;
499 world
->_create
= (test_callback_create_fn
*)world_create
;
500 world
->_destroy
= (test_callback_destroy_fn
*)world_destroy
;
502 world
->item
._startup
= (test_callback_fn
*)world_test_startup
;
503 world
->item
._flush
= (test_callback_fn
*)world_flush
;
504 world
->item
.set_pre((test_callback_fn
*)world_pre_run
);
505 world
->item
.set_post((test_callback_fn
*)world_post_run
);
506 world
->_on_error
= (test_callback_error_fn
*)world_on_error
;
508 world
->collection_startup
= (test_callback_fn
*)world_container_startup
;
509 world
->collection_shutdown
= (test_callback_fn
*)world_container_shutdown
;
511 world
->set_runner(&defualt_libmemcached_runner
);