Merge up to gearmand.
[m6w6/libmemcached] / libtest / memcached.cc
index 2b49c6085a4a8cde7e7effdbd916c89ba82dfad2..d92944f6bfeb1bd9cec17320229cd880f3edb6f6 100644 (file)
@@ -1,9 +1,8 @@
 /*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
- * 
- *  Libmemcached library
  *
- *  Copyright (C) 2011 Data Differential, http://datadifferential.com/
- *  Copyright (C) 2006-2009 Brian Aker All rights reserved.
+ *  Data Differential YATL (i.e. libtest)  library
+ *
+ *  Copyright (C) 2012 Data Differential, http://datadifferential.com/
  *
  *  Redistribution and use in source and binary forms, with or without
  *  modification, are permitted provided that the following conditions are
  *
  */
 
+#include <config.h>
+#include <libtest/common.h>
 
-/*
-  Startup, and shutdown the memcached servers.
-*/
-
-#define TEST_PORT_BASE MEMCACHED_DEFAULT_PORT+10
+#include <libmemcached-1.0/memcached.h>
+#include <libmemcachedutil-1.0/util.h>
 
-#include <libtest/common.h>
+using namespace libtest;
 
+#include <cassert>
+#include <cerrno>
 #include <cstdio>
 #include <cstdlib>
 #include <cstring>
-#include <ctime>
-#include <limits.h>
+#include <iostream>
 #include <signal.h>
-#include <sys/time.h>
+#include <sys/types.h>
+#include <sys/wait.h>
 #include <unistd.h>
-#include <iostream>
-
-#include <libmemcached/memcached.h>
-#include <libmemcached/util.h>
 
 #include <libtest/server.h>
-#include <libtest/killpid.h>
 #include <libtest/wait.h>
 
-#define SOCKET_FILE "/tmp/memcached.socket"
+#include <libtest/memcached.h>
 
-static pid_t __getpid(server_st& server)
-{
-  memcached_return_t rc;
-  pid_t pid= libmemcached_util_getpid(server.hostname(), server.port(), &rc);
-  return pid;
-}
+#ifndef __INTEL_COMPILER
+#pragma GCC diagnostic ignored "-Wold-style-cast"
+#endif
 
-static bool __ping(server_st& server)
-{
-  memcached_return_t rc;
-  bool ret= libmemcached_util_ping(server.hostname(), server.port(), &rc);
-  return ret;
-}
+using namespace libtest;
 
