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