1/*
2 * Copyright 2013 The Chromium Authors. All rights reserved.
3 * Use of this source code is governed by a BSD-style license that can be
4 * found in the LICENSE file.
5 */
6#include "chrome/browser/chromeos/extensions/virtual_keyboard_browsertest.h"
7
8#include <vector>
9
10#include "ash/shell.h"
11#include "base/command_line.h"
12#include "chrome/browser/ui/browser.h"
13#include "chrome/browser/ui/tabs/tab_strip_model.h"
14#include "chrome/test/base/in_process_browser_test.h"
15#include "chrome/test/base/ui_test_utils.h"
16#include "content/public/browser/render_view_host.h"
17#include "content/public/browser/render_widget_host_iterator.h"
18#include "content/public/browser/site_instance.h"
19#include "content/public/browser/web_contents.h"
20#include "content/public/test/browser_test_utils.h"
21#include "extensions/common/extension.h"
22#include "ui/aura/client/aura_constants.h"
23#include "ui/base/ime/input_method.h"
24#include "ui/keyboard/keyboard_controller.h"
25#include "ui/keyboard/keyboard_switches.h"
26
27namespace {
28const base::FilePath::CharType kWebuiTestDir[] = FILE_PATH_LITERAL("webui");
29
30const base::FilePath::CharType kMockController[] =
31    FILE_PATH_LITERAL("mock_controller.js");
32
33const base::FilePath::CharType kMockTimer[] =
34    FILE_PATH_LITERAL("mock_timer.js");
35
36const char kVirtualKeyboardTestDir[] = "chromeos/virtual_keyboard";
37
38const char kBaseKeyboardTestFramework[] = "virtual_keyboard_test_base.js";
39
40const char kExtensionId[] = "mppnpdlheglhdfmldimlhpnegondlapf";
41
42const char kVirtualKeyboardURL[] = "chrome://keyboard";
43
44}  // namespace
45
46VirtualKeyboardBrowserTestConfig::VirtualKeyboardBrowserTestConfig()
47    : base_framework_(kBaseKeyboardTestFramework),
48      extension_id_(kExtensionId),
49      test_dir_(kVirtualKeyboardTestDir),
50      url_(kVirtualKeyboardURL) {
51}
52
53VirtualKeyboardBrowserTestConfig::~VirtualKeyboardBrowserTestConfig() {};
54
55void VirtualKeyboardBrowserTest::SetUpCommandLine(CommandLine* command_line) {
56  command_line->AppendSwitch(keyboard::switches::kEnableVirtualKeyboard);
57}
58
59void VirtualKeyboardBrowserTest::RunTest(
60    const base::FilePath& file,
61    const VirtualKeyboardBrowserTestConfig& config) {
62  ui_test_utils::NavigateToURL(browser(), GURL(config.url_));
63  content::WebContents* web_contents =
64      browser()->tab_strip_model()->GetActiveWebContents();
65  content::WaitForLoadStop(web_contents);
66  ASSERT_TRUE(web_contents);
67
68  // Inject testing scripts.
69  InjectJavascript(base::FilePath(kWebuiTestDir),
70                   base::FilePath(kMockController));
71  InjectJavascript(base::FilePath(kWebuiTestDir), base::FilePath(kMockTimer));
72  InjectJavascript(base::FilePath(FILE_PATH_LITERAL(config.test_dir_)),
73                   base::FilePath(FILE_PATH_LITERAL(config.base_framework_)));
74  InjectJavascript(base::FilePath(FILE_PATH_LITERAL(config.test_dir_)), file);
75
76  ASSERT_TRUE(content::ExecuteScript(web_contents, utf8_content_));
77
78  // Inject DOM-automation test harness and run tests.
79  std::vector<int> resource_ids;
80  EXPECT_TRUE(ExecuteWebUIResourceTest(web_contents, resource_ids));
81}
82
83void VirtualKeyboardBrowserTest::ShowVirtualKeyboard() {
84  aura::Window* window = ash::Shell::GetPrimaryRootWindow();
85  ui::InputMethod* input_method =
86      window->GetProperty(aura::client::kRootWindowInputMethodKey);
87  ASSERT_TRUE(input_method);
88  input_method->ShowImeIfNeeded();
89}
90
91content::RenderViewHost* VirtualKeyboardBrowserTest::GetKeyboardRenderViewHost(
92    const std::string& id) {
93  ShowVirtualKeyboard();
94  GURL url = extensions::Extension::GetBaseURLFromExtensionId(id);
95  scoped_ptr<content::RenderWidgetHostIterator> widgets(
96      content::RenderWidgetHost::GetRenderWidgetHosts());
97  while (content::RenderWidgetHost* widget = widgets->GetNextHost()) {
98    if (widget->IsRenderView()) {
99      content::RenderViewHost* view = content::RenderViewHost::From(widget);
100      if (url == view->GetSiteInstance()->GetSiteURL()) {
101        content::WebContents* wc =
102            content::WebContents::FromRenderViewHost(view);
103        // Waits for Polymer to load.
104        content::WaitForLoadStop(wc);
105        return view;
106      }
107    }
108  }
109  LOG(ERROR) << "Extension not found:" << url;
110  return NULL;
111}
112
113void VirtualKeyboardBrowserTest::InjectJavascript(const base::FilePath& dir,
114                                                  const base::FilePath& file) {
115  base::FilePath path = ui_test_utils::GetTestFilePath(dir, file);
116  std::string library_content;
117  ASSERT_TRUE(base::ReadFileToString(path, &library_content)) << path.value();
118  utf8_content_.append(library_content);
119  utf8_content_.append(";\n");
120}
121
122// crbug.com/367817. Either this feature or just the test are depending
123// on the presense of Object.observe which is presently disabled by default.
124IN_PROC_BROWSER_TEST_F(VirtualKeyboardBrowserTest, DISABLED_AttributesTest) {
125  RunTest(base::FilePath(FILE_PATH_LITERAL("attributes_test.js")),
126          VirtualKeyboardBrowserTestConfig());
127}
128
129IN_PROC_BROWSER_TEST_F(VirtualKeyboardBrowserTest, TypingTest) {
130  RunTest(base::FilePath(FILE_PATH_LITERAL("typing_test.js")),
131          VirtualKeyboardBrowserTestConfig());
132}
133
134IN_PROC_BROWSER_TEST_F(VirtualKeyboardBrowserTest, ControlKeysTest) {
135  RunTest(base::FilePath(FILE_PATH_LITERAL("control_keys_test.js")),
136          VirtualKeyboardBrowserTestConfig());
137}
138
139IN_PROC_BROWSER_TEST_F(VirtualKeyboardBrowserTest, HideKeyboardKeyTest) {
140  RunTest(base::FilePath(FILE_PATH_LITERAL("hide_keyboard_key_test.js")),
141          VirtualKeyboardBrowserTestConfig());
142}
143
144IN_PROC_BROWSER_TEST_F(VirtualKeyboardBrowserTest, KeysetTransitionTest) {
145  RunTest(base::FilePath(FILE_PATH_LITERAL("keyset_transition_test.js")),
146          VirtualKeyboardBrowserTestConfig());
147}
148
149// Fails when enabling Object.observe. See http://crbug.com/370004
150#if defined(OS_CHROMEOS)
151#define MAYBE_IsKeyboardLoaded DISABLED_IsKeyboardLoaded
152#else
153#define MAYBE_IsKeyboardLoaded IsKeyboardLoaded
154#endif
155IN_PROC_BROWSER_TEST_F(VirtualKeyboardBrowserTest, MAYBE_IsKeyboardLoaded) {
156  content::RenderViewHost* keyboard_rvh =
157      GetKeyboardRenderViewHost(kExtensionId);
158  ASSERT_TRUE(keyboard_rvh);
159  bool loaded = false;
160  std::string script = "!!chrome.virtualKeyboardPrivate";
161  EXPECT_TRUE(content::ExecuteScriptAndExtractBool(
162      keyboard_rvh,
163      "window.domAutomationController.send(" + script + ");",
164      &loaded));
165  // Catches the regression in crbug.com/308653.
166  ASSERT_TRUE(loaded);
167}
168
169IN_PROC_BROWSER_TEST_F(VirtualKeyboardBrowserTest, DISABLED_EndToEndTest) {
170  // Get the virtual keyboard's render view host.
171  content::RenderViewHost* keyboard_rvh =
172      GetKeyboardRenderViewHost(kExtensionId);
173  ASSERT_TRUE(keyboard_rvh);
174
175  // Get the test page's render view host.
176  content::RenderViewHost* browser_rvh = browser()->tab_strip_model()->
177      GetActiveWebContents()->GetRenderViewHost();
178  ASSERT_TRUE(browser_rvh);
179
180  // Set up the test page.
181  GURL url = ui_test_utils::GetTestUrl(
182      base::FilePath(),
183      base::FilePath(FILE_PATH_LITERAL(
184          "chromeos/virtual_keyboard/end_to_end_test.html")));
185  ui_test_utils::NavigateToURL(browser(), url);
186
187  // Press 'a' on keyboard.
188  base::FilePath path = ui_test_utils::GetTestFilePath(
189      base::FilePath(FILE_PATH_LITERAL(kVirtualKeyboardTestDir)),
190      base::FilePath(FILE_PATH_LITERAL("end_to_end_test.js")));
191  std::string script;
192  ASSERT_TRUE(base::ReadFileToString(path, &script));
193  EXPECT_TRUE(content::ExecuteScript(keyboard_rvh, script));
194  // Verify 'a' appeared on test page.
195  bool success = false;
196  EXPECT_TRUE(content::ExecuteScriptAndExtractBool(
197      browser_rvh,
198      "success ? verifyInput('a') : waitForInput('a');",
199      &success));
200  ASSERT_TRUE(success);
201}
202
203// TODO(kevers|rsadam|bshe):  Add UI tests for remaining virtual keyboard
204// functionality.
205