/* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
*
- * Libmemcached library
+ * libtest
*
* Copyright (C) 2011 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
- * 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
*/
+
#include <config.h>
-#include <iostream>
-#include <cstdlib>
+#include <libtest/common.h>
+
#include <cassert>
+#include <cerrno>
+#include <cstdlib>
+#include <iostream>
+
+#include <algorithm>
+#include <functional>
+#include <locale>
+
+// trim from end
+static inline std::string &rtrim(std::string &s)
+{
+ s.erase(std::find_if(s.rbegin(), s.rend(), std::not1(std::ptr_fun<int, int>(std::isspace))).base(), s.end());
+ return s;
+}
#include <libtest/server.h>
+#include <libtest/stream.h>
#include <libtest/killpid.h>
+namespace libtest {
-std::ostream& operator<<(std::ostream& output, const server_st &arg)
+std::ostream& operator<<(std::ostream& output, const Server &arg)
{
if (arg.is_socket())
{
{
output << arg.hostname() << ":" << arg.port();
}
- return output; // for multiple << operators
-}
-static void global_sleep(void)
-{
- static struct timespec global_sleep_value= { 0, 50000 };
+ if (arg.has_pid())
+ {
+ output << " Pid:" << arg.pid();
+ }
+
+ if (arg.has_socket())
+ {
+ output << " Socket:" << arg.socket();
+ }
+
+ if (arg.running().empty() == false)
+ {
+ output << " Exec:" << arg.running();
+ }
-#ifdef WIN32
- sleep(1);
-#else
- nanosleep(&global_sleep_value, NULL);
-#endif
+ return output; // for multiple << operators
}
-server_st::server_st(in_port_t port_arg, test_server_getpid *get_pid_arg, test_server_ping *ping_arg) :
- _used(false),
+#define MAGIC_MEMORY 123570
+
+Server::Server(const std::string& host_arg, const in_port_t port_arg, bool is_socket_arg) :
+ _magic(MAGIC_MEMORY),
+ _is_socket(is_socket_arg),
_pid(-1),
_port(port_arg),
- __get_pid(get_pid_arg),
- __ping(ping_arg),
- _hostname("localhost")
+ _hostname(host_arg)
{
- pid_file[0]= 0;
}
-server_st::server_st(const std::string &socket_file, test_server_getpid *get_pid_arg, test_server_ping *ping_arg) :
- _used(false),
- _pid(-1),
- _port(0),
- __get_pid(get_pid_arg),
- __ping(ping_arg),
- _hostname(socket_file)
+Server::~Server()
{
- pid_file[0]= 0;
+ if (has_pid() and not kill(_pid))
+ {
+ Error << "Unable to kill:" << *this;
+ }
}
+bool Server::validate()
+{
+ return _magic == MAGIC_MEMORY;
+}
-server_st::~server_st()
+// If the server exists, kill it
+bool Server::cycle()
{
- if (has_pid())
+ 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()))
{
- kill();
+ if (kill(current_pid))
+ {
+ Log << "Killed existing server," << *this << " with pid:" << current_pid;
+ 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;
+ return false;
}
+
+ return true;
}
-bool server_st::start()
+bool Server::wait_for_pidfile() const
{
- assert(not _command.empty());
- assert(not has_pid());
+ Wait wait(pid_file(), 4);
- if (has_pid())
+ return wait.successful();
+}
+
+bool Server::start()
+{
+ // If we find that we already have a pid then kill it.
+ if (has_pid() and kill(_pid) == false)
+ {
+ Error << "Could not kill() existing server during start() pid:" << _pid;
return false;
+ }
+
+ if (has_pid() == false)
+ {
+ fatal_message("has_pid() failed, programer error");
+ }
+
+ Application app(executable(), is_libtool());
- if (system(_command.c_str()) == -1)
+ if (is_debug())
+ {
+ app.use_gdb();
+ }
+ else if (getenv("TESTS_ENVIRONMENT"))
+ {
+ if (strstr(getenv("TESTS_ENVIRONMENT"), "gdb"))
+ {
+ app.use_gdb();
+ }
+ }
+
+ if (args(app) == false)
+ {
+ Error << "Could not build command()";
return false;
+ }
- int count= 30;
- while (not ping() and --count)
+ Application::error_t ret;
+ if (Application::SUCCESS != (ret= app.run()))
{
- global_sleep();
+ Error << "Application::run() " << ret;
+ return false;
}
+ _running= app.print();
- if (count == 0)
+ if (Application::SUCCESS != (ret= app.wait()))
{
+ Error << "Application::wait() " << _running << " " << ret;
return false;
}
- _pid= get_pid();
+ if (is_helgrind() or is_valgrind())
+ {
+ dream(5, 50000);
+ }
+
+ if (pid_file().empty() == false)
+ {
+ Wait wait(pid_file(), 8);
+
+ if (wait.successful() == false)
+ {
+ libtest::fatal(LIBYATL_DEFAULT_PARAM,
+ "Unable to open pidfile for: %s",
+ _running.c_str());
+ }
+ }
+
+ int counter= 0;
+ bool pinged= false;
+ while ((pinged= ping()) == false and
+ counter < (is_helgrind() or is_valgrind() ? 20 : 5))
+ {
+ dream(counter++, 50000);
+ }
+
+ if (pinged == false)
+ {
+ // If we happen to have a pid file, lets try to kill it
+ if (pid_file().empty() == false)
+ {
+ if (kill_file(pid_file()) == false)
+ {
+ fatal_message("Failed to kill off server after startup occurred, when pinging failed");
+ }
+ Error << "Failed to ping() server started, having pid_file. exec:" << _running;
+ }
+ else
+ {
+ Error << "Failed to ping() server started. exec:" << _running;
+ }
+ _running.clear();
+ return false;
+ }
+
+ // A failing get_pid() at this point is considered an error
+ _pid= get_pid(true);
return has_pid();
}
-void server_st::reset_pid()
+void Server::reset_pid()
{
- pid_file[0]= 0;
+ _running.clear();
+ _pid_file.clear();
_pid= -1;
}
-pid_t server_st::pid()
+pid_t Server::pid()
{
- if (not has_pid())
+ return _pid;
+}
+
+void Server::add_option(const std::string& arg)
+{
+ _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];
+ file_buffer[0]= 0;
+
+ if (broken_pid_file())
{
- _pid= get_pid();
+ snprintf(file_buffer, sizeof(file_buffer), "/tmp/%s.socketXXXXXX", name());
+ }
+ else
+ {
+ snprintf(file_buffer, sizeof(file_buffer), "var/run/%s.socketXXXXXX", name());
}
- return _pid;
-}
+ int fd;
+ if ((fd= mkstemp(file_buffer)) == -1)
+ {
+ perror(file_buffer);
+ return false;
+ }
+ close(fd);
+ unlink(file_buffer);
+ _socket= file_buffer;
+
+ return true;
+}
-bool server_st::kill()
+bool Server::set_pid_file()
{
- if (is_used())
+ char file_buffer[FILENAME_MAX];
+ file_buffer[0]= 0;
+
+ if (broken_pid_file())
+ {
+ snprintf(file_buffer, sizeof(file_buffer), "/tmp/%s.pidXXXXXX", name());
+ }
+ else
+ {
+ snprintf(file_buffer, sizeof(file_buffer), "var/run/%s.pidXXXXXX", name());
+ }
+
+ int fd;
+ if ((fd= mkstemp(file_buffer)) == -1)
+ {
+ perror(file_buffer);
return false;
+ }
+ close(fd);
+ unlink(file_buffer);
+
+ _pid_file= file_buffer;
+
+ return true;
+}
+
+bool Server::set_log_file()
+{
+ char file_buffer[FILENAME_MAX];
+ file_buffer[0]= 0;
+
+ snprintf(file_buffer, sizeof(file_buffer), "var/log/%s.logXXXXXX", name());
+ int fd;
+ if ((fd= mkstemp(file_buffer)) == -1)
+ {
+ libtest::fatal(LIBYATL_DEFAULT_PARAM, "mkstemp() failed on %s with %s", file_buffer, strerror(errno));
+ }
+ close(fd);
+
+ _log_file= file_buffer;
+
+ return true;
+}
+
+bool Server::args(Application& app)
+{
+
+ // Set a log file if it was requested (and we can)
+ if (has_log_file_option())
+ {
+ set_log_file();
+ log_file_option(app, _log_file);
+ }
- if ((_pid= get_pid()))
+ if (getenv("LIBTEST_SYSLOG") and has_syslog())
{
- kill_pid(_pid);
- if (pid_file[0])
+ app.add_option("--syslog");
+ }
+
+ // Update pid_file
+ {
+ if (_pid_file.empty() and set_pid_file() == false)
{
- unlink(pid_file); // If this happens we may be dealing with a dead server that left its pid file.
+ return false;
}
- reset_pid();
- return true;
+ pid_file_option(app, pid_file());
}
-#if 0
- else if (pid_file[0])
+
+ assert(daemon_file_option());
+ if (daemon_file_option() and not is_valgrind() and not is_helgrind())
{
- kill_file(pid_file);
- reset_pid();
+ app.add_option(daemon_file_option());
+ }
- return true;
+ if (has_socket_file_option())
+ {
+ if (set_socket_file() == false)
+ {
+ return false;
+ }
+
+ socket_file_option(app, _socket);
}
-#endif
- return false;
+ if (has_port_option())
+ {
+ port_option(app, _port);
+ }
+
+ for (Options::const_iterator iter= _options.begin(); iter != _options.end(); iter++)
+ {
+ if ((*iter).second.empty() == false)
+ {
+ app.add_option((*iter).first, (*iter).second);
+ }
+ else
+ {
+ app.add_option((*iter).first);
+ }
+ }
+
+ return true;
}
-void server_startup_st::push_server(server_st *arg)
+bool Server::is_debug() const
{
- servers.push_back(arg);
+ return bool(getenv("LIBTEST_MANUAL_GDB"));
}
-void server_startup_st::shutdown()
+bool Server::is_valgrind() const
{
- for (std::vector<server_st *>::iterator iter= servers.begin(); iter != servers.end(); iter++)
- {
- if ((*iter)->is_used())
- continue;
+ return bool(getenv("LIBTEST_MANUAL_VALGRIND"));
+}
- (*iter)->kill();
- }
+bool Server::is_helgrind() const
+{
+ return bool(getenv("LIBTEST_MANUAL_HELGRIND"));
}
-server_startup_st::~server_startup_st()
+bool Server::kill(pid_t pid_arg)
{
- for (std::vector<server_st *>::iterator iter= servers.begin(); iter != servers.end(); iter++)
+ if (check_pid(pid_arg) and kill_pid(pid_arg)) // If we kill it, reset
{
- delete *iter;
+ if (broken_pid_file() and pid_file().empty() == false)
+ {
+ unlink(pid_file().c_str());
+ }
+
+ if (broken_socket_cleanup() and has_socket() and not socket().empty())
+ {
+ unlink(socket().c_str());
+ }
+
+ reset_pid();
+
+ return true;
}
- servers.clear();
+
+ return false;
}
+
+} // namespace libtest