Introduce ash mojo interface for lock screen action handlers

chrome/browser/chromeos/lock_screen_apps/state_controller_unittest.cc

 // Copyright 2017 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 <memory>
+#include <utility>
+#include <vector>
 
+#include "ash/public/interfaces/tray_action_handler.mojom.h"
 #include "base/memory/ptr_util.h"
+#include "base/run_loop.h"
 #include "base/test/scoped_command_line.h"
 #include "chrome/browser/chromeos/lock_screen_apps/state_controller.h"
 #include "chrome/browser/chromeos/lock_screen_apps/state_observer.h"
-#include "chrome/browser/chromeos/lock_screen_apps/types.h"
+#include "content/public/test/test_browser_thread_bundle.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
+using ash::mojom::TrayActionState;
+
 namespace {
 
-const lock_screen_apps::Action kTestAction = lock_screen_apps::Action::kNewNote;
-
 class TestStateObserver : public lock_screen_apps::StateObserver {
  public:
   TestStateObserver() = default;
   ~TestStateObserver() override = default;
 
-  void OnLockScreenAppsStateChanged(
-      lock_screen_apps::Action action,
-      lock_screen_apps::ActionState state) override {
-    ASSERT_EQ(kTestAction, action);
-
-    ++state_change_count_;
+  void OnLockScreenNoteStateChanged(TrayActionState state) override {
+    observed_states_.push_back(state);
   }
 
-  int state_change_count() const { return state_change_count_; }
+  const std::vector<TrayActionState> observed_states() const {
+    return observed_states_;
+  }
+
+  void clear_observed_states() { observed_states_.clear(); }
 
  private:
-  int state_change_count_ = 0;
+  std::vector<TrayActionState> observed_states_;
 
   DISALLOW_COPY_AND_ASSIGN(TestStateObserver);
 };
 
-class LockScreenAppStateControllerNotSupportedTest : public testing::Test {
+class TestTrayAction : public ash::mojom::TrayAction {
  public:
-  LockScreenAppStateControllerNotSupportedTest() = default;
+  TestTrayAction() : binding_(this) {}
 
-  ~LockScreenAppStateControllerNotSupportedTest() override = default;
+  ~TestTrayAction() override = default;
+
+  ash::mojom::TrayActionPtr CreateInterfacePtrAndBind() {
+    return binding_.CreateInterfacePtrAndBind();
+  }
+
+  void SetClient(ash::mojom::TrayActionClientPtr client,
+                 TrayActionState state) override {
+    client_ = std::move(client);
+    EXPECT_EQ(TrayActionState::kNotSupported, state);
+  }
+
+  void UpdateLockScreenNoteState(TrayActionState state) override {
+    observed_states_.push_back(state);
+  }
+
+  void SendNewNoteRequest() {
+    ASSERT_TRUE(client_);
+    client_->RequestNewLockScreenNote();
+  }
+
+  const std::vector<TrayActionState>& observed_states() const {
+    return observed_states_;
+  }
+
+  void clear_observed_states() { observed_states_.clear(); }

[James Cook, 2017/05/05 02:55:45]

ClearObservedStates

[tbarzic, 2017/05/05 04:46:27]

Done.

+
+ private:
+  mojo::Binding<ash::mojom::TrayAction> binding_;
+  ash::mojom::TrayActionClientPtr client_;
+
+  std::vector<TrayActionState> observed_states_;
+
+  DISALLOW_COPY_AND_ASSIGN(TestTrayAction);
+};
+
+class LockScreenAppStateNotSupportedTest : public testing::Test {
+ public:
+  LockScreenAppStateNotSupportedTest() = default;
+
+  ~LockScreenAppStateNotSupportedTest() override = default;
 
   void SetUp() override {
     command_line_ = base::MakeUnique<base::test::ScopedCommandLine>();
     command_line_->GetProcessCommandLine()->InitFromArgv({""});
   }
 
  private:
   std::unique_ptr<base::test::ScopedCommandLine> command_line_;
 
-  DISALLOW_COPY_AND_ASSIGN(LockScreenAppStateControllerNotSupportedTest);
+  DISALLOW_COPY_AND_ASSIGN(LockScreenAppStateNotSupportedTest);
 };
 
-class LockScreenAppStateControllerTest : public testing::Test {
+class LockScreenAppStateTest : public testing::Test {
  public:
-  LockScreenAppStateControllerTest() = default;
-  ~LockScreenAppStateControllerTest() override = default;
+  LockScreenAppStateTest() = default;
+  ~LockScreenAppStateTest() override = default;
 
   void SetUp() override {
     command_line_ = base::MakeUnique<base::test::ScopedCommandLine>();
     command_line_->GetProcessCommandLine()->InitFromArgv(
         {"", "--enable-lock-screen-apps"});
 
-    state_controller_ = lock_screen_apps::StateController::Get();
-    ASSERT_TRUE(state_controller_);
-
+    ASSERT_TRUE(lock_screen_apps::StateController::IsEnabled());
+    ash::mojom::TrayActionPtr action_controller_interface =
+        tray_action_.CreateInterfacePtrAndBind();
+    state_controller_ = lock_screen_apps::StateController::CreateForTesting(
+        std::move(action_controller_interface));
     state_controller_->AddObserver(&observer_);
   }
 
-  void TearDown() override { state_controller_->RemoveObserver(&observer_); }
+  void TearDown() override {
+    state_controller_->RemoveObserver(&observer_);
+    state_controller_.reset();
+  }
 
-  const TestStateObserver& observer() const { return observer_; }
+  TestStateObserver* observer() { return &observer_; }
+
+  TestTrayAction* tray_action() { return &tray_action_; }
 
   lock_screen_apps::StateController* state_controller() {
-    return state_controller_;
+    return state_controller_.get();
   }
 
  private:
   std::unique_ptr<base::test::ScopedCommandLine> command_line_;
+  content::TestBrowserThreadBundle threads_;
 
-  lock_screen_apps::StateController* state_controller_;
+  std::unique_ptr<lock_screen_apps::StateController> state_controller_;
   TestStateObserver observer_;
+  TestTrayAction tray_action_;
 
-  DISALLOW_COPY_AND_ASSIGN(LockScreenAppStateControllerTest);
+  DISALLOW_COPY_AND_ASSIGN(LockScreenAppStateTest);
 };
 
 }  // namespace
 
-TEST_F(LockScreenAppStateControllerNotSupportedTest, NoControllerInstance) {
-  EXPECT_FALSE(lock_screen_apps::StateController::Get());
+TEST_F(LockScreenAppStateNotSupportedTest, NoInstance) {
+  EXPECT_FALSE(lock_screen_apps::StateController::IsEnabled());
 }
 
-TEST_F(LockScreenAppStateControllerTest, InitialState) {
-  EXPECT_EQ(lock_screen_apps::ActionState::kNotSupported,
-            state_controller()->GetActionState(kTestAction));
-
-  ASSERT_EQ(0, observer().state_change_count());
+TEST_F(LockScreenAppStateTest, InitialState) {
+  EXPECT_EQ(TrayActionState::kNotSupported,
+            state_controller()->GetLockScreenNoteState());
 
   state_controller()->MoveToBackground();
 
-  EXPECT_EQ(lock_screen_apps::ActionState::kNotSupported,
-            state_controller()->GetActionState(kTestAction));
+  EXPECT_EQ(TrayActionState::kNotSupported,
+            state_controller()->GetLockScreenNoteState());
 
-  ASSERT_EQ(0, observer().state_change_count());
+  ASSERT_EQ(0u, observer()->observed_states().size());

[James Cook, 2017/05/05 02:55:45]

EXPECT_EQ

[tbarzic, 2017/05/05 04:46:27]

Done.

+  ASSERT_EQ(0u, tray_action()->observed_states().size());
 }
 
-TEST_F(LockScreenAppStateControllerTest, HandleActionWhenNotAvaiable) {
-  ASSERT_EQ(lock_screen_apps::ActionState::kNotSupported,
-            state_controller()->GetActionState(kTestAction));
-  EXPECT_FALSE(
-      state_controller()->HandleAction(lock_screen_apps::Action::kNewNote));
+TEST_F(LockScreenAppStateTest, MoveToBackgroundFromActive) {
+  state_controller()->SetLockScreenNoteStateForTesting(
+      TrayActionState::kActive);
+
+  state_controller()->MoveToBackground();
+  base::RunLoop().RunUntilIdle();
+
+  EXPECT_EQ(TrayActionState::kBackground,
+            state_controller()->GetLockScreenNoteState());
+
+  ASSERT_EQ(1u, observer()->observed_states().size());
+  EXPECT_EQ(TrayActionState::kBackground, observer()->observed_states()[0]);
+  ASSERT_EQ(1u, tray_action()->observed_states().size());
+  EXPECT_EQ(TrayActionState::kBackground, tray_action()->observed_states()[0]);
 }
+
+TEST_F(LockScreenAppStateTest, HandleActionWhenNotAvaiable) {
+  ASSERT_EQ(TrayActionState::kNotSupported,
+            state_controller()->GetLockScreenNoteState());
+
+  tray_action()->SendNewNoteRequest();
+  base::RunLoop().RunUntilIdle();

[James Cook, 2017/05/05 02:55:45]

If you want to be explicit about why you have to spin the message loop you can
expose a FlushForTesting() method and use that instead.

[tbarzic, 2017/05/05 04:46:27]

Done.

+
+  EXPECT_EQ(0u, observer()->observed_states().size());
+  EXPECT_EQ(0u, tray_action()->observed_states().size());
+}
+
+TEST_F(LockScreenAppStateTest, HandleAction) {
+  state_controller()->SetLockScreenNoteStateForTesting(
+      TrayActionState::kAvailable);
+
+  tray_action()->SendNewNoteRequest();
+  base::RunLoop().RunUntilIdle();
+
+  EXPECT_EQ(TrayActionState::kActive,
+            state_controller()->GetLockScreenNoteState());
+  ASSERT_EQ(1u, observer()->observed_states().size());
+  EXPECT_EQ(TrayActionState::kActive, observer()->observed_states()[0]);
+  observer()->clear_observed_states();
+  ASSERT_EQ(1u, tray_action()->observed_states().size());
+  EXPECT_EQ(TrayActionState::kActive, tray_action()->observed_states()[0]);
+  tray_action()->clear_observed_states();
+
+  tray_action()->SendNewNoteRequest();
+  base::RunLoop().RunUntilIdle();
+
+  EXPECT_EQ(0u, observer()->observed_states().size());

[James Cook, 2017/05/05 02:55:45]

A comment here would be helpful (since a trivial read of the code makes me
wonder "why doesn't it get another request?")

[tbarzic, 2017/05/05 04:46:27]

Done.

+  EXPECT_EQ(0u, tray_action()->observed_states().size());
+}

[James Cook, 2017/05/05 02:55:45]

Thanks for adding good test coverage, both here and in ash. It makes later
refactoring much easier.