Merge, better error messages
[m6w6/libmemcached] / libtest / memcached.cc
index e3d90947a2c0e1b99a5395dbb94f0942d27122f4..dd2ac1d642a1a9a1ac3fbf2e43e1c5a52f2517cf 100644 (file)
@@ -4,40 +4,27 @@
  *
  *  Copyright (C) 2011 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
- *  met:
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License as published by the Free Software Foundation; either
+ *  version 3 of the License, or (at your option) any later version.
  *
- *      * Redistributions of source code must retain the above copyright
- *  notice, this list of conditions and the following disclaimer.
- *
- *      * Redistributions in binary form must reproduce the above
- *  copyright notice, this list of conditions and the following disclaimer
- *  in the documentation and/or other materials provided with the
- *  distribution.
- *
- *      * The names of its contributors may not be used to endorse or
- *  promote products derived from this software without specific prior
- *  written permission.
- *
- *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
  *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
+
+#include <config.h>
 #include <libtest/common.h>
 
-#include <libmemcached/memcached.h>
-#include <libmemcached/util.h>
+#include <libmemcached-1.0/memcached.h>
+#include <libmemcachedutil-1.0/util.h>
 
 using namespace libtest;
 
@@ -63,61 +50,81 @@ using namespace libtest;
 
 using namespace libtest;
 
-class Memcached : public Server
+namespace {
+  bool is_memcached_libtool()
+  {
+    if (MEMCACHED_BINARY and strcmp(MEMCACHED_BINARY, "memcached/memcached") == 0) 
+    {
+      return true;
+    }
+
+    return false;
+  }
+}
+
+class Memcached : public libtest::Server
 {
+  std::string _username;
+  std::string _password;
+
 public:
-  Memcached(const std::string& host_arg, const in_port_t port_arg, const bool is_socket_arg) :
-    Server(host_arg, port_arg, is_socket_arg)
+  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)
   { }
 
-  pid_t get_pid(bool error_is_ok)
+  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)
   {
-    // Memcached is slow to start, so we need to do this
-    if (not pid_file().empty())
-    {
-      Wait wait(pid_file(), 0);
+    set_pid_file();
+  }
 
-      if (not wait.successful())
-      {
-        Error << "Pidfile was not found:" << pid_file();
-        return -1;
-      }
-    }
+  virtual const char *sasl() const
+  {
+    return NULL;
+  }
 
-    memcached_return_t rc;
-    if (has_socket())
-    {
-      _pid= libmemcached_util_getpid(socket().c_str(), port(), &rc);
-    }
-    else
-    {
-      _pid= libmemcached_util_getpid(hostname().c_str(), port(), &rc);
-    }
+  const std::string& password() const
+  {
+    return _password;
+  }
 
-    if ((memcached_failed(rc) or _pid < 1) and not error_is_ok)
-    {
-      Error << "libmemcached_util_getpid(" << memcached_strerror(NULL, rc) << ") pid: " << _pid << " for:" << *this;
-    }
+  const std::string& username() const
+  {
+    return _username;
+  }
+
+  bool wait_for_pidfile() const
+  {
+    Wait wait(pid(), 4);
 
-    return _pid;
+    return wait.successful();
   }
 
   bool ping()
   {
+#if 0
     // Memcached is slow to start, so we need to do this
-    if (not pid_file().empty())
+    if (pid_file().empty() == false)
     {
-      Wait wait(pid_file(), 0);
-
-      if (not wait.successful())
+      if (wait_for_pidfile() == false)
       {
-        Error << "Pidfile was not found:" << pid_file();
+        Error << "Pidfile was not found:" << pid_file() << " :" << running();
         return -1;
       }
     }
+#endif
 
     memcached_return_t rc;
     bool ret;
+
     if (has_socket())
     {
       ret= libmemcached_util_ping(socket().c_str(), 0, &rc);
@@ -127,10 +134,11 @@ public:
       ret= libmemcached_util_ping(hostname().c_str(), port(), &rc);
     }
 
-    if (memcached_failed(rc) or not ret)
+    if (memcached_failed(rc) or ret == false)
     {
-      Error << "libmemcached_util_ping(" << memcached_strerror(NULL, rc) << ")";
+      Error << "libmemcached_util_ping(" << hostname() << ", " << port() << ") error: " << memcached_strerror(NULL, rc);
     }
+
     return ret;
   }
 
