Fixes issue where if illegal options caused parsing to fail an incorrect
[m6w6/libmemcached] / tests / parser.cc
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * Gearmand client and server library.
4 *
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
15 * * Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following disclaimer
17 * in the documentation and/or other materials provided with the
18 * distribution.
19 *
20 * * The names of its contributors may not be used to endorse or
21 * promote products derived from this software without specific prior
22 * written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 *
36 */
37
38 #include <config.h>
39
40 #include <vector>
41 #include <iostream>
42 #include <string>
43
44 #include <libmemcached/memcached.h>
45
46 #include "tests/parser.h"
47 #include "tests/print.h"
48
49 enum scanner_type_t
50 {
51 NIL,
52 UNSIGNED,
53 SIGNED,
54 ARRAY
55 };
56
57
58 struct scanner_string_st {
59 const char *c_str;
60 size_t size;
61 };
62
63 static inline scanner_string_st scanner_string(const char *arg, size_t arg_size)
64 {
65 scanner_string_st local= { arg, arg_size };
66 return local;
67 }
68
69 #define make_scanner_string(X) scanner_string((X), static_cast<size_t>(sizeof(X) - 1))
70
71 static struct scanner_string_st scanner_string_null= { 0, 0};
72
73 struct scanner_variable_t {
74 enum scanner_type_t type;
75 struct scanner_string_st option;
76 struct scanner_string_st result;
77 test_return_t (*check_func)(memcached_st *memc, const scanner_string_st &hostname);
78 };
79
80 // Check and make sure the first host is what we expect it to be
81 static test_return_t __check_host(memcached_st *memc, const scanner_string_st &hostname)
82 {
83 memcached_server_instance_st instance=
84 memcached_server_instance_by_position(memc, 0);
85
86 test_true(instance);
87
88 const char *first_hostname = memcached_server_name(instance);
89 test_true(first_hostname);
90 test_strcmp(first_hostname, hostname.c_str);
91
92 return TEST_SUCCESS;
93 }
94
95 // Check and make sure the prefix_key is what we expect it to be
96 static test_return_t __check_prefix_key(memcached_st *memc, const scanner_string_st &hostname)
97 {
98 memcached_server_instance_st instance=
99 memcached_server_instance_by_position(memc, 0);
100
101 test_true(instance);
102
103 const char *first_hostname = memcached_server_name(instance);
104 test_true(first_hostname);
105 test_strcmp(first_hostname, hostname.c_str);
106
107 return TEST_SUCCESS;
108 }
109
110 static test_return_t __check_IO_MSG_WATERMARK(memcached_st *memc, const scanner_string_st &value)
111 {
112 uint64_t value_number;
113
114 value_number= atoll(value.c_str);
115
116 test_true(memcached_behavior_get(memc, MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK) == value_number);
117 return TEST_SUCCESS;
118 }
119
120 static test_return_t __check_AUTO_EJECT_HOSTS(memcached_st *memc, const scanner_string_st &value)
121 {
122 (void)value;
123 test_true(memcached_behavior_get(memc, MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS));
124 return TEST_SUCCESS;
125 }
126
127 static test_return_t __check_CACHE_LOOKUPS(memcached_st *memc, const scanner_string_st &value)
128 {
129 (void)value;
130 test_true(memcached_behavior_get(memc, MEMCACHED_BEHAVIOR_CACHE_LOOKUPS));
131 return TEST_SUCCESS;
132 }
133
134 static test_return_t __check_NOREPLY(memcached_st *memc, const scanner_string_st &value)
135 {
136 (void)value;
137 test_true(memcached_behavior_get(memc, MEMCACHED_BEHAVIOR_NOREPLY));
138 return TEST_SUCCESS;
139 }
140
141 static test_return_t __check_VERIFY_KEY(memcached_st *memc, const scanner_string_st &value)
142 {
143 (void)value;
144 test_true(memcached_behavior_get(memc, MEMCACHED_BEHAVIOR_VERIFY_KEY));
145 return TEST_SUCCESS;
146 }
147
148 static test_return_t __check_distribution_RANDOM(memcached_st *memc, const scanner_string_st &value)
149 {
150 (void)value;
151 test_true(memcached_behavior_get(memc, MEMCACHED_BEHAVIOR_DISTRIBUTION) == MEMCACHED_DISTRIBUTION_RANDOM);
152 return TEST_SUCCESS;
153 }
154
155 scanner_variable_t test_server_strings[]= {
156 { ARRAY, make_scanner_string("--server=localhost"), make_scanner_string("localhost"), __check_host },
157 { ARRAY, make_scanner_string("--server=10.0.2.1"), make_scanner_string("10.0.2.1"), __check_host },
158 { ARRAY, make_scanner_string("--server=example.com"), make_scanner_string("example.com"), __check_host },
159 { ARRAY, make_scanner_string("--server=localhost:30"), make_scanner_string("localhost"), __check_host },
160 { ARRAY, make_scanner_string("--server=10.0.2.1:20"), make_scanner_string("10.0.2.1"), __check_host },
161 { ARRAY, make_scanner_string("--server=example.com:1024"), make_scanner_string("example.com"), __check_host },
162 { NIL, scanner_string_null, scanner_string_null, NULL }
163 };
164
165 scanner_variable_t test_servers_strings[]= {
166 { ARRAY, make_scanner_string("--servers=localhost:11221,localhost:11222,localhost:11223,localhost:11224,localhost:11225"), scanner_string_null, NULL },
167 { ARRAY, make_scanner_string("--servers=a.example.com:81,localhost:82,b.example.com"), scanner_string_null, NULL },
168 { ARRAY, make_scanner_string("--servers=localhost,localhost:80"), scanner_string_null, NULL },
169 { NIL, scanner_string_null, scanner_string_null, NULL}
170 };
171
172
173 scanner_variable_t bad_test_strings[]= {
174 { ARRAY, make_scanner_string("-servers=localhost:11221,localhost:11222,localhost:11223,localhost:11224,localhost:11225"), scanner_string_null, NULL },
175 { ARRAY, make_scanner_string("-- servers=a.example.com:81,localhost:82,b.example.com"), scanner_string_null, NULL },
176 { ARRAY, make_scanner_string("--servers=localhost+80"), scanner_string_null, NULL},
177 { NIL, scanner_string_null, scanner_string_null, NULL}
178 };
179
180 scanner_variable_t test_number_options[]= {
181 { ARRAY, make_scanner_string("--CONNECT_TIMEOUT=456"), scanner_string_null, NULL },
182 { ARRAY, make_scanner_string("--IO_MSG_WATERMARK=456"), make_scanner_string("456"), __check_IO_MSG_WATERMARK },
183 { ARRAY, make_scanner_string("--IO_BYTES_WATERMARK=456"), scanner_string_null, NULL },
184 { ARRAY, make_scanner_string("--IO_KEY_PREFETCH=456"), scanner_string_null, NULL },
185 { ARRAY, make_scanner_string("--NUMBER_OF_REPLICAS=456"), scanner_string_null, NULL },
186 { ARRAY, make_scanner_string("--POLL_TIMEOUT=456"), scanner_string_null, NULL },
187 { ARRAY, make_scanner_string("--RCV_TIMEOUT=456"), scanner_string_null, NULL },
188 { ARRAY, make_scanner_string("--RETRY_TIMEOUT=456"), scanner_string_null, NULL },
189 { ARRAY, make_scanner_string("--SERVER_FAILURE_LIMIT=456"), scanner_string_null, NULL },
190 { ARRAY, make_scanner_string("--SND_TIMEOUT=456"), scanner_string_null, NULL },
191 { ARRAY, make_scanner_string("--SOCKET_RECV_SIZE=456"), scanner_string_null, NULL },
192 { ARRAY, make_scanner_string("--SOCKET_SEND_SIZE=456"), scanner_string_null, NULL },
193 { NIL, scanner_string_null, scanner_string_null, NULL}
194 };
195
196 scanner_variable_t test_boolean_options[]= {
197 { ARRAY, make_scanner_string("--AUTO_EJECT_HOSTS"), scanner_string_null, __check_AUTO_EJECT_HOSTS },
198 { ARRAY, make_scanner_string("--BINARY_PROTOCOL"), scanner_string_null, NULL },
199 { ARRAY, make_scanner_string("--BUFFER_REQUESTS"), scanner_string_null, NULL },
200 { ARRAY, make_scanner_string("--CACHE_LOOKUPS"), scanner_string_null, __check_CACHE_LOOKUPS },
201 #if 0 // Not all platforms support
202 { ARRAY, make_scanner_string("--CORK"), scanner_string_null, NULL },
203 #endif
204 { ARRAY, make_scanner_string("--HASH_WITH_PREFIX_KEY"), scanner_string_null, NULL },
205 { ARRAY, make_scanner_string("--KETAMA"), scanner_string_null, NULL },
206 { ARRAY, make_scanner_string("--KETAMA_WEIGHTED"), scanner_string_null, NULL },
207 { ARRAY, make_scanner_string("--NOREPLY"), scanner_string_null, __check_NOREPLY },
208 { ARRAY, make_scanner_string("--RANDOMIZE_REPLICA_READ"), scanner_string_null, NULL },
209 { ARRAY, make_scanner_string("--SORT_HOSTS"), scanner_string_null, NULL },
210 { ARRAY, make_scanner_string("--SUPPORT_CAS"), scanner_string_null, NULL },
211 { ARRAY, make_scanner_string("--TCP_NODELAY"), scanner_string_null, NULL },
212 { ARRAY, make_scanner_string("--TCP_KEEPALIVE"), scanner_string_null, NULL },
213 { ARRAY, make_scanner_string("--TCP_KEEPIDLE"), scanner_string_null, NULL },
214 { ARRAY, make_scanner_string("--USE_UDP"), scanner_string_null, NULL },
215 { ARRAY, make_scanner_string("--VERIFY_KEY"), scanner_string_null, __check_VERIFY_KEY },
216 { NIL, scanner_string_null, scanner_string_null, NULL}
217 };
218
219 scanner_variable_t prefix_key_strings[]= {
220 { ARRAY, make_scanner_string("--PREFIX_KEY=foo"), make_scanner_string("foo"), __check_prefix_key },
221 { ARRAY, make_scanner_string("--PREFIX-KEY=\"foo\""), make_scanner_string("foo"), __check_prefix_key },
222 { ARRAY, make_scanner_string("--PREFIX-KEY=\"This is a very long key\""), make_scanner_string("This is a very long key"), __check_prefix_key },
223 { NIL, scanner_string_null, scanner_string_null, NULL}
224 };
225
226 scanner_variable_t distribution_strings[]= {
227 { ARRAY, make_scanner_string("--DISTRIBUTION=consistent"), scanner_string_null, NULL },
228 { ARRAY, make_scanner_string("--DISTRIBUTION=random"), scanner_string_null, __check_distribution_RANDOM },
229 { ARRAY, make_scanner_string("--DISTRIBUTION=modula"), scanner_string_null, NULL },
230 { NIL, scanner_string_null, scanner_string_null, NULL}
231 };
232
233 scanner_variable_t hash_strings[]= {
234 { ARRAY, make_scanner_string("--HASH=CRC"), scanner_string_null, NULL },
235 { ARRAY, make_scanner_string("--HASH=FNV1A_32"), scanner_string_null, NULL },
236 { ARRAY, make_scanner_string("--HASH=FNV1A_64"), scanner_string_null, NULL },
237 { ARRAY, make_scanner_string("--HASH=FNV1_32"), scanner_string_null, NULL },
238 { ARRAY, make_scanner_string("--HASH=FNV1_64"), scanner_string_null, NULL },
239 { ARRAY, make_scanner_string("--HASH=JENKINS"), scanner_string_null, NULL },
240 { ARRAY, make_scanner_string("--HASH=MD5"), scanner_string_null, NULL },
241 { ARRAY, make_scanner_string("--HASH=MURMUR"), scanner_string_null, NULL },
242 { NIL, scanner_string_null, scanner_string_null, NULL}
243 };
244
245
246 static test_return_t _test_option(scanner_variable_t *scanner, bool test_true= true)
247 {
248 (void)test_true;
249 memcached_st *memc;
250 memc= memcached_create(NULL);
251
252 for (scanner_variable_t *ptr= scanner; ptr->type != NIL; ptr++)
253 {
254 memcached_return_t rc;
255 rc= memcached_parse_configuration(memc, ptr->option.c_str, ptr->option.size);
256 if (test_true)
257 {
258 if (rc != MEMCACHED_SUCCESS)
259 memcached_error_print(memc);
260
261 test_true(rc == MEMCACHED_SUCCESS);
262
263 if (ptr->check_func)
264 {
265 (*ptr->check_func)(memc, ptr->result);
266 }
267 }
268 else
269 {
270 test_false_with(rc == MEMCACHED_SUCCESS, ptr->option.c_str);
271 }
272 memcached_reset(memc);
273 }
274 memcached_free(memc);
275
276 return TEST_SUCCESS;
277 }
278
279 test_return_t server_test(memcached_st *junk)
280 {
281 (void)junk;
282 return _test_option(test_server_strings);
283 }
284
285 test_return_t servers_test(memcached_st *junk)
286 {
287 (void)junk;
288
289 test_return_t rc;
290 if ((rc= _test_option(test_server_strings)) != TEST_SUCCESS)
291 {
292 return rc;
293 }
294
295 #if 0
296 memcached_server_fn callbacks[1];
297 callbacks[0]= server_print_callback;
298 memcached_server_cursor(memc, callbacks, NULL, 1);
299 #endif
300
301 if ((rc= _test_option(bad_test_strings, false)) != TEST_SUCCESS)
302 {
303 return rc;
304 }
305
306 return TEST_SUCCESS;
307 }
308
309 test_return_t parser_number_options_test(memcached_st *junk)
310 {
311 (void)junk;
312 return _test_option(test_number_options);
313 }
314
315 test_return_t parser_boolean_options_test(memcached_st *junk)
316 {
317 (void)junk;
318 return _test_option(test_boolean_options);
319 }
320
321 test_return_t behavior_parser_test(memcached_st *junk)
322 {
323 (void)junk;
324 return TEST_SUCCESS;
325 }
326
327 test_return_t parser_hash_test(memcached_st *junk)
328 {
329 (void)junk;
330 return _test_option(hash_strings);
331 }
332
333 test_return_t parser_distribution_test(memcached_st *junk)
334 {
335 (void)junk;
336 return _test_option(distribution_strings);
337 }
338
339 test_return_t parser_key_prefix_test(memcached_st *junk)
340 {
341 (void)junk;
342 return _test_option(distribution_strings);
343 }
344
345 test_return_t memcached_parse_configure_file_test(memcached_st *junk)
346 {
347 (void)junk;
348 memcached_st memc;
349 memcached_st *memc_ptr= memcached_create(&memc);
350
351 test_true(memc_ptr);
352
353 memcached_return_t rc= memcached_parse_configure_file(memc_ptr, memcached_string_with_size("support/example.cnf"));
354 test_true_got(rc == MEMCACHED_SUCCESS, memcached_last_error_message(memc_ptr) ? memcached_last_error_message(memc_ptr) : memcached_strerror(NULL, rc));
355 memcached_free(memc_ptr);
356
357 return TEST_SUCCESS;
358 }
359
360 test_return_t memcached_create_with_options_with_filename(memcached_st *junk)
361 {
362 (void)junk;
363
364 memcached_st *memc_ptr;
365 memc_ptr= memcached_create_with_options(STRING_WITH_LEN("--CONFIGURE-FILE=\"support/example.cnf\""));
366 test_true_got(memc_ptr, memcached_last_error_message(memc_ptr));
367 memcached_free(memc_ptr);
368
369 return TEST_SUCCESS;
370 }
371
372 test_return_t libmemcached_check_configuration_with_filename_test(memcached_st *junk)
373 {
374 (void)junk;
375 memcached_return_t rc;
376 char buffer[BUFSIZ];
377
378 rc= libmemcached_check_configuration(STRING_WITH_LEN("--CONFIGURE-FILE=\"support/example.cnf\""), buffer, sizeof(buffer));
379 test_true_got(rc == MEMCACHED_SUCCESS, buffer);
380
381 rc= libmemcached_check_configuration(STRING_WITH_LEN("--CONFIGURE-FILE=support/example.cnf"), buffer, sizeof(buffer));
382 test_false_with(rc == MEMCACHED_SUCCESS, buffer);
383
384 rc= libmemcached_check_configuration(STRING_WITH_LEN("--CONFIGURE-FILE=\"bad-path/example.cnf\""), buffer, sizeof(buffer));
385 test_true_got(rc == MEMCACHED_ERRNO, buffer);
386
387 return TEST_SUCCESS;
388 }
389
390 test_return_t libmemcached_check_configuration_test(memcached_st *junk)
391 {
392 (void)junk;
393
394 memcached_return_t rc;
395 char buffer[BUFSIZ];
396
397 rc= libmemcached_check_configuration(STRING_WITH_LEN("--server=localhost"), buffer, sizeof(buffer));
398 test_true_got(rc == MEMCACHED_SUCCESS, buffer);
399
400 rc= libmemcached_check_configuration(STRING_WITH_LEN("--dude=localhost"), buffer, sizeof(buffer));
401 test_false_with(rc == MEMCACHED_SUCCESS, buffer);
402 test_true(rc == MEMCACHED_PARSE_ERROR);
403
404 return TEST_SUCCESS;
405 }
406
407 test_return_t memcached_create_with_options_test(memcached_st *junk)
408 {
409 (void)junk;
410
411 memcached_st *memc_ptr;
412 memc_ptr= memcached_create_with_options(STRING_WITH_LEN("--server=localhost"));
413 test_true_got(memc_ptr, memcached_last_error_message(memc_ptr));
414 memcached_free(memc_ptr);
415
416 memc_ptr= memcached_create_with_options(STRING_WITH_LEN("--dude=localhost"));
417 test_false_with(memc_ptr, memcached_last_error_message(memc_ptr));
418
419 return TEST_SUCCESS;
420 }
421
422 #define RANDOM_STRINGS 50
423 test_return_t random_statement_build_test(memcached_st *junk)
424 {
425 (void)junk;
426 std::vector<scanner_string_st *> option_list;
427
428 for (scanner_variable_t *ptr= test_server_strings; ptr->type != NIL; ptr++)
429 option_list.push_back(&ptr->option);
430
431 #if 0
432 for (scanner_variable_t *ptr= test_servers_strings; ptr->type != NIL; ptr++)
433 option_list.push_back(&ptr->option);
434 #endif
435
436 for (scanner_variable_t *ptr= test_number_options; ptr->type != NIL; ptr++)
437 option_list.push_back(&ptr->option);
438
439 for (scanner_variable_t *ptr= test_boolean_options; ptr->type != NIL; ptr++)
440 option_list.push_back(&ptr->option);
441
442 for (scanner_variable_t *ptr= prefix_key_strings; ptr->type != NIL; ptr++)
443 option_list.push_back(&ptr->option);
444
445 for (scanner_variable_t *ptr= distribution_strings; ptr->type != NIL; ptr++)
446 option_list.push_back(&ptr->option);
447
448 for (scanner_variable_t *ptr= hash_strings; ptr->type != NIL; ptr++)
449 option_list.push_back(&ptr->option);
450
451 for (uint32_t x= 0; x < RANDOM_STRINGS; x++)
452 {
453 std::string random_options;
454
455 uint32_t number_of= random() % option_list.size();
456 for (uint32_t options= 0; options < number_of; options++)
457 {
458 random_options+= option_list[random() % option_list.size()]->c_str;
459 random_options+= " ";
460 }
461 random_options.resize(random_options.size() -1);
462
463 memcached_return_t rc;
464 memcached_st *memc_ptr= memcached_create(NULL);
465 rc= memcached_parse_configuration(memc_ptr, random_options.c_str(), random_options.size());
466 if (rc == MEMCACHED_PARSE_ERROR)
467 {
468 std::cerr << std::endl << "Failed to parse(" << memcached_strerror(NULL, rc) << "): " << random_options << std::endl;
469 memcached_error_print(memc_ptr);
470 }
471 memcached_free(memc_ptr);
472 }
473
474 return TEST_SUCCESS;
475 }