Refactor backdrop

ash/wm/workspace/workspace_layout_manager_unittest.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 "ash/wm/workspace/workspace_layout_manager.h"
 
 #include <string>
 #include <utility>
 
+#include "ash/accessibility_delegate.h"
 #include "ash/public/cpp/config.h"
 #include "ash/public/cpp/shell_window_ids.h"
 #include "ash/root_window_controller.h"
 #include "ash/screen_util.h"
 #include "ash/session/session_controller.h"
 #include "ash/shelf/shelf_constants.h"
 #include "ash/shelf/shelf_layout_manager.h"
 #include "ash/shelf/wm_shelf.h"
 #include "ash/shell.h"
 #include "ash/shell_observer.h"
 #include "ash/shell_port.h"
+#include "ash/system/tray/system_tray_notifier.h"
 #include "ash/test/ash_test_base.h"
+#include "ash/test/shell_test_api.h"
+#include "ash/test/test_accessibility_delegate.h"
 #include "ash/test/test_session_controller_client.h"
 #include "ash/test/wm_window_test_api.h"
+#include "ash/test/workspace_controller_test_api.h"
 #include "ash/wm/fullscreen_window_finder.h"
-#include "ash/wm/maximize_mode/workspace_backdrop_delegate.h"
+#include "ash/wm/maximize_mode/maximize_mode_backdrop_delegate_impl.h"
+#include "ash/wm/overview/window_selector_controller.h"
 #include "ash/wm/window_state.h"
 #include "ash/wm/window_state_aura.h"
 #include "ash/wm/window_util.h"
 #include "ash/wm/wm_event.h"
+#include "ash/wm/workspace/backdrop_delegate.h"
 #include "ash/wm/workspace/workspace_window_resizer.h"
 #include "ash/wm_window.h"
 #include "base/command_line.h"
 #include "base/run_loop.h"
+#include "chromeos/audio/chromeos_sounds.h"
 #include "ui/aura/client/aura_constants.h"
 #include "ui/aura/client/focus_client.h"
+#include "ui/aura/test/test_window_delegate.h"
 #include "ui/aura/window.h"
+#include "ui/aura/window_targeter.h"
 #include "ui/base/ui_base_switches.h"
 #include "ui/base/ui_base_types.h"
 #include "ui/compositor/layer_type.h"
 #include "ui/compositor/scoped_animation_duration_scale_mode.h"
 #include "ui/display/display.h"
 #include "ui/display/manager/display_manager.h"
 #include "ui/display/screen.h"
 #include "ui/display/test/display_manager_test_api.h"
