Update all licenses to BSD.
[m6w6/libmemcached] / libtest / memcached.cc
index 8c79b17ddd51984504e182f5d22294bb8f2d7aa1..d17e5f51a12955d5bdb0d75bc480edbda6791f69 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
  *
  */
 
-
-/*
-  Startup, and shutdown the memcached servers.
-*/
-
-#define TEST_PORT_BASE MEMCACHED_DEFAULT_PORT+10
-
 #include <config.h>
+#include <libtest/common.h>
+
+#include <libmemcached-1.0/memcached.h>
+#include <libmemcachedutil-1.0/util.h>
 
-#include <iso646.h>
+using namespace libtest;
 
-#include <assert.h>
-#include <limits.h>
+#include <cassert>
+#include <cerrno>
+#include <cstdio>
+#include <cstdlib>
+#include <cstring>
+#include <iostream>
 #include <signal.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <sys/time.h>
-#include <time.h>
+#include <sys/types.h>
+#include <sys/wait.h>
 #include <unistd.h>
-#include <errno.h>
-
-#include <libmemcached/memcached.h>
-#include <libmemcached/util.h>
 
 #include <libtest/server.h>
+#include <libtest/wait.h>
 
-static void global_sleep(void)
-{
-  static struct timespec global_sleep_value= { 0, 50000 };
+#include <libtest/memcached.h>
 
-#ifdef WIN32
-  sleep(1);
-#else
-  nanosleep(&global_sleep_value, NULL);
+#ifndef __INTEL_COMPILER
+#pragma GCC diagnostic ignored "-Wold-style-cast"
 #endif
-}
 
-static bool wait_for_file(const char *filename)
-{
-  uint32_t timeout= 6;
-  uint32_t waited;
-  uint32_t this_wait;
-  uint32_t retry;
+using namespace libtest;
 
-  for (waited= 0, retry= 1; ; retry++, waited+= this_wait)
+namespace {
+  bool is_memcached_libtool()
   {
-    if ((! access(filename, R_OK)) || (waited >= timeout))
+    if (MEMCACHED_BINARY and strcmp(MEMCACHED_BINARY, "memcached/memcached") == 0) 
     {
       return true;
     }
 
-    this_wait= retry * retry / 3 + 1;
-    sleep(this_wait);
+    return false;
   }
-
-  return false;
 }
 
-static void kill_file(const char *file_buffer)
+class Memcached : public libtest::Server
 {
-  FILE *fp;
+  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();
+  }
+
+  virtual const char *sasl() const
+  {
+    return NULL;
+  }
+
+  const std::string& password() const
+  {
+    return _password;
+  }
+
+  const std::string& username() const
+  {
+    return _username;
+  }
 
-  while ((fp= fopen(file_buffer, "r")))
+  bool wait_for_pidfile() const
   {
-    char pid_buffer[1024];
+    Wait wait(pid(), 4);
 
-    if (fgets(pid_buffer, sizeof(pid_buffer), fp) != NULL)
+    return wait.successful();
+  }
+
+  bool ping()
+  {
+#if 0
+    // Memcached is slow to start, so we need to do this
+    if (pid_file().empty() == false)
     {
-      pid_t pid= (pid_t)atoi(pid_buffer);
-      if (pid != 0)
+      if (wait_for_pidfile() == false)
       {
-        if (kill(pid, SIGTERM) == -1)
-        {
-          remove(file_buffer); // If this happens we may be dealing with a dead server that left its pid file.
-        }
-        else
-        {
-          uint32_t counter= 3;
-          while ((kill(pid, 0) == 0) && --counter)
-          {
-            global_sleep();
-          }
-        }
+        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);
+    }
+    else
+    {
+      ret= libmemcached_util_ping(hostname().c_str(), port(), &rc);
+    }
 
-    global_sleep();
+    if (memcached_failed(rc) or ret == false)
+    {
+      Error << "libmemcached_util_ping(" << hostname() << ", " << port() << ") error: " << memcached_strerror(NULL, rc);
+    }
 
-    fclose(fp);
+    return ret;
   }
-}
 
