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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
/*
* Copyright © 2015-2016 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 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/>.
*
* Authored by: Christopher James Halse Rogers <christopher.halse.rogers@canonical.com>
* Brandon Schaefer <brandon.schaefer@canonical.com>
*/
#include "mir/input/input_device_info.h"
#include "mir_test_framework/fake_input_device.h"
#include "mir_test_framework/stub_server_platform_factory.h"
#include "mir_test_framework/connected_client_with_a_surface.h"
#include "mir/test/spin_wait.h"
#include "mir/test/signal.h"
#include "mir/cookie/authority.h"
#include "mir_test_framework/visible_surface.h"
#include "boost/throw_exception.hpp"
#include <linux/input.h>
#include <mutex>
namespace mtf = mir_test_framework;
namespace mt = mir::test;
namespace mi = mir::input;
namespace mis = mir::input::synthesis;
namespace
{
std::chrono::seconds const max_wait{4};
void cookie_capturing_callback(MirSurface*, MirEvent const* ev, void* ctx);
}
class ClientCookies : public mtf::ConnectedClientHeadlessServer
{
public:
ClientCookies()
{
server.override_the_cookie_authority([this] ()
{ return mir::cookie::Authority::create_saving(cookie_secret); });
}
void SetUp() override
{
mtf::ConnectedClientHeadlessServer::SetUp();
// Need fullscreen for the cursor events
auto const spec = mir_connection_create_spec_for_normal_surface(
connection, 100, 100, mir_pixel_format_abgr_8888);
mir_surface_spec_set_fullscreen_on_output(spec, 1);
mir_surface_spec_set_event_handler(spec, &cookie_capturing_callback, this);
surface = mir_surface_create_sync(spec);
mir_surface_spec_release(spec);
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
mir_buffer_stream_swap_buffers_sync(mir_surface_get_buffer_stream(surface));
#pragma GCC diagnostic pop
ready_to_accept_events.wait_for(max_wait);
if (!ready_to_accept_events.raised())
BOOST_THROW_EXCEPTION(std::runtime_error("Timeout waiting for surface to become focused and exposed"));
}
std::unique_ptr<mtf::FakeInputDevice> fake_keyboard{
mtf::add_fake_input_device(mi::InputDeviceInfo{"keyboard", "keyboard-uid" , mi::DeviceCapability::keyboard})
};
std::unique_ptr<mtf::FakeInputDevice> fake_pointer{
mtf::add_fake_input_device(mi::InputDeviceInfo{"mouse", "mouse-uid" , mi::DeviceCapability::pointer})
};
std::unique_ptr<mtf::FakeInputDevice> fake_touch_screen{
mtf::add_fake_input_device(mi::InputDeviceInfo{
"touch screen", "touch-screen-uid", mi::DeviceCapability::touchscreen | mi::DeviceCapability::multitouch})
};
mir::test::Signal ready_to_accept_events;
std::vector<std::vector<uint8_t>> out_cookies;
std::vector<uint8_t> cookie_secret;
size_t event_count{0};
mutable std::mutex mutex;
bool exposed{false};
bool focused{false};
MirSurface* surface;
};
namespace
{
void cookie_capturing_callback(MirSurface*, MirEvent const* ev, void* ctx)
{
auto const event_type = mir_event_get_type(ev);
auto client_cookie = static_cast<ClientCookies*>(ctx);
if (event_type == mir_event_type_surface)
{
auto event = mir_event_get_surface_event(ev);
auto const attrib = mir_surface_event_get_attribute(event);
auto const value = mir_surface_event_get_attribute_value(event);
std::lock_guard<std::mutex> lk(client_cookie->mutex);
if (attrib == mir_surface_attrib_visibility &&
value == mir_surface_visibility_exposed)
{
client_cookie->exposed = true;
}
if (attrib == mir_surface_attrib_focus &&
value == mir_surface_focused)
{
client_cookie->focused = true;
}
if (client_cookie->exposed && client_cookie->focused)
client_cookie->ready_to_accept_events.raise();
}
else if (event_type == mir_event_type_input)
{
auto const* iev = mir_event_get_input_event(ev);
std::lock_guard<std::mutex> lk(client_cookie->mutex);
if (mir_input_event_has_cookie(iev))
{
auto cookie = mir_input_event_get_cookie(iev);
size_t size = mir_cookie_buffer_size(cookie);
std::vector<uint8_t> cookie_bytes(size);
mir_cookie_to_buffer(cookie, cookie_bytes.data(), size);
mir_cookie_release(cookie);
client_cookie->out_cookies.push_back(cookie_bytes);
}
client_cookie->event_count++;
}
}
bool wait_for_n_events(size_t n, ClientCookies* client_cookie)
{
bool all_events = mt::spin_wait_for_condition_or_timeout(
[&n, &client_cookie]
{
std::lock_guard<std::mutex> lk(client_cookie->mutex);
return client_cookie->event_count >= n;
},
std::chrono::seconds{max_wait});
EXPECT_TRUE(all_events);
return all_events;
}
}
TEST_F(ClientCookies, keyboard_events_have_cookies)
{
fake_keyboard->emit_event(mis::a_key_down_event().of_scancode(KEY_M));
int events = 1;
if (wait_for_n_events(events, this))
{
std::lock_guard<std::mutex> lk(mutex);
ASSERT_FALSE(out_cookies.empty());
auto authority = mir::cookie::Authority::create_from(cookie_secret);
EXPECT_NO_THROW(authority->make_cookie(out_cookies.back()));
}
}
TEST_F(ClientCookies, pointer_motion_events_do_not_have_cookies)
{
fake_pointer->emit_event(mis::a_pointer_event().with_movement(1, 1));
size_t events = 1;
if (wait_for_n_events(events, this))
{
std::lock_guard<std::mutex> lk(mutex);
EXPECT_EQ(event_count, events);
EXPECT_TRUE(out_cookies.empty());
}
}
TEST_F(ClientCookies, pointer_click_events_have_cookies)
{
fake_pointer->emit_event(mis::a_button_down_event().of_button(BTN_LEFT).with_action(mis::EventAction::Down));
fake_pointer->emit_event(mis::a_button_up_event().of_button(BTN_LEFT));
int events = 2;
if (wait_for_n_events(events, this))
{
std::lock_guard<std::mutex> lk(mutex);
ASSERT_FALSE(out_cookies.empty());
auto authority = mir::cookie::Authority::create_from(cookie_secret);
EXPECT_NO_THROW(authority->make_cookie(out_cookies.back()));
}
}
TEST_F(ClientCookies, touch_motion_events_do_not_have_cookies)
{
fake_touch_screen->emit_event(
mis::a_touch_event()
.at_position({0, 0})
);
fake_touch_screen->emit_event(
mis::a_touch_event()
.with_action(mis::TouchParameters::Action::Move)
.at_position({1, 1})
);
size_t events = 1;
if (wait_for_n_events(events, this))
{
std::lock_guard<std::mutex> lk(mutex);
EXPECT_GE(event_count, events);
EXPECT_EQ(out_cookies.size(), 1u);
}
}
|