Add test for ChromeVox keyboard commands.

chrome/browser/chromeos/accessibility/spoken_feedback_browsertest.cc

 // Copyright 2014 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 <queue>
 
 #include "ash/shell.h"
 #include "ash/system/tray/system_tray.h"
 #include "base/command_line.h"
 #include "base/strings/string_util.h"
 #include "chrome/app/chrome_command_ids.h"
 #include "chrome/browser/chromeos/accessibility/accessibility_manager.h"
 #include "chrome/browser/chromeos/accessibility/speech_monitor.h"
 #include "chrome/browser/chromeos/login/ui/login_display_host.h"
 #include "chrome/browser/chromeos/login/ui/login_display_host_impl.h"
 #include "chrome/browser/chromeos/login/ui/webui_login_view.h"
 #include "chrome/browser/chromeos/profiles/profile_helper.h"
 #include "chrome/browser/extensions/api/braille_display_private/stub_braille_controller.h"
 #include "chrome/browser/speech/tts_controller.h"
 #include "chrome/browser/speech/tts_platform.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_commands.h"
 #include "chrome/browser/ui/browser_window.h"
+#include "chrome/browser/ui/tabs/tab_strip_model.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/extensions/extension_constants.h"
 #include "chrome/test/base/in_process_browser_test.h"
 #include "chrome/test/base/interactive_test_utils.h"
 #include "chrome/test/base/testing_profile.h"
 #include "chrome/test/base/ui_test_utils.h"
 #include "chromeos/chromeos_switches.h"
 #include "chromeos/login/user_names.h"
 #include "content/public/common/url_constants.h"
 #include "content/public/test/browser_test_utils.h"
@@ skipping 19 matching lines @@
 
   virtual void SetUpInProcessBrowserTestFixture() OVERRIDE {
     AccessibilityManager::SetBrailleControllerForTest(&braille_controller_);
   }
 
   virtual void TearDownOnMainThread() OVERRIDE {
     AccessibilityManager::SetBrailleControllerForTest(NULL);
   }
 
   void SendKeyPress(ui::KeyboardCode key) {
-    gfx::NativeWindow root_window =
-        ash::Shell::GetInstance()->GetPrimaryRootWindow();
-    ASSERT_TRUE(
-        ui_test_utils::SendKeyPressToWindowSync(
-            root_window, key, false, false, false, false));
+    ASSERT_NO_FATAL_FAILURE(
+        ASSERT_TRUE(
+            ui_test_utils::SendKeyPressToWindowSync(
+                NULL, key, false, false, false, false)));
+  }
+
+  void SendKeyPressWithControl(ui::KeyboardCode key) {
+    ASSERT_NO_FATAL_FAILURE(
+        ASSERT_TRUE(
+            ui_test_utils::SendKeyPressToWindowSync(
+                NULL, key, true, false, false, false)));
+  }
+
+  void SendKeyPressWithSearchAndShift(ui::KeyboardCode key) {
+    ASSERT_NO_FATAL_FAILURE(
+        ASSERT_TRUE(
+            ui_test_utils::SendKeyPressToWindowSync(
+                NULL, key, false, true, false, true)));
   }
 
   void RunJavaScriptInChromeVoxBackgroundPage(const std::string& script) {
     extensions::ExtensionHost* host =
         extensions::ExtensionSystem::Get(browser()->profile())->
         process_manager()->GetBackgroundHostForExtension(
             extension_misc::kChromeVoxExtensionId);
     CHECK(content::ExecuteScript(host->host_contents(), script));
   }
 
   void SimulateTouchScreenInChromeVox() {
     // ChromeVox looks at whether 'ontouchstart' exists to know whether
     // or not it should respond to hover events. Fake it so that touch
     // exploration events get spoken.
     RunJavaScriptInChromeVoxBackgroundPage(
         "window.ontouchstart = function() {};");
   }
 
   void DisableEarcons() {
     // Playing earcons from within a test is not only annoying if you're
     // running the test locally, but seems to cause crashes
     // (http://crbug.com/396507). Work around this by just telling
     // ChromeVox to not ever play earcons (prerecorded sound effects).
     RunJavaScriptInChromeVoxBackgroundPage(
         "cvox.ChromeVox.earcons.playEarcon = function() {};");
   }
 
