git.m6w6.name Git - m6w6/libmemcached/blob - libtest/cmdline.h

   1 /*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
   2  *
   3  *  Data Differential YATL (i.e. libtest)  library
   4  *
   5  *  Copyright (C) 2012 Data Differential, http://datadifferential.com/
   6  *
   7  *  Redistribution and use in source and binary forms, with or without
   8  *  modification, are permitted provided that the following conditions are
   9  *  met:
  10  *
  11  *      * Redistributions of source code must retain the above copyright
  12  *  notice, this list of conditions and the following disclaimer.
  13  *
  14  *      * Redistributions in binary form must reproduce the above
  15  *  copyright notice, this list of conditions and the following disclaimer
  16  *  in the documentation and/or other materials provided with the
  17  *  distribution.
  18  *
  19  *      * The names of its contributors may not be used to endorse or
  20  *  promote products derived from this software without specific prior
  21  *  written permission.
  22  *
  23  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  24  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  25  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  26  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  27  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  28  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  29  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  30  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  31  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  32  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  *
  35  */
  36
  37 #pragma once
  38
  39 #include <spawn.h>
  40
  41 // http://www.gnu.org/software/automake/manual/automake.html#Using-the-TAP-test-protocol
  42 #define EXIT_SKIP 77
  43 #define EXIT_FATAL 77
  44
  45 namespace libtest {
  46
  47 class Application {
  48 private:
  49   typedef std::vector< std::pair<std::string, std::string> > Options;
  50
  51 public:
  52
  53   enum error_t {
  54     SUCCESS= EXIT_SUCCESS,
  55     FAILURE= EXIT_FAILURE,
  56     INVALID= 127
  57   };
  58
  59   class Pipe {
  60   public:
  61     Pipe(int);
  62     ~Pipe();
  63
  64     int fd();
  65
  66     enum close_t {
  67       READ= 0,
  68       WRITE= 1
  69     };
  70
  71     void reset();
  72     void close(const close_t& arg);
  73     void dup_for_spawn(posix_spawn_file_actions_t& file_actions);
  74
  75     void nonblock();
  76     void cloexec();
  77     bool read(libtest::vchar_t&);
  78
  79   private:
  80     const int _std_fd;
  81     int _pipe_fd[2];
  82     bool _open[2];
  83   };
  84
  85 public:
  86   Application(const std::string& arg, const bool _use_libtool_arg= false);
  87
  88   virtual ~Application();
  89
  90   void add_option(const std::string&);
  91   void add_option(const std::string&, const std::string&);
  92   void add_long_option(const std::string& option_name, const std::string& option_value);
  93   error_t run(const char *args[]= NULL);
  94   error_t wait(bool nohang= true);
  95
  96   libtest::vchar_t stdout_result() const
  97   {
  98     return _stdout_buffer;
  99   }
 100
 101   size_t stdout_result_length() const
 102   {
 103     return _stdout_buffer.size();
 104   }
 105
 106   libtest::vchar_t stderr_result() const
 107   {
 108     return _stderr_buffer;
 109   }
 110
 111   const char* stderr_c_str() const
 112   {
 113     return &_stderr_buffer[0];
 114   }
 115
 116   size_t stderr_result_length() const
 117   {
 118     return _stderr_buffer.size();
 119   }
 120
 121   std::string print();
 122
 123   void use_valgrind(bool arg= true)
 124   {
 125     _use_valgrind= arg;
 126   }
 127
 128   bool check() const;
 129
 130   bool slurp();
 131   void murder();
 132
 133   void use_gdb(bool arg= true)
 134   {
 135     _use_gdb= arg;
 136   }
 137
 138   void use_ptrcheck(bool arg= true)
 139   {
 140     _use_ptrcheck= arg;
 141   }
 142
 143   std::string arguments();
 144
 145   std::string gdb_filename()
 146   {
 147     return  _gdb_filename;
 148   }
 149
 150   pid_t pid() const
 151   {
 152     return _pid;
 153   }
 154
 155   void will_fail()
 156   {
 157     _will_fail= true;
 158   }
 159
 160 private:
 161   void create_argv(const char *args[]);
 162   void delete_argv();
 163
 164 private:
 165   const bool _use_libtool;
 166   bool _use_valgrind;
 167   bool _use_gdb;
 168   bool _use_ptrcheck;
 169   bool _will_fail;
 170   size_t _argc;
 171   std::string _exectuble_name;
 172   std::string _exectuble;
 173   std::string _exectuble_with_path;
 174   std::string _gdb_filename;
 175   Options _options;
 176   Pipe stdin_fd;
 177   Pipe stdout_fd;
 178   Pipe stderr_fd;
 179   char * * built_argv;
 180   pid_t _pid;
 181   libtest::vchar_t _stdout_buffer;
 182   libtest::vchar_t _stderr_buffer;
 183 };
 184
 185 static inline std::ostream& operator<<(std::ostream& output, const enum Application::error_t &arg)
 186 {
 187   switch (arg)
 188   {
 189     case Application::SUCCESS:
 190       output << "EXIT_SUCCESS";
 191       break;
 192
 193     case Application::FAILURE:
 194       output << "EXIT_FAILURE";
 195       break;
 196
 197     case Application::INVALID:
 198       output << "127";
 199       break;
 200
 201     default:
 202       output << "EXIT_UNKNOWN";
 203   }
 204
 205   return output;
 206 }
 207
 208 int exec_cmdline(const std::string& executable, const char *args[], bool use_libtool= false);
 209
 210 const char *gearmand_binary();
 211 const char *drizzled_binary();
 212
 213 }