1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/*
* Copyright © Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 or 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "server_example_test_client.h"
#include "mir/fd.h"
#include "mir/server.h"
#include "mir/main_loop.h"
#include "mir/logging/logger.h"
#include "mir/log.h"
#include "mir/options/option.h"
#include <chrono>
#include <future>
#include <sys/wait.h>
namespace me = mir::examples;
namespace ml = mir::logging;
using namespace std::chrono_literals;
namespace
{
static auto const component = "server_example_test_client.cpp";
struct Self
{
std::unique_ptr<mir::time::Alarm> server_stop_action;
std::atomic<bool> test_failed;
};
void check_exit_status(pid_t pid, mir::Server& server, Self* self, int& countdown)
{
countdown--;
int status;
auto const wait_rc = waitpid(pid, &status, WNOHANG);
if (wait_rc == 0)
{
if (countdown > 0)
{
self->server_stop_action->reschedule_in(100ms);
return;
}
else
{
ml::log(ml::Severity::warning, "Client has not exited: Terminating client", component);
kill(pid, SIGKILL);
self->test_failed = true;
}
}
else if (wait_rc != pid)
{
ml::log(ml::Severity::informational, "No status available for client", component);
self->test_failed = true;
}
else if (WIFEXITED(status))
{
auto const exit_status = WEXITSTATUS(status);
if (exit_status == EXIT_SUCCESS)
{
ml::log(ml::Severity::informational, "Client exited successfully", component);
self->test_failed = false;
}
else
{
char const format[] = "Client has exited with status %d";
char buffer[sizeof format + 10];
snprintf(buffer, sizeof buffer, format, exit_status);
ml::log(ml::Severity::informational, buffer, component);
self->test_failed = true;
}
}
else if (WIFSIGNALED(status))
{
auto const signal = WTERMSIG(status);
char const format[] = "Client terminated by signal %d";
char buffer[sizeof format];
snprintf(buffer, sizeof buffer, format, signal);
ml::log(ml::Severity::informational, buffer, component);
self->test_failed = true;
}
else
{
ml::log(ml::Severity::informational, "Client died mysteriously", component);
self->test_failed = true;
}
server.stop();
}
}
struct me::TestClientRunner::Self : ::Self
{
std::unique_ptr<time::Alarm> client_kill_action;
};
me::TestClientRunner::TestClientRunner() : self{std::make_shared<Self>()} {}
void me::TestClientRunner::operator()(mir::Server& server)
{
static const char* const test_client_opt = "test-client";
static const char* const test_client_descr = "client executable";
static const char* const test_timeout_opt = "test-timeout";
static const char* const test_timeout_descr = "Seconds to run before sending SIGTERM to client";
server.add_configuration_option(test_client_opt, test_client_descr, OptionType::string);
server.add_configuration_option(test_timeout_opt, test_timeout_descr, 10);
server.add_init_callback([&server, self = self]
{
const auto options1 = server.get_options();
if (options1->is_set(test_client_opt))
{
self->test_failed = true;
auto const pid = fork();
if (pid == 0)
{
// Enable tests with toolkits supporting Wayland
auto const wayland_display = server.wayland_display();
setenv("WAYLAND_DISPLAY", wayland_display.value().c_str(), true); // configure Wayland socket
setenv("GDK_BACKEND", "wayland", true); // configure GTK to use Wayland
setenv("QT_QPA_PLATFORM", "wayland", true); // configure Qt to use Wayland
unsetenv("QT_QPA_PLATFORMTHEME"); // Discourage Qt from unsupported theme
setenv("SDL_VIDEODRIVER", "wayland", true); // configure SDL to use Wayland
auto const client = options1->get<std::string>(test_client_opt);
log(logging::Severity::informational, "mir::examples", "Starting test client: %s", client.c_str());
execlp(client.c_str(), client.c_str(), static_cast<char const*>(nullptr));
// If execl() returns then something is badly wrong
log(logging::Severity::critical, "mir::examples",
"Failed to execute client (%s) error: %s", client.c_str(), strerror(errno));
abort();
}
else if (pid > 0)
{
self->client_kill_action = server.the_main_loop()->create_alarm(
[pid, self]
{
kill(pid, SIGTERM);
self->server_stop_action->reschedule_in(100ms);
});
self->server_stop_action = server.the_main_loop()->create_alarm(
[pid, &server, self, countdown = 200]() mutable
{
check_exit_status(pid, server, self.get(), countdown);
});
self->client_kill_action->reschedule_in(std::chrono::seconds(options1->get<int>(test_timeout_opt)));
}
else
{
BOOST_THROW_EXCEPTION(std::runtime_error("Client failed to launch"));
}
}
else
{
self->test_failed = false;
}
});
}
bool me::TestClientRunner::test_failed() const { return self->test_failed; }
|
