jenkins-promote-staging-trunk-libmemcached-14
[awesomized/libmemcached] / 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 /**
40 Framework is the structure which is passed to the test implementation to be filled.
41 This must be implemented in order for the test framework to load the tests. We call
42 get_world() in order to fill this structure.
43 */
44
45 class Framework {
46 public:
47 collection_st *collections;
48
49 /* These methods are called outside of any collection call. */
50 test_callback_create_fn *_create;
51 test_callback_destroy_fn *_destroy;
52
53 public:
54 void* create(test_return_t& arg);
55
56 /**
57 If an error occurs during the test, this is called.
58 */
59 test_callback_error_fn *_on_error;
60
61 void set_on_error(test_callback_error_fn *arg)
62 {
63 _on_error= arg;
64 }
65
66 test_return_t on_error(const enum test_return_t, void *);
67
68 void set_socket()
69 {
70 _servers.set_socket();
71 }
72
73 void set_sasl(const std::string& username_arg, const std::string& password_arg)
74 {
75 _servers.set_sasl(username_arg, password_arg);
76 }
77
78 libtest::server_startup_st& servers()
79 {
80 return _servers;
81 }
82
83 /**
84 Runner represents the callers for the tests. If not implemented we will use
85 a set of default implementations.
86 */
87 libtest::Runner *_runner;
88
89 void set_runner(libtest::Runner *arg)
90 {
91 _runner= arg;
92 }
93
94 libtest::Runner *runner();
95
96
97 Framework();
98
99 virtual ~Framework();
100
101 Framework(const Framework&);
102
103 private:
104 Framework& operator=(const Framework&);
105 libtest::server_startup_st _servers;
106 bool _socket;
107 void *_creators_ptr;
108 unsigned long int _servers_to_run;
109 };