Deprecating high-conflict accelerators

ash/accelerators/accelerator_controller_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/accelerators/accelerator_controller.h"
 
 #include "ash/accelerators/accelerator_table.h"
 #include "ash/accessibility_delegate.h"
 #include "ash/ash_switches.h"
 #include "ash/display/display_manager.h"
@@ skipping 19 matching lines @@
 #include "ash/wm/wm_event.h"
 #include "base/command_line.h"
 #include "ui/aura/client/aura_constants.h"
 #include "ui/aura/test/test_window_delegate.h"
 #include "ui/aura/test/test_windows.h"
 #include "ui/aura/window.h"
 #include "ui/events/event.h"
 #include "ui/events/event_processor.h"
 #include "ui/events/test/event_generator.h"
 #include "ui/gfx/screen.h"
+#include "ui/message_center/message_center.h"
 #include "ui/views/widget/widget.h"
 
 #if defined(USE_X11)
 #include <X11/Xlib.h>
 #include "ui/events/test/events_test_utils_x11.h"
 #endif
 
 namespace ash {
 
 namespace {
@@ skipping 1351 matching lines @@
     window.reset(CreateTestWindowInShellWithBounds(gfx::Rect(5, 5, 20, 20)));
     wm::ActivateWindow(window.get());
     GetController()->PerformActionIfEnabled(WINDOW_MINIMIZE);
     delegate->TriggerAccessibilityAlert(ui::A11Y_ALERT_NONE);
     GetController()->PerformActionIfEnabled(kActionsNeedingWindow[i]);
     EXPECT_NE(delegate->GetLastAccessibilityAlert(),
               ui::A11Y_ALERT_WINDOW_NEEDED);
   }
 }
 
+namespace {
+
+// defines a class to test the behavior of deprecated accelerators.
+class DeprecatedAcceleratorTester : public AcceleratorControllerTest {
+ public:
+  DeprecatedAcceleratorTester() {}
+  ~DeprecatedAcceleratorTester() override {}
+
+  ui::Accelerator CreateAccelerator(const AcceleratorData& data) const {
+    ui::Accelerator result(data.keycode, data.modifiers);
+    result.set_type(data.trigger_on_press ? ui::ET_KEY_PRESSED
+                                          : ui::ET_KEY_RELEASED);
+    return result;
+  }
+
+  void ResetStateIfNeeded() {
+    Shell* shell = Shell::GetInstance();
+    if (shell->session_state_delegate()->IsScreenLocked() ||
+        shell->session_state_delegate()->IsUserSessionBlocked()) {
+      UnblockUserSession();
+    }
+  }
+
+  bool ContainsDeprecatedAcceleratorNotification() const {
+    return nullptr !=
+           message_center()->FindVisibleNotificationById(
+               kDeprecatedAcceleratorNotificationId);
+  }
+
+  bool IsMessageCenterEmpty() const {
+    return message_center()->GetVisibleNotifications().empty();
+  }
+
+  void RemoveAllNotifications() const {
+    message_center()->RemoveAllNotifications(false);
+  }
+
+  message_center::MessageCenter* message_center() const {
+    return message_center::MessageCenter::Get();
+  }
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(DeprecatedAcceleratorTester);
+};
+
+}  // namespace
+
+TEST_F(DeprecatedAcceleratorTester, TestDeprecatedAcceleratorsBehavior) {
+  for (size_t i = 0; i < kDeprecatedAcceleratorsLength; ++i) {
+    const DeprecatedAcceleratorData& data = kDeprecatedAccelerators[i];
+
+    EXPECT_TRUE(IsMessageCenterEmpty());
+
+    ui::Accelerator deprecated_accelerator =
+        CreateAccelerator(data.deprecated_accelerator);
+    if (data.deprecated_enabled)
+      EXPECT_TRUE(ProcessInController(deprecated_accelerator));
+    else
+      EXPECT_FALSE(ProcessInController(deprecated_accelerator));
+
+    // We expect to see a notification in the message center.
+    EXPECT_TRUE(ContainsDeprecatedAcceleratorNotification());
+    RemoveAllNotifications();
+
+    // If the action is LOCK_SCREEN, we must reset the state by unlocking the
+    // screen before we proceed testing the rest of accelerators.
+    ResetStateIfNeeded();
+  }
+}
+
+TEST_F(DeprecatedAcceleratorTester, TestNewAccelerators) {
+  // Add below the new accelerators that replaced the deprecated ones (if any).
+  const AcceleratorData kNewAccelerators[] = {
+#if defined(OS_CHROMEOS)
+    { true, ui::VKEY_L, ui::EF_COMMAND_DOWN, LOCK_SCREEN },
+    { true, ui::VKEY_ESCAPE, ui::EF_COMMAND_DOWN, SHOW_TASK_MANAGER },
+#endif  // defined(OS_CHROMEOS)
+  };
+
+  EXPECT_TRUE(IsMessageCenterEmpty());
+
+  for (auto data : kNewAccelerators) {
+    EXPECT_TRUE(ProcessInController(CreateAccelerator(data)));
+
+    // Expect no notifications from the new accelerators.
+    EXPECT_TRUE(IsMessageCenterEmpty());
+
+    // If the action is LOCK_SCREEN, we must reset the state by unlocking the
+    // screen before we proceed testing the rest of accelerators.
+    ResetStateIfNeeded();
+  }
+}
+
 }  // namespace ash