Additions to testing to better check return values/etc for servers.
[m6w6/libmemcached] / libtest / memcached.cc
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * libtest
4 *
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 3 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22
23 #include <libtest/common.h>
24
25 #include <libmemcached-1.0/memcached.h>
26 #include <libmemcachedutil-1.0/util.h>
27
28 using namespace libtest;
29
30 #include <cassert>
31 #include <cerrno>
32 #include <cstdio>
33 #include <cstdlib>
34 #include <cstring>
35 #include <iostream>
36 #include <signal.h>
37 #include <sys/types.h>
38 #include <sys/wait.h>
39 #include <unistd.h>
40
41 #include <libtest/server.h>
42 #include <libtest/wait.h>
43
44 #include <libtest/memcached.h>
45
46 #ifndef __INTEL_COMPILER
47 #pragma GCC diagnostic ignored "-Wold-style-cast"
48 #endif
49
50 using namespace libtest;
51
52 class Memcached : public libtest::Server
53 {
54 std::string _username;
55 std::string _password;
56
57 public:
58 Memcached(const std::string& host_arg, const in_port_t port_arg, const bool is_socket_arg, const std::string& username_arg, const std::string& password_arg) :
59 libtest::Server(host_arg, port_arg, is_socket_arg),
60 _username(username_arg),
61 _password(password_arg)
62 { }
63
64 Memcached(const std::string& host_arg, const in_port_t port_arg, const bool is_socket_arg) :
65 libtest::Server(host_arg, port_arg, is_socket_arg)
66 {
67 set_pid_file();
68 }
69
70 virtual const char *sasl() const
71 {
72 return NULL;
73 }
74
75 const std::string& password() const
76 {
77 return _password;
78 }
79
80 const std::string& username() const
81 {
82 return _username;
83 }
84
85 pid_t get_pid(bool error_is_ok)
86 {
87 // Memcached is slow to start, so we need to do this
88 if (not pid_file().empty())
89 {
90 if (error_is_ok and not wait_for_pidfile())
91 {
92 Error << "Pidfile was not found:" << pid_file();
93 return -1;
94 }
95 }
96
97 pid_t local_pid;
98 memcached_return_t rc= MEMCACHED_SUCCESS;
99 if (has_socket())
100 {
101 if (socket().empty())
102 {
103 return -1;
104 }
105
106 local_pid= libmemcached_util_getpid(socket().c_str(), port(), &rc);
107 }
108 else
109 {
110 local_pid= libmemcached_util_getpid(hostname().c_str(), port(), &rc);
111 }
112
113 if (error_is_ok and ((memcached_failed(rc) or not is_pid_valid(local_pid))))
114 {
115 Error << "libmemcached_util_getpid(" << memcached_strerror(NULL, rc) << ") pid: " << local_pid << " for:" << *this;
116 }
117
118 return local_pid;
119 }
120
121 bool ping()
122 {
123 // Memcached is slow to start, so we need to do this
124 if (not pid_file().empty())
125 {
126 if (not wait_for_pidfile())
127 {
128 Error << "Pidfile was not found:" << pid_file();
129 return -1;
130 }
131 }
132
133 memcached_return_t rc;
134 bool ret;
135
136 if (has_socket())
137 {
138 ret= libmemcached_util_ping(socket().c_str(), 0, &rc);
139 }
140 else
141 {
142 ret= libmemcached_util_ping(hostname().c_str(), port(), &rc);
143 }
144
145 if (memcached_failed(rc) or not ret)
146 {
147 Error << "libmemcached_util_ping(" << hostname() << ", " << port() << ") error: " << memcached_strerror(NULL, rc);
148 }
149
150 return ret;
151 }
152
153 const char *name()
154 {
155 return "memcached";
156 };
157
158 const char *executable()
159 {
160 return MEMCACHED_BINARY;
161 }
162
163 virtual void pid_file_option(Application& app, const std::string& arg)
164 {
165 if (arg.empty() == false)
166 {
167 app.add_option("-P", arg);
168 }
169 }
170
171 const char *socket_file_option() const
172 {
173 return "-s ";
174 }
175
176 const char *daemon_file_option()
177 {
178 return "-d";
179 }
180
181 virtual void port_option(Application& app, in_port_t arg)
182 {
183 char buffer[30];
184 snprintf(buffer, sizeof(buffer), "%d", int(arg));
185 app.add_option("-p", buffer);
186 }
187
188 bool has_port_option() const
189 {
190 return true;
191 }
192
193 bool has_socket_file_option() const
194 {
195 return true;
196 }
197
198 void socket_file_option(Application& app, const std::string& socket_arg)
199 {
200 if (socket_arg.empty() == false)
201 {
202 app.add_option("-s", socket_arg);
203 }
204 }
205
206 bool is_libtool()
207 {
208 return false;
209 }
210
211 bool broken_socket_cleanup()
212 {
213 return true;
214 }
215
216 // Memcached's pidfile is broken
217 bool broken_pid_file()
218 {
219 return true;
220 }
221
222 bool build(int argc, const char *argv[]);
223 };
224
225 class MemcachedSaSL : public Memcached
226 {
227 public:
228 MemcachedSaSL(const std::string& host_arg, const in_port_t port_arg, const bool is_socket_arg, const std::string& username_arg, const std::string &password_arg) :
229 Memcached(host_arg, port_arg, is_socket_arg, username_arg, password_arg)
230 { }
231
232 const char *name()
233 {
234 return "memcached-sasl";
235 };
236
237 const char *sasl() const
238 {
239 return " -S -B binary ";
240 }
241
242 const char *executable()
243 {
244 return MEMCACHED_SASL_BINARY;
245 }
246
247 pid_t get_pid(bool error_is_ok)
248 {
249 // Memcached is slow to start, so we need to do this
250 if (not pid_file().empty())
251 {
252 if (error_is_ok and not wait_for_pidfile())
253 {
254 Error << "Pidfile was not found:" << pid_file();
255 return -1;
256 }
257 }
258
259 pid_t local_pid;
260 memcached_return_t rc;
261 if (has_socket())
262 {
263 local_pid= libmemcached_util_getpid2(socket().c_str(), 0, username().c_str(), password().c_str(), &rc);
264 }
265 else
266 {
267 local_pid= libmemcached_util_getpid2(hostname().c_str(), port(), username().c_str(), password().c_str(), &rc);
268 }
269
270 if (error_is_ok and ((memcached_failed(rc) or not is_pid_valid(local_pid))))
271 {
272 Error << "libmemcached_util_getpid2(" << memcached_strerror(NULL, rc) << ") username: " << username() << " password: " << password() << " pid: " << local_pid << " for:" << *this;
273 }
274
275 return local_pid;
276 }
277
278 bool ping()
279 {
280 // Memcached is slow to start, so we need to do this
281 if (not pid_file().empty())
282 {
283 if (not wait_for_pidfile())
284 {
285 Error << "Pidfile was not found:" << pid_file();
286 return -1;
287 }
288 }
289
290 memcached_return_t rc;
291 bool ret;
292
293 if (has_socket())
294 {
295 ret= libmemcached_util_ping2(socket().c_str(), 0, username().c_str(), password().c_str(), &rc);
296 }
297 else
298 {
299 ret= libmemcached_util_ping2(hostname().c_str(), port(), username().c_str(), password().c_str(), &rc);
300 }
301
302 if (memcached_failed(rc) or not ret)
303 {
304 Error << "libmemcached_util_ping2(" << hostname() << ", " << port() << ", " << username() << ", " << password() << ") error: " << memcached_strerror(NULL, rc);
305 }
306
307 return ret;
308 }
309
310 };
311
312
313 #include <sstream>
314
315 bool Memcached::build(int argc, const char *argv[])
316 {
317 std::stringstream arg_buffer;
318
319 if (getuid() == 0 or geteuid() == 0)
320 {
321 add_option("-u", "root");
322 }
323
324 add_option("-l", "localhost");
325 add_option("-m", "128");
326 add_option("-M");
327
328 if (sasl())
329 {
330 add_option(sasl());
331 }
332
333 for (int x= 1 ; x < argc ; x++)
334 {
335 add_option(argv[x]);
336 }
337
338 return true;
339 }
340
341 namespace libtest {
342
343 libtest::Server *build_memcached(const std::string& hostname, const in_port_t try_port)
344 {
345 return new Memcached(hostname, try_port, false);
346 }
347
348 libtest::Server *build_memcached_socket(const std::string& socket_file, const in_port_t try_port)
349 {
350 return new Memcached(socket_file, try_port, true);
351 }
352
353
354 libtest::Server *build_memcached_sasl(const std::string& hostname, const in_port_t try_port, const std::string& username, const std::string &password)
355 {
356 if (username.empty())
357 {
358 return new MemcachedSaSL(hostname, try_port, false, "memcached", "memcached");
359 }
360
361 return new MemcachedSaSL(hostname, try_port, false, username, password);
362 }
363
364 libtest::Server *build_memcached_sasl_socket(const std::string& socket_file, const in_port_t try_port, const std::string& username, const std::string &password)
365 {
366 if (username.empty())
367 {
368 return new MemcachedSaSL(socket_file, try_port, true, "memcached", "memcached");
369 }
370
371 return new MemcachedSaSL(socket_file, try_port, true, username, password);
372 }
373
374 }
375