+#include "ui/events/base_event_utils.h"
+#include "ui/events/test/event_generator.h"
 #include "ui/gfx/geometry/insets.h"
 #include "ui/views/widget/widget.h"
 #include "ui/views/widget/widget_delegate.h"
 #include "ui/wm/core/window_util.h"
 
 // NOTE: many of these tests use GlobalMinimumSizeLock. This is needed as the
 // tests assume a minimum size of 0x0. In mash the minimum size, for top-level
 // windows, is not 0x0, so without this the tests fails.
 
 namespace ash {
@@ skipping 886 matching lines @@
 
   void SetUp() override {
     AshTestBase::SetUp();
     UpdateDisplay("800x600");
     default_container_ = Shell::GetPrimaryRootWindowController()->GetContainer(
         kShellWindowId_DefaultContainer);
   }
 
   // Turn the top window back drop on / off.
   void ShowTopWindowBackdrop(bool show) {
-    std::unique_ptr<WorkspaceLayoutManagerBackdropDelegate> backdrop;
+    std::unique_ptr<BackdropDelegate> backdrop;
     if (show) {
-      backdrop.reset(
-          new WorkspaceBackdropDelegate(WmWindow::Get(default_container_)));
+      backdrop = base::MakeUnique<MaximizeModeBackdropDelegateImpl>();
     }
     GetWorkspaceLayoutManager(default_container_)
-        ->SetMaximizeBackdropDelegate(std::move(backdrop));
+        ->SetBackdropDelegate(std::move(backdrop));
     // Closing and / or opening can be a delayed operation.
     base::RunLoop().RunUntilIdle();
   }
 
   // Return the default container.
   aura::Window* default_container() { return default_container_; }
 
   // Return the order of windows (top most first) as they are in the default
   // container. If the window is visible it will be a big letter, otherwise a
   // small one. The backdrop will be an X and unknown windows will be shown as
@@ skipping 31 matching lines @@
 }  // namespace
 
 // Check that creating the BackDrop without destroying it does not lead into
 // a crash.
 TEST_F(WorkspaceLayoutManagerBackdropTest, BackdropCrashTest) {
   ShowTopWindowBackdrop(true);
 }
 
 // Verify basic assumptions about the backdrop.
 TEST_F(WorkspaceLayoutManagerBackdropTest, BasicBackdropTests) {
-  // Create a backdrop and see that there is one window (the backdrop) and
-  // that the size is the same as the default container as well as that it is
-  // not visible.
+  // THe background widget will be created when there is a window.

[James Cook, 2017/05/15 21:57:39]

nit: THe -> The

[oshima, 2017/05/16 08:22:09]

Done.

   ShowTopWindowBackdrop(true);
-  ASSERT_EQ(1U, default_container()->children().size());
-  EXPECT_FALSE(default_container()->children()[0]->IsVisible());
+  ASSERT_EQ(0U, default_container()->children().size());

[James Cook, 2017/05/15 21:57:39]

super-nit: 0u

[oshima, 2017/05/16 08:22:09]

Done.

 
   {
     // Add a window and make sure that the backdrop is the second child.
     std::unique_ptr<aura::Window> window(
         CreateTestWindow(gfx::Rect(1, 2, 3, 4)));
     window->Show();
     ASSERT_EQ(2U, default_container()->children().size());
     EXPECT_TRUE(default_container()->children()[0]->IsVisible());
     EXPECT_TRUE(default_container()->children()[1]->IsVisible());
     EXPECT_EQ(window.get(), default_container()->children()[1]);
@@ skipping 66 matching lines @@
 // Tests that when hidding the shelf, that the backdrop stays fullscreen.
 TEST_F(WorkspaceLayoutManagerBackdropTest,
        ShelfVisibilityDoesNotChangesBounds) {
   WmShelf* shelf = GetPrimaryShelf();
   ShelfLayoutManager* shelf_layout_manager = shelf->shelf_layout_manager();
   ShowTopWindowBackdrop(true);
   RunAllPendingInMessageLoop();
   const gfx::Size fullscreen_size =
       display::Screen::GetScreen()->GetPrimaryDisplay().size();
 
+  std::unique_ptr<aura::Window> window(CreateTestWindow(gfx::Rect(1, 2, 3, 4)));
+  window->Show();
+
   ASSERT_EQ(SHELF_VISIBLE, shelf_layout_manager->visibility_state());
+
   EXPECT_EQ(fullscreen_size,
             default_container()->children()[0]->bounds().size());
   shelf->SetAutoHideBehavior(SHELF_AUTO_HIDE_ALWAYS_HIDDEN);
   shelf_layout_manager->UpdateVisibilityState();
 
   // When the shelf is re-shown WorkspaceLayoutManager shrinks all children but
   // the backdrop.
   shelf->SetAutoHideBehavior(SHELF_AUTO_HIDE_BEHAVIOR_NEVER);
   shelf_layout_manager->UpdateVisibilityState();
   EXPECT_EQ(fullscreen_size,
@@ skipping 154 matching lines @@
   // which alters the supplied bounds.
   window->SetBounds(keyboard_bounds());
   wm::GetWindowState(window.get())->set_ignore_keyboard_bounds_change(true);
   wm::ActivateWindow(window.get());
 
   EXPECT_EQ(keyboard_bounds(), window->bounds());
   ShowKeyboard();
   EXPECT_EQ(keyboard_bounds(), window->bounds());
 }
 
+TEST_F(WorkspaceLayoutManagerKeyboardTest, BackdropTest) {

[James Cook, 2017/05/15 21:57:39]

Can you either move the backdrop tests to someplace related to maximize mode
(maximize_mode_window_manager_unittest.cc?) or backdrop (make a new
backdrop_controller_unittest.cc?) or WorkspaceController?

Or if that's too much work, at least document in the class comments for
BackdropController where the tests live.

[oshima, 2017/05/16 08:22:09]

This test already have tests for backdrop, and I'm adding new tests that uses
property key.
I should have grouped them together. moved.

+  WorkspaceController* wc =
+      test::ShellTestApi(Shell::Get()).workspace_controller();
+  test::WorkspaceControllerTestApi test_helper(wc);
+
+  std::unique_ptr<aura::Window> window1(
+      CreateTestWindow(gfx::Rect(0, 0, 100, 100)));
+  window1->SetName("1");
+  window1->Show();
+  std::unique_ptr<aura::Window> window2(
+      CreateTestWindow(gfx::Rect(0, 0, 100, 100)));
+  window2->SetName("2");
+  window2->Show();
+  std::unique_ptr<aura::Window> window3(
+      CreateTestWindow(gfx::Rect(0, 0, 100, 100)));
+  window3->SetName("3");
+  window3->Show();
+  EXPECT_FALSE(test_helper.GetBackdropWindow());
+
+  window2->SetProperty(aura::client::kHasBackdrop, true);
+  aura::Window* backdrop = test_helper.GetBackdropWindow();
+  EXPECT_TRUE(test_helper.GetBackdropWindow());

[James Cook, 2017/05/15 21:57:39]

EXPECT_TRUE(backdrop)

[oshima, 2017/05/16 08:22:09]

Done.

+  {
+    aura::Window::Windows children = window1->parent()->children();
+    EXPECT_EQ(children[0], window1.get());
+    EXPECT_EQ(children[1], backdrop);
+    EXPECT_EQ(children[2], window2.get());
+    EXPECT_EQ(children[3], window3.get());
+  }
+
+  // Setting the property to the one below the backdrop window shouldn't change
+  // the state.
+  window1->SetProperty(aura::client::kHasBackdrop, true);
+  {
+    aura::Window::Windows children = window1->parent()->children();
+    EXPECT_EQ(children[0], window1.get());
+    EXPECT_EQ(children[1], backdrop);
+    EXPECT_EQ(children[2], window2.get());
+    EXPECT_EQ(children[3], window3.get());
+  }
+
+  // Setting the property to the top will move the backdrop up.
+  window3->SetProperty(aura::client::kHasBackdrop, true);
+  {
+    aura::Window::Windows children = window1->parent()->children();
+    EXPECT_EQ(children[0], window1.get());
+    EXPECT_EQ(children[1], window2.get());
+    EXPECT_EQ(children[2], backdrop);
+    EXPECT_EQ(children[3], window3.get());
+  }
+
+  // Claring the property in the middle will not change the backdrop position.

[James Cook, 2017/05/15 21:57:39]

Clearing

[oshima, 2017/05/16 08:22:09]

Done.

+  window2->ClearProperty(aura::client::kHasBackdrop);
+  {
+    aura::Window::Windows children = window1->parent()->children();
+    EXPECT_EQ(children[0], window1.get());
+    EXPECT_EQ(children[1], window2.get());
+    EXPECT_EQ(children[2], backdrop);
+    EXPECT_EQ(children[3], window3.get());
+  }
+
+  // Claring the property on tpo will move the backdrop to bottom.

[James Cook, 2017/05/15 21:57:40]

ditto, and tpo -> top

[oshima, 2017/05/16 08:22:09]

Done.

+  window3->ClearProperty(aura::client::kHasBackdrop);
+  {
+    aura::Window::Windows children = window1->parent()->children();
+    EXPECT_EQ(children[0], backdrop);
+    EXPECT_EQ(children[1], window1.get());
+    EXPECT_EQ(children[2], window2.get());
+    EXPECT_EQ(children[3], window3.get());
+  }
+
+  // Toggle overview

[James Cook, 2017/05/15 21:57:39]

super nit: end with .

[oshima, 2017/05/16 08:22:09]

Done.

+  Shell::Get()->window_selector_controller()->ToggleOverview();
+  RunAllPendingInMessageLoop();
+  EXPECT_FALSE(test_helper.GetBackdropWindow());
+
+  Shell::Get()->window_selector_controller()->ToggleOverview();
+  RunAllPendingInMessageLoop();
+  backdrop = test_helper.GetBackdropWindow();
+  EXPECT_TRUE(backdrop);
+  {
+    aura::Window::Windows children = window1->parent()->children();
+    EXPECT_EQ(children[0], backdrop);
+    EXPECT_EQ(children[1], window1.get());
+    EXPECT_EQ(children[2], window2.get());
+    EXPECT_EQ(children[3], window3.get());
+  }
+
+  wc->SetBackdropDelegate(base::MakeUnique<MaximizeModeBackdropDelegateImpl>());

[James Cook, 2017/05/15 21:57:39]

nit: Comment what you're testing here.

[oshima, 2017/05/16 08:22:09]

Done.

+  {
+    aura::Window::Windows children = window1->parent()->children();
+    EXPECT_EQ(children[0], window1.get());
+    EXPECT_EQ(children[1], window2.get());
+    EXPECT_EQ(children[2], backdrop);
+    EXPECT_EQ(children[3], window3.get());
+  }
+
+  // Toggle overview with the delegate

[James Cook, 2017/05/15 21:57:39]

super nit: end with .

[oshima, 2017/05/16 08:22:09]

Done.

+  Shell::Get()->window_selector_controller()->ToggleOverview();
+  RunAllPendingInMessageLoop();
+  EXPECT_FALSE(test_helper.GetBackdropWindow());
+  Shell::Get()->window_selector_controller()->ToggleOverview();
+  RunAllPendingInMessageLoop();
+  backdrop = test_helper.GetBackdropWindow();
+  {
+    aura::Window::Windows children = window1->parent()->children();
+    EXPECT_EQ(children[0], window1.get());
+    EXPECT_EQ(children[1], window2.get());
+    EXPECT_EQ(children[2], backdrop);
+    EXPECT_EQ(children[3], window3.get());
+  }
+
+  // Removing the delegate will move the backdrop back to window1.
+  std::unique_ptr<BackdropDelegate> no_delegate;
+  wc->SetBackdropDelegate(std::move(no_delegate));
+  {
+    aura::Window::Windows children = window1->parent()->children();
+    EXPECT_EQ(children[0], backdrop);
+    EXPECT_EQ(children[1], window1.get());
+    EXPECT_EQ(children[2], window2.get());
+    EXPECT_EQ(children[3], window3.get());
+  }
+}
+
+TEST_F(WorkspaceLayoutManagerKeyboardTest, SpokenFeedbackFullscreenBackground) {
+  constexpr int kNoSoundKey = -1;
+
+  WorkspaceController* wc =
+      test::ShellTestApi(Shell::Get()).workspace_controller();
+  test::WorkspaceControllerTestApi test_helper(wc);
+  test::TestAccessibilityDelegate* accessibility_delegate =
+      static_cast<test::TestAccessibilityDelegate*>(
+          Shell::Get()->accessibility_delegate());
+
+  aura::test::TestWindowDelegate delegate;
+  std::unique_ptr<aura::Window> window(CreateTestWindowInShellWithDelegate(
+      &delegate, 0, gfx::Rect(0, 0, 100, 100)));
+  window->Show();
+
+  window->SetProperty(aura::client::kHasBackdrop, true);
+  EXPECT_TRUE(test_helper.GetBackdropWindow());
+
+  ui::test::EventGenerator& generator = GetEventGenerator();
+
+  generator.MoveMouseTo(300, 300);
+  generator.ClickLeftButton();
+  EXPECT_EQ(kNoSoundKey, accessibility_delegate->GetPlayedEarconAndReset());
+
+  generator.MoveMouseRelativeTo(window.get(), 10, 10);
+  generator.ClickLeftButton();
+  EXPECT_EQ(kNoSoundKey, accessibility_delegate->GetPlayedEarconAndReset());
+
+  // Enable spoken feedback.
+  Shell::Get()->accessibility_delegate()->ToggleSpokenFeedback(
+      ash::A11Y_NOTIFICATION_NONE);
+  Shell::Get()->system_tray_notifier()->NotifyAccessibilityModeChanged(
+      ash::A11Y_NOTIFICATION_NONE);
+  EXPECT_TRUE(
+      Shell::Get()->accessibility_delegate()->IsSpokenFeedbackEnabled());
+
+  generator.MoveMouseTo(300, 300);
+  generator.ClickLeftButton();
+  EXPECT_EQ(chromeos::SOUND_VOLUME_ADJUST,
+            accessibility_delegate->GetPlayedEarconAndReset());
+
+  generator.MoveMouseRelativeTo(window.get(), 10, 10);
+  generator.ClickLeftButton();
+  EXPECT_EQ(kNoSoundKey, accessibility_delegate->GetPlayedEarconAndReset());
+
+  // Disable spoken feedback. Shadow underlay is restored.
+  Shell::Get()->accessibility_delegate()->ToggleSpokenFeedback(
+      A11Y_NOTIFICATION_NONE);
+  Shell::Get()->system_tray_notifier()->NotifyAccessibilityModeChanged(
+      A11Y_NOTIFICATION_NONE);
+  EXPECT_FALSE(
+      Shell::Get()->accessibility_delegate()->IsSpokenFeedbackEnabled());
+
+  generator.MoveMouseTo(300, 300);
+  generator.ClickLeftButton();
+  EXPECT_EQ(kNoSoundKey, accessibility_delegate->GetPlayedEarconAndReset());
+
+  generator.MoveMouseTo(70, 70);
+  generator.ClickLeftButton();
+  EXPECT_EQ(kNoSoundKey, accessibility_delegate->GetPlayedEarconAndReset());
+}

[James Cook, 2017/05/15 21:57:39]

Thanks for adding the test coverage!

+
 }  // namespace ash