/* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
- *
- * Libtest library
*
- * Copyright (C) 2011 Data Differential, http://datadifferential.com/
+ * 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 "libtest/yatlcon.h"
+
#include <libtest/common.h>
#include <cassert>
#include <cerrno>
+#include <climits>
#include <cstdlib>
#include <iostream>
#include <algorithm>
#include <functional>
#include <locale>
+#include <unistd.h>
// trim from end
static inline std::string &rtrim(std::string &s)
#include <libtest/stream.h>
#include <libtest/killpid.h>
-#ifdef HAVE_LIBGEARMAN
-#include <libtest/gearmand.h>
-#endif
-
-#ifdef HAVE_LIBMEMCACHED
-#include <libtest/memcached.h>
-#endif
-
namespace libtest {
std::ostream& operator<<(std::ostream& output, const Server &arg)
output << " Socket:" << arg.socket();
}
- if (not arg.running().empty())
+ if (arg.running().empty() == false)
{
output << " Exec:" << arg.running();
}
-
return output; // for multiple << operators
}
-void Server::nap(void)
+#ifdef __GLIBC__
+namespace {
+
+class Buffer
{
-#ifdef WIN32
- sleep(1);
-#else
- struct timespec global_sleep_value= { 0, 50000 };
- nanosleep(&global_sleep_value, NULL);
-#endif
+public:
+ Buffer(char *b) : b_(b) {}
+ ~Buffer() { if (b_) free(b_); }
+ char* buf() { return b_; }
+private:
+ char *b_;
+};
+
}
+#endif // __GLIBC__
+
+#define MAGIC_MEMORY 123570
-Server::Server(const std::string& host_arg, const in_port_t port_arg, bool is_socket_arg) :
+Server::Server(const std::string& host_arg, const in_port_t port_arg,
+ const std::string& executable, const bool _is_libtool,
+ bool is_socket_arg) :
+ _magic(MAGIC_MEMORY),
_is_socket(is_socket_arg),
- _pid(-1),
_port(port_arg),
- _hostname(host_arg)
+ _hostname(host_arg),
+ _app(executable, _is_libtool),
+ out_of_ban_killed_(false),
+ _timeout(40)
{
}
Server::~Server()
{
- if (has_pid() and not kill(_pid))
- {
- Error << "Unable to kill:" << *this;
- }
+ kill();
+}
+
+bool Server::check()
+{
+ _app.slurp();
+ _app.check();
+ return true;
}
-std::string server_startup_st::option_string() const
+bool Server::validate()
{
- std::string temp= server_list;
- rtrim(temp);
- return temp;
+ return _magic == MAGIC_MEMORY;
}
// If the server exists, kill it
uint32_t limit= 3;
// Try to ping, and kill the server #limit number of times
- pid_t current_pid;
- while (--limit and (current_pid= get_pid()) != -1)
+ while (--limit and
+ is_pid_valid(_app.pid()))
{
- if (kill(current_pid))
+ if (kill())
{
- Log << "Killed existing server," << *this << " with pid:" << current_pid;
- nap();
+ Log << "Killed existing server," << *this;
+ dream(0, 50000);
continue;
}
}
// For whatever reason we could not kill it, and we reached limit
if (limit == 0)
{
- Error << "Reached limit, could not kill server pid:" << current_pid;
+ Error << "Reached limit, could not kill server";
return false;
}
return true;
}
-// Grab a one off command
-bool Server::command(std::string& command_arg)
+bool Server::wait_for_pidfile() const
{
- rebuild_base_command();
+ Wait wait(pid_file(), 4);
- command_arg+= _base_command;
+ return wait.successful();
+}
- if (args(command_arg))
+bool Server::init(const char *argv[])
+{
+ if (argv)
{
- return true;
+ for (const char **ptr= argv; *ptr ; ++ptr)
+ {
+ if (ptr)
+ {
+ add_option(*ptr);
+ }
+ }
}
- return false;
+ return build();
+}
+
+bool Server::has_pid() const
+{
+ return (_app.pid() > 1);
}
+
bool Server::start()
{
// If we find that we already have a pid then kill it.
- if (has_pid() and not kill(_pid))
+ if (has_pid() == true)
{
- Error << "Could not kill() existing server during start() pid:" << _pid;
- return false;
+#if 0
+ fatal_message("has_pid() failed, programer error");
+#endif
}
- assert(not has_pid());
- _running.clear();
- if (not command(_running))
+ if (getenv("YATL_GDB_SERVER"))
{
- Error << "Could not build command()";
- return false;
+ _app.use_gdb(true);
}
- if (is_valgrind() or is_helgrind())
+ if (port() == LIBTEST_FAIL_PORT)
{
- _running+= " &";
+ throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
+ hostname(), port(), "Called failure");
}
- if (system(_running.c_str()) == -1)
+ if (getenv("YATL_PTRCHECK_SERVER"))
{
- Error << "system() failed:" << strerror(errno);
- _running.clear();
- return false;
+ _app.use_ptrcheck(true);
+ }
+ else if (getenv("YATL_VALGRIND_SERVER"))
+ {
+ _app.use_valgrind(true);
+ }
+
+ out_of_ban_killed(false);
+ if (args(_app) == false)
+ {
+ throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
+ hostname(), port(), "Could not build command()");
}
- if (is_helgrind())
+ libtest::release_port(_port);
+
+ Application::error_t ret;
+ if (Application::SUCCESS != (ret= _app.run()))
{
- sleep(4);
+ throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
+ hostname(), port(), "Application::run() %s", libtest::Application::toString(ret));
+ return false;
}
+ _running= _app.print();
- if (pid_file_option() and not pid_file().empty())
+ if (valgrind_is_caller())
{
- Wait wait(pid_file());
+ dream(5, 50000);
+ }
- if (not wait.successful())
+ size_t repeat= 5;
+ _app.slurp();
+ while (--repeat)
+ {
+ if (pid_file().empty() == false)
{
- Error << "Unable to open pidfile: " << pid_file();
+ Wait wait(pid_file(), 8);
+
+ if (wait.successful() == false)
+ {
+ if (_app.check())
+ {
+ _app.slurp();
+ continue;
+ }
+
+#ifdef __GLIBC__
+ Buffer buf( get_current_dir_name());
+ char *getcwd_buf= buf.buf();
+#else
+ libtest::vchar_t buf;
+ buf.resize(PATH_MAX);
+ char *getcwd_buf= getcwd(&buf[0], buf.size());
+#endif // __GLIBC__
+ throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
+ hostname(), port(),
+ "Unable to open pidfile in %s for: %s stderr:%s",
+ getcwd_buf ? getcwd_buf : "",
+ _running.c_str(),
+ _app.stderr_c_str());
+ }
}
}
- int count= is_helgrind() ? 20 : 5;
- while (not ping() and --count)
+ bool pinged= false;
+ uint32_t this_wait= 0;
{
- nap();
+ uint32_t waited;
+ uint32_t retry;
+
+ for (waited= 0, retry= 1; ; retry++, waited+= this_wait)
+ {
+ if (_app.check() == false)
+ {
+ break;
+ }
+
+ if ((pinged= ping()) == true)
+ {
+ break;
+ }
+ else if (waited >= _timeout)
+ {
+ break;
+ }
+
+ this_wait= retry * retry / 3 + 1;
+ libtest::dream(this_wait, 0);
+ }
}
- if (count == 0)
+ if (pinged == false)
{
- Error << "Failed to ping() server once started:" << *this;
+#if 0
+ Error << "Failed to ping(" << _app.pid() << ") wait: " << this_wait << " " << hostname() << ":" << port() << " run:" << _running << " " << error();
+#endif
+
+ // If we happen to have a pid file, lets try to kill it
+ if ((pid_file().empty() == false) and (access(pid_file().c_str(), R_OK) == 0))
+ {
+ _app.slurp();
+ if (kill_file(pid_file()) == false)
+ {
+ throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
+ hostname(), port(),
+ "Failed to kill off server, waited: %u after startup occurred, when pinging failed: %.*s stderr:%.*s",
+ this_wait,
+ int(_running.size()), _running.c_str(),
+ int(_app.stderr_result_length()), _app.stderr_c_str());
+ }
+ else
+ {
+ throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
+ hostname(), port(),
+ "Failed native ping(), pid: %d was alive: %s waited: %u server started, having pid_file. exec: %.*s stderr:%.*s",
+ int(_app.pid()),
+ _app.check() ? "true" : "false",
+ this_wait,
+ int(_running.size()), _running.c_str(),
+ int(_app.stderr_result_length()), _app.stderr_c_str());
+ }
+ }
+ else
+ {
+ throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
+ hostname(), port(),
+ "Failed native ping(), pid: %d is alive: %s waited: %u server started. exec: %.*s stderr:%.*s",
+ int(_app.pid()),
+ _app.check() ? "true" : "false",
+ this_wait,
+ int(_running.size()), _running.c_str(),
+ int(_app.stderr_result_length()), _app.stderr_c_str());
+ }
_running.clear();
+
return false;
}
- // A failing get_pid() at this point is considered an error
- _pid= get_pid(true);
-
return has_pid();
}
{
_running.clear();
_pid_file.clear();
- _pid= -1;
}
-pid_t Server::pid()
+pid_t Server::pid() const
+{
+ return _app.pid();
+}
+
+void Server::add_option(const std::string& arg)
{
- return _pid;
+ _options.push_back(std::make_pair(arg, std::string()));
+}
+
+void Server::add_option(const std::string& name_, const std::string& value_)
+{
+ _options.push_back(std::make_pair(name_, value_));
}
bool Server::set_socket_file()
{
- char file_buffer[FILENAME_MAX];
+ libtest::vchar_t file_buffer;
+ file_buffer.resize(FILENAME_MAX);
file_buffer[0]= 0;
if (broken_pid_file())
{
- snprintf(file_buffer, sizeof(file_buffer), "/tmp/%s.socketXXXXXX", name());
+ snprintf(&file_buffer[0], file_buffer.size(), "/tmp/%s.socketXXXXXX", name());
}
else
{
- snprintf(file_buffer, sizeof(file_buffer), "tests/var/run/%s.socketXXXXXX", name());
+ snprintf(&file_buffer[0], file_buffer.size(), "var/run/%s.socketXXXXXX", name());
}
int fd;
- if ((fd= mkstemp(file_buffer)) == -1)
+ if ((fd= mkstemp(&file_buffer[0])) == -1)
{
- perror(file_buffer);
+ perror(&file_buffer[0]);
return false;
}
close(fd);
- unlink(file_buffer);
+ unlink(&file_buffer[0]);
- _socket= file_buffer;
+ _socket= &file_buffer[0];
return true;
}
bool Server::set_pid_file()
{
- char file_buffer[FILENAME_MAX];
+ libtest::vchar_t file_buffer;
+ file_buffer.resize(FILENAME_MAX);
file_buffer[0]= 0;
if (broken_pid_file())
{
- snprintf(file_buffer, sizeof(file_buffer), "/tmp/%s.pidXXXXXX", name());
+ snprintf(&file_buffer[0], file_buffer.size(), "/tmp/%s.pidXXXXXX", name());
}
else
{
- snprintf(file_buffer, sizeof(file_buffer), "tests/var/run/%s.pidXXXXXX", name());
+ snprintf(&file_buffer[0], file_buffer.size(), "var/run/%s.pidXXXXXX", name());
}
int fd;
- if ((fd= mkstemp(file_buffer)) == -1)
+ if ((fd= mkstemp(&file_buffer[0])) == -1)
{
- perror(file_buffer);
- return false;
+ throw libtest::fatal(LIBYATL_DEFAULT_PARAM, "mkstemp() failed on %s with %s", &file_buffer[0], strerror(errno));
}
close(fd);
- unlink(file_buffer);
+ unlink(&file_buffer[0]);
- _pid_file= file_buffer;
+ _pid_file= &file_buffer[0];
return true;
}
bool Server::set_log_file()
{
- char file_buffer[FILENAME_MAX];
+ libtest::vchar_t file_buffer;
+ file_buffer.resize(FILENAME_MAX);
file_buffer[0]= 0;
- snprintf(file_buffer, sizeof(file_buffer), "tests/var/log/%s.logXXXXXX", name());
+ snprintf(&file_buffer[0], file_buffer.size(), "var/log/%s.logXXXXXX", name());
int fd;
- if ((fd= mkstemp(file_buffer)) == -1)
+ if ((fd= mkstemp(&file_buffer[0])) == -1)
{
- perror(file_buffer);
- return false;
+ throw libtest::fatal(LIBYATL_DEFAULT_PARAM, "mkstemp() failed on %s with %s", &file_buffer[0], strerror(errno));
}
close(fd);
- _log_file= file_buffer;
+ _log_file= &file_buffer[0];
return true;
}
-void Server::rebuild_base_command()
-{
- _base_command.clear();
- if (is_libtool())
- {
- _base_command+= "./libtool --mode=execute ";
- }
-
- if (is_debug())
- {
- _base_command+= "gdb ";
- }
- else if (is_valgrind())
- {
- _base_command+= "valgrind --log-file=tests/var/tmp/valgrind.out --error-exitcode=1 --leak-check=yes --show-reachable=yes --track-fds=yes --malloc-fill=A5 --free-fill=DE ";
-
- }
- else if (is_helgrind())
- {
- _base_command+= "valgrind --log-file=tests/var/tmp/helgrind.out --tool=helgrind --read-var-info=yes --error-exitcode=1 -v ";
- }
-
- _base_command+= executable();
-}
-
-void Server::set_extra_args(const std::string &arg)
+bool Server::args(Application& app)
{
- _extra_args= arg;
-}
-
-bool Server::args(std::string& options)
-{
- std::stringstream arg_buffer;
// Set a log file if it was requested (and we can)
- if (getenv("LIBTEST_LOG") and log_file_option())
- {
- if (not set_log_file())
- return false;
-
- arg_buffer << " " << log_file_option() << _log_file;
- }
-
- // Update pid_file
- if (pid_file_option())
+ if (has_log_file_option())
{
- if (not set_pid_file())
- return false;
-
- arg_buffer << " " << pid_file_option() << pid_file();
+ set_log_file();
+ log_file_option(app, _log_file);
}
- assert(daemon_file_option());
- if (daemon_file_option() and not is_valgrind() and not is_helgrind())
+ if (getenv("LIBTEST_SYSLOG") and has_syslog())
{
- arg_buffer << " " << daemon_file_option();
+ app.add_option("--syslog");
}
- if (_is_socket and socket_file_option())
+ // Update pid_file
{
- if (not set_socket_file())
+ if (_pid_file.empty() and set_pid_file() == false)
+ {
return false;
+ }
- arg_buffer << " " << socket_file_option() << "\"" << _socket << "\"";
+ pid_file_option(app, pid_file());
}
- assert(port_option());
- if (port_option() and _port > 0)
+ if (has_socket_file_option())
{
- arg_buffer << " " << port_option() << _port;
- }
-
- options+= arg_buffer.str();
-
- if (not _extra_args.empty())
- options+= _extra_args;
-
- return true;
-}
-
-bool Server::is_debug() const
-{
- return bool(getenv("LIBTEST_MANUAL_GDB"));
-}
-
-bool Server::is_valgrind() const
-{
- return bool(getenv("LIBTEST_MANUAL_VALGRIND"));
-}
-
-bool Server::is_helgrind() const
-{
- return bool(getenv("LIBTEST_MANUAL_HELGRIND"));
-}
-
-bool Server::kill(pid_t pid_arg)
-{
- if (check_pid(pid_arg) and kill_pid(pid_arg)) // If we kill it, reset
- {
- if (broken_pid_file() and not pid_file().empty())
+ if (set_socket_file() == false)
{
- unlink(pid_file().c_str());
+ return false;
}
- reset_pid();
-
- return true;
+ socket_file_option(app, _socket);
}
- return false;
-}
-
-void server_startup_st::push_server(Server *arg)
-{
- servers.push_back(arg);
-
- char port_str[NI_MAXSERV];
- snprintf(port_str, sizeof(port_str), "%u", int(arg->port()));
-
- std::string server_config_string;
- if (arg->has_socket())
+ if (has_port_option())
{
- server_config_string+= "--socket=";
- server_config_string+= '"';
- server_config_string+= arg->socket();
- server_config_string+= '"';
- server_config_string+= " ";
+ port_option(app, _port);
}
- else
- {
- server_config_string+= "--server=";
- server_config_string+= arg->hostname();
- server_config_string+= ":";
- server_config_string+= port_str;
- server_config_string+= " ";
- }
-
- server_list+= server_config_string;
-}
-
-Server* server_startup_st::pop_server()
-{
- Server *tmp= servers.back();
- servers.pop_back();
- return tmp;
-}
-
-void server_startup_st::shutdown(bool remove)
-{
- if (remove)
+ for (Options::const_iterator iter= _options.begin(); iter != _options.end(); ++iter)
{
- for (std::vector<Server *>::iterator iter= servers.begin(); iter != servers.end(); iter++)
+ if ((*iter).first.empty() == false)
{
- delete *iter;
- }
- servers.clear();
- }
- else
- {
- for (std::vector<Server *>::iterator iter= servers.begin(); iter != servers.end(); iter++)
- {
- if ((*iter)->has_pid() and not (*iter)->kill((*iter)->pid()))
+ if ((*iter).second.empty() == false)
{
- Error << "Unable to kill:" << *(*iter);
+ app.add_option((*iter).first, (*iter).second);
+ }
+ else
+ {
+ app.add_option((*iter).first);
}
}
}
-}
-
-server_startup_st::~server_startup_st()
-{
- shutdown(true);
-}
-
-bool server_startup_st::is_debug() const
-{
- return bool(getenv("LIBTEST_MANUAL_GDB"));
-}
-
-bool server_startup_st::is_valgrind() const
-{
- return bool(getenv("LIBTEST_MANUAL_VALGRIND"));
-}
-bool server_startup_st::is_helgrind() const
-{
- return bool(getenv("LIBTEST_MANUAL_HELGRIND"));
+ return true;
}
-
-bool server_startup(server_startup_st& construct, const std::string& server_type, in_port_t try_port, int argc, const char *argv[])
+bool Server::kill()
{
- Outn();
-
- // Look to see if we are being provided ports to use
+ if (check_pid(_app.pid())) // If we kill it, reset
{
- char variable_buffer[1024];
- snprintf(variable_buffer, sizeof(variable_buffer), "LIBTEST_PORT_%lu", (unsigned long)construct.count());
-
- char *var;
- if ((var= getenv(variable_buffer)))
+ _app.murder();
+ if (broken_pid_file() and pid_file().empty() == false)
{
- in_port_t tmp= in_port_t(atoi(var));
-
- if (tmp > 0)
- try_port= tmp;
+ unlink(pid_file().c_str());
}
- }
-
- Server *server= NULL;
- if (0)
- { }
- else if (server_type.compare("gearmand") == 0)
- {
-#ifdef GEARMAND_BINARY
- #ifdef HAVE_LIBGEARMAN
- server= build_gearmand("localhost", try_port);
- #else
- Error << "Libgearman was not found";
- #endif
-#else
- Error << "No gearmand binary is available";
-#endif
- }
- else if (server_type.compare("memcached") == 0)
- {
-#ifdef MEMCACHED_BINARY
-#ifdef HAVE_LIBMEMCACHED
- server= build_memcached("localhost", try_port);
-#else
- Error << "Libmemcached was not found";
-#endif
-#else
- Error << "No memcached binary is available";
-#endif
- }
- else
- {
- Error << "Failed to start " << server_type << ", no support was found to be compiled in for it.";
- }
-
- if (server == NULL)
- {
- Error << "Failure occured while creating server: " << server_type;
- return false;
- }
-
- /*
- We will now cycle the server we have created.
- */
- if (not server->cycle())
- {
- Error << "Could not start up server " << *server;
- delete server;
- return false;
- }
-
- server->build(argc, argv);
-
- if (construct.is_debug())
- {
- Out << "Pausing for startup, hit return when ready.";
- std::string gdb_command= server->base_command();
- std::string options;
- Out << "run " << server->args(options);
- getchar();
- }
- else if (not server->start())
- {
- Error << "Failed to start " << *server;
- delete server;
- return false;
- }
- else
- {
- Out << "STARTING SERVER(pid:" << server->pid() << "): " << server->running();
- }
-
- construct.push_server(server);
-
- if (default_port() == 0)
- {
- assert(server->has_port());
- set_default_port(server->port());
- }
-
- Outn();
-
- return true;
-}
-
-bool server_startup_st::start_socket_server(const std::string& server_type, const in_port_t try_port, int argc, const char *argv[])
-{
- (void)try_port;
- Outn();
-
- Server *server= NULL;
- if (0)
- { }
- else if (server_type.compare("gearmand") == 0)
- {
- Error << "Socket files are not supported for gearmand yet";
- }
- else if (server_type.compare("memcached") == 0)
- {
-#ifdef MEMCACHED_BINARY
-#ifdef HAVE_LIBMEMCACHED
- server= build_memcached_socket("localhost", try_port);
-#else
- Error << "Libmemcached was not found";
-#endif
-#else
- Error << "No memcached binary is available";
-#endif
- }
- else
- {
- Error << "Failed to start " << server_type << ", no support was found to be compiled in for it.";
- }
- if (server == NULL)
- {
- Error << "Failure occured while creating server: " << server_type;
- return false;
- }
-
- /*
- We will now cycle the server we have created.
- */
- if (not server->cycle())
- {
- Error << "Could not start up server " << *server;
- delete server;
- return false;
- }
+ if (broken_socket_cleanup() and has_socket() and not socket().empty())
+ {
+ unlink(socket().c_str());
+ }
- server->build(argc, argv);
+ reset_pid();
- if (is_debug())
- {
- Out << "Pausing for startup, hit return when ready.";
- std::string gdb_command= server->base_command();
- std::string options;
- Out << "run " << server->args(options);
- getchar();
- }
- else if (not server->start())
- {
- Error << "Failed to start " << *server;
- delete server;
- return false;
- }
- else
- {
- Out << "STARTING SERVER(pid:" << server->pid() << "): " << server->running();
+ return true;
}
- push_server(server);
-
- set_default_socket(server->socket().c_str());
-
- Outn();
-
- return true;
+ return false;
}
} // namespace libtest