git.m6w6.name Git - awesomized/libmemcached/blob - libtest/memcached.cc

   1 /*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
   2  *
   3  *  Data Differential YATL (i.e. libtest)  library
   4  *
   5  *  Copyright (C) 2012 Data Differential, http://datadifferential.com/
   6  *
   7  *  Redistribution and use in source and binary forms, with or without
   8  *  modification, are permitted provided that the following conditions are
   9  *  met:
  10  *
  11  *      * Redistributions of source code must retain the above copyright
  12  *  notice, this list of conditions and the following disclaimer.
  13  *
  14  *      * Redistributions in binary form must reproduce the above
  15  *  copyright notice, this list of conditions and the following disclaimer
  16  *  in the documentation and/or other materials provided with the
  17  *  distribution.
  18  *
  19  *      * The names of its contributors may not be used to endorse or
  20  *  promote products derived from this software without specific prior
  21  *  written permission.
  22  *
  23  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  24  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  25  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  26  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  27  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  28  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  29  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  30  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  31  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  32  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  *
  35  */
  36
  37 #include "mem_config.h"
  38 #include <libtest/common.h>
  39
  40 #include <libmemcached-1.0/memcached.h>
  41 #include <libmemcachedutil-1.0/util.h>
  42
  43 using namespace libtest;
  44
  45 #include <cassert>
  46 #include <cerrno>
  47 #include <cstdio>
  48 #include <cstdlib>
  49 #include <cstring>
  50 #include <iostream>
  51 #include <signal.h>
  52 #include <sys/types.h>
  53 #include <sys/wait.h>
  54 #include <unistd.h>
  55
  56 #include <libtest/server.h>
  57 #include <libtest/wait.h>
  58
  59 #include <libtest/memcached.h>
  60
  61 #ifndef __INTEL_COMPILER
  62 #pragma GCC diagnostic ignored "-Wold-style-cast"
  63 #endif
  64
  65 using namespace libtest;
  66
  67 namespace {
  68   bool is_memcached_libtool()
  69   {
  70     if (MEMCACHED_BINARY and strcmp(MEMCACHED_BINARY, "memcached/memcached") == 0)
  71     {
  72       return true;
  73     }
  74
  75     return false;
  76   }
  77 }
  78
  79 class Memcached : public libtest::Server
  80 {
  81   std::string _username;
  82   std::string _password;
  83
  84 public:
  85   Memcached(const std::string& host_arg,
  86             const in_port_t port_arg,
  87             const bool is_socket_arg,
  88             const std::string& username_arg,
  89             const std::string& password_arg) :
  90     libtest::Server(host_arg, port_arg,
  91                     MEMCACHED_BINARY, is_memcached_libtool(), is_socket_arg),
  92     _username(username_arg),
  93     _password(password_arg)
  94   { }
  95
  96   Memcached(const std::string& host_arg, const in_port_t port_arg, const bool is_socket_arg) :
  97     libtest::Server(host_arg, port_arg,
  98                     MEMCACHED_BINARY, is_memcached_libtool(), is_socket_arg)
  99   {
 100     set_pid_file();
 101   }
 102
 103   virtual const char *sasl() const
 104   {
 105     return NULL;
 106   }
 107
 108   const std::string& password() const
 109   {
 110     return _password;
 111   }
 112
 113   const std::string& username() const
 114   {
 115     return _username;
 116   }
 117
 118   bool wait_for_pidfile() const
 119   {
 120     Wait wait(pid(), 4);
 121
 122     return wait.successful();
 123   }
 124
 125   bool ping()
 126   {
 127     if (out_of_ban_killed())
 128     {
 129       return false;
 130     }
 131
 132     SimpleClient client(_hostname, _port);
 133
 134     std::string response;
 135     return client.send_message("version", response);
 136   }
 137
 138   const char *name()
 139   {
 140     return "memcached";
 141   };
 142
 143   const char *executable()
 144   {
 145     return MEMCACHED_BINARY;
 146   }
 147
 148   bool is_libtool()
 149   {
 150     return is_memcached_libtool();
 151   }
 152
 153   virtual void pid_file_option(Application& app, const std::string& arg)
 154   {
 155     if (arg.empty() == false)
 156     {
 157       app.add_option("-P", arg);
 158     }
 159   }
 160
 161   const char *socket_file_option() const
 162   {
 163     return "-s ";
 164   }
 165
 166   virtual void port_option(Application& app, in_port_t arg)
 167   {
 168     char buffer[30];
 169     snprintf(buffer, sizeof(buffer), "%d", int(arg));
 170     app.add_option("-p", buffer);
 171   }
 172
 173   bool has_port_option() const
 174   {
 175     return true;
 176   }
 177
 178   bool has_socket_file_option() const
 179   {
 180     return has_socket();
 181   }
 182
 183   void socket_file_option(Application& app, const std::string& socket_arg)
 184   {
 185     if (socket_arg.empty() == false)
 186     {
 187       app.add_option("-s", socket_arg);
 188     }
 189   }
 190
 191   bool broken_socket_cleanup()
 192   {
 193     return true;
 194   }
 195
 196   // Memcached's pidfile is broken
 197   bool broken_pid_file()
 198   {
 199     return true;
 200   }
 201
 202   bool build(size_t argc, const char *argv[]);
 203 };
 204
 205 class MemcachedLight : public libtest::Server
 206 {
 207
 208 public:
 209   MemcachedLight(const std::string& host_arg, const in_port_t port_arg) :
 210     libtest::Server(host_arg, port_arg, MEMCACHED_LIGHT_BINARY, true)
 211   {
 212     set_pid_file();
 213   }
 214
 215   bool ping()
 216   {
 217     // Memcached is slow to start, so we need to do this
 218     if (not pid_file().empty())
 219     {
 220       if (not wait_for_pidfile())
 221       {
 222         Error << "Pidfile was not found:" << pid_file();
 223         return false;
 224       }
 225     }
 226
 227     std::stringstream error_message;
 228     pid_t local_pid= get_pid_from_file(pid_file(), error_message);
 229     if (local_pid > 0)
 230     {
 231       if (::kill(local_pid, 0) == 0)
 232       {
 233         return true;
 234       }
 235     }
 236
 237     return false;
 238   }
 239
 240   const char *name()
 241   {
 242     return "memcached_light";
 243   };
 244
 245   const char *executable()
 246   {
 247     return MEMCACHED_LIGHT_BINARY;
 248   }
 249
 250   virtual void port_option(Application& app, in_port_t arg)
 251   {
 252     char buffer[1024];
 253     snprintf(buffer, sizeof(buffer), "--port=%d", int(arg));
 254     app.add_option(buffer);
 255   }
 256
 257   bool has_port_option() const
 258   {
 259     return true;
 260   }
 261
 262   bool is_libtool()
 263   {
 264     return true;
 265   }
 266
 267   void log_file_option(Application& app, const std::string& arg)
 268   {
 269     if (arg.empty() == false)
 270     {
 271       std::string buffer("--log-file=");
 272       buffer+= arg;
 273       app.add_option("--verbose");
 274       app.add_option(buffer);
 275     }
 276   }
 277
 278   bool has_log_file_option() const
 279   {
 280     return true;
 281   }
 282
 283   bool build(size_t argc, const char *argv[]);
 284 };
 285
 286 class MemcachedSaSL : public Memcached
 287 {
 288 public:
 289   MemcachedSaSL(const std::string& host_arg,
 290                 const in_port_t port_arg,
 291                 const bool is_socket_arg,
 292                 const std::string& username_arg,
 293                 const std::string &password_arg) :
 294     Memcached(host_arg, port_arg, is_socket_arg, username_arg, password_arg)
 295   { }
 296
 297   const char *name()
 298   {
 299     return "memcached-sasl";
 300   };
 301
 302   const char *sasl() const
 303   {
 304     return " -S -B binary ";
 305   }
 306
 307   const char *executable()
 308   {
 309     return MEMCACHED_SASL_BINARY;
 310   }
 311
 312   bool ping()
 313   {
 314     memcached_return_t rc;
 315     bool ret;
 316
 317     if (has_socket())
 318     {
 319       ret= libmemcached_util_ping2(socket().c_str(), 0, username().c_str(), password().c_str(), &rc);
 320     }
 321     else
 322     {
 323       ret= libmemcached_util_ping2(hostname().c_str(), port(), username().c_str(), password().c_str(), &rc);
 324     }
 325
 326     if (memcached_failed(rc) or ret == false)
 327     {
 328       error(memcached_strerror(NULL, rc));
 329     }
 330
 331     return ret;
 332   }
 333
 334 };
 335
 336
 337 #include <sstream>
 338
 339 bool Memcached::build(size_t argc, const char *argv[])
 340 {
 341   if (getuid() == 0 or geteuid() == 0)
 342   {
 343     add_option("-u", "root");
 344   }
 345
 346   add_option("-l", "localhost");
 347 #ifndef TARGET_OS_OSX
 348   add_option("-m", "128");
 349   add_option("-M");
 350 #endif
 351
 352   if (sasl())
 353   {
 354     add_option(sasl());
 355   }
 356
 357   for (size_t x= 0 ; x < argc ; x++)
 358   {
 359     add_option(argv[x]);
 360   }
 361
 362   return true;
 363 }
 364
 365 bool MemcachedLight::build(size_t argc, const char *argv[])
 366 {
 367   for (size_t x= 0 ; x < argc ; x++)
 368   {
 369     add_option(argv[x]);
 370   }
 371
 372   return true;
 373 }
 374
 375 namespace libtest {
 376
 377 libtest::Server *build_memcached(const std::string& hostname, const in_port_t try_port)
 378 {
 379   return new Memcached(hostname, try_port, false);
 380 }
 381
 382 libtest::Server *build_memcached_socket(const std::string& socket_file, const in_port_t try_port)
 383 {
 384   return new Memcached(socket_file, try_port, true);
 385 }
 386
 387 libtest::Server *build_memcached_light(const std::string& hostname, const in_port_t try_port)
 388 {
 389   return new MemcachedLight(hostname, try_port);
 390 }
 391
 392
 393 libtest::Server *build_memcached_sasl(const std::string& hostname, const in_port_t try_port, const std::string& username, const std::string &password)
 394 {
 395   if (username.empty())
 396   {
 397     return new MemcachedSaSL(hostname, try_port, false,  "memcached", "memcached");
 398   }
 399
 400   return new MemcachedSaSL(hostname, try_port, false,  username, password);
 401 }
 402
 403 libtest::Server *build_memcached_sasl_socket(const std::string& socket_file, const in_port_t try_port, const std::string& username, const std::string &password)
 404 {
 405   if (username.empty())
 406   {
 407     return new MemcachedSaSL(socket_file, try_port, true, "memcached", "memcached");
 408   }
 409
 410   return new MemcachedSaSL(socket_file, try_port, true, username, password);
 411 }
 412
 413 }
 414