Add a test for the mouseleave event on window.

chrome/browser/mouseleave_browsertest.cc

 // Copyright (c) 2012 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 "base/files/file_path.h"
 #include "base/strings/utf_string_conversions.h"
+#include "chrome/app/chrome_command_ids.h"
+#include "chrome/browser/chrome_notification_types.h"
+#include "chrome/browser/renderer_context_menu/render_view_context_menu.h"
+#include "chrome/browser/renderer_context_menu/render_view_context_menu_browsertest_util.h"
 #include "chrome/browser/ui/browser.h"
+#include "chrome/browser/ui/browser_commands.h"
+#include "chrome/browser/ui/browser_finder.h"
 #include "chrome/browser/ui/browser_window.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 "components/app_modal/app_modal_dialog.h"
+#include "content/public/browser/render_frame_host.h"
+#include "content/public/browser/render_view_host.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/test/browser_test_utils.h"
+#include "content/public/test/test_navigation_observer.h"
 #include "ui/base/test/ui_controls.h"
 
 namespace {
 
 class MouseLeaveTest : public InProcessBrowserTest {
  public:
   MouseLeaveTest() {}
 
-  void MouseLeaveTestCommon() {
-    GURL test_url = ui_test_utils::GetTestUrl(
-        base::FilePath(), base::FilePath(FILE_PATH_LITERAL("mouseleave.html")));
-
-    content::WebContents* tab =
-        browser()->tab_strip_model()->GetActiveWebContents();
+  void NavigateAndLoadContent(content::WebContents* tab, GURL& url) {
     gfx::Rect tab_view_bounds = tab->GetContainerBounds();
 
-    gfx::Point in_content_point(
-        tab_view_bounds.x() + tab_view_bounds.width() / 2,
-        tab_view_bounds.y() + 10);
-    gfx::Point above_content_point(
-        tab_view_bounds.x() + tab_view_bounds.width() / 2,
-        tab_view_bounds.y() - 2);
+    in_content_ = gfx::Point(tab_view_bounds.x() + tab_view_bounds.width() / 2,
+                             tab_view_bounds.y() + 10);
+    above_content_ =
+        gfx::Point(tab_view_bounds.x() + tab_view_bounds.width() / 2,
+                   tab_view_bounds.y() - 2);
 
-    // Start by moving the point just above the content.
-    ui_controls::SendMouseMove(above_content_point.x(),
-                               above_content_point.y());
+    ui_controls::SendMouseMove(above_content_.x(), above_content_.y());
 
     // Navigate to the test html page.
     base::string16 load_expected_title(base::ASCIIToUTF16("onload"));
     content::TitleWatcher load_title_watcher(tab, load_expected_title);
-    ui_test_utils::NavigateToURL(browser(), test_url);
+    ui_test_utils::NavigateToURL(browser(), url);
     // Wait for the onload() handler to complete so we can do the
     // next part of the test.
     EXPECT_EQ(load_expected_title, load_title_watcher.WaitAndGetTitle());
 
-    // Move the cursor to the top-center of the content, which will trigger
-    // a javascript onMouseOver event.
-    ui_controls::SendMouseMove(in_content_point.x(), in_content_point.y());
+    // Move the cursor to the top-center of the content which will trigger
+    // a javascript event.
+    ui_controls::SendMouseMove(in_content_.x(), in_content_.y());
 
     // Wait on the correct intermediate title.
     base::string16 entered_expected_title(base::ASCIIToUTF16("entered"));
     content::TitleWatcher entered_title_watcher(tab, entered_expected_title);
     EXPECT_EQ(entered_expected_title, entered_title_watcher.WaitAndGetTitle());
+  }
+
+  void MouseLeaveTestCommon() {
+    content::WebContents* tab =
+        browser()->tab_strip_model()->GetActiveWebContents();
+    GURL test_url = ui_test_utils::GetTestUrl(
+        base::FilePath(), base::FilePath(FILE_PATH_LITERAL("mouseleave.html")));
+
+    NavigateAndLoadContent(tab, test_url);
 
     // Move the cursor above the content again, which should trigger
     // a javascript onMouseOut event.
-    ui_controls::SendMouseMove(above_content_point.x(),
-                               above_content_point.y());
+    ui_controls::SendMouseMove(above_content().x(), above_content().y());
 
     // Wait on the correct final value of the cookie.
     base::string16 left_expected_title(base::ASCIIToUTF16("left"));
     content::TitleWatcher left_title_watcher(tab, left_expected_title);
     EXPECT_EQ(left_expected_title, left_title_watcher.WaitAndGetTitle());
   }
 
+  gfx::Point in_content() { return in_content_; }
+
+  gfx::Point above_content() { return above_content_; }
+
+ private:
+  gfx::Point in_content_;
+  gfx::Point above_content_;
+
   DISALLOW_COPY_AND_ASSIGN(MouseLeaveTest);
 };
 
 #if defined(OS_MACOSX) || defined(OS_LINUX) || defined(OS_WIN)
 // OS_MACOSX: Missing automation provider support: http://crbug.com/45892.
 // OS_LINUX: http://crbug.com/133361.
 // OS_WIN: http://crbug.com/419468
 #define MAYBE_TestOnMouseOut DISABLED_TestOnMouseOut
 #else
 #define MAYBE_TestOnMouseOut TestOnMouseOut
 #endif
 
 IN_PROC_BROWSER_TEST_F(MouseLeaveTest, MAYBE_TestOnMouseOut) {
   MouseLeaveTestCommon();
 }
 
 #if defined(OS_WIN)
 // For MAC: Missing automation provider support: http://crbug.com/45892
 // For linux : http://crbug.com/133361. interactive mouse tests are flaky.
 IN_PROC_BROWSER_TEST_F(MouseLeaveTest, MouseDownOnBrowserCaption) {
   gfx::Rect browser_bounds = browser()->window()->GetBounds();
   ui_controls::SendMouseMove(browser_bounds.x() + 200,
                              browser_bounds.y() + 10);
   ui_controls::SendMouseClick(ui_controls::LEFT);
 
   MouseLeaveTestCommon();
 }
 #endif
 
+#if defined(OS_WIN)
+// This test is for preventing a regression that the mouseleave is triggered
+// on Window when opening the new window.
+#define MAYBE_NewWindow NewWindow
+#else

[pkotwicz, 2015/02/04 19:43:31]

Can you add comments as to why the test is disabled on Mac, Desktop Linux and
ChromeOS?

[Miyoung Shin, 2015/02/08 14:29:04]

I've added the comment at patchset3

+#define MAYBE_NewWindow DISABLED_NewWindow
+#endif
+
+IN_PROC_BROWSER_TEST_F(MouseLeaveTest, MAYBE_NewWindow) {
+  content::WebContents* tab =
+      browser()->tab_strip_model()->GetActiveWebContents();
+  GURL test_url = ui_test_utils::GetTestUrl(
+      base::FilePath(), base::FilePath(FILE_PATH_LITERAL("mouseleave.html")));
+
+  NavigateAndLoadContent(tab, test_url);
+
+  // Create an new window.
+  ui_test_utils::BrowserAddedObserver browser_added_observer;
+  chrome::NewWindow(browser());
+  Browser* new_browser = browser_added_observer.WaitForSingleNewBrowser();
+
+  ASSERT_EQ(2u, chrome::GetTotalBrowserCount());
+
+  // Close the second window.

[pkotwicz, 2015/02/04 19:43:31]

Is there a reason that you are closing the browser window?

[Miyoung Shin, 2015/02/08 14:29:04]

I removed it.
I thought that I should close the browser window to finish completely the
testbut it's not necessary. 

+  content::WindowedNotificationObserver browser_closed_observer(
+      chrome::NOTIFICATION_BROWSER_CLOSED,
+      content::NotificationService::AllSources());
+  chrome::CloseWindow(new_browser);
+  browser_closed_observer.Wait();
+
+  ASSERT_EQ(1u, chrome::GetTotalBrowserCount());
+
+  tab->GetMainFrame()->ExecuteJavaScript(base::ASCIIToUTF16("done()"));
+  base::string16 done_expected_title(base::ASCIIToUTF16("with mouseleave"));
+  content::TitleWatcher done_title_watcher(tab, done_expected_title);
+  EXPECT_EQ(done_expected_title, done_title_watcher.WaitAndGetTitle());
+}
+
+#if defined(OS_WIN) || defined(OS_MACOSX)
+// This test is for preventing a regression that a mouseleave is triggered
+// when showing the context menu.

[pkotwicz, 2015/02/04 19:43:31]

Can you please link to crbug.com/450138 for an example of such a regression?

[Miyoung Shin, 2015/02/08 14:29:04]

Done

+// OS_WIN : http://crbug.com/450138
+// OS_MACOSX: Missing automation provider support: http://crbug.com/45892.
+#define MAYBE_ContextMenu DISABLED_ContextMenu
+#else
+#define MAYBE_ContextMenu ContextMenu
+#endif
+
+IN_PROC_BROWSER_TEST_F(MouseLeaveTest, MAYBE_ContextMenu) {
+  content::WebContents* tab =
+      browser()->tab_strip_model()->GetActiveWebContents();
+  GURL test_url = ui_test_utils::GetTestUrl(
+      base::FilePath(), base::FilePath(FILE_PATH_LITERAL("mouseleave.html")));
+
+  NavigateAndLoadContent(tab, test_url);
+
+  // Wait until guest sees a context menu, select an arbitrary item (copy).
+  ContextMenuNotificationObserver context_menu_observer(
+      IDC_CONTENT_CONTEXT_COPYLINKLOCATION);

[pkotwicz, 2015/02/04 19:43:31]

I think that if you use SaveLinkAsContextMenuObserver,
SaveLinkAsContextMenuObserver::WaitForMenu() will block till the menu is opened.
I think that it will wait long enough that any ET_MOUSE_EXITED events sent as a
result of the menu showing will have been dispatched to Blink.

I think that SaveLinkAsContextMenuObserver::WaitForMenu() automatically closes
the menu when the menu is opened so you don't need to worry about sending a
mouse click to hide the menu. SaveLinkAsContextMenuObserver::WaitForMenu()
automatically closing the menu when the menu is opened is a good thing. (If it
didn't SaveLinkAsContextMenuObserver::WaitForMenu() would block forever)

It is probably worth creating a new base class for SaveLinkAsContextMenuObserver
and using it here.

[Miyoung Shin, 2015/02/08 14:29:04]

thank you for your suggestion. I changed to use SaveLinkAsContextMenuObserver
and it works well.

+
+  ui_controls::SendMouseClick(ui_controls::RIGHT);
+  base::string16 show_expected_title(base::ASCIIToUTF16("showed"));
+  content::TitleWatcher show_title_watcher(tab, show_expected_title);
+  EXPECT_EQ(show_expected_title, show_title_watcher.WaitAndGetTitle());
+
+  ui_controls::SendMouseClick(ui_controls::LEFT);
+  tab->GetMainFrame()->ExecuteJavaScript(base::ASCIIToUTF16("done()"));
+  base::string16 done_expected_title(base::ASCIIToUTF16("without mouseleave"));
+  content::TitleWatcher done_title_watcher(tab, done_expected_title);

[pkotwicz, 2015/02/04 19:43:31]

Will the test timeout if a ET_MOUSE_EXITED event is sent?

[Miyoung Shin, 2015/02/08 14:29:04]

Yes, the test is timeout.

[pkotwicz, 2015/02/10 22:50:14]

It is hard to tell for a sheriff whether a test times out due to a regression or
due to flakiness. I think that you can use TitleWatcher::AlsoWaitForTitle() to
make TitleWatcher::WaitAndGetTitle() stop waiting if the title is set to "with
mouseleave" (the failure case)

[Miyoung Shin, 2015/02/12 14:23:26]

Thank your for your good information. I added AlsoWaitForTitle for the failure
case

+  EXPECT_EQ(done_expected_title, done_title_watcher.WaitAndGetTitle());
+}
+
+#if defined(OS_WIN) || defined(OS_MACOSX)

[pkotwicz, 2015/02/04 19:43:31]

Can you reference crbug.com/394672 for an example of such a regression?

[Miyoung Shin, 2015/02/08 14:29:04]

I changed it. If I didn't catch your point from the reference, please let me
know.

[pkotwicz, 2015/02/10 22:50:14]

I was suggesting changing the comment to something like this:
"Test that a mouseleave is not triggered when showing a modal dialog. Sample
regression: crbug.com/394672"

The reason that I want to include a sample regression is because:
- The reason why the test exists is clear
- Testing for something not occurring is weird

You don't need to do something similar for MouseLeaveTest.MAYBE_ContextMenu
because the regression has not yet been fixed

[Miyoung Shin, 2015/02/12 14:23:26]

Done

+// This test is for preventing a regression that a mouseleave is triggered
+// when showing the modal dialog.
+// OS_WIN : http://crbug.com/450138
+// OS_MACOSX: Missing automation provider support: http://crbug.com/45892.
+#define MAYBE_ModalDialog DISABLED_ModalDialog
+#else
+#define MAYBE_ModalDialog ModalDialog
+#endif
+
+IN_PROC_BROWSER_TEST_F(MouseLeaveTest, MAYBE_ModalDialog) {
+  content::WebContents* tab =
+      browser()->tab_strip_model()->GetActiveWebContents();
+  GURL test_url = ui_test_utils::GetTestUrl(
+      base::FilePath(), base::FilePath(FILE_PATH_LITERAL("mouseleave.html")));
+
+  NavigateAndLoadContent(tab, test_url);
+
+  tab->GetMainFrame()->ExecuteJavaScript(base::UTF8ToUTF16("alert()"));
+  // Cancel the dialog.
+  app_modal::AppModalDialog* alert = ui_test_utils::WaitForAppModalDialog();
+  alert->CloseModalDialog();

[pkotwicz, 2015/02/04 19:43:31]

Can you call content::RunAllPendingInMessageLoop() here for sanity. This way if
there is a task which dispatches an ET_MOUSE_EXITED event it will get run. For
instance, WindowEventDispatcher::OnOtherRootGotCapture() sends a ET_MOUSE_EXITED
event in a task

(I would do this for the other two tests too)

[Miyoung Shin, 2015/02/08 14:29:04]

Done

+
+  tab->GetMainFrame()->ExecuteJavaScript(base::ASCIIToUTF16("done()"));
+  base::string16 done_expected_title(base::ASCIIToUTF16("without mouseleave"));
+  content::TitleWatcher done_title_watcher(tab, done_expected_title);
+  EXPECT_EQ(done_expected_title, done_title_watcher.WaitAndGetTitle());
+}
+
 }  // namespace