Allow webdriver users to choose between sending the key events when...

chrome/browser/automation/testing_automation_provider.cc

 // Copyright (c) 2011 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/automation/testing_automation_provider.h"
 
 #include <map>
 #include <string>
 #include <vector>
 
@@ skipping 2052 matching lines @@
   handler_map["CloseTab"] =
       &TestingAutomationProvider::CloseTabJSON;
   handler_map["WebkitMouseMove"] =
       &TestingAutomationProvider::WebkitMouseMove;
   handler_map["WebkitMouseClick"] =
       &TestingAutomationProvider::WebkitMouseClick;
   handler_map["WebkitMouseDrag"] =
       &TestingAutomationProvider::WebkitMouseDrag;
   handler_map["SendWebkitKeyEvent"] =
       &TestingAutomationProvider::SendWebkitKeyEvent;
+  handler_map["SendOSLevelKeyEvent"] =
+      &TestingAutomationProvider::SendOSLevelKeyEvent;
   handler_map["ActivateTab"] =
       &TestingAutomationProvider::ActivateTabJSON;
 #if defined(OS_CHROMEOS)
   handler_map["GetLoginInfo"] = &TestingAutomationProvider::GetLoginInfo;
   handler_map["LoginAsGuest"] = &TestingAutomationProvider::LoginAsGuest;
   handler_map["Login"] = &TestingAutomationProvider::Login;
 
   handler_map["LockScreen"] = &TestingAutomationProvider::LockScreen;
   handler_map["UnlockScreen"] = &TestingAutomationProvider::UnlockScreen;
   handler_map["SignoutInScreenLocker"] =
@@ skipping 2432 matching lines @@
   if (!base::OpenProcessHandle(static_cast<base::ProcessId>(pid), &process)) {
     AutomationJSONReply(this, reply_message).SendError(base::StringPrintf(
         "Failed to open process handle for pid %d", pid));
     return;
   }
   new RendererProcessClosedObserver(this, reply_message);
   base::KillProcess(process, 0, false);
   base::CloseProcessHandle(process);
 }
 
