mirror of https://github.com/sysown/proxysql
Merge pull request #3855 from sysown/v2.x-3838
Properly handle 'EINTR' for signals for RESTAPI - Closes: 3838pull/3859/head
René Cannaò
4 years ago
committed by
GitHub
commit
f9d04422f1
@ -0,0 +1,229 @@
|
||||
/**
|
||||
* @file reg_test_3838-restapi_eintr-t.cpp
|
||||
* @brief This is a regression test for issue #3838. Test checks that scripts executed via RESTAPI doesn't get
|
||||
* unproperly interrupted by signals.
|
||||
* @details The test register a simple waiting script into the RESTAPI, for latter issuing multiple different
|
||||
* signals to it and checks that:
|
||||
* - ProxySQL properly handles the signals being set to the executed script.
|
||||
* - Timeouts work properly no matter the signaling.
|
||||
* - ProxySQL correctly reports the child termination exit status. E.g. If terminated by a signal.
|
||||
* @date 2022-04-27
|
||||
*/
|
||||
|
||||
#include <algorithm>
|
||||
#include <string>
|
||||
#include <stdio.h>
|
||||
#include <vector>
|
||||
#include <thread>
|
||||
#include <tuple>
|
||||
|
||||
#include <signal.h>
|
||||
#include <unistd.h>
|
||||
|
||||
#include <curl/curl.h>
|
||||
|
||||
#include <mysql.h>
|
||||
#include <mysql/mysqld_error.h>
|
||||
|
||||
#include "json.hpp"
|
||||
#include "tap.h"
|
||||
#include "proxysql_utils.h"
|
||||
#include "command_line.h"
|
||||
#include "utils.h"
|
||||
|
||||
using std::string;
|
||||
using std::vector;
|
||||
|
||||
const int SIGNAL_NUM = 5;
|
||||
const string base_address { "http://localhost:6070/sync/" };
|
||||
|
||||
using params = std::string;
|
||||
using signal_t = int;
|
||||
using rescode_t = long;
|
||||
|
||||
vector<std::tuple<string, params, rescode_t, signal_t, int>> endpoint_requests {
|
||||
std::make_tuple("simple_sleep", "1", 200, 18, 0),
|
||||
std::make_tuple("simple_sleep_timeout", "4", 424, 18, ETIME),
|
||||
std::make_tuple("simple_sleep_timeout", "4", 424, 19, ETIME),
|
||||
std::make_tuple("simple_sleep", "2", 424, 15, 15),
|
||||
};
|
||||
|
||||
int main(int argc, char** argv) {
|
||||
CommandLine cl;
|
||||
|
||||
if (cl.getEnv()) {
|
||||
diag("Failed to get the required environmental variables.");
|
||||
return EXIT_FAILURE;
|
||||
}
|
||||
|
||||
plan(endpoint_requests.size());
|
||||
|
||||
MYSQL* proxysql_admin = mysql_init(NULL);
|
||||
|
||||
// Initialize connections
|
||||
if (!proxysql_admin) {
|
||||
fprintf(stderr, "File %s, line %d, Error: %s\n", __FILE__, __LINE__, mysql_error(proxysql_admin));
|
||||
return EXIT_FAILURE;
|
||||
}
|
||||
if (!mysql_real_connect(proxysql_admin, cl.host, cl.admin_username, cl.admin_password, NULL, cl.admin_port, NULL, 0)) {
|
||||
fprintf(stderr, "File %s, line %d, Error: %s\n", __FILE__, __LINE__, mysql_error(proxysql_admin));
|
||||
return EXIT_FAILURE;
|
||||
}
|
||||
|
||||
// Enable 'RESTAPI'
|
||||
MYSQL_QUERY(proxysql_admin, "SET admin-restapi_enabled='true'");
|
||||
MYSQL_QUERY(proxysql_admin, "SET admin-restapi_port=6070");
|
||||
|
||||
MYSQL_QUERY(proxysql_admin, "LOAD ADMIN VARIABLES TO RUNTIME");
|
||||
|
||||
// Clean current 'restapi_routes' if any
|
||||
MYSQL_QUERY(proxysql_admin, "DELETE FROM restapi_routes");
|
||||
|
||||
// Configure restapi_routes to be used
|
||||
string test_script_base_path { string { cl.workdir } + "reg_test_3838_scripts" };
|
||||
|
||||
vector<string> t_valid_scripts_inserts {
|
||||
"INSERT INTO restapi_routes (active, timeout_ms, method, uri, script, comment)"
|
||||
" VALUES (1,3000,'POST','simple_sleep','%s/simple_sleep.sh','simple_sleep_comment')",
|
||||
"INSERT INTO restapi_routes (active, timeout_ms, method, uri, script, comment)"
|
||||
" VALUES (1,3000,'POST','simple_sleep_timeout','%s/simple_sleep.sh','simple_sleep_to_comment')",
|
||||
};
|
||||
vector<string> valid_scripts_inserts {};
|
||||
|
||||
for (const auto& t_valid_script_insert : t_valid_scripts_inserts) {
|
||||
string valid_script_insert {};
|
||||
string_format(t_valid_script_insert, valid_script_insert, test_script_base_path.c_str());
|
||||
valid_scripts_inserts.push_back(valid_script_insert);
|
||||
}
|
||||
|
||||
// Configure routes for valid scripts
|
||||
for (const auto& valid_script_insert : valid_scripts_inserts) {
|
||||
MYSQL_QUERY(proxysql_admin, valid_script_insert.c_str());
|
||||
}
|
||||
|
||||
// Load RESTAPI
|
||||
MYSQL_QUERY(proxysql_admin, "LOAD RESTAPI TO RUNTIME");
|
||||
|
||||
// Sensible wait until the new configured enpoints are ready. Use the first enpoint for the check
|
||||
const auto& first_request_tuple { endpoint_requests.front() };
|
||||
const string full_endpoint {
|
||||
base_address + std::get<0>(first_request_tuple) + "/"
|
||||
};
|
||||
int endpoint_timeout = wait_until_enpoint_ready(full_endpoint, std::get<1>(first_request_tuple), 10, 500);
|
||||
|
||||
if (endpoint_timeout) {
|
||||
diag(
|
||||
"Timeout while trying to reach first valid enpoint. Test failed, skipping endpoint testing..."
|
||||
);
|
||||
goto skip_endpoints_testing;
|
||||
}
|
||||
|
||||
for (const auto& request : endpoint_requests) {
|
||||
const string endpoint { base_address + std::get<0>(request) + "/"};
|
||||
const string params { std::get<1>(request) };
|
||||
const long exp_rc = std::get<2>(request);
|
||||
const int signal = std::get<3>(request);
|
||||
const int exp_child_exit_st = std::get<4>(request);
|
||||
|
||||
string post_out_err { "" };
|
||||
uint64_t curl_res_code = 0;
|
||||
|
||||
CURLcode post_err = CURLE_HTTP_POST_ERROR;
|
||||
|
||||
// 1. Perform the POST operation
|
||||
std::thread post_op_th([&] () -> void {
|
||||
post_err = perform_simple_post(endpoint, params, curl_res_code, post_out_err);
|
||||
});
|
||||
|
||||
// 2. Find the child process
|
||||
string s_pid {};
|
||||
|
||||
int timeout = 1000;
|
||||
int waited = 0;
|
||||
int e_res= 0;
|
||||
|
||||
while (waited < timeout) {
|
||||
e_res = exec("ps aux | grep -e \"[/]bin/sh.*.simple_sleep.sh\" | awk '{print $2}'", s_pid);
|
||||
|
||||
if (e_res == 0 && s_pid.empty()) {
|
||||
usleep(200 * 1000);
|
||||
waited += 200;
|
||||
} else {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (e_res != EXIT_SUCCESS || s_pid.empty()) {
|
||||
if (e_res != EXIT_SUCCESS) {
|
||||
fprintf(stderr, "File %s, line %d, 'exec' failed with error: '%d'\n", __FILE__, __LINE__, e_res);
|
||||
} else {
|
||||
const string err_msg {"Invalid command executed or faulty test logic" };
|
||||
fprintf(stderr, "File %s, line %d, Error: '%s'\n", __FILE__, __LINE__, err_msg.c_str());
|
||||
}
|
||||
} else {
|
||||
// 3. Send multiple signals to the child process
|
||||
int pid = std::stol(s_pid);
|
||||
int k_res = 0;
|
||||
|
||||
if (signal == 18) {
|
||||
for (int i = 0; i < SIGNAL_NUM; i++) {
|
||||
k_res = kill(pid, 19);
|
||||
if (k_res != 0) { break; }
|
||||
|
||||
usleep(100*1000);
|
||||
|
||||
k_res = kill(pid, 18);
|
||||
if (k_res != 0) { break; }
|
||||
}
|
||||
} else {
|
||||
for (int i = 0; i < SIGNAL_NUM; i++) {
|
||||
k_res = kill(pid, signal);
|
||||
}
|
||||
}
|
||||
|
||||
if (k_res != 0) {
|
||||
fprintf(stderr, "File %s, line %d, 'kill' failed with error: '%d'\n", __FILE__, __LINE__, errno);
|
||||
}
|
||||
}
|
||||
|
||||
post_op_th.join();
|
||||
|
||||
try {
|
||||
int child_exit_st = 0;
|
||||
int signaled = 0;
|
||||
int exp_signaled = 0;
|
||||
|
||||
if (post_out_err.empty() == false) {
|
||||
nlohmann::json j_curl_err = nlohmann::json::parse(post_out_err);
|
||||
child_exit_st = std::stol(j_curl_err["error_code"].get<string>());
|
||||
}
|
||||
|
||||
// NOTE: This is pointless because the value doesn't change, but it's a demonstration on how to
|
||||
// recover child process exit statuses for debugging purposes.
|
||||
if (exp_child_exit_st == 15) {
|
||||
exp_signaled = 1;
|
||||
signaled = WIFSIGNALED(child_exit_st);
|
||||
child_exit_st = WTERMSIG(child_exit_st);
|
||||
}
|
||||
|
||||
bool ok_check =
|
||||
post_err == CURLE_OK && curl_res_code == exp_rc &&
|
||||
exp_signaled == signaled && exp_child_exit_st == child_exit_st;
|
||||
|
||||
ok(
|
||||
ok_check,
|
||||
"Performing a POST over endpoint '%s' should result into a '%ld' response:"
|
||||
" (curl_err: '%d', response_errcode: '%ld', signaled: '%d', child_exit_st: '%d', curlerr: '%s')",
|
||||
endpoint.c_str(), exp_rc, post_err, curl_res_code, signaled, child_exit_st, post_out_err.c_str()
|
||||
);
|
||||
} catch (const std::exception& ex) {
|
||||
diag("Invalid error kind returned by ProxySQL, JSON parsing failed with error: %s", ex.what());
|
||||
}
|
||||
}
|
||||
|
||||
skip_endpoints_testing:
|
||||
|
||||
mysql_close(proxysql_admin);
|
||||
|
||||
return exit_status();
|
||||
}
|
||||
@ -0,0 +1,10 @@
|
||||
#!/bin/sh
|
||||
|
||||
if [ ! "$1" ]; then
|
||||
echo { \"err\": \"Missing required operand\" }
|
||||
exit 1
|
||||
fi
|
||||
|
||||
sleep $1
|
||||
|
||||
echo { \"param\": $1 }
|
||||
Loading…
Reference in new issue