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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
// Copyright 2018 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <wayland-server.h>
#include <cstring>
#include <memory>
#include <string>
#include <vector>
#include "base/bind.h"
#include "base/containers/contains.h"
#include "base/containers/flat_set.h"
#include "base/location.h"
#include "base/strings/utf_string_conversions.h"
#include "base/test/mock_callback.h"
#include "base/threading/thread_task_runner_handle.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "ui/base/clipboard/clipboard_buffer.h"
#include "ui/base/clipboard/clipboard_constants.h"
#include "ui/events/base_event_utils.h"
#include "ui/ozone/platform/wayland/test/mock_surface.h"
#include "ui/ozone/platform/wayland/test/test_data_device.h"
#include "ui/ozone/platform/wayland/test/test_data_device_manager.h"
#include "ui/ozone/platform/wayland/test/test_data_offer.h"
#include "ui/ozone/platform/wayland/test/test_data_source.h"
#include "ui/ozone/platform/wayland/test/test_wayland_server_thread.h"
#include "ui/ozone/platform/wayland/test/wayland_test.h"
#include "ui/ozone/public/platform_clipboard.h"
using testing::_;
using testing::Mock;
using testing::Values;
namespace ui {
namespace {
constexpr char kSampleClipboardText[] = "This is a sample text for clipboard.";
template <typename StringType>
ui::PlatformClipboard::Data ToClipboardData(const StringType& data_string) {
std::vector<uint8_t> data_vector;
data_vector.assign(data_string.begin(), data_string.end());
return base::RefCountedBytes::TakeVector(&data_vector);
}
} // namespace
class WaylandClipboardTest : public WaylandTest {
public:
WaylandClipboardTest() = default;
void SetUp() override {
WaylandTest::SetUp();
Sync();
data_device_manager_ = server_.data_device_manager();
ASSERT_TRUE(data_device_manager_);
clipboard_ = connection_->clipboard();
ASSERT_TRUE(clipboard_);
offered_data_.clear();
}
protected:
// Fill the clipboard backing store with sample data.
void OfferData(ClipboardBuffer buffer,
const char* data,
const std::string& mime_type) {
std::vector<uint8_t> data_vector(data, data + std::strlen(data));
offered_data_[mime_type] = base::RefCountedBytes::TakeVector(&data_vector);
base::MockCallback<PlatformClipboard::OfferDataClosure> offer_callback;
EXPECT_CALL(offer_callback, Run()).Times(1);
clipboard_->OfferClipboardData(buffer, offered_data_, offer_callback.Get());
}
wl::TestDataDeviceManager* data_device_manager_;
PlatformClipboard* clipboard_;
PlatformClipboard::DataMap offered_data_;
private:
DISALLOW_COPY_AND_ASSIGN(WaylandClipboardTest);
};
TEST_P(WaylandClipboardTest, WriteToClipboard) {
// The client writes data to the clipboard ...
OfferData(ClipboardBuffer::kCopyPaste, kSampleClipboardText,
{kMimeTypeTextUtf8});
Sync();
// ... and the server reads it.
base::RunLoop run_loop;
auto callback = base::BindOnce(
[](base::RunLoop* loop, std::vector<uint8_t>&& data) {
std::string string_data(data.begin(), data.end());
EXPECT_EQ(kSampleClipboardText, string_data);
loop->Quit();
},
&run_loop);
data_device_manager_->data_source()->ReadData(kMimeTypeTextUtf8,
std::move(callback));
run_loop.Run();
}
TEST_P(WaylandClipboardTest, ReadFromClipboard) {
auto* data_offer = data_device_manager_->data_device()->OnDataOffer();
data_offer->OnOffer(kMimeTypeTextUtf8,
ToClipboardData(std::string(kSampleClipboardText)));
data_device_manager_->data_device()->OnSelection(data_offer);
Sync();
// The client requests to read the clipboard data from the server. The Server
// writes in some sample data, and we check it matches expectation.
base::RunLoop run_loop;
auto callback = base::BindOnce(
[](base::OnceClosure quit_closure, const PlatformClipboard::Data& data) {
ASSERT_TRUE(data.get());
std::string string_data(data->front_as<const char>(), data->size());
EXPECT_EQ(kSampleClipboardText, string_data);
std::move(quit_closure).Run();
},
run_loop.QuitClosure());
clipboard_->RequestClipboardData(ClipboardBuffer::kCopyPaste,
kMimeTypeTextUtf8, std::move(callback));
Sync();
run_loop.Run();
}
// Regression test for crbug.com/1183939. Ensures unicode mime types take
// priority over text/plain when reading text.
TEST_P(WaylandClipboardTest, ReadFromClipboardPrioritizeUtf) {
auto* data_offer = data_device_manager_->data_device()->OnDataOffer();
data_offer->OnOffer(kMimeTypeText,
ToClipboardData(std::string("ascii_text")));
data_offer->OnOffer(kMimeTypeTextUtf8,
ToClipboardData(std::string("utf8_text")));
data_device_manager_->data_device()->OnSelection(data_offer);
Sync();
base::RunLoop run_loop;
auto callback = base::BindOnce(
[](base::OnceClosure quit_closure, const PlatformClipboard::Data& data) {
std::string str(data->front_as<const char>(), data->size());
EXPECT_EQ("utf8_text", str);
std::move(quit_closure).Run();
},
run_loop.QuitClosure());
clipboard_->RequestClipboardData(ClipboardBuffer::kCopyPaste,
kMimeTypeTextUtf8, std::move(callback));
Sync();
run_loop.Run();
}
TEST_P(WaylandClipboardTest, ReadFromClipboardWithoutOffer) {
// When no data offer is advertised and client requests clipboard data
// from the server, the response callback should be gracefully called with
// null data.
auto callback = base::BindOnce(
[](const PlatformClipboard::Data& data) { ASSERT_FALSE(data); });
clipboard_->RequestClipboardData(ClipboardBuffer::kCopyPaste,
kMimeTypeTextUtf8, std::move(callback));
}
TEST_P(WaylandClipboardTest, IsSelectionOwner) {
OfferData(ClipboardBuffer::kCopyPaste, kSampleClipboardText,
{kMimeTypeTextUtf8});
Sync();
ASSERT_TRUE(clipboard_->IsSelectionOwner(ClipboardBuffer::kCopyPaste));
// The compositor sends OnCancelled whenever another application
// on the system sets a new selection. It means we are not the application
// that owns the current selection data.
data_device_manager_->data_source()->OnCancelled();
Sync();
ASSERT_FALSE(clipboard_->IsSelectionOwner(ClipboardBuffer::kCopyPaste));
}
// Ensures WaylandClipboard correctly handles overlapping read requests for
// different clipboard buffers.
TEST_P(WaylandClipboardTest, OverlapReadingFromDifferentBuffers) {
// Offer a piece of text in kCopyPaste clipboard buffer.
auto* data_offer = data_device_manager_->data_device()->OnDataOffer();
data_offer->OnOffer(kMimeTypeTextUtf8,
ToClipboardData(std::string(kSampleClipboardText)));
data_device_manager_->data_device()->OnSelection(data_offer);
Sync();
// Post a read request for kSelection buffer, which will start its execution
// after kCopyPaste request (below) starts.
base::MockCallback<PlatformClipboard::RequestDataClosure> selection_callback;
EXPECT_CALL(selection_callback, Run(_)).Times(1);
base::ThreadTaskRunnerHandle::Get()->PostTask(
FROM_HERE,
base::BindOnce(&PlatformClipboard::RequestClipboardData,
base::Unretained(clipboard_), ClipboardBuffer::kSelection,
kMimeTypeTextUtf8, selection_callback.Get()));
// Instantly start a clipboard read request for kCopyPaste buffer (the actual
// data transfer will take place asynchronously. See WaylandDataDevice impl)
// and ensure read callback is called with the expected resulting data,
// regardless any other request that may arrive in the meantime.
base::RunLoop run_loop;
clipboard_->RequestClipboardData(
ClipboardBuffer::kCopyPaste, kMimeTypeTextUtf8,
base::BindOnce(
[](base::OnceClosure quit_closure,
const PlatformClipboard::Data& data) {
ASSERT_TRUE(data.get());
EXPECT_EQ(kSampleClipboardText,
std::string(data->front_as<const char>(), data->size()));
std::move(quit_closure).Run();
},
run_loop.QuitClosure()));
Sync();
run_loop.Run();
Sync();
}
// Ensures clipboard change callback is fired only once per read/write.
TEST_P(WaylandClipboardTest, ClipboardChangeNotifications) {
base::MockCallback<PlatformClipboard::ClipboardDataChangedCallback>
clipboard_changed_callback;
clipboard_->SetClipboardDataChangedCallback(clipboard_changed_callback.Get());
const auto buffer = ClipboardBuffer::kCopyPaste;
// 1. For selection offered by an external application.
EXPECT_CALL(clipboard_changed_callback, Run(buffer)).Times(1);
auto* data_offer = data_device_manager_->data_device()->OnDataOffer();
data_offer->OnOffer(kMimeTypeTextUtf8,
ToClipboardData(std::string(kSampleClipboardText)));
data_device_manager_->data_device()->OnSelection(data_offer);
Sync();
EXPECT_FALSE(clipboard_->IsSelectionOwner(ClipboardBuffer::kCopyPaste));
// 2. For selection offered by Chromium.
EXPECT_CALL(clipboard_changed_callback, Run(buffer)).Times(1);
OfferData(buffer, kSampleClipboardText, {kMimeTypeTextUtf8});
Sync();
EXPECT_TRUE(clipboard_->IsSelectionOwner(buffer));
}
INSTANTIATE_TEST_SUITE_P(XdgVersionStableTest,
WaylandClipboardTest,
Values(wl::ServerConfig{
.shell_version = wl::ShellVersion::kStable}));
INSTANTIATE_TEST_SUITE_P(XdgVersionV6Test,
WaylandClipboardTest,
Values(wl::ServerConfig{
.shell_version = wl::ShellVersion::kV6}));
} // namespace ui
|