-static bool cycle_server(server_st  *server)
-{
-  while (1)
+namespace {
+  bool is_memcached_libtool()
   {
-    if (libmemcached_util_ping(server->hostname(), server->port(), NULL))
+    if (MEMCACHED_BINARY and strcmp(MEMCACHED_BINARY, "memcached/memcached") == 0) 
     {
-      // First we try to kill it, and on fail of that we flush it.
-      pid_t pid= libmemcached_util_getpid(server->hostname(), server->port(), NULL);
-
-      if (pid > 0 and kill_pid(pid))
-      {
-        Error << "Killed existing server," << *server << " with pid:" << pid;
-        continue;
-      }
-      else if (libmemcached_util_flush(server->hostname(), server->port(), NULL)) // If we can flush it, we will just use it
-      { 
-        Error << "Found server on port " << int(server->port()) << ", flushed it!";
-        server->set_used();
-        return true;
-      } // No idea what is wrong here, so we need to find a different port
-      else
-      {
-        return false;
-      }
+      return true;
     }
 
-    break;
+    return false;
   }
-
-  return true;
 }
 
-bool server_startup(server_startup_st *construct)
+class Memcached : public libtest::Server
 {
-  Logn();
+  std::string _username;
+  std::string _password;
+
+public:
+  Memcached(const std::string& host_arg,
+            const in_port_t port_arg,
+            const bool is_socket_arg,
+            const std::string& username_arg,
+            const std::string& password_arg) :
+    libtest::Server(host_arg, port_arg, 
+                    MEMCACHED_BINARY, is_memcached_libtool(), is_socket_arg),
+    _username(username_arg),
+    _password(password_arg)
+  { }
+
+  Memcached(const std::string& host_arg, const in_port_t port_arg, const bool is_socket_arg) :
+    libtest::Server(host_arg, port_arg,
+                    MEMCACHED_BINARY, is_memcached_libtool(), is_socket_arg)
+  {
+    set_pid_file();
+  }
 
-  if (getenv(((char *)"MEMCACHED_SERVERS")))
+  virtual const char *sasl() const
   {
-    construct->server_list= getenv(((char *)"MEMCACHED_SERVERS"));
-    Log << "MEMCACHED_SERVERS " << construct->server_list;
-    construct->count= 0;
+    return NULL;
   }
-  else
+
+  const std::string& password() const
   {
-    std::string server_config_string;
+    return _password;
+  }
 
-    uint32_t port_base= 0;
-    for (uint32_t x= 0; x < (construct->count -1); x++)
-    {
-      server_st *server= NULL;
+  const std::string& username() const
+  {
+    return _username;
+  }
 
-      {
-        char *var;
-        char variable_buffer[1024];
-
-        snprintf(variable_buffer, sizeof(variable_buffer), "LIBMEMCACHED_PORT_%u", x);
-
-        if ((var= getenv(variable_buffer)))
-        {
-          server= new server_st((in_port_t)atoi(var), __getpid, __ping);
-        }
-        else
-        {
-          server= new server_st(in_port_t(x +TEST_PORT_BASE +port_base), __getpid, __ping);
-
-          while (not cycle_server(server))
-          {
-            Error << "Found server " << *server << ", could not flush it, so trying next port.";
-            port_base++;
-            server->set_port(in_port_t(x +TEST_PORT_BASE +port_base));
-          }
-        }
-      }
+  bool wait_for_pidfile() const
+  {
+    Wait wait(pid(), 4);
 
-      if (server->is_used())
-      {
-        Log << "Using server at : " << server;
-      }
-      else
-      {
-        char buffer[FILENAME_MAX];
-        if (x == 0)
-        {
-          snprintf(buffer, sizeof(buffer), "%s -d -t 1 -p %u -U %u -m 128",
-                   MEMCACHED_BINARY, server->port(), server->port());
-        }
-        else
-        {
-          snprintf(buffer, sizeof(buffer), "%s -d -t 1 -p %u -U %u",
-                   MEMCACHED_BINARY, server->port(), server->port());
-        }
-        server->set_command(buffer);
-
-        if (not server->start())
-        {
-          Error << "Failed system(" << buffer << ")";
-          delete server;
-          return false;
-        }
-        Log << "STARTING SERVER: " << buffer << " pid:" << server->pid();
-      }
-      construct->push_server(server);
+    return wait.successful();
+  }
 
-      if (x == 0)
+  bool ping()
+  {
+#if 0
+    // Memcached is slow to start, so we need to do this
+    if (pid_file().empty() == false)
+    {
+      if (wait_for_pidfile() == false)
       {
-        assert(server->has_port());
-        set_default_port(server->port());
+        Error << "Pidfile was not found:" << pid_file() << " :" << running();
+        return -1;
       }
+    }
+#endif
 
-      char port_str[NI_MAXSERV];
-      snprintf(port_str, sizeof(port_str), "%u", int(server->port()));
+    memcached_return_t rc;
+    bool ret;
 
-      server_config_string+= "--server=";
-      server_config_string+= server->hostname();
-      server_config_string+= ":";
-      server_config_string+= port_str;
-      server_config_string+= " ";
+    if (has_socket())
+    {
+      ret= libmemcached_util_ping(socket().c_str(), 0, &rc);
+    }
+    else
+    {
+      ret= libmemcached_util_ping(hostname().c_str(), port(), &rc);
     }
 
-    // Socket
+    if (memcached_failed(rc) or ret == false)
     {
+      error(memcached_strerror(NULL, rc));
+    }
 
-      std::string socket_file(SOCKET_FILE);
-      char *var;
+    return ret;
+  }
 
-      if ((var= getenv("LIBMEMCACHED_SOCKET")))
-      {
-        socket_file= var;
-      }
+  const char *name()
+  {
+    return "memcached";
+  };
+
+  const char *executable()
+  {
+    return MEMCACHED_BINARY;
+  }
+
+  bool is_libtool()
+  {
+    return is_memcached_libtool();
+  }
 
-      server_st *server= new server_st(SOCKET_FILE, __getpid, __ping);
+  virtual void pid_file_option(Application& app, const std::string& arg)
+  {
+    if (arg.empty() == false)
+    {
+      app.add_option("-P", arg);
+    }
+  }
 
-      if (not cycle_server(server))
+  const char *socket_file_option() const
+  {
+    return "-s ";
+  }
+
+  virtual void port_option(Application& app, in_port_t arg)
+  {
+    char buffer[30];
+    snprintf(buffer, sizeof(buffer), "%d", int(arg));
+    app.add_option("-p", buffer); 
+  }
+
+  bool has_port_option() const
+  {
+    return true;
+  }
+
+  bool has_socket_file_option() const
+  {
+    return has_socket();
+  }
+
+  void socket_file_option(Application& app, const std::string& socket_arg)
+  {
+    if (socket_arg.empty() == false)
+    {
+      app.add_option("-s", socket_arg);
+    }
+  }
+
+  bool broken_socket_cleanup()
+  {
+    return true;
+  }
+
+  // Memcached's pidfile is broken
+  bool broken_pid_file()
+  {
+    return true;
+  }
+
+  bool build(size_t argc, const char *argv[]);
+};
+
+class MemcachedLight : public libtest::Server
+{
+
+public:
+  MemcachedLight(const std::string& host_arg, const in_port_t port_arg) :
+    libtest::Server(host_arg, port_arg, MEMCACHED_LIGHT_BINARY, true)
+  {
+    set_pid_file();
+  }
+
+  bool ping()
+  {
+    // Memcached is slow to start, so we need to do this
+    if (not pid_file().empty())
+    {
+      if (not wait_for_pidfile())
       {
-        Error << "Found server " << server << ", could not flush it, failing since socket file is not available.";
+        Error << "Pidfile was not found:" << pid_file();
         return false;
       }
+    }
 
-      if (server->is_used())
-      {
-        Log << "Using server at : " << *server;
-      }
-      else
+    std::stringstream error_message;
+    pid_t local_pid= get_pid_from_file(pid_file(), error_message);
+    if (local_pid > 0)
+    {
+      if (::kill(local_pid, 0) == 0)
       {
-        char buffer[FILENAME_MAX];
-        snprintf(buffer, sizeof(buffer), "%s -d -t 1 -s %s", MEMCACHED_BINARY, SOCKET_FILE);
-        server->set_command(buffer);
-
-        if (not server->start())
-        {
-          Error << "Failed system(" << buffer << ")";
-          delete server;
-          return false;
-        }
-        Log << "STARTING SERVER: " << buffer << " pid:" << server->pid();
+        return true;
       }
-      set_default_socket(server->hostname());
-      construct->push_server(server);
+    }
 
-      {
-        server_config_string+= "--socket=\"";
-        server_config_string+= server->hostname();
-        server_config_string+= "\" ";
-      }
+    return false;
+  }
+
+  const char *name()
+  {
+    return "memcached_light";
+  };
+
+  const char *executable()
+  {
+    return MEMCACHED_LIGHT_BINARY;
+  }
+
+  virtual void port_option(Application& app, in_port_t arg)
+  {
+    char buffer[1024];
+    snprintf(buffer, sizeof(buffer), "--port=%d", int(arg));
+    app.add_option(buffer);
+  }
+
+  bool has_port_option() const
+  {
+    return true;
+  }
+
+  bool is_libtool()
+  {
+    return true;
+  }
+
+  void log_file_option(Application& app, const std::string& arg)
+  {
+    if (arg.empty() == false)
+    {
+      std::string buffer("--log-file=");
+      buffer+= arg;
+      app.add_option("--verbose");
+      app.add_option(buffer);
     }
+  }
+
+  bool has_log_file_option() const
+  {
+    return true;
+  }
+
+  bool build(size_t argc, const char *argv[]);
+};
+
+class MemcachedSaSL : public Memcached
+{
+public:
+  MemcachedSaSL(const std::string& host_arg,
+                const in_port_t port_arg, 
+                const bool is_socket_arg, 
+                const std::string& username_arg, 
+                const std::string &password_arg) :
+    Memcached(host_arg, port_arg, is_socket_arg, username_arg, password_arg)
+  { }
+
+  const char *name()
+  {
+    return "memcached-sasl";
+  };
+
+  const char *sasl() const
+  {
+    return " -S -B binary ";
+  }
 
-    server_config_string.resize(server_config_string.size() -1); // Remove final space
-    construct->server_list= server_config_string;
+  const char *executable()
+  {
+    return MEMCACHED_SASL_BINARY;
   }
 
-  Logn();
+  bool ping()
+  {
+    memcached_return_t rc;
+    bool ret;
 
-  srandom((unsigned int)time(NULL));
+    if (has_socket())
+    {
+      ret= libmemcached_util_ping2(socket().c_str(), 0, username().c_str(), password().c_str(), &rc);
+    }
+    else
+    {
+      ret= libmemcached_util_ping2(hostname().c_str(), port(), username().c_str(), password().c_str(), &rc);
+    }
+
+    if (memcached_failed(rc) or ret == false)
+    {
+      error(memcached_strerror(NULL, rc));
+    }
+
+    return ret;
+  }
+
+};
+
+
+#include <sstream>
+
+bool Memcached::build(size_t argc, const char *argv[])
+{
+  if (getuid() == 0 or geteuid() == 0)
+  {
+    add_option("-u", "root");
+  }
+
+  add_option("-l", "localhost");
+#ifndef TARGET_OS_OSX
+  add_option("-m", "128");
+  add_option("-M");
+#endif
+
+  if (sasl())
+  {
+    add_option(sasl());
+  }
+
+  for (int x= 0 ; x < argc ; x++)
+  {
+    add_option(argv[x]);
+  }
+
+  return true;
+}
+
+bool MemcachedLight::build(size_t argc, const char *argv[])
+{
+  for (size_t x= 0 ; x < argc ; x++)
+  {
+    add_option(argv[x]);
+  }
 
   return true;
 }
 
-void server_shutdown(server_startup_st *construct)
+namespace libtest {
+
+libtest::Server *build_memcached(const std::string& hostname, const in_port_t try_port)
+{
+  return new Memcached(hostname, try_port, false);
+}
+
+libtest::Server *build_memcached_socket(const std::string& socket_file, const in_port_t try_port)
+{
+  return new Memcached(socket_file, try_port, true);
+}
+
+libtest::Server *build_memcached_light(const std::string& hostname, const in_port_t try_port)
+{
+  return new MemcachedLight(hostname, try_port);
+}
+
+
+libtest::Server *build_memcached_sasl(const std::string& hostname, const in_port_t try_port, const std::string& username, const std::string &password)
 {
-  if (not construct)
-    return;
+  if (username.empty())
+  {
+    return new MemcachedSaSL(hostname, try_port, false,  "memcached", "memcached");
+  }
 
-  construct->shutdown();
+  return new MemcachedSaSL(hostname, try_port, false,  username, password);
 }
+
+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)
+{
+  if (username.empty())
+  {
+    return new MemcachedSaSL(socket_file, try_port, true, "memcached", "memcached");
+  }
+
+  return new MemcachedSaSL(socket_file, try_port, true, username, password);
+}
+
+}
+