-void server_startup(server_startup_st *construct)
-{
-  if ((construct->server_list= getenv("MEMCACHED_SERVERS")))
+  const char *name()
+  {
+    return "memcached";
+  };
+
+  const char *executable()
+  {
+    return MEMCACHED_BINARY;
+  }
+
+  bool is_libtool()
+  {
+    return is_memcached_libtool();
+  }
+
+  virtual void pid_file_option(Application& app, const std::string& arg)
   {
-    printf("servers %s\n", construct->server_list);
-    construct->count= 0;
+    if (arg.empty() == false)
+    {
+      app.add_option("-P", arg);
+    }
   }
-  else
+
+  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)
     {
-      char server_string_buffer[8096];
-      char *end_ptr;
-      end_ptr= server_string_buffer;
+      app.add_option("-s", socket_arg);
+    }
+  }
 
-      uint32_t port_base= 0;
-      for (uint32_t x= 0; x < construct->count; x++)
-      {
-        int status;
-
-        snprintf(construct->pid_file[x], FILENAME_MAX, "/tmp/memcached.pidXXXXXX");
-        int fd;
-        if ((fd= mkstemp(construct->pid_file[x])) == -1)
-        {
-          perror("mkstemp");
-          return;
-        }
-        close(fd);
-
-        {
-          char *var;
-          char variable_buffer[1024];
-
-          snprintf(variable_buffer, sizeof(variable_buffer), "LIBMEMCACHED_PORT_%u", x);
-
-          if ((var= getenv(variable_buffer)))
-          {
-            construct->port[x]= (in_port_t)atoi(var);
-          }
-          else
-          {
-            do {
-              construct->port[x]= (in_port_t)(x + TEST_PORT_BASE + port_base);
-
-              if (libmemcached_util_ping("localhost", construct->port[x], NULL))
-              {
-                if (libmemcached_util_flush("localhost", construct->port[x], NULL))
-                { 
-                  fprintf(stderr, "Found server on port %d, flushed it!\n", (int)construct->port[x]);
-                  construct->is_used[x]= true;
-                } // If we can flush it, we will just use it
-                else
-                {
-                  fprintf(stderr, "Found server on port %d, could not flush it, so trying next port.\n", (int)construct->port[x]);
-                  port_base++;
-                  construct->port[x]= 0;
-                }
-              }
-            } while (construct->port[x] == 0);
-          }
-        }
-
-        char buffer[FILENAME_MAX];
-        if (x == 0)
-        {
-          snprintf(buffer, sizeof(buffer), "%s -d -P %s -t 1 -p %u -U %u -m 128",
-                   MEMCACHED_BINARY, construct->pid_file[x], construct->port[x], construct->port[x]);
-        }
-        else
-        {
-          snprintf(buffer, sizeof(buffer), "%s -d -P %s -t 1 -p %u -U %u",
-                   MEMCACHED_BINARY, construct->pid_file[x], construct->port[x], construct->port[x]);
-        }
-
-        if (construct->is_used[x])
-        {
-          fprintf(stderr, "USING SERVER: %s\n", buffer);
-        }
-        else
-        {
-          if (libmemcached_util_ping("localhost", construct->port[x], NULL))
-          {
-            fprintf(stderr, "Server on port %u already exists\n", construct->port[x]);
-          }
-          else
-          {
-            status= system(buffer);
-            fprintf(stderr, "STARTING SERVER: %s  status:%d\n", buffer, status);
-          }
-        }
-
-        size_t remaining_length= sizeof(server_string_buffer) - (size_t)(end_ptr -server_string_buffer);
-        int count= snprintf(end_ptr, remaining_length,  "--server=localhost:%u ", construct->port[x]);
-
-        if ((size_t)count >= remaining_length or count < 0)
-        {
-          fprintf(stderr, "server names grew to be larger then buffer allowed\n");
-          abort();
-        }
-        end_ptr+= count;
-      }
-      *end_ptr= 0;
+  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();
+  }
 
