git.m6w6.name Git - m6w6/libmemcached/blob - tests/parser.cc

   1 /*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
   2  *
   3  *  Libmemcached Client and Server
   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 #define BUILDING_LIBMEMCACHED
  45 #include <libmemcached/memcached.h>
  46
  47 #include "tests/parser.h"
  48 #include "tests/print.h"
  49
  50 enum scanner_type_t
  51 {
  52   NIL,
  53   UNSIGNED,
  54   SIGNED,
  55   ARRAY
  56 };
  57
  58
  59 struct scanner_string_st {
  60   const char *c_str;
  61   size_t size;
  62 };
  63
  64 static inline scanner_string_st scanner_string(const char *arg, size_t arg_size)
  65 {
  66   scanner_string_st local= { arg, arg_size };
  67   return local;
  68 }
  69
  70 #define make_scanner_string(X) scanner_string((X), static_cast<size_t>(sizeof(X) - 1))
  71
  72 static struct scanner_string_st scanner_string_null= { 0, 0};
  73
  74 struct scanner_variable_t {
  75   enum scanner_type_t type;
  76   struct scanner_string_st option;
  77   struct scanner_string_st result;
  78   test_return_t (*check_func)(memcached_st *memc, const scanner_string_st &hostname);
  79 };
  80
  81 // Check and make sure the first host is what we expect it to be
  82 static test_return_t __check_host(memcached_st *memc, const scanner_string_st &hostname)
  83 {
  84   memcached_server_instance_st instance=
  85     memcached_server_instance_by_position(memc, 0);
  86
  87   test_true(instance);
  88
  89   const char *first_hostname = memcached_server_name(instance);
  90   test_true(first_hostname);
  91   test_strcmp(first_hostname, hostname.c_str);
  92
  93   return TEST_SUCCESS;
  94 }
  95
  96 // Check and make sure the prefix_key is what we expect it to be
  97 static test_return_t __check_prefix_key(memcached_st *memc, const scanner_string_st &hostname)
  98 {
  99   memcached_server_instance_st instance=
 100     memcached_server_instance_by_position(memc, 0);
 101
 102   test_true(instance);
 103
 104   const char *first_hostname = memcached_server_name(instance);
 105   test_true(first_hostname);
 106   test_strcmp(first_hostname, hostname.c_str);
 107
 108   return TEST_SUCCESS;
 109 }
 110
 111 static test_return_t __check_IO_MSG_WATERMARK(memcached_st *memc, const scanner_string_st &value)
 112 {
 113   uint64_t value_number;
 114
 115   value_number= atoll(value.c_str);
 116
 117   test_true(memcached_behavior_get(memc, MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK) == value_number);
 118   return TEST_SUCCESS;
 119 }
 120
 121 static test_return_t __check_REMOVE_FAILED_SERVERS(memcached_st *memc, const scanner_string_st &value)
 122 {
 123   (void)value;
 124   test_true(memcached_behavior_get(memc, MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS));
 125   return TEST_SUCCESS;
 126 }
 127
 128 static test_return_t __check_NOREPLY(memcached_st *memc, const scanner_string_st &value)
 129 {
 130   (void)value;
 131   test_true(memcached_behavior_get(memc, MEMCACHED_BEHAVIOR_NOREPLY));
 132   return TEST_SUCCESS;
 133 }
 134
 135 static test_return_t __check_VERIFY_KEY(memcached_st *memc, const scanner_string_st &value)
 136 {
 137   (void)value;
 138   test_true(memcached_behavior_get(memc, MEMCACHED_BEHAVIOR_VERIFY_KEY));
 139   return TEST_SUCCESS;
 140 }
 141
 142 static test_return_t __check_distribution_RANDOM(memcached_st *memc, const scanner_string_st &value)
 143 {
 144   (void)value;
 145   test_true(memcached_behavior_get(memc, MEMCACHED_BEHAVIOR_DISTRIBUTION) == MEMCACHED_DISTRIBUTION_RANDOM);
 146   return TEST_SUCCESS;
 147 }
 148
 149 scanner_variable_t test_server_strings[]= {
 150   { ARRAY, make_scanner_string("--server=localhost"), make_scanner_string("localhost"), __check_host },
 151   { ARRAY, make_scanner_string("--server=10.0.2.1"), make_scanner_string("10.0.2.1"), __check_host },
 152   { ARRAY, make_scanner_string("--server=example.com"), make_scanner_string("example.com"), __check_host },
 153   { ARRAY, make_scanner_string("--server=localhost:30"), make_scanner_string("localhost"), __check_host },
 154   { ARRAY, make_scanner_string("--server=10.0.2.1:20"), make_scanner_string("10.0.2.1"), __check_host },
 155   { ARRAY, make_scanner_string("--server=example.com:1024"), make_scanner_string("example.com"), __check_host },
 156   { NIL, scanner_string_null, scanner_string_null, NULL }
 157 };
 158
 159 scanner_variable_t test_server_strings_with_weights[]= {
 160   { ARRAY, make_scanner_string("--server=10.0.2.1:30/?40"), make_scanner_string("10.0.2.1"), __check_host },
 161   { ARRAY, make_scanner_string("--server=example.com:1024/?30"), make_scanner_string("example.com"), __check_host },
 162   { ARRAY, make_scanner_string("--server=10.0.2.1/?20"), make_scanner_string("10.0.2.1"), __check_host },
 163   { ARRAY, make_scanner_string("--server=example.com/?10"), make_scanner_string("example.com"), __check_host },
 164   { NIL, scanner_string_null, scanner_string_null, NULL }
 165 };
 166
 167 scanner_variable_t bad_test_strings[]= {
 168   { ARRAY, make_scanner_string("-servers=localhost:11221,localhost:11222,localhost:11223,localhost:11224,localhost:11225"), scanner_string_null, NULL },
 169   { ARRAY, make_scanner_string("-- servers=a.example.com:81,localhost:82,b.example.com"), scanner_string_null, NULL },
 170   { ARRAY, make_scanner_string("--servers=localhost:+80"), scanner_string_null, NULL},
 171   { ARRAY, make_scanner_string("--servers=localhost.com."), scanner_string_null, NULL},
 172   { ARRAY, make_scanner_string("--server=localhost.com."), scanner_string_null, NULL},
 173   { ARRAY, make_scanner_string("--server=localhost.com.:80"), scanner_string_null, NULL},
 174   { NIL, scanner_string_null, scanner_string_null, NULL}
 175 };
 176
 177 scanner_variable_t test_number_options[]= {
 178   { ARRAY,  make_scanner_string("--CONNECT_TIMEOUT=456"), scanner_string_null, NULL },
 179   { ARRAY,  make_scanner_string("--IO_BYTES_WATERMARK=456"), scanner_string_null, NULL },
 180   { ARRAY,  make_scanner_string("--IO_KEY_PREFETCH=456"), scanner_string_null, NULL },
 181   { ARRAY,  make_scanner_string("--IO_MSG_WATERMARK=456"), make_scanner_string("456"), __check_IO_MSG_WATERMARK },
 182   { ARRAY,  make_scanner_string("--NUMBER_OF_REPLICAS=456"), scanner_string_null, NULL },
 183   { ARRAY,  make_scanner_string("--POLL_TIMEOUT=456"), scanner_string_null, NULL },
 184   { ARRAY,  make_scanner_string("--RCV_TIMEOUT=456"), scanner_string_null, NULL },
 185   { ARRAY,  make_scanner_string("--REMOVE-FAILED-SERVERS=3"), scanner_string_null, __check_REMOVE_FAILED_SERVERS },
 186   { ARRAY,  make_scanner_string("--RETRY_TIMEOUT=456"), scanner_string_null, NULL },
 187   { ARRAY,  make_scanner_string("--SND_TIMEOUT=456"), scanner_string_null, NULL },
 188   { ARRAY,  make_scanner_string("--SOCKET_RECV_SIZE=456"), scanner_string_null, NULL },
 189   { ARRAY,  make_scanner_string("--SOCKET_SEND_SIZE=456"), scanner_string_null, NULL },
 190   { NIL, scanner_string_null, scanner_string_null, NULL}
 191 };
 192
 193 scanner_variable_t test_boolean_options[]= {
 194   { ARRAY,  make_scanner_string("--BINARY_PROTOCOL"), scanner_string_null, NULL },
 195   { ARRAY,  make_scanner_string("--BUFFER_REQUESTS"), scanner_string_null, NULL },
 196   { ARRAY,  make_scanner_string("--HASH_WITH_PREFIX_KEY"), scanner_string_null, NULL },
 197   { ARRAY,  make_scanner_string("--NOREPLY"), scanner_string_null, __check_NOREPLY },
 198   { ARRAY,  make_scanner_string("--RANDOMIZE_REPLICA_READ"), scanner_string_null, NULL },
 199   { ARRAY,  make_scanner_string("--SORT_HOSTS"), scanner_string_null, NULL },
 200   { ARRAY,  make_scanner_string("--SUPPORT_CAS"), scanner_string_null, NULL },
 201   { ARRAY,  make_scanner_string("--TCP_NODELAY"), scanner_string_null, NULL },
 202   { ARRAY,  make_scanner_string("--TCP_KEEPALIVE"), scanner_string_null, NULL },
 203   { ARRAY,  make_scanner_string("--TCP_KEEPIDLE"), scanner_string_null, NULL },
 204   { ARRAY,  make_scanner_string("--USE_UDP"), scanner_string_null, NULL },
 205   { ARRAY,  make_scanner_string("--VERIFY_KEY"), scanner_string_null, __check_VERIFY_KEY },
 206   { NIL, scanner_string_null, scanner_string_null, NULL}
 207 };
 208
 209 scanner_variable_t prefix_key_strings[]= {
 210   { ARRAY, make_scanner_string("--PREFIX_KEY=foo"), make_scanner_string("foo"), __check_prefix_key },
 211   { ARRAY, make_scanner_string("--PREFIX-KEY=\"foo\""), make_scanner_string("foo"), __check_prefix_key },
 212   { ARRAY, make_scanner_string("--PREFIX-KEY=\"This is a very long key\""), make_scanner_string("This is a very long key"), __check_prefix_key },
 213   { NIL, scanner_string_null, scanner_string_null, NULL}
 214 };
 215
 216 scanner_variable_t distribution_strings[]= {
 217   { ARRAY,  make_scanner_string("--DISTRIBUTION=consistent"), scanner_string_null, NULL },
 218   { ARRAY,  make_scanner_string("--DISTRIBUTION=consistent,CRC"), scanner_string_null, NULL },
 219   { ARRAY,  make_scanner_string("--DISTRIBUTION=consistent,MD5"), scanner_string_null, NULL },
 220   { ARRAY,  make_scanner_string("--DISTRIBUTION=random"), scanner_string_null, __check_distribution_RANDOM },
 221   { ARRAY,  make_scanner_string("--DISTRIBUTION=modula"), scanner_string_null, NULL },
 222   { NIL, scanner_string_null, scanner_string_null, NULL}
 223 };
 224
 225 scanner_variable_t hash_strings[]= {
 226   { ARRAY,  make_scanner_string("--HASH=CRC"), scanner_string_null, NULL },
 227   { ARRAY,  make_scanner_string("--HASH=FNV1A_32"), scanner_string_null, NULL },
 228   { ARRAY,  make_scanner_string("--HASH=FNV1A_64"), scanner_string_null, NULL },
 229   { ARRAY,  make_scanner_string("--HASH=FNV1_32"), scanner_string_null, NULL },
 230   { ARRAY,  make_scanner_string("--HASH=FNV1_64"), scanner_string_null, NULL },
 231   { ARRAY,  make_scanner_string("--HASH=JENKINS"), scanner_string_null, NULL },
 232   { ARRAY,  make_scanner_string("--HASH=MD5"), scanner_string_null, NULL },
 233   { ARRAY,  make_scanner_string("--HASH=MURMUR"), scanner_string_null, NULL },
 234   { NIL, scanner_string_null, scanner_string_null, NULL}
 235 };
 236
 237
 238 static test_return_t _test_option(scanner_variable_t *scanner, bool test_true= true)
 239 {
 240   (void)test_true;
 241   memcached_st *memc;
 242   memc= memcached_create(NULL);
 243
 244   for (scanner_variable_t *ptr= scanner; ptr->type != NIL; ptr++)
 245   {
 246     memcached_return_t rc;
 247     rc= memcached_parse_configuration(memc, ptr->option.c_str, ptr->option.size);
 248     if (test_true)
 249     {
 250       if (rc != MEMCACHED_SUCCESS)
 251       {
 252         memcached_error_print(memc);
 253       }
 254
 255       test_true(rc == MEMCACHED_SUCCESS);
 256
 257       if (ptr->check_func)
 258       {
 259         test_return_t test_rc= (*ptr->check_func)(memc, ptr->result);
 260         if (test_rc != TEST_SUCCESS)
 261           return test_rc;
 262       }
 263     }
 264     else
 265     {
 266       test_false_with(rc == MEMCACHED_SUCCESS, ptr->option.c_str);
 267     }
 268     memcached_reset(memc);
 269   }
 270   memcached_free(memc);
 271
 272   return TEST_SUCCESS;
 273 }
 274
 275 test_return_t server_test(memcached_st *)
 276 {
 277   return _test_option(test_server_strings);
 278 }
 279
 280 test_return_t server_with_weight_test(memcached_st *)
 281 {
 282   return _test_option(test_server_strings_with_weights);
 283 }
 284
 285 test_return_t servers_bad_test(memcached_st *)
 286 {
 287   test_return_t rc;
 288   if ((rc= _test_option(bad_test_strings, false)) != TEST_SUCCESS)
 289   {
 290     return rc;
 291   }
 292
 293   return TEST_SUCCESS;
 294 }
 295
 296 test_return_t parser_number_options_test(memcached_st*)
 297 {
 298   return _test_option(test_number_options);
 299 }
 300
 301 test_return_t parser_boolean_options_test(memcached_st*)
 302 {
 303   return _test_option(test_boolean_options);
 304 }
 305
 306 test_return_t behavior_parser_test(memcached_st*)
 307 {
 308   return TEST_SUCCESS;
 309 }
 310
 311 test_return_t parser_hash_test(memcached_st*)
 312 {
 313   return _test_option(hash_strings);
 314 }
 315
 316 test_return_t parser_distribution_test(memcached_st*)
 317 {
 318   return _test_option(distribution_strings);
 319 }
 320
 321 test_return_t parser_key_prefix_test(memcached_st*)
 322 {
 323   return _test_option(distribution_strings);
 324 }
 325
 326 #define SUPPORT_EXAMPLE_CNF "support/example.cnf"
 327
 328 test_return_t memcached_parse_configure_file_test(memcached_st*)
 329 {
 330   if (access(SUPPORT_EXAMPLE_CNF, R_OK))
 331     return TEST_SKIPPED;
 332
 333   memcached_st memc;
 334   memcached_st *memc_ptr= memcached_create(&memc);
 335
 336   test_true(memc_ptr);
 337
 338   memcached_set_configuration_file(memc_ptr, memcached_string_with_size(SUPPORT_EXAMPLE_CNF));
 339   memcached_reset(memc_ptr);
 340   memcached_free(memc_ptr);
 341
 342   return TEST_SUCCESS;
 343 }
 344
 345 test_return_t memcached_create_with_options_with_filename(memcached_st*)
 346 {
 347   if (access(SUPPORT_EXAMPLE_CNF, R_OK))
 348     return TEST_SKIPPED;
 349
 350   memcached_st *memc_ptr;
 351   memc_ptr= memcached_create_with_options(STRING_WITH_LEN("--CONFIGURE-FILE=\"support/example.cnf\""));
 352   test_true_got(memc_ptr, memcached_last_error_message(memc_ptr));
 353   memcached_free(memc_ptr);
 354
 355   return TEST_SUCCESS;
 356 }
 357
 358 test_return_t libmemcached_check_configuration_with_filename_test(memcached_st*)
 359 {
 360   if (access(SUPPORT_EXAMPLE_CNF, R_OK))
 361     return TEST_SKIPPED;
 362
 363   memcached_return_t rc;
 364   char buffer[BUFSIZ];
 365
 366   rc= libmemcached_check_configuration(STRING_WITH_LEN("--CONFIGURE-FILE=\"support/example.cnf\""), buffer, sizeof(buffer));
 367   test_true_got(rc == MEMCACHED_SUCCESS, buffer);
 368
 369   rc= libmemcached_check_configuration(STRING_WITH_LEN("--CONFIGURE-FILE=support/example.cnf"), buffer, sizeof(buffer));
 370   test_false_with(rc == MEMCACHED_SUCCESS, buffer);
 371
 372   rc= libmemcached_check_configuration(STRING_WITH_LEN("--CONFIGURE-FILE=\"bad-path/example.cnf\""), buffer, sizeof(buffer));
 373   test_true_got(rc == MEMCACHED_ERRNO, buffer);
 374
 375   return TEST_SUCCESS;
 376 }
 377
 378 test_return_t libmemcached_check_configuration_test(memcached_st*)
 379 {
 380   memcached_return_t rc;
 381   char buffer[BUFSIZ];
 382
 383   rc= libmemcached_check_configuration(STRING_WITH_LEN("--server=localhost"), buffer, sizeof(buffer));
 384   test_true_got(rc == MEMCACHED_SUCCESS, buffer);
 385
 386   rc= libmemcached_check_configuration(STRING_WITH_LEN("--dude=localhost"), buffer, sizeof(buffer));
 387   test_false_with(rc == MEMCACHED_SUCCESS, buffer);
 388   test_true(rc == MEMCACHED_PARSE_ERROR);
 389
 390   return TEST_SUCCESS;
 391 }
 392
 393 test_return_t memcached_create_with_options_test(memcached_st*)
 394 {
 395   memcached_st *memc_ptr;
 396   memc_ptr= memcached_create_with_options(STRING_WITH_LEN("--server=localhost"));
 397   test_true_got(memc_ptr, memcached_last_error_message(memc_ptr));
 398   memcached_free(memc_ptr);
 399
 400   memc_ptr= memcached_create_with_options(STRING_WITH_LEN("--dude=localhost"));
 401   test_false_with(memc_ptr, memcached_last_error_message(memc_ptr));
 402
 403   return TEST_SUCCESS;
 404 }
 405
 406 test_return_t test_include_keyword(memcached_st*)
 407 {
 408   if (access(SUPPORT_EXAMPLE_CNF, R_OK))
 409     return TEST_SKIPPED;
 410
 411   char buffer[BUFSIZ];
 412   memcached_return_t rc;
 413   rc= libmemcached_check_configuration(STRING_WITH_LEN("INCLUDE \"support/example.cnf\""), buffer, sizeof(buffer));
 414   test_true_got(rc == MEMCACHED_SUCCESS, buffer);
 415
 416   return TEST_SUCCESS;
 417 }
 418
 419 test_return_t test_end_keyword(memcached_st*)
 420 {
 421   char buffer[BUFSIZ];
 422   memcached_return_t rc;
 423   rc= libmemcached_check_configuration(STRING_WITH_LEN("--server=localhost END bad keywords"), buffer, sizeof(buffer));
 424   test_true_got(rc == MEMCACHED_SUCCESS, buffer);
 425
 426   return TEST_SUCCESS;
 427 }
 428
 429 test_return_t test_reset_keyword(memcached_st*)
 430 {
 431   char buffer[BUFSIZ];
 432   memcached_return_t rc;
 433   rc= libmemcached_check_configuration(STRING_WITH_LEN("--server=localhost reset --server=bad.com"), buffer, sizeof(buffer));
 434   test_true_got(rc == MEMCACHED_SUCCESS, buffer);
 435
 436   return TEST_SUCCESS;
 437 }
 438
 439 test_return_t test_error_keyword(memcached_st*)
 440 {
 441   char buffer[BUFSIZ];
 442   memcached_return_t rc;
 443   rc= libmemcached_check_configuration(STRING_WITH_LEN("--server=localhost ERROR --server=bad.com"), buffer, sizeof(buffer));
 444   test_true_got(rc != MEMCACHED_SUCCESS, buffer);
 445
 446   return TEST_SUCCESS;
 447 }
 448
 449 #define RANDOM_STRINGS 100
 450 test_return_t random_statement_build_test(memcached_st*)
 451 {
 452   std::vector<scanner_string_st *> option_list;
 453
 454   for (scanner_variable_t *ptr= test_server_strings; ptr->type != NIL; ptr++)
 455     option_list.push_back(&ptr->option);
 456
 457   for (scanner_variable_t *ptr= test_number_options; ptr->type != NIL; ptr++)
 458     option_list.push_back(&ptr->option);
 459
 460   for (scanner_variable_t *ptr= test_boolean_options; ptr->type != NIL; ptr++)
 461     option_list.push_back(&ptr->option);
 462
 463   for (scanner_variable_t *ptr= prefix_key_strings; ptr->type != NIL; ptr++)
 464     option_list.push_back(&ptr->option);
 465
 466   for (scanner_variable_t *ptr= distribution_strings; ptr->type != NIL; ptr++)
 467     option_list.push_back(&ptr->option);
 468
 469   for (scanner_variable_t *ptr= hash_strings; ptr->type != NIL; ptr++)
 470     option_list.push_back(&ptr->option);
 471
 472   for (uint32_t x= 0; x < RANDOM_STRINGS; x++)
 473   {
 474     std::string random_options;
 475
 476     uint32_t number_of= random() % option_list.size();
 477     for (uint32_t options= 0; options < number_of; options++)
 478     {
 479       random_options+= option_list[random() % option_list.size()]->c_str;
 480       random_options+= " ";
 481     }
 482
 483     memcached_return_t rc;
 484     memcached_st *memc_ptr= memcached_create(NULL);
 485     rc= memcached_parse_configuration(memc_ptr, random_options.c_str(), random_options.size() -1);
 486     if (rc == MEMCACHED_PARSE_ERROR)
 487     {
 488       std::cerr << std::endl << "Failed to parse(" << memcached_strerror(NULL, rc) << "): " << random_options << std::endl;
 489       memcached_error_print(memc_ptr);
 490     }
 491     memcached_free(memc_ptr);
 492   }
 493
 494   return TEST_SUCCESS;
 495 }