@@ -144,9 +152,17 @@ public:
     return MEMCACHED_BINARY;
   }
 
-  const char *pid_file_option()
+  bool is_libtool()
+  {
+    return is_memcached_libtool();
+  }
+
+  virtual void pid_file_option(Application& app, const std::string& arg)
   {
-    return "-P ";
+    if (arg.empty() == false)
+    {
+      app.add_option("-P", arg);
+    }
   }
 
   const char *socket_file_option() const
@@ -154,24 +170,34 @@ public:
     return "-s ";
   }
 
-  const char *daemon_file_option()
+  virtual void port_option(Application& app, in_port_t arg)
   {
-    return "-d";
+    char buffer[30];
+    snprintf(buffer, sizeof(buffer), "%d", int(arg));
+    app.add_option("-p", buffer); 
   }
 
-  const char *log_file_option()
+  bool has_port_option() const
   {
-    return NULL;
+    return true;
   }
 
-  const char *port_option()
+  bool has_socket_file_option() const
   {
-    return "-p ";
+    return has_socket();
   }
 
-  bool is_libtool()
+  void socket_file_option(Application& app, const std::string& socket_arg)
   {
-    return false;
+    if (socket_arg.empty() == false)
+    {
+      app.add_option("-s", socket_arg);
+    }
+  }
+
+  bool broken_socket_cleanup()
+  {
+    return true;
   }
 
   // Memcached's pidfile is broken
@@ -180,41 +206,223 @@ public:
     return true;
   }
 
-  bool build(int argc, const char *argv[]);
+  bool build(size_t argc, const char *argv[]);
 };
 
+class MemcachedLight : public libtest::Server
+{
 
-#include <sstream>
+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 << "Pidfile was not found:" << pid_file();
+        return false;
+      }
+    }
+
+    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)
+      {
+        return true;
+      }
+    }
+
+    return false;
+  }
+
+  const char *name()
+  {
+    return "memcached_light";
+  };
+
+  const char *executable()
+  {
+    return MEMCACHED_LIGHT_BINARY;
+  }
 
-bool Memcached::build(int argc, const char *argv[])
+  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
 {
-  std::stringstream arg_buffer;
+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 ";
+  }
+
+  const char *executable()
+  {
+    return MEMCACHED_SASL_BINARY;
+  }
+
+  bool ping()
+  {
+    // Memcached is slow to start, so we need to do this
+    if (pid_file().empty() == false)
+    {
+      if (wait_for_pidfile() == false)
+      {
+        Error << "Pidfile was not found:" << pid_file();
+        return -1;
+      }
+    }
+
+    memcached_return_t rc;
+    bool ret;
+
+    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 << "libmemcached_util_ping2(" << hostname() << ", " << port() << ", " << username() << ", " << password() << ") error: " << memcached_strerror(NULL, rc);
+    }
 
+    return ret;
+  }
+
+};
+
+
+#include <sstream>
+
+bool Memcached::build(size_t argc, const char *argv[])
+{
   if (getuid() == 0 or geteuid() == 0)
   {
-    arg_buffer << " -u root ";
+    add_option("-u", "root");
   }
 
-  for (int x= 1 ; x < argc ; x++)
+  add_option("-l", "localhost");
+  add_option("-m", "128");
+  add_option("-M");
+
+  if (sasl())
   {
-    arg_buffer << " " << argv[x] << " ";
+    add_option(sasl());
   }
 
-  set_extra_args(arg_buffer.str());
+  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;
 }
 
 namespace libtest {
 
-Server *build_memcached(const std::string& hostname, const in_port_t try_port)
+libtest::Server *build_memcached(const std::string& hostname, const in_port_t try_port)
 {
   return new Memcached(hostname, try_port, false);
 }
 
-Server *build_memcached_socket(const std::string& hostname, const in_port_t try_port)
+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 Memcached(hostname, try_port, true);
+  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 (username.empty())
+  {
+    return new MemcachedSaSL(hostname, try_port, false,  "memcached", "memcached");
+  }
+
+  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);
 }
 
 }