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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
content / browser / accessibility / scoped_accessibility_mode_browsertest.cc [blame]
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/public/browser/scoped_accessibility_mode.h"
#include <memory>
#include <utility>
#include "base/memory/raw_ptr.h"
#include "base/scoped_observation.h"
#include "content/public/browser/browser_accessibility_state.h"
#include "content/public/browser/web_contents.h"
#include "content/public/test/browser_test.h"
#include "content/public/test/content_browser_test.h"
#include "content/shell/browser/shell.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "ui/accessibility/ax_mode.h"
#include "ui/accessibility/ax_mode_observer.h"
#include "ui/accessibility/platform/ax_platform.h"
namespace content {
using ::testing::_;
namespace {
class MockAXModeObserver : public ui::AXModeObserver {
public:
MOCK_METHOD(void, OnAXModeAdded, (ui::AXMode mode), (override));
};
} // namespace
// A test for ScopedAccessibilityModes vended by BrowserAccessibilityState.
class ScopedAccessibilityModeTest : public ContentBrowserTest {
protected:
ScopedAccessibilityModeTest() = default;
void SetUpOnMainThread() override {
ContentBrowserTest::SetUpOnMainThread();
accessibility_state_ = BrowserAccessibilityState::GetInstance();
// Get the initial BrowserContext and WebContents created by
// ContentBrowserTest.
auto* const default_shell = shell();
browser_context1_ = default_shell->web_contents()->GetBrowserContext();
web_contents1_ = default_shell->web_contents();
// Create a second WebContents belonging to the initial BrowserContext.
web_contents2_ = CreateBrowser()->web_contents();
// Create a third WebContents belonging to a distinct BrowserContext.
web_contents3_ = CreateOffTheRecordBrowser()->web_contents();
browser_context2_ = web_contents3_->GetBrowserContext();
}
void TearDownOnMainThread() override {
// Forget about the WebContentses and BrowserContext -- ContentBrowserTest
// will clean them up.
web_contents3_ = nullptr;
browser_context2_ = nullptr;
web_contents2_ = nullptr;
web_contents1_ = nullptr;
browser_context1_ = nullptr;
accessibility_state_ = nullptr;
ContentBrowserTest::TearDownOnMainThread();
}
BrowserAccessibilityState& accessibility_state() {
return *accessibility_state_;
}
// The initial BrowserContext and its two WebContentses.
BrowserContext& browser_context1() { return *browser_context1_; }
WebContents& web_contents1() { return *web_contents1_; }
WebContents& web_contents2() { return *web_contents2_; }
// The second BrowserContext and its WebContents.
BrowserContext& browser_context2() { return *browser_context2_; }
WebContents& web_contents3() { return *web_contents3_; }
#if BUILDFLAG(IS_WIN)
static constexpr ui::AXMode kIgnoredModeFlags{ui::AXMode::kNativeAPIs};
#else
static constexpr ui::AXMode kIgnoredModeFlags{};
#endif
private:
raw_ptr<BrowserAccessibilityState> accessibility_state_ = nullptr;
raw_ptr<BrowserContext> browser_context1_ = nullptr;
raw_ptr<WebContents> web_contents1_ = nullptr;
raw_ptr<WebContents> web_contents2_ = nullptr;
raw_ptr<BrowserContext> browser_context2_ = nullptr;
raw_ptr<WebContents> web_contents3_ = nullptr;
};
// Matches `arg` if it equals `flags`, ignoring those in `ignored_flags`. This
// is required on Windows, where kNativeAPIs may be turned on when a window
// receives focus; see https://crbug.com/1447827.
MATCHER_P2(EqualsIgnoring, flags, ignored_flags, "") {
return (arg & ~ignored_flags) == (flags & ~ignored_flags);
}
// Verifies that all WebContentses in the process receive mode flags targeting
// the process.
IN_PROC_BROWSER_TEST_F(ScopedAccessibilityModeTest, Process) {
::testing::StrictMock<MockAXModeObserver> mock_observer;
base::ScopedObservation<ui::AXPlatform, ui::AXModeObserver> observation(
&mock_observer);
observation.Observe(&ui::AXPlatform::GetInstance());
// Accessibility is off to start with.
ASSERT_EQ(web_contents1().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
ASSERT_EQ(web_contents2().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
ASSERT_EQ(web_contents3().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
// Add the basic flags to the process and verify that observers were notified
// and that they were applied to all WebContentses.
EXPECT_CALL(mock_observer, OnAXModeAdded(EqualsIgnoring(ui::kAXModeBasic,
kIgnoredModeFlags)));
auto scoped_mode_1 =
accessibility_state().CreateScopedModeForProcess(ui::kAXModeBasic);
::testing::Mock::VerifyAndClearExpectations(&mock_observer);
EXPECT_EQ(web_contents1().GetAccessibilityMode(), ui::kAXModeBasic);
EXPECT_EQ(web_contents2().GetAccessibilityMode(), ui::kAXModeBasic);
EXPECT_EQ(web_contents3().GetAccessibilityMode(), ui::kAXModeBasic);
// Now add the complete flags and verify.
EXPECT_CALL(mock_observer, OnAXModeAdded(EqualsIgnoring(ui::kAXModeComplete,
ui::kAXModeBasic)));
auto scoped_mode_2 =
accessibility_state().CreateScopedModeForProcess(ui::kAXModeComplete);
::testing::Mock::VerifyAndClearExpectations(&mock_observer);
EXPECT_EQ(web_contents1().GetAccessibilityMode(), ui::kAXModeComplete);
EXPECT_EQ(web_contents2().GetAccessibilityMode(), ui::kAXModeComplete);
EXPECT_EQ(web_contents3().GetAccessibilityMode(), ui::kAXModeComplete);
// Release the basic flags and verify that complete still applies.
scoped_mode_1.reset();
::testing::Mock::VerifyAndClearExpectations(&mock_observer);
EXPECT_EQ(web_contents1().GetAccessibilityMode(), ui::kAXModeComplete);
EXPECT_EQ(web_contents2().GetAccessibilityMode(), ui::kAXModeComplete);
EXPECT_EQ(web_contents3().GetAccessibilityMode(), ui::kAXModeComplete);
// Release the complete flags and verify that all flags are cleared.
scoped_mode_2.reset();
::testing::Mock::VerifyAndClearExpectations(&mock_observer);
EXPECT_EQ(web_contents1().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
EXPECT_EQ(web_contents2().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
EXPECT_EQ(web_contents3().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
}
// Verifies that only WebContentses belonging to a specific BrowserContext
// receive mode flags targeting that BrowserContext.
IN_PROC_BROWSER_TEST_F(ScopedAccessibilityModeTest, BrowserContext) {
// Accessibility is off to start with.
ASSERT_EQ(web_contents1().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
ASSERT_EQ(web_contents2().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
ASSERT_EQ(web_contents3().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
ASSERT_EQ(accessibility_state().GetAccessibilityModeForBrowserContext(
&browser_context1()) &
~kIgnoredModeFlags,
ui::AXMode());
ASSERT_EQ(accessibility_state().GetAccessibilityModeForBrowserContext(
&browser_context2()) &
~kIgnoredModeFlags,
ui::AXMode());
// Add the basic flags to all WebContentses for the first BrowserContext and
// verify that they were applied only to its WebContentses.
auto scoped_mode_1 = accessibility_state().CreateScopedModeForBrowserContext(
&browser_context1(), ui::kAXModeBasic);
EXPECT_EQ(web_contents1().GetAccessibilityMode(), ui::kAXModeBasic);
EXPECT_EQ(web_contents2().GetAccessibilityMode(), ui::kAXModeBasic);
EXPECT_EQ(web_contents3().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
EXPECT_EQ(accessibility_state().GetAccessibilityModeForBrowserContext(
&browser_context1()),
ui::kAXModeBasic);
EXPECT_EQ(accessibility_state().GetAccessibilityModeForBrowserContext(
&browser_context2()) &
~kIgnoredModeFlags,
ui::AXMode());
// Now add the complete flags and verify that they were applied.
auto scoped_mode_2 = accessibility_state().CreateScopedModeForBrowserContext(
&browser_context1(), ui::kAXModeComplete);
EXPECT_EQ(web_contents1().GetAccessibilityMode(), ui::kAXModeComplete);
EXPECT_EQ(web_contents2().GetAccessibilityMode(), ui::kAXModeComplete);
EXPECT_EQ(web_contents3().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
EXPECT_EQ(accessibility_state().GetAccessibilityModeForBrowserContext(
&browser_context1()),
ui::kAXModeComplete);
EXPECT_EQ(accessibility_state().GetAccessibilityModeForBrowserContext(
&browser_context2()) &
~kIgnoredModeFlags,
ui::AXMode());
// Release the basic flags and verify that complete still applies.
scoped_mode_1.reset();
EXPECT_EQ(web_contents1().GetAccessibilityMode(), ui::kAXModeComplete);
EXPECT_EQ(web_contents2().GetAccessibilityMode(), ui::kAXModeComplete);
EXPECT_EQ(web_contents3().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
EXPECT_EQ(accessibility_state().GetAccessibilityModeForBrowserContext(
&browser_context1()),
ui::kAXModeComplete);
EXPECT_EQ(accessibility_state().GetAccessibilityModeForBrowserContext(
&browser_context2()) &
~kIgnoredModeFlags,
ui::AXMode());
// Release the complete flags and verify that all flags are cleared.
scoped_mode_2.reset();
EXPECT_EQ(web_contents1().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
EXPECT_EQ(web_contents2().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
EXPECT_EQ(web_contents3().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
EXPECT_EQ(accessibility_state().GetAccessibilityModeForBrowserContext(
&browser_context1()) &
~kIgnoredModeFlags,
ui::AXMode());
EXPECT_EQ(accessibility_state().GetAccessibilityModeForBrowserContext(
&browser_context2()) &
~kIgnoredModeFlags,
ui::AXMode());
}
// Verifies that only a targeted WebContentses receives mode flags.
IN_PROC_BROWSER_TEST_F(ScopedAccessibilityModeTest, WebContents) {
// Accessibility is off to start with.
ASSERT_EQ(web_contents1().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
ASSERT_EQ(web_contents2().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
ASSERT_EQ(web_contents3().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
// Add the basic flags to the WebContext and verify that they were applied.
auto scoped_mode_1 = accessibility_state().CreateScopedModeForWebContents(
&web_contents1(), ui::kAXModeBasic);
EXPECT_EQ(web_contents1().GetAccessibilityMode(), ui::kAXModeBasic);
EXPECT_EQ(web_contents2().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
EXPECT_EQ(web_contents3().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
// Now add the complete flags and verify that they were applied.
auto scoped_mode_2 = accessibility_state().CreateScopedModeForWebContents(
&web_contents1(), ui::kAXModeComplete);
EXPECT_EQ(web_contents1().GetAccessibilityMode(), ui::kAXModeComplete);
EXPECT_EQ(web_contents2().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
EXPECT_EQ(web_contents3().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
// Release the basic flags and verify that complete still applies.
scoped_mode_1.reset();
EXPECT_EQ(web_contents1().GetAccessibilityMode(), ui::kAXModeComplete);
EXPECT_EQ(web_contents2().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
EXPECT_EQ(web_contents3().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
// Release the complete flags and verify that all flags are cleared.
scoped_mode_2.reset();
ASSERT_EQ(web_contents1().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
EXPECT_EQ(web_contents2().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
EXPECT_EQ(web_contents3().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
}
// Verifies that filtering results in a WebContents receives various web flags
// only when web accessibility is enabled.
IN_PROC_BROWSER_TEST_F(ScopedAccessibilityModeTest, Filtering) {
// Accessibility is off to start with.
ASSERT_EQ(web_contents1().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
// Enable PDF OCR for the WebContents.
auto wc_mode = accessibility_state().CreateScopedModeForWebContents(
&web_contents1(), ui::AXMode::kPDFOcr);
// No change to the WebContents.
ASSERT_EQ(web_contents1().GetAccessibilityMode() & ~kIgnoredModeFlags,
ui::AXMode());
// Enable basic accessibility for the process.
auto process_mode =
accessibility_state().CreateScopedModeForProcess(ui::kAXModeBasic);
// Now the WebContents gets both.
ASSERT_EQ(web_contents1().GetAccessibilityMode() & ~kIgnoredModeFlags,
(ui::kAXModeBasic | ui::AXMode::kPDFOcr) & ~kIgnoredModeFlags);
// Add image labeling for the WebContents.
wc_mode = accessibility_state().CreateScopedModeForWebContents(
&web_contents1(), ui::AXMode::kPDFOcr | ui::AXMode::kLabelImages);
// The WebContents doesn't get kLabelImages until kScreenReader appears.
ASSERT_EQ(web_contents1().GetAccessibilityMode() & ~kIgnoredModeFlags,
(ui::kAXModeBasic | ui::AXMode::kPDFOcr) & ~kIgnoredModeFlags);
process_mode =
accessibility_state().CreateScopedModeForProcess(ui::kAXModeComplete);
ASSERT_EQ(
web_contents1().GetAccessibilityMode() & ~kIgnoredModeFlags,
(ui::kAXModeComplete | ui::AXMode::kPDFOcr | ui::AXMode::kLabelImages) &
~kIgnoredModeFlags);
}
} // namespace content