1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3 * Data Differential YATL (i.e. libtest) library
5 * Copyright (C) 2012 Data Differential, http://datadifferential.com/
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
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
19 * * The names of its contributors may not be used to endorse or
20 * promote products derived from this software without specific prior
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.
38 #include <libtest/common.h>
52 static inline std::string
&rtrim(std::string
&s
)
54 s
.erase(std::find_if(s
.rbegin(), s
.rend(), std::not1(std::ptr_fun
<int, int>(std::isspace
))).base(), s
.end());
58 #include <libtest/server.h>
59 #include <libtest/stream.h>
60 #include <libtest/killpid.h>
64 std::ostream
& operator<<(std::ostream
& output
, const Server
&arg
)
68 output
<< arg
.hostname();
72 output
<< arg
.hostname() << ":" << arg
.port();
77 output
<< " Pid:" << arg
.pid();
82 output
<< " Socket:" << arg
.socket();
85 if (arg
.running().empty() == false)
87 output
<< " Exec:" << arg
.running();
90 return output
; // for multiple << operators
93 #define MAGIC_MEMORY 123570
95 Server::Server(const std::string
& host_arg
, const in_port_t port_arg
,
96 const std::string
& executable
, const bool _is_libtool
,
99 _is_socket(is_socket_arg
),
102 _app(executable
, _is_libtool
)
117 bool Server::validate()
119 return _magic
== MAGIC_MEMORY
;
122 // If the server exists, kill it
127 // Try to ping, and kill the server #limit number of times
129 is_pid_valid(_app
.pid()))
133 Log
<< "Killed existing server," << *this;
139 // For whatever reason we could not kill it, and we reached limit
142 Error
<< "Reached limit, could not kill server";
149 bool Server::wait_for_pidfile() const
151 Wait
wait(pid_file(), 4);
153 return wait
.successful();
156 bool Server::has_pid() const
158 return (_app
.pid() > 1);
164 // If we find that we already have a pid then kill it.
165 if (has_pid() == true)
168 fatal_message("has_pid() failed, programer error");
172 // This needs more work.
180 if (getenv("YATL_PTRCHECK_SERVER"))
184 else if (getenv("YATL_VALGRIND_SERVER"))
189 if (args(_app
) == false)
191 Error
<< "Could not build command()";
195 libtest::release_port(_port
);
196 Application::error_t ret
;
197 if (Application::SUCCESS
!= (ret
= _app
.run()))
199 Error
<< "Application::run() " << ret
;
202 _running
= _app
.print();
204 if (valgrind_is_caller())
213 if (pid_file().empty() == false)
215 Wait
wait(pid_file(), 8);
217 if (wait
.successful() == false)
226 char *getcwd_buf
= getcwd(buf
, sizeof(buf
));
227 throw libtest::fatal(LIBYATL_DEFAULT_PARAM
,
228 "Unable to open pidfile in %s for: %s stderr:%s",
229 getcwd_buf
? getcwd_buf
: "",
231 _app
.stderr_c_str());
236 uint32_t this_wait
= 0;
239 uint32_t timeout
= 20; // This number should be high enough for valgrind startup (which is slow)
243 for (waited
= 0, retry
= 1; ; retry
++, waited
+= this_wait
)
245 if ((pinged
= ping()) == true)
249 else if (waited
>= timeout
)
254 this_wait
= retry
* retry
/ 3 + 1;
255 libtest::dream(this_wait
, 0);
261 // If we happen to have a pid file, lets try to kill it
262 if ((pid_file().empty() == false) and (access(pid_file().c_str(), R_OK
) == 0))
265 if (kill_file(pid_file()) == false)
267 throw libtest::fatal(LIBYATL_DEFAULT_PARAM
,
268 "Failed to kill off server, waited: %u after startup occurred, when pinging failed: %.*s stderr:%.*s",
270 int(_running
.size()), _running
.c_str(),
271 int(_app
.stderr_result_length()), _app
.stderr_c_str());
274 throw libtest::fatal(LIBYATL_DEFAULT_PARAM
,
275 "Failed native ping(), pid: %d is alive: %s waited: %u server started, having pid_file. exec: %.*s stderr:%.*s",
277 _app
.check() ? "true" : "false",
279 int(_running
.size()), _running
.c_str(),
280 int(_app
.stderr_result_length()), _app
.stderr_c_str());
284 throw libtest::fatal(LIBYATL_DEFAULT_PARAM
,
285 "Failed native ping(), pid: %d is alive: %s waited: %u server started. exec: %.*s stderr:%.*s",
287 _app
.check() ? "true" : "false",
289 int(_running
.size()), _running
.c_str(),
290 int(_app
.stderr_result_length()), _app
.stderr_c_str());
299 void Server::reset_pid()
305 pid_t
Server::pid() const
310 void Server::add_option(const std::string
& arg
)
312 _options
.push_back(std::make_pair(arg
, std::string()));
315 void Server::add_option(const std::string
& name
, const std::string
& value
)
317 _options
.push_back(std::make_pair(name
, value
));
320 bool Server::set_socket_file()
322 char file_buffer
[FILENAME_MAX
];
325 if (broken_pid_file())
327 snprintf(file_buffer
, sizeof(file_buffer
), "/tmp/%s.socketXXXXXX", name());
331 snprintf(file_buffer
, sizeof(file_buffer
), "var/run/%s.socketXXXXXX", name());
335 if ((fd
= mkstemp(file_buffer
)) == -1)
343 _socket
= file_buffer
;
348 bool Server::set_pid_file()
350 char file_buffer
[FILENAME_MAX
];
353 if (broken_pid_file())
355 snprintf(file_buffer
, sizeof(file_buffer
), "/tmp/%s.pidXXXXXX", name());
359 snprintf(file_buffer
, sizeof(file_buffer
), "var/run/%s.pidXXXXXX", name());
363 if ((fd
= mkstemp(file_buffer
)) == -1)
365 throw libtest::fatal(LIBYATL_DEFAULT_PARAM
, "mkstemp() failed on %s with %s", file_buffer
, strerror(errno
));
370 _pid_file
= file_buffer
;
375 bool Server::set_log_file()
377 char file_buffer
[FILENAME_MAX
];
380 snprintf(file_buffer
, sizeof(file_buffer
), "var/log/%s.logXXXXXX", name());
382 if ((fd
= mkstemp(file_buffer
)) == -1)
384 throw libtest::fatal(LIBYATL_DEFAULT_PARAM
, "mkstemp() failed on %s with %s", file_buffer
, strerror(errno
));
388 _log_file
= file_buffer
;
393 bool Server::args(Application
& app
)
396 // Set a log file if it was requested (and we can)
397 if (has_log_file_option())
400 log_file_option(app
, _log_file
);
403 if (getenv("LIBTEST_SYSLOG") and has_syslog())
405 app
.add_option("--syslog");
410 if (_pid_file
.empty() and set_pid_file() == false)
415 pid_file_option(app
, pid_file());
418 if (has_socket_file_option())
420 if (set_socket_file() == false)
425 socket_file_option(app
, _socket
);
428 if (has_port_option())
430 port_option(app
, _port
);
433 for (Options::const_iterator iter
= _options
.begin(); iter
!= _options
.end(); iter
++)
435 if ((*iter
).second
.empty() == false)
437 app
.add_option((*iter
).first
, (*iter
).second
);
441 app
.add_option((*iter
).first
);
450 if (check_pid(_app
.pid())) // If we kill it, reset
453 if (broken_pid_file() and pid_file().empty() == false)
455 unlink(pid_file().c_str());
458 if (broken_socket_cleanup() and has_socket() and not socket().empty())
460 unlink(socket().c_str());
471 } // namespace libtest