Adds browser test framework for the IME keyboard, and some basic typing tests.

chrome/browser/chromeos/extensions/virtual_keyboard_browsertest.cc

 /*
  * Copyright 2013 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 "chrome/browser/chromeos/extensions/virtual_keyboard_browsertest.h"
 
 #include <vector>
 
 #include "ash/shell.h"
 #include "base/command_line.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/tabs/tab_strip_model.h"
 #include "chrome/test/base/in_process_browser_test.h"
 #include "chrome/test/base/ui_test_utils.h"
 #include "content/public/browser/render_view_host.h"
 #include "content/public/browser/render_widget_host_iterator.h"
 #include "content/public/browser/site_instance.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/test/browser_test_utils.h"
 #include "ui/aura/client/aura_constants.h"
 #include "ui/base/ime/input_method.h"
 #include "ui/keyboard/keyboard_controller.h"
 #include "ui/keyboard/keyboard_switches.h"
 
 namespace {
+const base::FilePath::CharType kWebuiTestDir[] = FILE_PATH_LITERAL("webui");
 
-const base::FilePath kWebuiTestDir =
-    base::FilePath(FILE_PATH_LITERAL("webui"));
+const base::FilePath::CharType kMockController[] =
+    FILE_PATH_LITERAL("mock_controller.js");
 
-const base::FilePath kVirtualKeyboardTestDir =
-    base::FilePath(FILE_PATH_LITERAL("chromeos/virtual_keyboard"));
+const base::FilePath::CharType kMockTimer[] =
+    FILE_PATH_LITERAL("mock_timer.js");
 
-const base::FilePath kMockController =
-    base::FilePath(FILE_PATH_LITERAL("mock_controller.js"));
+const std::string kVirtualKeyboardTestDir = "chromeos/virtual_keyboard";
 
-const base::FilePath kMockTimer =
-    base::FilePath(FILE_PATH_LITERAL("mock_timer.js"));
+const std::string kBaseKeyboardTestFramework = "virtual_keyboard_test_base.js";
 
-const base::FilePath kBaseKeyboardTestFramework =
-    base::FilePath(FILE_PATH_LITERAL("virtual_keyboard_test_base.js"));
+const std::string kExtensionId = "mppnpdlheglhdfmldimlhpnegondlapf";
+
+const std::string kVirtualKeyboardURL = "chrome://keyboard";
 
 }  // namespace
 
-class VirtualKeyboardBrowserTest : public InProcessBrowserTest {
- public:
+VirtualKeyboardBrowserTestHelper::VirtualKeyboardBrowserTestHelper()

[Jeffrey Yasskin, 2014/05/02 22:09:37]

The header file should mention the default values, or maybe say "see the .cc for
default values".

[rsadam, 2014/05/05 17:44:42]

Done.

+    : base_framework_(kBaseKeyboardTestFramework),
+      extension_id_(kExtensionId),
+      test_dir_(kVirtualKeyboardTestDir),
+      url_(kVirtualKeyboardURL) {
+}
 
-  // Ensure that the virtual keyboard is enabled.
-  virtual void SetUpCommandLine(CommandLine* command_line) OVERRIDE {
-    command_line->AppendSwitch(
-        keyboard::switches::kEnableVirtualKeyboard);
-  }
+VirtualKeyboardBrowserTestHelper::~VirtualKeyboardBrowserTestHelper() {};
 
-  // Injects javascript in |file| into the keyboard page and runs test methods.
-  void RunTest(const base::FilePath& file) {
-    ui_test_utils::NavigateToURL(browser(), GURL("chrome://keyboard"));
+void VirtualKeyboardBrowserTest::SetUpCommandLine(CommandLine* command_line) {
+  command_line->AppendSwitch(keyboard::switches::kEnableVirtualKeyboard);
+}
 
-    content::WebContents* web_contents =
-        browser()->tab_strip_model()->GetActiveWebContents();
-    ASSERT_TRUE(web_contents);
+void VirtualKeyboardBrowserTest::RunTest(
+    const base::FilePath& file,
+    const VirtualKeyboardBrowserTestHelper& helper) {
+  ui_test_utils::NavigateToURL(browser(), GURL(helper.url()));
+  content::WebContents* web_contents =
+      browser()->tab_strip_model()->GetActiveWebContents();
+  content::WaitForLoadStop(web_contents);
+  ASSERT_TRUE(web_contents);
 
-    // Inject testing scripts.
-    InjectJavascript(kWebuiTestDir, kMockController);
-    InjectJavascript(kWebuiTestDir, kMockTimer);
-    InjectJavascript(kVirtualKeyboardTestDir, kBaseKeyboardTestFramework);
-    InjectJavascript(kVirtualKeyboardTestDir, file);
+  // Inject testing scripts.
+  InjectJavascript(base::FilePath(kWebuiTestDir),
+                   base::FilePath(kMockController));
+  InjectJavascript(base::FilePath(kWebuiTestDir), base::FilePath(kMockTimer));
+  InjectJavascript(base::FilePath(FILE_PATH_LITERAL(helper.test_dir())),
+                   base::FilePath(FILE_PATH_LITERAL(helper.base_framework())));
+  InjectJavascript(base::FilePath(FILE_PATH_LITERAL(helper.test_dir())), file);
 
-    ASSERT_TRUE(content::ExecuteScript(web_contents, utf8_content_));
+  ASSERT_TRUE(content::ExecuteScript(web_contents, utf8_content_));
 
-    // Inject DOM-automation test harness and run tests.
-    std::vector<int> resource_ids;
-    EXPECT_TRUE(ExecuteWebUIResourceTest(web_contents, resource_ids));
-  }
+  // Inject DOM-automation test harness and run tests.
+  std::vector<int> resource_ids;
+  EXPECT_TRUE(ExecuteWebUIResourceTest(web_contents, resource_ids));
+}
 
-  void showVirtualKeyboard() {
-    aura::Window *window = ash::Shell::GetPrimaryRootWindow();
-    ui::InputMethod* input_method = window->GetProperty(
-        aura::client::kRootWindowInputMethodKey);
-    ASSERT_TRUE(input_method);
-    input_method->ShowImeIfNeeded();
-  }
+void VirtualKeyboardBrowserTest::ShowVirtualKeyboard() {
+  aura::Window* window = ash::Shell::GetPrimaryRootWindow();
+  ui::InputMethod* input_method =
+      window->GetProperty(aura::client::kRootWindowInputMethodKey);
+  ASSERT_TRUE(input_method);
+  input_method->ShowImeIfNeeded();
+}
 
-  content::RenderViewHost* GetKeyboardRenderViewHost() {
-    showVirtualKeyboard();
-    std::string kVirtualKeyboardURL =
-        "chrome-extension://mppnpdlheglhdfmldimlhpnegondlapf/";
-    scoped_ptr<content::RenderWidgetHostIterator> widgets(
-        content::RenderWidgetHost::GetRenderWidgetHosts());
-    while (content::RenderWidgetHost* widget = widgets->GetNextHost()) {
-      if (widget->IsRenderView()) {
-        content::RenderViewHost* view = content::RenderViewHost::From(widget);
-        std::string url = view->GetSiteInstance()->GetSiteURL().spec();
-        if (url == kVirtualKeyboardURL) {
-          content::WebContents* wc =
-              content::WebContents::FromRenderViewHost(view);
-          // Waits for Polymer to load.
-          content::WaitForLoadStop(wc);
-          return view;
-        }
+content::RenderViewHost* VirtualKeyboardBrowserTest::GetKeyboardRenderViewHost(
+    const std::string id) {

[Jeffrey Yasskin, 2014/05/02 22:09:37]

Take std::strings as "const std::string&", unless you modify the argument inside
the function.

[rsadam, 2014/05/05 17:44:42]

Done.

+  ShowVirtualKeyboard();
+  std::string url = "chrome-extension://" + id + "/";

[Jeffrey Yasskin, 2014/05/02 22:09:37]

This should probably be "Extension::GetBaseURLFromExtensionId(id)"

[rsadam, 2014/05/05 17:44:42]

Done.

+  scoped_ptr<content::RenderWidgetHostIterator> widgets(
+      content::RenderWidgetHost::GetRenderWidgetHosts());
+  while (content::RenderWidgetHost* widget = widgets->GetNextHost()) {
+    if (widget->IsRenderView()) {
+      content::RenderViewHost* view = content::RenderViewHost::From(widget);
+      if (url == view->GetSiteInstance()->GetSiteURL().spec()) {
+        content::WebContents* wc =
+            content::WebContents::FromRenderViewHost(view);
+        // Waits for Polymer to load.
+        content::WaitForLoadStop(wc);
+        return view;
       }
     }
-    return NULL;
   }
+  LOG(ERROR) << "Extension not found:" << url;
+  return NULL;
+}
 
- private:
-
-  // Injects javascript into the keyboard page.  The test |file| is in
-  // directory |dir| relative to the root testing directory.
-  void InjectJavascript(const base::FilePath& dir,
-                        const base::FilePath& file) {
-    base::FilePath path = ui_test_utils::GetTestFilePath(dir, file);
-    std::string library_content;
-    ASSERT_TRUE(base::ReadFileToString(path, &library_content))
-        << path.value();
-    utf8_content_.append(library_content);
-    utf8_content_.append(";\n");
-  }
-
-  std::string utf8_content_;
-};
+void VirtualKeyboardBrowserTest::InjectJavascript(const base::FilePath& dir,
+                                                  const base::FilePath& file) {
+  base::FilePath path = ui_test_utils::GetTestFilePath(dir, file);
+  std::string library_content;
+  ASSERT_TRUE(base::ReadFileToString(path, &library_content)) << path.value();
+  utf8_content_.append(library_content);
+  utf8_content_.append(";\n");
+}
 
 // crbug.com/367817. Either this feature or just the test are depending
 // on the presense of Object.observe which is presently disabled by default.
 IN_PROC_BROWSER_TEST_F(VirtualKeyboardBrowserTest, DISABLED_AttributesTest) {
-  RunTest(base::FilePath(FILE_PATH_LITERAL("attributes_test.js")));
+  RunTest(base::FilePath(FILE_PATH_LITERAL("attributes_test.js")),
+          VirtualKeyboardBrowserTestHelper());
 }
 
 IN_PROC_BROWSER_TEST_F(VirtualKeyboardBrowserTest, TypingTest) {
-  RunTest(base::FilePath(FILE_PATH_LITERAL("typing_test.js")));
+  RunTest(base::FilePath(FILE_PATH_LITERAL("typing_test.js")),
+          VirtualKeyboardBrowserTestHelper());
 }
 
 IN_PROC_BROWSER_TEST_F(VirtualKeyboardBrowserTest, ControlKeysTest) {
-  RunTest(base::FilePath(FILE_PATH_LITERAL("control_keys_test.js")));
+  RunTest(base::FilePath(FILE_PATH_LITERAL("control_keys_test.js")),
+          VirtualKeyboardBrowserTestHelper());
 }
 
 IN_PROC_BROWSER_TEST_F(VirtualKeyboardBrowserTest, HideKeyboardKeyTest) {
-  RunTest(base::FilePath(FILE_PATH_LITERAL("hide_keyboard_key_test.js")));
+  RunTest(base::FilePath(FILE_PATH_LITERAL("hide_keyboard_key_test.js")),
+          VirtualKeyboardBrowserTestHelper());
 }
 
 IN_PROC_BROWSER_TEST_F(VirtualKeyboardBrowserTest, KeysetTransitionTest) {
-  RunTest(base::FilePath(FILE_PATH_LITERAL("keyset_transition_test.js")));
+  RunTest(base::FilePath(FILE_PATH_LITERAL("keyset_transition_test.js")),
+          VirtualKeyboardBrowserTestHelper());
 }
 
 IN_PROC_BROWSER_TEST_F(VirtualKeyboardBrowserTest, IsKeyboardLoaded) {
-  content::RenderViewHost* keyboard_rvh = GetKeyboardRenderViewHost();
+  content::RenderViewHost* keyboard_rvh =
+      GetKeyboardRenderViewHost(kExtensionId);
   ASSERT_TRUE(keyboard_rvh);
   bool loaded = false;
   std::string script = "!!chrome.virtualKeyboardPrivate";
   EXPECT_TRUE(content::ExecuteScriptAndExtractBool(
       keyboard_rvh,
       "window.domAutomationController.send(" + script + ");",
       &loaded));
   // Catches the regression in crbug.com/308653.
   ASSERT_TRUE(loaded);
 }
 
 IN_PROC_BROWSER_TEST_F(VirtualKeyboardBrowserTest, EndToEndTest) {
   // Get the virtual keyboard's render view host.
-  content::RenderViewHost* keyboard_rvh = GetKeyboardRenderViewHost();
+  content::RenderViewHost* keyboard_rvh =
+      GetKeyboardRenderViewHost(kExtensionId);
   ASSERT_TRUE(keyboard_rvh);
 
   // Get the test page's render view host.
   content::RenderViewHost* browser_rvh = browser()->tab_strip_model()->
       GetActiveWebContents()->GetRenderViewHost();
   ASSERT_TRUE(browser_rvh);
 
   // Set up the test page.
   GURL url = ui_test_utils::GetTestUrl(
       base::FilePath(),
       base::FilePath(FILE_PATH_LITERAL(
           "chromeos/virtual_keyboard/end_to_end_test.html")));
   ui_test_utils::NavigateToURL(browser(), url);
 
   // Press 'a' on keyboard.
   base::FilePath path = ui_test_utils::GetTestFilePath(
-      kVirtualKeyboardTestDir,
+      base::FilePath(FILE_PATH_LITERAL(kVirtualKeyboardTestDir)),
       base::FilePath(FILE_PATH_LITERAL("end_to_end_test.js")));
   std::string script;
   ASSERT_TRUE(base::ReadFileToString(path, &script));
   EXPECT_TRUE(content::ExecuteScript(keyboard_rvh, script));
   // Verify 'a' appeared on test page.
   bool success = false;
   EXPECT_TRUE(content::ExecuteScriptAndExtractBool(
       browser_rvh,
       "success ? verifyInput('a') : waitForInput('a');",
       &success));
   ASSERT_TRUE(success);
 }
 
 // TODO(kevers|rsadam|bshe):  Add UI tests for remaining virtual keyboard
 // functionality.