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
|
// Copyright 2017 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 "ash/accelerators/accelerator_table.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/browser/ui/tabs/tab_strip_model.h"
#include "chrome/common/url_constants.h"
#include "chrome/test/base/in_process_browser_test.h"
#include "chrome/test/base/ui_test_utils.h"
#include "content/public/browser/web_contents.h"
#include "content/public/browser/web_ui_message_handler.h"
#include "content/public/test/browser_test_utils.h"
#include "ui/events/keycodes/keyboard_code_conversion.h"
namespace {
class TestWebUIMessageHandler : public content::WebUIMessageHandler {
public:
TestWebUIMessageHandler() = default;
~TestWebUIMessageHandler() override = default;
// content::WebUIMessageHandler:
void RegisterMessages() override {
web_ui()->RegisterMessageCallback(
"didPaint", base::Bind(&TestWebUIMessageHandler::HandleDidPaint,
base::Unretained(this)));
}
private:
void HandleDidPaint(const base::ListValue*) {}
DISALLOW_COPY_AND_ASSIGN(TestWebUIMessageHandler);
};
content::WebContents* StartKeyboardOverlayUI(Browser* browser) {
ui_test_utils::NavigateToURL(browser,
GURL(chrome::kChromeUIKeyboardOverlayURL));
content::WebContents* web_contents =
browser->tab_strip_model()->GetActiveWebContents();
web_contents->GetWebUI()->AddMessageHandler(
base::MakeUnique<TestWebUIMessageHandler>());
return web_contents;
}
bool IsDisplayUIScalingEnabled(content::WebContents* web_contents) {
bool is_display_ui_scaling_enabled;
EXPECT_TRUE(content::ExecuteScriptAndExtractBool(
web_contents,
"domAutomationController.send(isDisplayUIScalingEnabled());",
&is_display_ui_scaling_enabled));
return is_display_ui_scaling_enabled;
}
// Skip some accelerators in the tests:
// 1. If the accelerator has no modifier, i.e. ui::EF_NONE, or for "Caps
// Lock", such as ui::VKEY_MENU and ui::VKEY_LWIN, the logic to show it on
// the keyboard overlay is not by the mapping of
// keyboardOverlayData['shortcut'], so it can not be tested by this test.
// 2. If it has debug modifiers: ui::EF_CONTROL_DOWN | ui::EF_ALT_DOWN |
// ui::EF_SHIFT_DOWN
bool ShouldSkip(const ash::AcceleratorData& accelerator) {
return accelerator.keycode == ui::VKEY_MENU ||
accelerator.keycode == ui::VKEY_LWIN ||
accelerator.modifiers == ui::EF_NONE ||
accelerator.modifiers ==
(ui::EF_CONTROL_DOWN | ui::EF_ALT_DOWN | ui::EF_SHIFT_DOWN);
}
std::string KeyboardCodeToLabel(const ash::AcceleratorData& accelerator,
content::WebContents* web_contents) {
std::string label;
EXPECT_TRUE(content::ExecuteScriptAndExtractString(
web_contents,
"domAutomationController.send("
" (function(number) {"
" if (!!KEYCODE_TO_LABEL[number]) {"
" return KEYCODE_TO_LABEL[number];"
" } else {"
" return 'NONE';"
" }"
" })(" +
std::to_string(static_cast<unsigned int>(accelerator.keycode)) +
" )"
");",
&label));
if (label == "NONE") {
label = base::ToLowerASCII(static_cast<char>(
LocatedToNonLocatedKeyboardCode(accelerator.keycode)));
}
return label;
}
std::string GenerateShortcutKey(const ash::AcceleratorData& accelerator,
content::WebContents* web_contents) {
std::string shortcut = KeyboardCodeToLabel(accelerator, web_contents);
// The order of the "if" conditions should not be changed because the
// modifiers are expected to be alphabetical sorted in the generated
// shortcut.
if (accelerator.modifiers & ui::EF_ALT_DOWN)
shortcut.append("<>ALT");
if (accelerator.modifiers & ui::EF_CONTROL_DOWN)
shortcut.append("<>CTRL");
if (accelerator.modifiers & ui::EF_COMMAND_DOWN)
shortcut.append("<>SEARCH");
if (accelerator.modifiers & ui::EF_SHIFT_DOWN)
shortcut.append("<>SHIFT");
return shortcut;
}
bool ContainsShortcut(const std::string& shortcut,
content::WebContents* web_contents) {
bool contains;
EXPECT_TRUE(content::ExecuteScriptAndExtractBool(
web_contents,
"domAutomationController.send("
" !!keyboardOverlayData['shortcut']['" + shortcut + "']"
");",
&contains));
return contains;
}
} // namespace
using KeyboardOverlayUIBrowserTest = InProcessBrowserTest;
IN_PROC_BROWSER_TEST_F(KeyboardOverlayUIBrowserTest,
AcceleratorsShouldHaveKeyboardOverlay) {
content::WebContents* const web_contents = StartKeyboardOverlayUI(browser());
const bool is_display_ui_scaling_enabled =
IsDisplayUIScalingEnabled(web_contents);
for (size_t i = 0; i < ash::kAcceleratorDataLength; ++i) {
const ash::AcceleratorData& entry = ash::kAcceleratorData[i];
if (ShouldSkip(entry))
continue;
const std::string shortcut = GenerateShortcutKey(entry, web_contents);
if (!is_display_ui_scaling_enabled) {
if (shortcut == "-<>CTRL<>SHIFT" || shortcut == "+<>CTRL<>SHIFT" ||
shortcut == "0<>CTRL<>SHIFT") {
continue;
}
}
EXPECT_TRUE(ContainsShortcut(shortcut, web_contents))
<< "Please add the new accelerators to keyboard "
"overlay. Add one entry '" +
shortcut +
"' in the 'shortcut' section"
" at the bottom of the file of "
"'/chrome/browser/resources/chromeos/"
"keyboard_overlay_data.js'. Please keep it in "
"alphabetical order.";
}
}
IN_PROC_BROWSER_TEST_F(KeyboardOverlayUIBrowserTest,
DeprecatedAcceleratorsShouldNotHaveKeyboardOverlay) {
content::WebContents* const web_contents = StartKeyboardOverlayUI(browser());
for (size_t i = 0; i < ash::kDeprecatedAcceleratorsLength; ++i) {
const ash::AcceleratorData& entry = ash::kDeprecatedAccelerators[i];
if (ShouldSkip(entry))
continue;
const std::string shortcut = GenerateShortcutKey(entry, web_contents);
EXPECT_FALSE(ContainsShortcut(shortcut, web_contents))
<< "Please remove the deprecated accelerator '" + shortcut +
"' from the 'shortcut' section"
" at the bottom of the file of "
"'/chrome/browser/resources/chromeos/"
"keyboard_overlay_data.js'.";
}
}
|