+  void LoadChromeVoxAndThenNavigateToURL(const GURL& url) {
+    // The goal of this helper function is to avoid race conditions between
+    // the page loading and the ChromeVox extension loading and fully

[David Tseng, 2014/09/22 21:52:21]

Mention something about the content script being fully initialized here.

+    // initializing. To do this, we first load a test url that repeatedly
+    // asks ChromeVox to speak 'ready', then we load ChromeVox and block
+    // until we get that 'ready' speech.
+
+    ui_test_utils::NavigateToURL(
+        browser(),
+        GURL("data:text/html;charset=utf-8,"
+             "<script>"
+             "window.setInterval(function() {"
+             "  try {"
+             "    cvox.Api.speak('ready');"
+             "  } catch (e) {}"
+             "}, 100);"
+             "</script>"));
+    EXPECT_FALSE(AccessibilityManager::Get()->IsSpokenFeedbackEnabled());
+    AccessibilityManager::Get()->EnableSpokenFeedback(
+        true, ash::A11Y_NOTIFICATION_NONE);
+
+    // Block until we get "ready".
+    while (speech_monitor_.GetNextUtterance() != "ready") {

[David Tseng, 2014/09/22 21:52:21]

Should we sleep here inside the loop to avoid potentially hanging the machine?

+    }
+
+    // Now load the requested url.
+    ui_test_utils::NavigateToURL(browser(), url);
+  }
+
+  SpeechMonitor speech_monitor_;
+
  private:
   StubBrailleController braille_controller_;
   DISALLOW_COPY_AND_ASSIGN(LoggedInSpokenFeedbackTest);
 };
 
 IN_PROC_BROWSER_TEST_F(LoggedInSpokenFeedbackTest, AddBookmark) {
   EXPECT_FALSE(AccessibilityManager::Get()->IsSpokenFeedbackEnabled());
 
-  SpeechMonitor monitor;
   AccessibilityManager::Get()->EnableSpokenFeedback(
       true, ash::A11Y_NOTIFICATION_NONE);
-  EXPECT_TRUE(monitor.SkipChromeVoxEnabledMessage());
+  EXPECT_TRUE(speech_monitor_.SkipChromeVoxEnabledMessage());
   DisableEarcons();
 
   chrome::ExecuteCommand(browser(), IDC_SHOW_BOOKMARK_BAR);
 
   // Create a bookmark with title "foo".
   chrome::ExecuteCommand(browser(), IDC_BOOKMARK_PAGE);
-  EXPECT_EQ("Bookmark added!,", monitor.GetNextUtterance());
-  EXPECT_EQ("about blank,", monitor.GetNextUtterance());
-  EXPECT_EQ("Bookmark name,", monitor.GetNextUtterance());
-  EXPECT_EQ("text box", monitor.GetNextUtterance());
+  EXPECT_EQ("Bookmark added!,", speech_monitor_.GetNextUtterance());
+  EXPECT_EQ("about blank,", speech_monitor_.GetNextUtterance());
+  EXPECT_EQ("Bookmark name,", speech_monitor_.GetNextUtterance());
+  EXPECT_EQ("text box", speech_monitor_.GetNextUtterance());
 
   SendKeyPress(ui::VKEY_F);
-  EXPECT_EQ("f", monitor.GetNextUtterance());
+  EXPECT_EQ("f", speech_monitor_.GetNextUtterance());
   SendKeyPress(ui::VKEY_O);
-  EXPECT_EQ("o", monitor.GetNextUtterance());
+  EXPECT_EQ("o", speech_monitor_.GetNextUtterance());
   SendKeyPress(ui::VKEY_O);
-  EXPECT_EQ("o", monitor.GetNextUtterance());
+  EXPECT_EQ("o", speech_monitor_.GetNextUtterance());
 
   SendKeyPress(ui::VKEY_TAB);
-  EXPECT_EQ("Bookmarks bar,", monitor.GetNextUtterance());
-  EXPECT_EQ("Bookmark folder,", monitor.GetNextUtterance());
-  EXPECT_TRUE(MatchPattern(monitor.GetNextUtterance(), "combo box*"));
+  EXPECT_EQ("Bookmarks bar,", speech_monitor_.GetNextUtterance());
+  EXPECT_EQ("Bookmark folder,", speech_monitor_.GetNextUtterance());
+  EXPECT_TRUE(MatchPattern(speech_monitor_.GetNextUtterance(), "combo box*"));
 
   SendKeyPress(ui::VKEY_RETURN);
 
-  EXPECT_TRUE(MatchPattern(monitor.GetNextUtterance(), "*oolbar*"));
+  EXPECT_TRUE(MatchPattern(speech_monitor_.GetNextUtterance(), "*oolbar*"));
   // Wait for active window change to be announced to avoid interference from
   // that below.
-  while (monitor.GetNextUtterance() != "window about blank tab") {
+  while (speech_monitor_.GetNextUtterance() != "window about blank tab") {
     // Do nothing.
   }
 
   // Focus bookmarks bar and listen for "foo".
   chrome::ExecuteCommand(browser(), IDC_FOCUS_BOOKMARKS);
   while (true) {
-    std::string utterance = monitor.GetNextUtterance();
+    std::string utterance = speech_monitor_.GetNextUtterance();
     VLOG(0) << "Got utterance: " << utterance;
     if (utterance == "Bookmarks,")
       break;
   }
-  EXPECT_EQ("foo,", monitor.GetNextUtterance());
-  EXPECT_EQ("button", monitor.GetNextUtterance());
+  EXPECT_EQ("foo,", speech_monitor_.GetNextUtterance());
+  EXPECT_EQ("button", speech_monitor_.GetNextUtterance());
 }
 
 //
 // Spoken feedback tests in both a logged in browser window and guest mode.
 //
 
 enum SpokenFeedbackTestVariant {
   kTestAsNormalUser,
   kTestAsGuestUser
 };
@@ skipping 19 matching lines @@
 
 INSTANTIATE_TEST_CASE_P(
     TestAsNormalAndGuestUser,
     SpokenFeedbackTest,
     ::testing::Values(kTestAsNormalUser,
                       kTestAsGuestUser));
 
 IN_PROC_BROWSER_TEST_P(SpokenFeedbackTest, EnableSpokenFeedback) {
   EXPECT_FALSE(AccessibilityManager::Get()->IsSpokenFeedbackEnabled());
 
-  SpeechMonitor monitor;
   AccessibilityManager::Get()->EnableSpokenFeedback(
       true, ash::A11Y_NOTIFICATION_NONE);
-  EXPECT_TRUE(monitor.SkipChromeVoxEnabledMessage());
+  EXPECT_TRUE(speech_monitor_.SkipChromeVoxEnabledMessage());
 }
 
 IN_PROC_BROWSER_TEST_P(SpokenFeedbackTest, FocusToolbar) {
   EXPECT_FALSE(AccessibilityManager::Get()->IsSpokenFeedbackEnabled());
 
-  SpeechMonitor monitor;
   AccessibilityManager::Get()->EnableSpokenFeedback(
       true, ash::A11Y_NOTIFICATION_NONE);
-  EXPECT_TRUE(monitor.SkipChromeVoxEnabledMessage());
+  EXPECT_TRUE(speech_monitor_.SkipChromeVoxEnabledMessage());
   DisableEarcons();
 
   chrome::ExecuteCommand(browser(), IDC_FOCUS_TOOLBAR);
   // Might be "Google Chrome Toolbar" or "Chromium Toolbar".
-  EXPECT_TRUE(MatchPattern(monitor.GetNextUtterance(), "*oolbar*"));
-  EXPECT_EQ("Reload,", monitor.GetNextUtterance());
-  EXPECT_EQ("button", monitor.GetNextUtterance());
+  EXPECT_TRUE(MatchPattern(speech_monitor_.GetNextUtterance(), "*oolbar*"));
+  EXPECT_EQ("Reload,", speech_monitor_.GetNextUtterance());
+  EXPECT_EQ("button", speech_monitor_.GetNextUtterance());
 }
 
 IN_PROC_BROWSER_TEST_P(SpokenFeedbackTest, TypeInOmnibox) {
   EXPECT_FALSE(AccessibilityManager::Get()->IsSpokenFeedbackEnabled());
 
-  SpeechMonitor monitor;
   AccessibilityManager::Get()->EnableSpokenFeedback(
       true, ash::A11Y_NOTIFICATION_NONE);
-  EXPECT_TRUE(monitor.SkipChromeVoxEnabledMessage());
+  EXPECT_TRUE(speech_monitor_.SkipChromeVoxEnabledMessage());
   DisableEarcons();
 
   // Wait for ChromeVox to finish speaking.
   chrome::ExecuteCommand(browser(), IDC_FOCUS_LOCATION);
   while (true) {
-    std::string utterance = monitor.GetNextUtterance();
+    std::string utterance = speech_monitor_.GetNextUtterance();
     VLOG(0) << "Got utterance: " << utterance;
     if (utterance == "text box")
       break;
   }
 
   SendKeyPress(ui::VKEY_X);
-  EXPECT_EQ("x", monitor.GetNextUtterance());
+  EXPECT_EQ("x", speech_monitor_.GetNextUtterance());
 
   SendKeyPress(ui::VKEY_Y);
-  EXPECT_EQ("y", monitor.GetNextUtterance());
+  EXPECT_EQ("y", speech_monitor_.GetNextUtterance());
 
   SendKeyPress(ui::VKEY_Z);
-  EXPECT_EQ("z", monitor.GetNextUtterance());
+  EXPECT_EQ("z", speech_monitor_.GetNextUtterance());
 
   SendKeyPress(ui::VKEY_BACK);
-  EXPECT_EQ("z", monitor.GetNextUtterance());
+  EXPECT_EQ("z", speech_monitor_.GetNextUtterance());
+}
+
+IN_PROC_BROWSER_TEST_P(SpokenFeedbackTest, ChromeVoxShiftSearch) {
+  LoadChromeVoxAndThenNavigateToURL(
+      GURL("data:text/html;charset=utf-8,<button autofocus>Click me</button>"));
+  while (true) {
+    std::string utterance = speech_monitor_.GetNextUtterance();
+    if (utterance == "Click me")

[David Tseng, 2014/09/22 21:52:21]

Would be helpful to state why we're expecting this? (initial page focus)?

+      break;
+  }

[David Tseng, 2014/09/22 21:52:21]

Ditto.

+  EXPECT_EQ("Button", speech_monitor_.GetNextUtterance());
+
+  // Press Search+Shift+/ to enter ChromeVox's "find in page".
+  SendKeyPressWithSearchAndShift(ui::VKEY_OEM_2);
+  EXPECT_EQ("Find in page.", speech_monitor_.GetNextUtterance());
+  EXPECT_EQ("Enter a search query.", speech_monitor_.GetNextUtterance());
+}
+
+IN_PROC_BROWSER_TEST_P(SpokenFeedbackTest, ChromeVoxPrefixKey) {
+  LoadChromeVoxAndThenNavigateToURL(
+      GURL("data:text/html;charset=utf-8,<button autofocus>Click me</button>"));
+  while (true) {
+    std::string utterance = speech_monitor_.GetNextUtterance();
+    if (utterance == "Click me")
+      break;
+  }
+  EXPECT_EQ("Button", speech_monitor_.GetNextUtterance());
+
+  // Press the prefix key Ctrl+';' followed by '/'
+  // to enter ChromeVox's "find in page".
+  SendKeyPressWithControl(ui::VKEY_OEM_1);
+  SendKeyPress(ui::VKEY_OEM_2);
+  EXPECT_EQ("Find in page.", speech_monitor_.GetNextUtterance());
+  EXPECT_EQ("Enter a search query.", speech_monitor_.GetNextUtterance());
 }
 
 IN_PROC_BROWSER_TEST_P(SpokenFeedbackTest, TouchExploreStatusTray) {
   EXPECT_FALSE(AccessibilityManager::Get()->IsSpokenFeedbackEnabled());
 
-  SpeechMonitor monitor;
   AccessibilityManager::Get()->EnableSpokenFeedback(
       true, ash::A11Y_NOTIFICATION_NONE);
-  EXPECT_TRUE(monitor.SkipChromeVoxEnabledMessage());
+  EXPECT_TRUE(speech_monitor_.SkipChromeVoxEnabledMessage());
   DisableEarcons();
 
   SimulateTouchScreenInChromeVox();
 
   // Send an accessibility hover event on the system tray, which is
   // what we get when you tap it on a touch screen when ChromeVox is on.
   ash::SystemTray* tray = ash::Shell::GetInstance()->GetPrimarySystemTray();
   tray->NotifyAccessibilityEvent(ui::AX_EVENT_HOVER, true);
 
-  EXPECT_EQ("Status tray,", monitor.GetNextUtterance());
-  EXPECT_TRUE(MatchPattern(monitor.GetNextUtterance(), "time*,"));
-  EXPECT_TRUE(MatchPattern(monitor.GetNextUtterance(), "Battery*,"));
-  EXPECT_EQ("button", monitor.GetNextUtterance());
+  EXPECT_EQ("Status tray,", speech_monitor_.GetNextUtterance());
+  EXPECT_TRUE(MatchPattern(speech_monitor_.GetNextUtterance(), "time*,"));
+  EXPECT_TRUE(MatchPattern(speech_monitor_.GetNextUtterance(), "Battery*,"));
+  EXPECT_EQ("button", speech_monitor_.GetNextUtterance());
 }
 
 //
 // Spoken feedback tests that run only in guest mode.
 //
 
 class GuestSpokenFeedbackTest : public LoggedInSpokenFeedbackTest {
  protected:
   GuestSpokenFeedbackTest() {}
   virtual ~GuestSpokenFeedbackTest() {}
 
   virtual void SetUpCommandLine(CommandLine* command_line) OVERRIDE {
     command_line->AppendSwitch(chromeos::switches::kGuestSession);
     command_line->AppendSwitch(::switches::kIncognito);
     command_line->AppendSwitchASCII(chromeos::switches::kLoginProfile, "user");
     command_line->AppendSwitchASCII(chromeos::switches::kLoginUser,
                                     chromeos::login::kGuestUserName);
   }
 
  private:
   DISALLOW_COPY_AND_ASSIGN(GuestSpokenFeedbackTest);
 };
 
 IN_PROC_BROWSER_TEST_F(GuestSpokenFeedbackTest, FocusToolbar) {
   EXPECT_FALSE(AccessibilityManager::Get()->IsSpokenFeedbackEnabled());
 
-  SpeechMonitor monitor;
   AccessibilityManager::Get()->EnableSpokenFeedback(
       true, ash::A11Y_NOTIFICATION_NONE);
-  EXPECT_TRUE(monitor.SkipChromeVoxEnabledMessage());
+  EXPECT_TRUE(speech_monitor_.SkipChromeVoxEnabledMessage());
   DisableEarcons();
 
   chrome::ExecuteCommand(browser(), IDC_FOCUS_TOOLBAR);
   // Might be "Google Chrome Toolbar" or "Chromium Toolbar".
-  EXPECT_TRUE(MatchPattern(monitor.GetNextUtterance(), "*oolbar*"));
-  EXPECT_EQ("Reload,", monitor.GetNextUtterance());
-  EXPECT_EQ("button", monitor.GetNextUtterance());
+  EXPECT_TRUE(MatchPattern(speech_monitor_.GetNextUtterance(), "*oolbar*"));
+  EXPECT_EQ("Reload,", speech_monitor_.GetNextUtterance());
+  EXPECT_EQ("button", speech_monitor_.GetNextUtterance());
 }
 
 //
 // Spoken feedback tests of the out-of-box experience.
 //
 
 class OobeSpokenFeedbackTest : public InProcessBrowserTest {
  protected:
   OobeSpokenFeedbackTest() {}
   virtual ~OobeSpokenFeedbackTest() {}
 
   virtual void SetUpCommandLine(CommandLine* command_line) OVERRIDE {
     command_line->AppendSwitch(chromeos::switches::kLoginManager);
     command_line->AppendSwitch(chromeos::switches::kForceLoginManagerInTests);
     command_line->AppendSwitchASCII(chromeos::switches::kLoginProfile, "user");
   }
 
   virtual void SetUpOnMainThread() OVERRIDE {
     AccessibilityManager::Get()->
         SetProfileForTest(ProfileHelper::GetSigninProfile());
   }
 
+  SpeechMonitor speech_monitor_;
+
  private:
   DISALLOW_COPY_AND_ASSIGN(OobeSpokenFeedbackTest);
 };
 
 // Test is flaky: http://crbug.com/346797
 IN_PROC_BROWSER_TEST_F(OobeSpokenFeedbackTest, DISABLED_SpokenFeedbackInOobe) {
   ui_controls::EnableUIControls();
   EXPECT_FALSE(AccessibilityManager::Get()->IsSpokenFeedbackEnabled());
 
   LoginDisplayHost* login_display_host = LoginDisplayHostImpl::default_host();
   WebUILoginView* web_ui_login_view = login_display_host->GetWebUILoginView();
   views::Widget* widget = web_ui_login_view->GetWidget();
   gfx::NativeWindow window = widget->GetNativeWindow();
 
-  SpeechMonitor monitor;
   AccessibilityManager::Get()->EnableSpokenFeedback(
       true, ash::A11Y_NOTIFICATION_NONE);
-  EXPECT_TRUE(monitor.SkipChromeVoxEnabledMessage());
+  EXPECT_TRUE(speech_monitor_.SkipChromeVoxEnabledMessage());
 
-  EXPECT_EQ("Select your language:", monitor.GetNextUtterance());
-  EXPECT_EQ("English ( United States)", monitor.GetNextUtterance());
-  EXPECT_TRUE(MatchPattern(monitor.GetNextUtterance(), "Combo box * of *"));
+  EXPECT_EQ("Select your language:", speech_monitor_.GetNextUtterance());
+  EXPECT_EQ("English ( United States)", speech_monitor_.GetNextUtterance());
+  EXPECT_TRUE(MatchPattern(speech_monitor_.GetNextUtterance(),
+                           "Combo box * of *"));
   ASSERT_TRUE(
       ui_test_utils::SendKeyPressToWindowSync(
           window, ui::VKEY_TAB, false, false, false, false));
-  EXPECT_EQ("Select your keyboard:", monitor.GetNextUtterance());
+  EXPECT_EQ("Select your keyboard:", speech_monitor_.GetNextUtterance());
 }
 
 }  // namespace chromeos