git.m6w6.name Git - m6w6/libmemcached/blob - libtest/framework.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 <libtest/signal.h>
  40
  41 /**
  42   Framework is the structure which is passed to the test implementation to be filled.
  43   This must be implemented in order for the test framework to load the tests. We call
  44   get_world() in order to fill this structure.
  45 */
  46
  47 #include <vector>
  48
  49 class Framework {
  50 public:
  51
  52 public:
  53   test_return_t create();
  54
  55   void create(test_callback_create_fn* arg)
  56   {
  57     _create= arg;
  58   }
  59
  60   void destroy(test_callback_destroy_fn* arg)
  61   {
  62     _destroy= arg;
  63   }
  64
  65   void collections(collection_st* arg)
  66   {
  67     _collections= arg;
  68   }
  69
  70   void set_on_error(test_callback_error_fn *arg)
  71   {
  72     _on_error= arg;
  73   }
  74
  75   test_return_t on_error(const enum test_return_t, void *);
  76
  77   void set_socket()
  78   {
  79     _servers.set_socket();
  80   }
  81
  82   void set_sasl(const std::string& username_arg, const std::string& password_arg)
  83   {
  84     _servers.set_sasl(username_arg, password_arg);
  85   }
  86
  87   libtest::server_startup_st& servers()
  88   {
  89     return _servers;
  90   }
  91
  92   void set_runner(libtest::Runner *arg)
  93   {
  94     _runner= arg;
  95   }
  96
  97   libtest::Runner *runner();
  98
  99   void exec();
 100
 101   libtest::Collection& collection();
 102
 103   Framework(libtest::SignalThread&, const std::string&);
 104
 105   virtual ~Framework();
 106
 107   Framework(libtest::SignalThread&,
 108             const std::string&,
 109             const std::string&);
 110
 111   bool match(const char* arg);
 112
 113   void *creators_ptr()
 114   {
 115     return _creators_ptr;
 116   }
 117
 118   libtest::SignalThread& signal()
 119   {
 120     return _signal;
 121   }
 122
 123   uint32_t sum_total();
 124   uint32_t sum_success();
 125   uint32_t sum_skipped();
 126   uint32_t sum_failed();
 127
 128   size_t size()
 129   {
 130     return _collection.size();
 131   }
 132
 133   uint32_t total() const
 134   {
 135     return _total;
 136   }
 137
 138   uint32_t success() const
 139   {
 140     return _success;
 141   }
 142
 143   uint32_t skipped() const
 144   {
 145     return _skipped;
 146   }
 147
 148   uint32_t failed() const
 149   {
 150     return _failed;
 151   }
 152
 153 private:
 154   Framework& operator=(const Framework&);
 155
 156   collection_st *_collections;
 157
 158   uint32_t _total;
 159   uint32_t _success;
 160   uint32_t _skipped;
 161   uint32_t _failed;
 162
 163   /* These methods are called outside of any collection call. */
 164   test_callback_create_fn *_create;
 165   test_callback_destroy_fn *_destroy;
 166
 167   /**
 168     If an error occurs during the test, this is called.
 169   */
 170   test_callback_error_fn *_on_error;
 171
 172   /**
 173     Runner represents the callers for the tests. If not implemented we will use
 174     a set of default implementations.
 175   */
 176   libtest::Runner *_runner;
 177
 178   libtest::server_startup_st _servers;
 179   bool _socket;
 180   void *_creators_ptr;
 181   unsigned long int _servers_to_run;
 182   std::vector<libtest::Collection*> _collection;
 183   libtest::SignalThread& _signal;
 184   std::string _only_run;
 185   std::string _wildcard;
 186 };