/* 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 <config.h>
+#include <libmemcached/memcached.h>
+#include <libmemcached/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)
+using namespace libtest;
+
+class Memcached : public libtest::Server
{
- uint32_t timeout= 6;
- uint32_t waited;
- uint32_t this_wait;
- uint32_t retry;
+ 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();
+ }
- for (waited= 0, retry= 1; ; retry++, waited+= this_wait)
+ virtual const char *sasl() const
{
- if ((! access(filename, R_OK)) || (waited >= timeout))
+ 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())
{
- return true;
+ if (error_is_ok and not wait_for_pidfile())
+ {
+ Error << "Pidfile was not found:" << pid_file();
+ return -1;
+ }
}
- this_wait= retry * retry / 3 + 1;
- sleep(this_wait);
- }
+ 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);
+ }
- return false;
-}
+ 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;
+ }
-static void kill_file(const char *file_buffer)
-{
- FILE *fp;
+ return local_pid;
+ }
- while ((fp= fopen(file_buffer, "r")))
+ bool ping()
{
- char pid_buffer[1024];
-
- if (fgets(pid_buffer, sizeof(pid_buffer), fp) != NULL)
+ // Memcached is slow to start, so we need to do this
+ if (not pid_file().empty())
{
- pid_t pid= (pid_t)atoi(pid_buffer);
- if (pid != 0)
+ if (not wait_for_pidfile())
{
- 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();
+ return -1;
}
}
- global_sleep();
+ 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);
+ }
- fclose(fp);
+ return ret;
+ }
+
+ const char *name()
+ {
+ return "memcached";
+ };
+
+ 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;
}
-}
-void server_startup(server_startup_st *construct)
+ bool build(int argc, const char *argv[]);
+};
+
+class MemcachedSaSL : public Memcached
{
- if ((construct->server_list= getenv("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()
+ {
+ return "memcached-sasl";
+ };
+
+ const char *sasl() const
{
- printf("servers %s\n", construct->server_list);
- construct->count= 0;
+ return " -S -B binary ";
}
- else
+
+ const char *executable()
{
- {
- char server_string_buffer[8096];
- char *end_ptr;
- end_ptr= server_string_buffer;
+ return MEMCACHED_SASL_BINARY;
+ }
- uint32_t port_base= 0;
- for (uint32_t x= 0; x < construct->count; 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())
+ {
+ if (error_is_ok and not wait_for_pidfile())
{
- 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;
+ Error << "Pidfile was not found:" << pid_file();
+ return -1;
}
- *end_ptr= 0;
+ }
+ 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);
+ }
- for (uint32_t x= 0; x < construct->count; x++)
- {
- if (! wait_for_file(construct->pid_file[x]))
- {
- abort();
- }
- }
+ 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;
+ }
- for (uint32_t x= 0; x < construct->count; x++)
+ return local_pid;
+ }
+
+ bool ping()
+ {
+ // Memcached is slow to start, so we need to do this
+ if (not pid_file().empty())
+ {
+ if (not wait_for_pidfile())
{
- 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();
- }
+ 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);
+ }
- construct->server_list= strndup(server_string_buffer, strlen(server_string_buffer) -1);
+ if (memcached_failed(rc) or not ret)
+ {
+ Error << "libmemcached_util_ping2(" << hostname() << ", " << port() << ", " << username() << ", " << password() << ") error: " << memcached_strerror(NULL, rc);
}
+
+ return ret;
+ }
+
+};
+
+
+#include <sstream>
+
+bool Memcached::build(int argc, const char *argv[])
+{
+ std::stringstream arg_buffer;
+
+ if (getuid() == 0 or geteuid() == 0)
+ {
+ arg_buffer << " -u root ";
}
- srandom((unsigned int)time(NULL));
+ arg_buffer << " -l localhost ";
+ arg_buffer << " -m 128 ";
+ arg_buffer << " -M ";
+
+ if (sasl())
+ {
+ arg_buffer << sasl();
+ }
+
+ for (int x= 1 ; x < argc ; x++)
+ {
+ arg_buffer << " " << argv[x] << " ";
+ }
+
+ set_extra_args(arg_buffer.str());
+
+ return true;
+}
+
+namespace libtest {
- printf("\n");
+libtest::Server *build_memcached(const std::string& hostname, const in_port_t try_port)
+{
+ return new Memcached(hostname, try_port, false);
}
-void server_shutdown(server_startup_st *construct)
+libtest::Server *build_memcached_socket(const std::string& socket_file, const in_port_t try_port)
{
- if (construct->server_list)
+ 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())
{
- for (uint32_t x= 0; x < construct->count; x++)
- {
- if (construct->is_used[x])
- continue;
+ return new MemcachedSaSL(hostname, try_port, false, "memcached", "memcached");
+ }
- kill_file(construct->pid_file[x]);
- }
+ return new MemcachedSaSL(hostname, try_port, false, username, password);
+}
- free(construct->server_list);
+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);
+}
+
}
+