+bool TestingAutomationProvider::BuildWebKeyEventFromArgs(
+    DictionaryValue* args,
+    IPC::Message* reply_message,
+    NativeWebKeyboardEvent* event) {
+

[kkania, 2011/03/24 23:20:32]

remove unecessary newline

[timothe, 2011/03/25 11:07:59]

Done.

+  int type, modifiers;
+  bool is_system_key;
+  string16 unmodified_text, text;
+  std::string key_identifier;
+    if (!args->GetInteger("type", &type)) {

[kkania, 2011/03/24 23:20:32]

fix indentation

[timothe, 2011/03/25 11:07:59]

Done.

+    AutomationJSONReply(this, reply_message)
+        .SendError("'type' missing or invalid.");
+    return false;
+  }
+  if (!args->GetBoolean("isSystemKey", &is_system_key)) {
+    AutomationJSONReply(this, reply_message)
+        .SendError("'isSystemKey' missing or invalid.");
+    return false;
+  }
+  if (!args->GetString("unmodifiedText", &unmodified_text)) {
+    AutomationJSONReply(this, reply_message)
+        .SendError("'unmodifiedText' missing or invalid.");
+    return false;
+  }
+  if (!args->GetString("text", &text)) {
+    AutomationJSONReply(this, reply_message)
+        .SendError("'text' missing or invalid.");
+    return false;
+  }
+  if (!args->GetInteger("nativeKeyCode", &event->nativeKeyCode)) {
+    AutomationJSONReply(this, reply_message)
+        .SendError("'nativeKeyCode' missing or invalid.");
+    return false;
+  }
+  if (!args->GetInteger("windowsKeyCode", &event->windowsKeyCode)) {
+    AutomationJSONReply(this, reply_message)
+        .SendError("'windowsKeyCode' missing or invalid.");
+    return false;
+  }
+  if (!args->GetInteger("modifiers", &modifiers)) {
+    AutomationJSONReply(this, reply_message)
+        .SendError("'modifiers' missing or invalid.");
+    return false;
+  }
+  if (args->GetString("keyIdentifier", &key_identifier)) {
+    base::strlcpy(event->keyIdentifier,
+                  key_identifier.c_str(),
+                  WebKit::WebKeyboardEvent::keyIdentifierLengthCap);
+  } else {
+    event->setKeyIdentifierFromWindowsKeyCode();
+  }
+
+  if (type == automation::kRawKeyDownType) {
+    event->type = WebKit::WebInputEvent::RawKeyDown;
+  } else if (type == automation::kKeyDownType) {
+    event->type = WebKit::WebInputEvent::KeyDown;
+  } else if (type == automation::kKeyUpType) {
+    event->type = WebKit::WebInputEvent::KeyUp;
+  } else if (type == automation::kCharType) {
+    event->type = WebKit::WebInputEvent::Char;
+  } else {
+    AutomationJSONReply(this, reply_message)
+        .SendError("'type' refers to an unrecognized keyboard event type");
+    return false;
+  }
+
+  string16 unmodified_text_truncated = unmodified_text.substr(
+      0, WebKit::WebKeyboardEvent::textLengthCap - 1);
+  memcpy(event->unmodifiedText,
+         unmodified_text_truncated.c_str(),
+         unmodified_text_truncated.length() + 1);
+  string16 text_truncated = text.substr(
+      0, WebKit::WebKeyboardEvent::textLengthCap - 1);
+  memcpy(event->text, text_truncated.c_str(), text_truncated.length() + 1);
+
+  event->modifiers = 0;
+  if (modifiers & automation::kShiftKeyMask)
+    event->modifiers |= WebKit::WebInputEvent::ShiftKey;
+  if (modifiers & automation::kControlKeyMask)
+    event->modifiers |= WebKit::WebInputEvent::ControlKey;
+  if (modifiers & automation::kAltKeyMask)
+    event->modifiers |= WebKit::WebInputEvent::AltKey;
+  if (modifiers & automation::kMetaKeyMask)
+    event->modifiers |= WebKit::WebInputEvent::MetaKey;
+
+  event->isSystemKey = is_system_key;
+  event->timeStampSeconds = base::Time::Now().ToDoubleT();
+  event->skip_in_browser = true;
+  return true;
+}
+
 void TestingAutomationProvider::SendWebkitKeyEvent(
     DictionaryValue* args,
     IPC::Message* reply_message) {
+  NativeWebKeyboardEvent event;
+  // BuildWebKeyEventFromArgs handles telling what when wrong and sending
+  // the reply message, if it failed we just have to stop here.
+  if (!BuildWebKeyEventFromArgs(args, reply_message, &event))

[kkania, 2011/03/24 23:20:32]

instead of giving reply_message, can you give it an std::string* error_msg like
GetTabFromJSONArgs does; then send the error here.

[timothe, 2011/03/25 11:07:59]

Done.

+    return;
+
   TabContents* tab_contents;
   std::string error;
   if (!GetTabFromJSONArgs(args, &tab_contents, &error)) {
     AutomationJSONReply(this, reply_message).SendError(error);
     return;
   }
+  LOG(INFO) << "reply_message:" << reply_message;

[Paweł Hajdan Jr., 2011/03/23 10:16:05]

Please remove debugging LOG messages before checking in.

[timothe, 2011/03/23 10:54:04]

Done.

+  new InputEventAckNotificationObserver(this, reply_message, event.type);
+  tab_contents->render_view_host()->ForwardKeyboardEvent(event);
+}
 
