/* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
- *
- * libtest
*
- * Copyright (C) 2011 Data Differential, http://datadifferential.com/
+ * Data Differential YATL (i.e. libtest) library
*
- * 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.
+ * Copyright (C) 2012 Data Differential, http://datadifferential.com/
*
- * 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.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * 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.
*
- * 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 "libtest/yatlcon.h"
#include <libtest/common.h>
#include <cassert>
#include <cerrno>
+#include <climits>
#include <cstdlib>
#include <iostream>
+#include <string>
#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>
-extern "C" {
- static bool exited_successfully(int status, const std::string &command)
- {
- if (status == 0)
- {
- return true;
- }
-
- if (WIFEXITED(status) == true)
- {
- int ret= WEXITSTATUS(status);
-
- if (ret == 0)
- {
- return true;
- }
- else if (ret == EXIT_FAILURE)
- {
- libtest::Error << "Command executed, but returned EXIT_FAILURE: " << command;
- }
- else
- {
- libtest::Error << "Command executed, but returned " << ret;
- }
- }
- else if (WIFSIGNALED(status) == true)
- {
- int ret_signal= WTERMSIG(status);
- libtest::Error << "Died from signal " << strsignal(ret_signal);
- }
-
- return false;
- }
-}
-
-
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
}
-Server::Server(const std::string& host_arg, const in_port_t port_arg, bool is_socket_arg) :
+#ifdef __GLIBC__
+namespace {
+
+class Buffer
+{
+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,
+ 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.clear();
+ return _app.check();
+}
+
+bool Server::validate()
+{
+ 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 is_pid_valid(current_pid= get_pid()))
+ while (--limit and
+ is_pid_valid(_app.pid()))
{
- if (kill(current_pid))
+ if (kill())
{
- Log << "Killed existing server," << *this << " with pid:" << current_pid;
+ 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::wait_for_pidfile() const
+bool Server::has_pid() const
{
- Wait wait(pid_file(), 4);
-
- return wait.successful();
+ return (_app.pid() > 1);
}
+
bool Server::start()
{
- // If we find that we already have a pid then kill it.
- if (has_pid() and kill(_pid) == false)
+ if (getenv("YATL_GDB_SERVER"))
{
- Error << "Could not kill() existing server during start() pid:" << _pid;
- return false;
+ _app.use_gdb(true);
}
- assert(not has_pid());
- _running.clear();
- if (command(_running) == false)
+ if (port() == LIBTEST_FAIL_PORT)
{
- Error << "Could not build command()";
- return false;
+ throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
+ hostname(), port(), "Called failure");
}
- if (is_valgrind() or is_helgrind())
+ if (getenv("YATL_PTRCHECK_SERVER"))
+ {
+ _app.use_ptrcheck(true);
+ }
+ else if (getenv("YATL_VALGRIND_SERVER"))
{
- _running+= " &";
+ _app.use_valgrind(true);
}
- int ret= system(_running.c_str());
- if (exited_successfully(ret, _running) == false)
+ out_of_ban_killed(false);
+ if (args(_app) == false)
{
- Error << "system(" << _running << ") failed: " << strerror(errno);
- _running.clear();
+ throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
+ hostname(), port(), "Could not build command()");
+ }
+
+ libtest::release_port(_port);
+
+ Application::error_t ret;
+ if (Application::SUCCESS != (ret= _app.run()))
+ {
+ throw libtest::disconnected(LIBYATL_DEFAULT_PARAM,
+ hostname(), port(), "Application::run() %s", libtest::Application::toString(ret));
return false;
}
+ _running= _app.print();
- if (is_helgrind() or is_valgrind())
+ if (valgrind_is_caller())
{
dream(5, 50000);
}
- if (pid_file_option() and pid_file().empty() == false)
+ size_t repeat= 5;
+ _app.slurp();
+ while (--repeat)
{
- Wait wait(pid_file(), 8);
-
- if (not wait.successful())
+ if (pid_file().empty() == false)
{
- Error << "Unable to open pidfile for: " << _running;
+ 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 counter= 0;
bool pinged= false;
- while ((pinged= ping()) == false and
- counter < (is_helgrind() or is_valgrind() ? 20 : 5))
+ uint32_t this_wait= 0;
{
- dream(counter++, 50000);
+ 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 (pinged == false)
{
+#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_option() and pid_file().empty() == false)
+ if ((pid_file().empty() == false) and (access(pid_file().c_str(), R_OK) == 0))
{
- Error << "We are going to kill it off";
- kill_file(pid_file());
+ _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());
}
- Error << "Failed to ping() server started with:" << _running;
_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), "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), "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), "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()
+bool Server::args(Application& app)
{
- _base_command.clear();
- if (is_libtool())
- {
- _base_command+= libtool();
- _base_command+= " --mode=execute ";
- }
-
- if (is_debug() and getenv("GDB_COMMAND"))
- {
- _base_command+= getenv("GDB_COMMAND");
- _base_command+= " ";
- }
- else if (is_valgrind() and getenv("VALGRIND_COMMAND"))
- {
- _base_command+= getenv("VALGRIND_COMMAND");
- _base_command+= " ";
- }
- else if (is_helgrind() and getenv("HELGRIND_COMMAND"))
- {
- _base_command+= getenv("HELGRIND_COMMAND");
- _base_command+= " ";
- }
-
- if (is_libtool())
- {
- if (getenv("PWD"))
- {
- _base_command+= getenv("PWD");
- _base_command+= "/";
- }
- }
-
- _base_command+= executable();
-}
-
-void Server::set_extra_args(const std::string &arg)
-{
- _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 (has_log_file_option())
{
- if (not set_log_file())
- {
- return false;
- }
-
- arg_buffer << " " << log_file_option() << _log_file;
+ set_log_file();
+ log_file_option(app, _log_file);
}
if (getenv("LIBTEST_SYSLOG") and has_syslog())
{
- arg_buffer << " --syslog";
+ app.add_option("--syslog");
}
// Update pid_file
- if (pid_file_option())
{
if (_pid_file.empty() and set_pid_file() == false)
{
return false;
}
- arg_buffer << " " << pid_file_option() << pid_file();
- }
-
- assert(daemon_file_option());
- if (daemon_file_option() and not is_valgrind() and not is_helgrind())
- {
- arg_buffer << " " << daemon_file_option();
+ pid_file_option(app, pid_file());
}
- if (_is_socket and socket_file_option())
+ if (has_socket_file_option())
{
- if (not set_socket_file())
+ if (set_socket_file() == false)
{
return false;
}
- arg_buffer << " " << socket_file_option() << "\"" << _socket << "\"";
+ socket_file_option(app, _socket);
}
- assert(port_option());
- if (port_option() and _port > 0)
+ if (has_port_option())
{
- arg_buffer << " " << port_option() << _port;
+ port_option(app, _port);
}
- options+= arg_buffer.str();
-
- if (not _extra_args.empty())
+ for (Options::const_iterator iter= _options.begin(); iter != _options.end(); ++iter)
{
- options+= _extra_args;
+ if ((*iter).first.empty() == false)
+ {
+ if ((*iter).second.empty() == false)
+ {
+ app.add_option((*iter).first, (*iter).second);
+ }
+ else
+ {
+ app.add_option((*iter).first);
+ }
+ }
}
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
+bool Server::kill()
{
- 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 (check_pid(_app.pid())) // If we kill it, reset
{
+ _app.murder();
if (broken_pid_file() and pid_file().empty() == false)
{
unlink(pid_file().c_str());
return false;
}
+std::pair<std::string, std::string> Server::output()
+{
+ _app.slurp();
+ return {
+ std::string {
+ _app.stdout_result().data(),
+ _app.stdout_result().size()
+ },
+ std::string {
+ _app.stderr_result().data(),
+ _app.stderr_result().size()
+ }
+ };
+}
+
+
} // namespace libtest