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
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <wayland-server-core.h>
#include "base/debug/crash_logging.h"
#include "base/environment.h"
#include "base/i18n/number_formatting.h"
#include "base/nix/xdg_util.h"
#include "base/strings/strcat.h"
#include "base/strings/utf_string_conversions.h"
#include "base/test/bind.h"
#include "components/crash/core/common/crash_key.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "ui/ozone/platform/wayland/test/mock_surface.h"
#include "ui/ozone/platform/wayland/test/test_wayland_server_thread.h"
#include "ui/ozone/platform/wayland/test/wayland_test.h"
using ::testing::Values;
namespace ui {
namespace {
std::string NumberToString(uint32_t number) {
return base::UTF16ToUTF8(base::FormatNumber(number));
}
} // namespace
// Tests that various types of critical errors result in correct crash keys.
//
// Posting the error terminates the client-server connection. Further attempts
// to sync will hang. That is why we run "bare" lambdas in all tests of this
// suite instead of using `PostToServerAndWait()`: that helper syncs the
// connection after running the server task. Due to the same reason we disable
// the sync on the test tear down. To ensure that the error message is caught
// by the crash reporter, we wait until idle in the end of each test before
// checking the crash key value.
class WaylandEventWatcherTest : public WaylandTestSimple {
protected:
void TearDown() override {
// All tests in this suite terminate the client-server connection by posting
// various errors. We cannot sync the connection on tear down.
DisableSyncOnTearDown();
WaylandTestSimple::TearDown();
}
};
TEST_F(WaylandEventWatcherTest, CrashKeyResourceError) {
const std::string kTestErrorString = "This is a nice error.";
std::string text;
auto callback = base::BindLambdaForTesting(
[&text](const std::string& data) { text = data; });
server_.RunAndWait(base::BindLambdaForTesting(
[&kTestErrorString, callback,
surface_id = window_->root_surface()->get_surface_id()](
wl::TestWaylandServerThread* server) {
auto* const xdg_surface = server->GetObject<wl::MockSurface>(surface_id)
->xdg_surface()
->resource();
// Prepare the expectation error string.
const std::string expected_error_code = base::StrCat(
{wl_resource_get_class(xdg_surface), "#",
NumberToString(wl_resource_get_id(xdg_surface)), ": error ",
NumberToString(
static_cast<uint32_t>(XDG_SURFACE_ERROR_UNCONFIGURED_BUFFER)),
": ", kTestErrorString});
callback.Run(expected_error_code);
wl_resource_post_error(xdg_surface,
XDG_SURFACE_ERROR_UNCONFIGURED_BUFFER, "%s",
kTestErrorString.c_str());
}));
base::RunLoop().RunUntilIdle();
EXPECT_EQ(text, crash_reporter::GetCrashKeyValue("wayland_error"));
}
TEST_F(WaylandEventWatcherTest, CrashKeyResourceNoMemory) {
// Prepare the expectation error string.
const std::string expected_error_code = base::StrCat(
{"wl_display#1: error ",
NumberToString(static_cast<uint32_t>(WL_DISPLAY_ERROR_NO_MEMORY)),
": no memory"});
server_.RunAndWait(base::BindLambdaForTesting(
[surface_id = window_->root_surface()->get_surface_id()](
wl::TestWaylandServerThread* server) {
auto* const xdg_surface = server->GetObject<wl::MockSurface>(surface_id)
->xdg_surface()
->resource();
wl_resource_post_no_memory(xdg_surface);
}));
base::RunLoop().RunUntilIdle();
EXPECT_EQ(expected_error_code,
crash_reporter::GetCrashKeyValue("wayland_error"));
}
TEST_F(WaylandEventWatcherTest, CrashKeyClientNoMemoryError) {
const std::string expected_error_code = base::StrCat(
{"wl_display#1: error ",
NumberToString(static_cast<uint32_t>(WL_DISPLAY_ERROR_NO_MEMORY)),
": no memory"});
server_.RunAndWait(
base::BindLambdaForTesting([](wl::TestWaylandServerThread* server) {
wl_client_post_no_memory(server->client());
}));
base::RunLoop().RunUntilIdle();
EXPECT_EQ(expected_error_code,
crash_reporter::GetCrashKeyValue("wayland_error"));
}
TEST_F(WaylandEventWatcherTest, CrashKeyClientImplementationError) {
const std::string kError = "A nice error.";
const std::string expected_error_code = base::StrCat(
{"wl_display#1: error ",
NumberToString(static_cast<uint32_t>(WL_DISPLAY_ERROR_IMPLEMENTATION)),
": ", kError});
server_.RunAndWait(base::BindLambdaForTesting(
[&kError](wl::TestWaylandServerThread* server) {
wl_client_post_implementation_error(server->client(), "%s",
kError.c_str());
}));
base::RunLoop().RunUntilIdle();
EXPECT_EQ(expected_error_code,
crash_reporter::GetCrashKeyValue("wayland_error"));
}
TEST_F(WaylandEventWatcherTest, CrashKeyCompositorNameSet) {
const std::string kTestWaylandCompositor = "OzoneWaylandTestCompositor";
base::Environment::Create()->SetVar(base::nix::kXdgCurrentDesktopEnvVar,
kTestWaylandCompositor);
server_.RunAndWait(
base::BindLambdaForTesting([](wl::TestWaylandServerThread* server) {
wl_client_post_implementation_error(server->client(), "%s",
"stub error");
}));
base::RunLoop().RunUntilIdle();
EXPECT_EQ(kTestWaylandCompositor,
crash_reporter::GetCrashKeyValue("wayland_compositor"));
}
TEST_F(WaylandEventWatcherTest, CrashKeyCompositorNameUnset) {
base::Environment::Create()->UnSetVar(base::nix::kXdgCurrentDesktopEnvVar);
server_.RunAndWait(
base::BindLambdaForTesting([](wl::TestWaylandServerThread* server) {
wl_client_post_implementation_error(server->client(), "%s",
"stub error");
}));
base::RunLoop().RunUntilIdle();
EXPECT_EQ("Unknown", crash_reporter::GetCrashKeyValue("wayland_compositor"));
}
} // namespace ui
|
