Implement drag and drop testing in a platform independent way.

chrome/browser/ui/panels/panel_browsertest.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 "base/command_line.h"
 #include "chrome/browser/download/download_manager.h"
 #include "chrome/browser/extensions/extension_service.h"
 #include "chrome/browser/prefs/pref_service.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_list.h"
 #include "chrome/browser/ui/browser_window.h"
 #include "chrome/browser/ui/find_bar/find_bar.h"
 #include "chrome/browser/ui/find_bar/find_bar_controller.h"
+#include "chrome/browser/ui/panels/native_panel.h"
 #include "chrome/browser/ui/panels/panel.h"
 #include "chrome/browser/ui/panels/panel_manager.h"
 #include "chrome/browser/ui/tab_contents/tab_contents_wrapper.h"
 #include "chrome/browser/web_applications/web_app.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/extensions/extension.h"
 #include "chrome/common/pref_names.h"
 #include "chrome/test/base/in_process_browser_test.h"
 #include "chrome/test/base/ui_test_utils.h"
@@ skipping 24 matching lines @@
                                                    bounds,
                                                    browser()->profile());
     EXPECT_TRUE(panel_browser->is_type_panel());
 
     TabContentsWrapper* tab_contents =
         new TabContentsWrapper(new TestTabContents(browser()->profile(), NULL));
     panel_browser->AddTab(tab_contents, PageTransition::LINK);
 
     Panel* panel = static_cast<Panel*>(panel_browser->window());
     panel->Show();
+    MessageLoopForUI::current()->RunAllPending();
+
     return panel;
   }
 
   // Creates a testing extension.
   scoped_refptr<Extension> CreateExtension(const FilePath::StringType& path) {
 #if defined(OS_WIN)
     FilePath full_path(FILE_PATH_LITERAL("c:\\"));
 #else
     FilePath full_path(FILE_PATH_LITERAL("/"));
 #endif
@@ skipping 74 matching lines @@
         web_app::GenerateApplicationNameFromExtensionId(extension3->id()),
         gfx::Rect(0, 0, 500, 200));
     signal3.Wait();
     signal4.Wait();
     ASSERT_EQ(2, panel_manager->num_panels());
     EXPECT_LT(panel6->GetBounds().right(), panel1->GetBounds().x());
 
     panel1->Close();
     panel6->Close();
   }