-  int type, modifiers;
-  bool is_system_key;
-  string16 unmodified_text, text;
-  std::string key_identifier;
-  NativeWebKeyboardEvent event;
-  if (!args->GetInteger("type", &type)) {
-    AutomationJSONReply reply(this, reply_message);
-    reply.SendError("'type' missing or invalid.");
-    return;
-  }
-  if (!args->GetBoolean("isSystemKey", &is_system_key)) {
-    AutomationJSONReply reply(this, reply_message);
-    reply.SendError("'isSystemKey' missing or invalid.");
-    return;
-  }
-  if (!args->GetString("unmodifiedText", &unmodified_text)) {
-    AutomationJSONReply reply(this, reply_message);
-    reply.SendError("'unmodifiedText' missing or invalid.");
-    return;
-  }
-  if (!args->GetString("text", &text)) {
-    AutomationJSONReply reply(this, reply_message);
-    reply.SendError("'text' missing or invalid.");
-    return;
-  }
-  if (!args->GetInteger("nativeKeyCode", &event.nativeKeyCode)) {
-    AutomationJSONReply reply(this, reply_message);
-    reply.SendError("'nativeKeyCode' missing or invalid.");
-    return;
-  }
-  if (!args->GetInteger("windowsKeyCode", &event.windowsKeyCode)) {
-    AutomationJSONReply reply(this, reply_message);
-    reply.SendError("'windowsKeyCode' missing or invalid.");
+void TestingAutomationProvider::SendSuccessReply(IPC::Message* reply_message) {
+  AutomationJSONReply(this, reply_message).SendSuccess(NULL);
+}
+
+void TestingAutomationProvider::SendOSLevelKeyEvent(
+    DictionaryValue* args,
+    IPC::Message* reply_message) {
+  int modifiers, keycode;
+  if (!args->GetInteger("nativeKeyCode", &keycode)) {

[kkania, 2011/03/24 23:20:32]

ui::KeyboardCode is supposed to be a platform independent key code (although
really it is just a windows key code). A native key code is like a gdk key.

How about rename this to "keyCode"?

[timothe, 2011/03/25 11:07:59]

Done.

+    AutomationJSONReply(this, reply_message)
+        .SendError("'nativeKeyCode' missing or invalid.");
     return;
   }
   if (!args->GetInteger("modifiers", &modifiers)) {
-    AutomationJSONReply reply(this, reply_message);
-    reply.SendError("'modifiers' missing or invalid.");
-    return;
-  }
-  if (args->GetString("keyIdentifier", &key_identifier)) {
-    base::strlcpy(event.keyIdentifier,
-                  key_identifier.c_str(),
-                  WebKit::WebKeyboardEvent::keyIdentifierLengthCap);
-  } else {
-    event.setKeyIdentifierFromWindowsKeyCode();
-  }
-
-  if (type == automation::kRawKeyDownType) {
-    event.type = WebKit::WebInputEvent::RawKeyDown;
-  } else if (type == automation::kKeyDownType) {
-    event.type = WebKit::WebInputEvent::KeyDown;
-  } else if (type == automation::kKeyUpType) {
-    event.type = WebKit::WebInputEvent::KeyUp;
-  } else if (type == automation::kCharType) {
-    event.type = WebKit::WebInputEvent::Char;
-  } else {
-    AutomationJSONReply reply(this, reply_message);
-    reply.SendError("'type' refers to an unrecognized keyboard event type");
+    AutomationJSONReply(this, reply_message)
+        .SendError("'modifiers' missing or invalid.");
     return;
   }
 
-  string16 unmodified_text_truncated = unmodified_text.substr(
-      0, WebKit::WebKeyboardEvent::textLengthCap - 1);
-  memcpy(event.unmodifiedText,
-         unmodified_text_truncated.c_str(),
-         unmodified_text_truncated.length() + 1);
-  string16 text_truncated = text.substr(
-      0, WebKit::WebKeyboardEvent::textLengthCap - 1);
-  memcpy(event.text, text_truncated.c_str(), text_truncated.length() + 1);
+  std::string error;
+  Browser* browser;
+  TabContents* tab_contents;
+  if (!GetBrowserAndTabFromJSONArgs(args, &browser, &tab_contents, &error)) {
+    AutomationJSONReply(this, reply_message).SendError(error);
+    return;
+  }
+  // The key events will be sent ot the browser level, we need the current tab

[kkania, 2011/03/24 23:20:32]

ot -> at

[timothe, 2011/03/25 11:07:59]

Done.

+  // containing the element we send the text in to be shown.

[kkania, 2011/03/24 23:20:32]

I do not like this comment for two reasons:
1) It says it will send a key event to the browser level. What is a browser
level? I know what you mean, but this is unclear.
2) It references elements. This function can be used for typing in the omnibox
too, right?

Please fix.

[timothe, 2011/03/25 11:07:59]

1) Done, changed to "browser window".

