Fix for valgrind issue around memcached_result_st not being free()
[m6w6/libmemcached] / libtest / comparison.hpp
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 <typeinfo>
40
41 #if defined(HAVE_LIBMEMCACHED) && HAVE_LIBMEMCACHED
42 #include <libmemcached-1.0/memcached.h>
43 #include <libmemcachedutil-1.0/ostream.hpp>
44 #endif
45
46 #if defined(HAVE_LIBGEARMAN) && HAVE_LIBGEARMAN
47 #include <libgearman-1.0/ostream.hpp>
48 #endif
49
50 namespace libtest {
51
52 LIBTEST_API
53 bool gdb_is_caller(void);
54
55 LIBTEST_API
56 bool valgrind_is_caller(void);
57
58 LIBTEST_API
59 bool _in_valgrind(const char *file, int line, const char *func);
60
61 template <class T_comparable, class T_hint>
62 bool _compare_truth_hint(const char *file, int line, const char *func, T_comparable __expected, const char *assertation_label, T_hint __hint)
63 {
64 if (__expected == false)
65 {
66 libtest::stream::make_cerr(file, line, func) << "Assertation \"" << assertation_label << "\" failed, hint: " << __hint;
67 return false;
68 }
69
70 return true;
71 }
72
73 template <class T1_comparable, class T2_comparable>
74 bool _compare(const char *file, int line, const char *func, const T1_comparable& __expected, const T2_comparable& __actual, bool use_io)
75 {
76 if (__expected != __actual)
77 {
78 if (use_io)
79 {
80 libtest::stream::make_cerr(file, line, func) << "Expected \"" << __expected << "\" got \"" << __actual << "\"";
81 }
82
83 return false;
84 }
85
86 return true;
87 }
88
89 template <class T1_comparable, class T2_comparable>
90 bool _compare_strcmp(const char *file, int line, const char *func, const T1_comparable& __expected, const T2_comparable& __actual)
91 {
92 if (__expected == NULL)
93 {
94 fatal_message("Expected value was NULL, programmer error");
95 }
96
97 if (__actual == NULL)
98 {
99 libtest::stream::make_cerr(file, line, func) << "Expected " << __expected << " but got NULL";
100 return false;
101 }
102
103 if (strncmp(__expected, __actual, strlen(__expected)))
104 {
105 libtest::stream::make_cerr(file, line, func) << "Expected " << __expected << " passed \"" << __actual << "\"";
106 return false;
107 }
108
109 return true;
110 }
111
112 template <class T_comparable>
113 bool _compare_zero(const char *file, int line, const char *func, T_comparable __actual)
114 {
115 if (T_comparable(0) != __actual)
116 {
117 libtest::stream::make_cerr(file, line, func) << "Expected 0 got \"" << __actual << "\"";
118 return false;
119 }
120
121 return true;
122 }
123
124 template <class T_comparable>
125 bool _truth(const char *file, int line, const char *func, T_comparable __truth)
126 {
127 if (bool(__truth))
128 {
129 libtest::stream::make_cerr(file, line, func) << "Assertion failed for " << func << "() with \"" << __truth << "\"";
130 return false;
131 }
132
133 return true;
134 }
135
136 template <class T1_comparable, class T2_comparable, class T_hint>
137 bool _compare_hint(const char *file, int line, const char *func, T1_comparable __expected, T2_comparable __actual, T_hint __hint, bool io_error= true)
138 {
139 if (__expected != __actual)
140 {
141 if (io_error)
142 {
143 libtest::stream::make_cerr(file, line, func) << "Expected \"" << __expected << "\" got \"" << __actual << "\"" << " Additionally: \"" << __hint << "\"";
144 }
145
146 return false;
147 }
148
149 return true;
150 }
151
152 template <class T1_comparable, class T2_comparable, class T_hint>
153 bool _ne_compare_hint(const char *file, int line, const char *func, T1_comparable __expected, T2_comparable __actual, T_hint __hint, bool io_error= true)
154 {
155 if (__expected == __actual)
156 {
157 if (io_error)
158 {
159 libtest::stream::make_cerr(file, line, func) << "Expected \"" << __expected << "\" got \"" << __actual << "\"" << " Additionally: \"" << __hint << "\"";
160 }
161
162 return false;
163 }
164
165 return true;
166 }
167
168 } // namespace libtest