+
+  struct DragTestData {
+    DragTestData(int drag_delta_x,
+                 int drag_delta_y,
+                 bool is_big_delta,
+                 bool should_cancel_drag)
+        : drag_delta_x(drag_delta_x), drag_delta_y(drag_delta_y),
+          is_big_delta(is_big_delta), should_cancel_drag(should_cancel_drag) {}
+    int drag_delta_x;
+    int drag_delta_y;
+    bool is_big_delta;  // Drag big enough to cause shuffling.
+    bool should_cancel_drag;
+  };
+
+  void TestDragging(std::vector<Panel*>* panels,
+                    const DragTestData& drag_test_data) {
+    // Test dragging each panel in the list.
+    for (size_t drag_index = 0; drag_index < panels->size(); ++drag_index) {
+      std::vector<int> expected_delta_x_after_drag;
+      std::vector<int> expected_delta_x_after_finish;
+
+      for (size_t j = 0; j < panels->size(); ++j) {

[jianli, 2011/08/11 20:52:09]

Probably more efficient to say:
  size_t num_panels = panels->size();
  for (...) {
    std::vector<int> expected_delta_x_after_drag(num_panels, 0);
    std::vector<int> expected_delta_x_after_finish(num_panels, 0);

[prasadt, 2011/08/11 21:07:56]

Done.

+        expected_delta_x_after_drag.push_back(0);
+        expected_delta_x_after_finish.push_back(0);
+      }
+
+      expected_delta_x_after_drag[drag_index] = drag_test_data.drag_delta_x;
+      size_t swap_index = drag_index;
+      if (drag_test_data.is_big_delta) {
+        if (drag_test_data.drag_delta_x > 0 && drag_index != 0) {
+          // Dragged to right.
+          swap_index = drag_index - 1;
+        } else if (drag_test_data.drag_delta_x < 0 &&
+            drag_index != panels->size() - 1) {
+          // Dragged to left.
+          swap_index = drag_index + 1;
+        }
+      }
+      if (swap_index != drag_index) {
+        expected_delta_x_after_drag[swap_index] =
+            (*panels)[drag_index]->GetRestoredBounds().x() -
+            (*panels)[swap_index]->GetRestoredBounds().x();
+        expected_delta_x_after_finish[swap_index] =
+            expected_delta_x_after_drag[swap_index];
+        expected_delta_x_after_finish[drag_index] =
+            -expected_delta_x_after_drag[swap_index];
+      }
+      ValidateDragging(*panels, drag_index, drag_test_data.drag_delta_x,
+          drag_test_data.drag_delta_y, expected_delta_x_after_drag,
+          expected_delta_x_after_finish, drag_test_data.should_cancel_drag);
+
+      if (swap_index != drag_index && !drag_test_data.should_cancel_drag) {
+        // Swap the panels in the vector so they reflect their true relative
+        // positions.
+        Panel* tmp_panel = (*panels)[swap_index];
+        (*panels)[swap_index] = (*panels)[drag_index];
+        (*panels)[drag_index] = tmp_panel;
+      }
+    }
+  }
+
+  void ValidateDragging(const std::vector<Panel*>& panels,
+                        int index_to_drag,
+                        int delta_x,
+                        int delta_y,
+                        const std::vector<int>& expected_delta_x_after_drag,
+                        const std::vector<int>& expected_delta_x_after_finish,
+                        bool should_cancel_drag) {
+    // Keep track of the initial bounds for comparison.
+    std::vector<gfx::Rect> initial_bounds(panels.size());
+    for (size_t i = 0; i < panels.size(); ++i)
+      initial_bounds[i] = panels[i]->GetRestoredBounds();
+
+    // Trigger the mouse-pressed event.
+    // All panels should remain in their original positions.
+    NativePanel* panel_to_drag = panels[index_to_drag]->native_panel();
+    NativePanelTesting* panel_testing_to_drag =
+        NativePanelTesting::Create(panel_to_drag);
+    gfx::Point button_press_point(initial_bounds[index_to_drag].x(),
+                                  initial_bounds[index_to_drag].y());
+    panel_testing_to_drag->PressLeftMouseButtonTitlebar(button_press_point);
+    for (size_t i = 0; i < panels.size(); ++i)
+      EXPECT_EQ(initial_bounds[i], panels[i]->GetRestoredBounds());
+
+    if (delta_x || delta_y) {

[jianli, 2011/08/11 20:52:09]

We can remove this if test since we do not have this test case.

[prasadt, 2011/08/11 21:07:56]

Done.

+      // Trigger the drag.
+      panel_testing_to_drag->DragTitlebar(delta_x, delta_y);
+
+      for (size_t i = 0; i < panels.size(); ++i) {
+        gfx::Rect expected_bounds = initial_bounds[i];
+        expected_bounds.Offset(expected_delta_x_after_drag[i], 0);
+        EXPECT_EQ(expected_bounds, panels[i]->GetRestoredBounds());
+      }
+    }
+
+    // Cancel the dragging if asked.

[jianli, 2011/08/11 20:52:09]

To be consistent with other comment: dragging => drag

[prasadt, 2011/08/11 21:07:56]

Done.

+    // All panels should stay in their original positions.
+    if (should_cancel_drag) {
+      panel_testing_to_drag->CancelDragTitlebar();
+      for (size_t i = 0; i < panels.size(); ++i)
+        EXPECT_EQ(initial_bounds[i], panels[i]->GetRestoredBounds());
+      return;
+    }
+
+    // Otherwise finish the drag.
+    panel_testing_to_drag->FinishDragTitlebar();
+    for (size_t i = 0; i < panels.size(); ++i) {
+      gfx::Rect expected_bounds = initial_bounds[i];
+      expected_bounds.Offset(expected_delta_x_after_finish[i], 0);
+      EXPECT_EQ(expected_bounds, panels[i]->GetRestoredBounds());
+    }
+    delete panel_testing_to_drag;

[jianli, 2011/08/11 20:52:09]

Better to use scoped_ptr, instead of self-deleting.

[prasadt, 2011/08/11 21:07:56]

Done.

+  }
 };
 
 IN_PROC_BROWSER_TEST_F(PanelBrowserTest, CreatePanel) {
   PanelManager* panel_manager = PanelManager::GetInstance();
   EXPECT_EQ(0, panel_manager->num_panels()); // No panels initially.
 
   Panel* panel = CreatePanel("PanelTest", gfx::Rect());
   EXPECT_EQ(1, panel_manager->num_panels());
 
   gfx::Rect bounds = panel->GetBounds();
@@ skipping 18 matching lines @@
 #ifdef OS_MACOSX
 #define MAYBE_CreatePanelOnOverflow DISABLED_CreatePanelOnOverflow
 #else
 #define MAYBE_CreatePanelOnOverflow CreatePanelOnOverflow
 #endif
 
 IN_PROC_BROWSER_TEST_F(PanelBrowserTest, MAYBE_CreatePanelOnOverflow) {
   TestCreatePanelOnOverflow();
 }
 
+#ifdef OS_MACOSX
+#define MAYBE_DragPanels DISABLED_DragPanels
+#else
+#define MAYBE_DragPanels DragPanels
+#endif
+
+IN_PROC_BROWSER_TEST_F(PanelBrowserTest, MAYBE_DragPanels) {
+  std::vector<Panel*> panels;
+  panels.push_back(CreatePanel("PanelTest0", gfx::Rect()));
+
+  int small_delta = 5;
+  int big_delta = panels[0]->GetRestoredBounds().width() * 0.5 + 5;
+
+  // Setup test data.
+  // Template - DragTestData(delta_x, delta_y, is_big_delta, should_cancel_drag)
+  std::vector<DragTestData> drag_test_data;
+  drag_test_data.push_back(DragTestData(
+      small_delta, small_delta, false, false));
+  drag_test_data.push_back(DragTestData(
+      -small_delta, -small_delta, false, false));
+  drag_test_data.push_back(DragTestData(big_delta, big_delta, true, false));
+  drag_test_data.push_back(DragTestData(big_delta, small_delta, true, false));
+  drag_test_data.push_back(DragTestData(-big_delta, -big_delta, true, false));
+  drag_test_data.push_back(DragTestData(-big_delta, 0, true, false));
+  drag_test_data.push_back(DragTestData(big_delta, big_delta, true, true));
+  drag_test_data.push_back(DragTestData(-big_delta, -big_delta, true, true));
+
+  for (int num_panels = 1; num_panels <= 3; ++num_panels) {
+    if (num_panels > 1)
+      panels.push_back(CreatePanel("PanelTest", gfx::Rect()));
+    for (size_t j = 0; j < drag_test_data.size(); ++j) {
+      // Test for each combination of drag test data and number of panels.
+      TestDragging(&panels, drag_test_data[j]);
+    }
+  }
+
+  for (size_t i = 0; i < panels.size(); ++i)
+    panels[i]->Close();
+}
+
 class PanelDownloadTest : public PanelBrowserTest {
  public:
   PanelDownloadTest() : PanelBrowserTest() { }
 
   // Creates a temporary directory for downloads that is auto-deleted
   // on destruction.
   bool CreateDownloadDirectory(Profile* profile) {
     bool created = downloads_directory_.CreateUniqueTempDir();
     if (!created)
       return false;
@@ skipping 144 matching lines @@
   EXPECT_EQ(1, tabbed_browser->tab_count());
   ASSERT_TRUE(tabbed_browser->window()->IsDownloadShelfVisible());
   tabbed_browser->CloseWindow();
 #endif
 
   EXPECT_EQ(1, panel_browser->tab_count());
   ASSERT_FALSE(panel_browser->window()->IsDownloadShelfVisible());
 
   panel_browser->CloseWindow();
 }