Import/Merge of libtest latest.
[m6w6/libmemcached] / libtest / server.h
index 00f29cd837b19c9c21630c7fbbf0be835d942b04..a41e621bb1f491cccf804d334493b360c53e4409 100644 (file)
@@ -1,14 +1,45 @@
-/*
- * 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>
 #include <netdb.h>
 #include <netinet/in.h>
 #include <unistd.h>
 #include <vector>
 
-#define SERVERS_TO_CREATE 5
-
-struct server_st;
+namespace libtest {
 
-typedef pid_t (test_server_getpid)(server_st &);
-typedef bool (test_server_ping)(server_st &);
+struct Server {
+private:
+  typedef std::vector< std::pair<std::string, std::string> > Options;
 
-struct server_st {
 private:
-  bool _used;
-  pid_t _pid;
+  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()
+
+protected:
   in_port_t _port;
-  char pid_file[FILENAME_MAX]; // Did we start it, or was it just sitting there?
-  std::string _command;
-  test_server_getpid *__get_pid;
-  test_server_ping *__ping;
   std::string _hostname;
+  std::string _extra_args;
 
 public:
-  server_st(in_port_t port_arg, test_server_getpid *, test_server_ping *);
+  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();
 
-  server_st(const std::string &socket_file, test_server_getpid *, test_server_ping *);
+  virtual const char *name()= 0;
+  virtual bool is_libtool()= 0;
 
-  void set_methods(test_server_getpid *get_pid_arg, test_server_ping *ping_arg)
+  virtual bool has_socket_file_option() const
   {
-    __get_pid= get_pid_arg;
-    __ping= ping_arg;
+    return false;
   }
 
-  const char *hostname() const
+  virtual void socket_file_option(Application& app, const std::string& socket_arg)
   {
-    if (_hostname.empty())
-      return "";
+    if (socket_arg.empty() == false)
+    {
+      std::string buffer("--socket=");
+      buffer+= socket_arg;
+      app.add_option(buffer);
+    }
+  }
 
-    return _hostname.c_str();
+  virtual bool has_log_file_option() const
+  {
+    return false;
   }
 
-  bool ping()
+  virtual void log_file_option(Application& app, const std::string& arg)
   {
-    if (__ping)
-      return __ping(*this);
+    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()
+  {
     return false;
   }
 
-  pid_t get_pid()
+  const std::string& pid_file() const
+  {
+    return _pid_file;
+  }
+
+  const std::string& base_command() const
   {
-    if (__get_pid)
-      return _pid= __get_pid(*this);
+    return _base_command;
+  }
+
+  const std::string& log_file() const
+  {
+    return _log_file;
+  }
 
-    return -1;
+  const std::string& hostname() const
+  {
+    return _hostname;
+  }
+
+  const std::string& socket() const
+  {
+    return _socket;
   }
 
-  void set_port(in_port_t arg)
+  bool has_socket() const
   {
-    _port= arg;
+    return _is_socket;
   }
 
+  bool cycle();
+
+  virtual bool ping()= 0;
+
+  virtual bool build(size_t 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
   {
     return _port;
@@ -84,28 +192,42 @@ public:
     return (_port != 0);
   }
 
-  void set_command(const char *arg)
+  virtual bool has_syslog() const
   {
-    _command= arg;
+    return false;
   }
 
-  void set_used()
+  // Reset a server if another process has killed the server
+  void reset()
   {
-    _used= true;
+    _pid_file.clear();
+    _log_file.clear();
   }
 
-  pid_t pid();
+  pid_t pid() const;
+
+  bool has_pid() const;
 
-  bool is_used() const
+  virtual bool has_pid_file() const
   {
-    return _used;
+    return true;
   }
 
-  ~server_st();
+  const std::string& error()
+  {
+    return _error;
+  }
 
-  bool has_pid()
+  void error(std::string arg)
   {
-    return (_pid > 1);
+    _error= arg;
+  }
+
+  virtual bool wait_for_pidfile() const;
+
+  bool check_pid(pid_t pid_arg) const
+  {
+    return (pid_arg > 1);
   }
 
   bool is_socket() const
@@ -113,41 +235,40 @@ public:
     return _hostname[0] == '/';
   }
 
-  bool kill();
-  bool start();
+  const std::string running() const
+  {
+    return _running;
+  }
 
-private:
-  void reset_pid();
-};
+  bool check();
+
+  std::string log_and_pid();
 
-std::ostream& operator<<(std::ostream& output, const server_st &arg);
+  bool kill();
+  bool start();
+  bool command(libtest::Application& app);
 
-struct server_startup_st
-{
-  uint32_t count;
-  uint8_t udp;
-  std::string server_list;
-  std::vector<server_st *> servers;
+  bool validate();
 
-  server_startup_st() :
-    count(SERVERS_TO_CREATE),
-    udp(0)
-  { }
+protected:
+  bool set_pid_file();
+  Options _options;
+  Application _app;
 
-  void shutdown();
-  void push_server(server_st *);
+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 args(Application&);
 
-  ~server_startup_st();
+  std::string _error;
 };
 
-#ifdef __cplusplus
-extern "C" {
-#endif
+std::ostream& operator<<(std::ostream& output, const libtest::Server &arg);
 
+} // namespace libtest
 
-bool server_startup(server_startup_st *construct);
-void server_shutdown(server_startup_st *construct);
 
-#ifdef __cplusplus
-}
-#endif