-      for (uint32_t x= 0; x < construct->count; x++)
+  bool ping()
+  {
+    // Memcached is slow to start, so we need to do this
+    if (not pid_file().empty())
+    {
+      if (not wait_for_pidfile())
       {
-        if (! wait_for_file(construct->pid_file[x]))
-        {
-          abort();
-        }
+        Error << "Pidfile was not found:" << pid_file();
+        return false;
       }
+    }
 
-      for (uint32_t x= 0; x < construct->count; x++)
+    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)
       {
-        uint32_t counter= 3000; // Absurd, just to catch run away process
-
-        if (construct->is_used[x])
-          continue;
-
-        while (construct->pids[x] <= 0  && --counter)
-        {
-          FILE *file= fopen(construct->pid_file[x], "r");
-          if (file)
-          {
-            char pid_buffer[1024];
-            char *found= fgets(pid_buffer, sizeof(pid_buffer), file);
-
-            if (found)
-            {
-              construct->pids[x]= atoi(pid_buffer);
-              fclose(file);
-
-              if (construct->pids[x] > 0)
-                break;
-            }
-            fclose(file);
-          }
-
-          switch (errno)
-          {
-          default:
-            fprintf(stderr, "Could not open pid file %s -> fopen(%s) -> %s:%d\n", construct->pid_file[x], strerror(errno), __FILE__, __LINE__);
-            abort();
-
-          case ENOENT:
-          case EINTR:
-          case EACCES:
-          case EINPROGRESS:
-            break;
-
-          case ENOTCONN:
-            continue;
-          }
-
-          // Safety 3rd, check to see if the file has gone away
-          if (! wait_for_file(construct->pid_file[x]))
-          {
-            abort();
-          }
-        }
-
-        bool was_started= false;
-        if (construct->pids[x] > 0)
-        {
-          counter= 30;
-          while (--counter)
-          {
-            if (kill(construct->pids[x], 0) == 0)
-            {
-              was_started= true;
-              break;
-            }
-            global_sleep();
-          }
-        }
-
-        if (was_started == false)
-        {
-          fprintf(stderr, "Failed to open buffer %s(%d)\n", construct->pid_file[x], construct->pids[x]);
-          for (uint32_t y= 0; y < construct->count; y++)
-          {
-            if (construct->pids[y] > 0)
-              kill(construct->pids[y], SIGTERM);
-          }
-          abort();
-        }
+        return true;
       }
+    }
 
-      construct->server_list= strndup(server_string_buffer, strlen(server_string_buffer) -1);
+    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);
     }
   }
 
-  srandom((unsigned int)time(NULL));
+  bool has_log_file_option() const
+  {
+    return true;
+  }
 
-  printf("\n");
-}
+  bool build(size_t argc, const char *argv[]);
+};
 
-void server_shutdown(server_startup_st *construct)
+class MemcachedSaSL : public Memcached
 {
-  if (construct->server_list)
+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()
   {
-    for (uint32_t x= 0; x < construct->count; x++)
+    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
     {
-      if (construct->is_used[x])
-        continue;
+      ret= libmemcached_util_ping2(hostname().c_str(), port(), username().c_str(), password().c_str(), &rc);
+    }
 
-      kill_file(construct->pid_file[x]);
+    if (memcached_failed(rc) or ret == false)
+    {
+      Error << "libmemcached_util_ping2(" << hostname() << ", " << port() << ", " << username() << ", " << password() << ") error: " << memcached_strerror(NULL, rc);
     }
 
-    free(construct->server_list);
+    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");
+  add_option("-m", "128");
+  add_option("-M");
+
+  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;
+}
+
+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 (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);
 }
+
+}
+