tests: run memcached verbosely, catch output and show it on failure
[awesomized/libmemcached] / libtest / server.h
index d987a0b7d3307e8e5ebde87b4014b022bc7d9104..10c1d3745befe08fd3ff25852d78aeab9718ba78 100644 (file)
@@ -1,14 +1,43 @@
-/*
- * Copyright (C) 2011 Data Differential, http://datadifferential.com/
- * Copyright (C) 2006-2009 Brian Aker
- * All rights reserved.
+/*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
+ *
+ *  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
+ *  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.
  *
- * Use and distribution licensed under the BSD license.  See
- * the COPYING file in the parent directory for full text.
  */
 
 #pragma once
 
+#include <libtest/cmdline.h>
+
 #include <cassert>
 #include <cstdio>
 #include <cstring>
@@ -22,13 +51,17 @@ namespace libtest {
 
 struct Server {
 private:
+  typedef std::vector< std::pair<std::string, std::string> > Options;
+
+private:
+  uint64_t _magic;
   bool _is_socket;
   std::string _socket;
+  std::string _sasl;
   std::string _pid_file;
   std::string _log_file;
   std::string _base_command; // executable command which include libtool, valgrind, gdb, etc
   std::string _running; // Current string being used for system()
-  pid_t _pid;
 
 protected:
   in_port_t _port;
@@ -36,21 +69,73 @@ protected:
   std::string _extra_args;
 
 public:
-  Server(const std::string& hostname, const in_port_t port_arg, const bool is_socket_arg= false);
+  Server(const std::string& hostname, const in_port_t port_arg,
+         const std::string& executable, const bool _is_libtool,
+         const bool is_socket_arg= false);
 
   virtual ~Server();
 
   virtual const char *name()= 0;
-  virtual const char *executable()= 0;
-  virtual const char *port_option()= 0;
-  virtual const char *pid_file_option()= 0;
-  virtual const char *daemon_file_option()= 0;
-  virtual const char *log_file_option()= 0;
   virtual bool is_libtool()= 0;
 
-  virtual const char *socket_file_option() const
+  virtual bool has_socket_file_option() const
+  {
+    return false;
+  }
+
+  virtual void socket_file_option(Application& app, const std::string& socket_arg)
+  {
+    if (socket_arg.empty() == false)
+    {
+      std::string buffer("--socket=");
+      buffer+= socket_arg;
+      app.add_option(buffer);
+    }
+  }
+
+  virtual bool has_log_file_option() const
+  {
+    return false;
+  }
+
+  virtual void log_file_option(Application& app, const std::string& arg)
   {
-    return NULL;
+    if (arg.empty() == false)
+    {
+      std::string buffer("--log-file=");
+      buffer+= arg;
+      app.add_option(buffer);
+    }
+  }
+
+  virtual void pid_file_option(Application& app, const std::string& arg)
+  {
+    if (arg.empty() == false)
+    {
+      std::string buffer("--pid-file=");
+      buffer+= arg;
+      app.add_option(buffer);
+    }
+  }
+
+  virtual bool has_port_option() const
+  {
+    return false;
+  }
+
+  virtual void port_option(Application& app, in_port_t arg)
+  {
+    if (arg > 0)
+    {
+      char buffer[1024];
+      snprintf(buffer, sizeof(buffer), "--port=%d", int(arg));
+      app.add_option(buffer);
+    }
+  }
+
+  virtual bool broken_socket_cleanup()
+  {
+    return false;
   }
 
   virtual bool broken_pid_file()
@@ -92,9 +177,11 @@ public:
 
   virtual bool ping()= 0;
 
-  virtual pid_t get_pid(bool error_is_ok= false)= 0;
+  bool init(const char *argv[]);
+  virtual bool build()= 0;
 
-  virtual bool build(int argc, const char *argv[])= 0;
+  void add_option(const std::string&);
+  void add_option(const std::string&, const std::string&);
 
   in_port_t port() const
   {
@@ -106,30 +193,46 @@ public:
     return (_port != 0);
   }
 
+  virtual bool has_syslog() const
+  {
+    return false;
+  }
+
   // Reset a server if another process has killed the server
   void reset()
   {
-    _pid= -1;
     _pid_file.clear();
     _log_file.clear();
   }
 
-  void set_extra_args(const std::string &arg);
+  std::pair<std::string, std::string> output();
+
+  pid_t pid() const;
 
-  bool args(std::string& options);
+  bool has_pid() const;
+
+  virtual bool has_pid_file() const
+  {
+    return true;
+  }
 
-  pid_t pid();
+  const std::string& error()
+  {
+    return _error;
+  }
 
-  pid_t pid() const
+  void error(std::string arg)
   {
-    return _pid;
+    _error= arg;
   }
 
-  bool has_pid() const
+  void reset_error()
   {
-    return (_pid > 1);
+    _error.clear();
   }
 
+  virtual bool wait_for_pidfile() const;
+
   bool check_pid(pid_t pid_arg) const
   {
     return (pid_arg > 1);
@@ -137,7 +240,7 @@ public:
 
   bool is_socket() const
   {
-    return _hostname[0] == '/';
+    return _is_socket;
   }
 
   const std::string running() const
@@ -145,76 +248,51 @@ public:
     return _running;
   }
 
+  bool check();
+
   std::string log_and_pid();
 
-  bool kill(pid_t pid_arg);
+  bool kill();
   bool start();
-  bool command(std::string& command_arg);
-
-protected:
-  void nap();
-
-private:
-  bool is_helgrind() const;
-  bool is_valgrind() const;
-  bool is_debug() const;
-  bool set_log_file();
-  bool set_pid_file();
-  bool set_socket_file();
-  void rebuild_base_command();
-  void reset_pid();
-};
-
-std::ostream& operator<<(std::ostream& output, const libtest::Server &arg);
-
-class server_startup_st
-{
-private:
-  std::string server_list;
-  bool _socket;
-
-public:
-
-  uint8_t udp;
-  std::vector<Server *> servers;
-
-  server_startup_st() :
-    _socket(false),
-    udp(0)
-  { }
-
-  bool start_socket_server(const std::string& server_type, const in_port_t try_port, int argc, const char *argv[]);
+  bool command(libtest::Application& app);
 
-  std::string option_string() const;
+  bool validate();
 
-  size_t count() const
+  void out_of_ban_killed(bool arg)
   {
-    return servers.size();
+    out_of_ban_killed_= arg;
   }
 
-  bool is_debug() const;
-  bool is_helgrind() const;
-  bool is_valgrind() const;
-
-  bool socket()
+  bool out_of_ban_killed()
   {
-    return _socket;
+    return out_of_ban_killed_;
   }
 
-  void set_socket()
+  void timeout(uint32_t timeout_)
   {
-    _socket= true;
+    _timeout= timeout_;
   }
 
+protected:
+  bool set_pid_file();
+  Options _options;
+  Application _app;
 
-  void shutdown(bool remove= false);
-  void push_server(Server *);
-  Server *pop_server();
+private:
+  bool is_helgrind() const;
+  bool is_valgrind() const;
+  bool is_debug() const;
+  bool set_log_file();
+  bool set_socket_file();
+  void reset_pid();
+  bool out_of_ban_killed_;
+  bool args(Application&);
 
-  ~server_startup_st();
+  std::string _error;
+  uint32_t _timeout; // This number should be high enough for valgrind startup (which is slow)
 };
 
-bool server_startup(server_startup_st&, const std::string&, in_port_t try_port, int argc, const char *argv[]);
+std::ostream& operator<<(std::ostream& output, const libtest::Server &arg);
 
 } // namespace libtest