/* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
*
- * Libmemcached library
+ * libtest
*
* Copyright (C) 2011 Data Differential, http://datadifferential.com/
- * Copyright (C) 2006-2009 Brian Aker All rights reserved.
*
- * 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
*/
-/*
- Startup, and shutdown the memcached servers.
-*/
+#include <libtest/common.h>
-#define TEST_PORT_BASE MEMCACHED_DEFAULT_PORT+10
+#include <libmemcached/memcached.h>
+#include <libmemcached/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)
+class Memcached : public libtest::Server
{
- while (1)
+ 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, 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, is_socket_arg)
+ {
+ set_pid_file();
+ }
+
+ virtual const char *sasl() const
{
- if (libmemcached_util_ping(server->hostname(), server->port(), NULL))
+ return NULL;
+ }
+
+ const std::string& password() const
+ {
+ return _password;
+ }
+
+ const std::string& username() const
+ {
+ return _username;
+ }
+
+ pid_t get_pid(bool error_is_ok)
+ {
+ // Memcached is slow to start, so we need to do this
+ if (not pid_file().empty())
{
- // 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);
+ Wait wait(pid_file(), 0);
- if (pid > 0 and kill_pid(pid))
+ if (error_is_ok and not wait.successful())
{
- Error << "Killed existing server," << *server << " with pid:" << pid;
- continue;
+ Error << "Pidfile was not found:" << pid_file();
+ return -1;
}
- 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
+ }
+
+ pid_t local_pid;
+ memcached_return_t rc= MEMCACHED_SUCCESS;
+ if (has_socket())
+ {
+ local_pid= libmemcached_util_getpid(socket().c_str(), 0, &rc);
+ }
+ else
+ {
+ local_pid= libmemcached_util_getpid(hostname().c_str(), port(), &rc);
+ }
+
+ if (error_is_ok and ((memcached_failed(rc) or not is_pid_valid(local_pid))))
+ {
+ Error << "libmemcached_util_getpid(" << memcached_strerror(NULL, rc) << ") pid: " << local_pid << " for:" << *this;
+ }
+
+ return local_pid;
+ }
+
+ bool ping()
+ {
+ // Memcached is slow to start, so we need to do this
+ if (not pid_file().empty())
+ {
+ Wait wait(pid_file(), 0);
+
+ if (not wait.successful())
{
- return false;
+ Error << "Pidfile was not found:" << pid_file();
+ return -1;
}
}
- break;
+ 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);
+ }
+
+ if (memcached_failed(rc) or not ret)
+ {
+ Error << "libmemcached_util_ping(" << hostname() << ", " << port() << ") error: " << memcached_strerror(NULL, rc);
+ }
+
+ return ret;
}
- return true;
-}
+ const char *name()
+ {
+ return "memcached";
+ };
-bool server_startup(server_startup_st *construct)
+ const char *executable()
+ {
+ return MEMCACHED_BINARY;
+ }
+
+ const char *pid_file_option()
+ {
+ return "-P ";
+ }
+
+ const char *socket_file_option() const
+ {
+ return "-s ";
+ }
+
+ const char *daemon_file_option()
+ {
+ return "-d";
+ }
+
+ const char *log_file_option()
+ {
+ return NULL;
+ }
+
+ const char *port_option()
+ {
+ return "-p ";
+ }
+
+ bool is_libtool()
+ {
+ return false;
+ }
+
+ bool broken_socket_cleanup()
+ {
+ return true;
+ }
+
+ // Memcached's pidfile is broken
+ bool broken_pid_file()
+ {
+ return true;
+ }
+
+ bool build(int argc, const char *argv[]);
+};
+
+class MemcachedSaSL : public Memcached
{
- Log;
- if (getenv(((char *)"MEMCACHED_SERVERS")))
+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()
{
- construct->server_list= getenv(((char *)"MEMCACHED_SERVERS"));
- Log << "MEMCACHED_SERVERS " << construct->server_list;
- construct->count= 0;
+ return "memcached-sasl";
+ };
+
+ const char *sasl() const
+ {
+ return " -S -B binary ";
}
- else
+
+ const char *executable()
{
- std::string server_config_string;
+ return MEMCACHED_SASL_BINARY;
+ }
- uint32_t port_base= 0;
- for (uint32_t x= 0; x < (construct->count -1); x++)
+ pid_t get_pid(bool error_is_ok)
+ {
+ // Memcached is slow to start, so we need to do this
+ if (not pid_file().empty())
{
- server_st *server= NULL;
+ Wait wait(pid_file(), 0);
+ if (error_is_ok and not wait.successful())
{
- 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));
- }
- }
+ Error << "Pidfile was not found:" << pid_file();
+ return -1;
}
+ }
- 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);
+ pid_t local_pid;
+ memcached_return_t rc;
+ if (has_socket())
+ {
+ local_pid= libmemcached_util_getpid2(socket().c_str(), 0, username().c_str(), password().c_str(), &rc);
+ }
+ else
+ {
+ local_pid= libmemcached_util_getpid2(hostname().c_str(), port(), username().c_str(), password().c_str(), &rc);
+ }
+
+ if (error_is_ok and ((memcached_failed(rc) or not is_pid_valid(local_pid))))
+ {
+ Error << "libmemcached_util_getpid2(" << memcached_strerror(NULL, rc) << ") username: " << username() << " password: " << password() << " pid: " << local_pid << " for:" << *this;
+ }
+
+ return local_pid;
+ }
- if (x == 0)
+ bool ping()
+ {
+ // Memcached is slow to start, so we need to do this
+ if (not pid_file().empty())
+ {
+ Wait wait(pid_file(), 0);
+
+ if (not wait.successful())
{
- assert(server->has_port());
- set_default_port(server->port());
+ Error << "Pidfile was not found:" << pid_file();
+ return -1;
}
+ }
- 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_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);
}
- // Socket
+ if (memcached_failed(rc) or not ret)
{
+ Error << "libmemcached_util_ping2(" << hostname() << ", " << port() << ", " << username() << ", " << password() << ") error: " << memcached_strerror(NULL, rc);
+ }
+
+ return ret;
+ }
- std::string socket_file(SOCKET_FILE);
- char *var;
+};
- if ((var= getenv("LIBMEMCACHED_SOCKET")))
- {
- socket_file= var;
- }
- server_st *server= new server_st(SOCKET_FILE, __getpid, __ping);
+#include <sstream>
- if (not cycle_server(server))
- {
- Error << "Found server " << server << ", could not flush it, failing since socket file is not available.";
- return false;
- }
+bool Memcached::build(int argc, const char *argv[])
+{
+ std::stringstream arg_buffer;
- if (server->is_used())
- {
- Log << "Using server at : " << *server;
- }
- else
- {
- 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();
- }
- set_default_socket(server->hostname());
- construct->push_server(server);
+ if (getuid() == 0 or geteuid() == 0)
+ {
+ arg_buffer << " -u root ";
+ }
- {
- server_config_string+= "--socket=\"";
- server_config_string+= server->hostname();
- server_config_string+= "\" ";
- }
- }
+ arg_buffer << " -l 127.0.0.1 ";
+ arg_buffer << " -m 128 ";
+ arg_buffer << " -M ";
- server_config_string.resize(server_config_string.size() -1); // Remove final space
- construct->server_list= server_config_string;
+ if (sasl())
+ {
+ arg_buffer << sasl();
}
- Log;
+ for (int x= 1 ; x < argc ; x++)
+ {
+ arg_buffer << " " << argv[x] << " ";
+ }
- srandom((unsigned int)time(NULL));
+ set_extra_args(arg_buffer.str());
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)
{
- if (not construct)
- return;
+ 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_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");
+ }
- 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);
+}
+
+}
+