2) Well, Typing in the omnibox is more a side effect than a feature: you must
first get an element on the page using webdriver, then if you send the "ctrl+L"
shortcut the event gets sent to the browser which understands it as "go to the
omnibox" by default. Afterwards if you send keys to the previously selected
element they will be sent to the omnibox as it is focused.
If we want to make it clear to the user, I saw that the automation provider also
have a SetOmniboxText, OmniboxAcceptInput and OmniboxMovePopupSelection, we
could make this available from webdriver either by adding a new command to the
wire protocol (don't know if that's a good idea...) or by specifying a special
id that would return the omnibox when queried via
get_element_by_id("#chrome_omnibox") for instance.

On 2011/03/24 23:20:32, kkania wrote:

[kkania, 2011/03/25 16:37:36]

I see. I don't think we want to add SetOmniboxText and friends to the webdriver
protocol. Webdriver is focused on testing websites, not the browser.

[timothe, 2011/03/28 18:35:48]

I agree, let's not add browser centric capabilities to the driver.

On 2011/03/25 16:37:36, kkania wrote:

+  browser->SelectTabContentsAt(

[kkania, 2011/03/25 16:37:36]

If you want to keep this selection here, change the name of this method and the
JSON message to SendOSLevelKeyEventToTab.

Otherwise, remove this select here, the tab_index parameter of the JSON message,
and do the selection on the ChromeDriver side.

[timothe, 2011/03/28 18:35:48]

Done. Added ToTab.

On 2011/03/25 16:37:36, kkania wrote:

+      browser->GetIndexOfController(&tab_contents->controller()), true);
 
-  event.modifiers = 0;
-  if (modifiers & automation::kShiftKeyMask)
-    event.modifiers |= WebKit::WebInputEvent::ShiftKey;
-  if (modifiers & automation::kControlKeyMask)
-    event.modifiers |= WebKit::WebInputEvent::ControlKey;
-  if (modifiers & automation::kAltKeyMask)
-    event.modifiers |= WebKit::WebInputEvent::AltKey;
-  if (modifiers & automation::kMetaKeyMask)
-    event.modifiers |= WebKit::WebInputEvent::MetaKey;
+  BrowserWindow* browser_window = browser->window();
+  if (!browser_window) {
+    AutomationJSONReply(this, reply_message)
+        .SendError("Could not get the browser window");
+    return;
+  }
+  gfx::NativeWindow window = browser_window->GetNativeHandle();
+  if (!window) {
+    AutomationJSONReply(this, reply_message)
+        .SendError("Could not get the browser window handle");
+    return;
+  }
 
-  event.isSystemKey = is_system_key;
-  event.timeStampSeconds = base::Time::Now().ToDoubleT();
-  event.skip_in_browser = true;
-  new InputEventAckNotificationObserver(this, reply_message, event.type);
-  tab_contents->render_view_host()->ForwardKeyboardEvent(event);
+  bool control = !!(modifiers & automation::kControlKeyMask);
+  bool shift = !!(modifiers & automation::kShiftKeyMask);
+  bool alt = !!(modifiers & automation::kAltKeyMask);
+  bool meta = !!(modifiers & automation::kMetaKeyMask);
+  if (!ui_controls::SendKeyPressNotifyWhenDone(
+          window, static_cast<ui::KeyboardCode>(keycode),
+          control, shift, alt, meta,
+          NewRunnableMethod(this,
+              &TestingAutomationProvider::SendSuccessReply, reply_message))) {
+    AutomationJSONReply(this, reply_message)
+        .SendError("Could not send the native key event");
+  }
 }
 
 // Sample JSON input: { "command": "GetNTPThumbnailMode" }
 // For output, refer to GetNTPThumbnailMode() in
 // chrome/test/pyautolib/pyauto.py.
 void TestingAutomationProvider::GetNTPThumbnailMode(
     Browser* browser,
     DictionaryValue* args,
     IPC::Message* reply_message) {
   const int shown_sections = ShownSectionsHandler::GetShownSections(
@@ skipping 567 matching lines @@
     // If you change this, update Observer for NotificationType::SESSION_END
     // below.
     MessageLoop::current()->PostTask(FROM_HERE,
         NewRunnableMethod(this, &TestingAutomationProvider::OnRemoveProvider));
   }
 }
 
 void TestingAutomationProvider::OnRemoveProvider() {
   AutomationProviderList::GetInstance()->RemoveProvider(this);
 }