cros: Use SessionController in UserMetricsRecorder to get login status

ash/metrics/user_metrics_recorder_unittest.cc

 // Copyright 2015 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/metrics/user_metrics_recorder.h"
 
 #include <memory>
 
 #include "ash/login_status.h"
 #include "ash/public/cpp/config.h"
+#include "ash/session/session_controller.h"
 #include "ash/shelf/shelf_model.h"
 #include "ash/shell.h"
 #include "ash/shell_port.h"
 #include "ash/test/ash_test_base.h"
-#include "ash/test/test_system_tray_delegate.h"
+#include "ash/test/test_session_controller_client.h"
 #include "ash/test/user_metrics_recorder_test_api.h"
 #include "ash/wm_window.h"
 #include "base/test/histogram_tester.h"
 
+using session_manager::SessionState;
+
 namespace ash {
 namespace {
 
 const char kAsh_NumberOfVisibleWindowsInPrimaryDisplay[] =
     "Ash.NumberOfVisibleWindowsInPrimaryDisplay";
 
 const char kAsh_ActiveWindowShowTypeOverTime[] =
     "Ash.ActiveWindowShowTypeOverTime";
 
 const char kAsh_Shelf_NumberOfItems[] = "Ash.Shelf.NumberOfItems";
 
 const char kAsh_Shelf_NumberOfPinnedItems[] = "Ash.Shelf.NumberOfPinnedItems";
 
 const char kAsh_Shelf_NumberOfUnpinnedItems[] =
     "Ash.Shelf.NumberOfUnpinnedItems";
 
 }  // namespace
 
-// Test fixture for the UserMetricsRecorder class.
-class UserMetricsRecorderTest : public test::AshTestBase {
+// Test fixture for the UserMetricsRecorder class. The tests manage their own
+// session state.
+class UserMetricsRecorderTest : public test::NoSessionAshTestBase {
  public:
-  UserMetricsRecorderTest();
-  ~UserMetricsRecorderTest() override;
+  UserMetricsRecorderTest() = default;
+  ~UserMetricsRecorderTest() override = default;
 
-  // test::AshTestBase:
-  void SetUp() override;
-  void TearDown() override;
-
-  // Sets the user login status.
-  void SetLoginStatus(LoginStatus login_status);
-
-  // Sets the current user session to be active or inactive in a desktop
-  // environment.
-  void SetUserInActiveDesktopEnvironment(bool is_active);
-
-  test::UserMetricsRecorderTestAPI* user_metrics_recorder_test_api() {
-    return user_metrics_recorder_test_api_.get();
-  }
+  test::UserMetricsRecorderTestAPI& test_api() { return test_api_; }
 
   base::HistogramTester& histograms() { return histograms_; }
 
  private:
   // Test API to access private members of the test target.
-  std::unique_ptr<test::UserMetricsRecorderTestAPI>
-      user_metrics_recorder_test_api_;
+  test::UserMetricsRecorderTestAPI test_api_;
 
   // Histogram value verifier.
   base::HistogramTester histograms_;
 
-  // The active SystemTrayDelegate. Not owned.
-  test::TestSystemTrayDelegate* test_system_tray_delegate_;
-
   DISALLOW_COPY_AND_ASSIGN(UserMetricsRecorderTest);
 };
 
-UserMetricsRecorderTest::UserMetricsRecorderTest() {}
-
-UserMetricsRecorderTest::~UserMetricsRecorderTest() {}
-
-void UserMetricsRecorderTest::SetUp() {
-  test::AshTestBase::SetUp();
-  user_metrics_recorder_test_api_.reset(new test::UserMetricsRecorderTestAPI());
-  test_system_tray_delegate_ = GetSystemTrayDelegate();
-}
-
-void UserMetricsRecorderTest::TearDown() {
-  test_system_tray_delegate_ = nullptr;
-  test::AshTestBase::TearDown();
-}
-
-void UserMetricsRecorderTest::SetLoginStatus(LoginStatus login_status) {
-  test_system_tray_delegate_->SetLoginStatus(login_status);
-}
-
-void UserMetricsRecorderTest::SetUserInActiveDesktopEnvironment(
-    bool is_active) {
-  if (is_active) {
-    SetLoginStatus(LoginStatus::USER);
-    ASSERT_TRUE(
-        user_metrics_recorder_test_api()->IsUserInActiveDesktopEnvironment());
-  } else {
-    SetLoginStatus(LoginStatus::LOCKED);
-    ASSERT_FALSE(
-        user_metrics_recorder_test_api()->IsUserInActiveDesktopEnvironment());
-  }
-}
-
 // Verifies the return value of IsUserInActiveDesktopEnvironment() for the
 // different login status values.
 TEST_F(UserMetricsRecorderTest, VerifyIsUserInActiveDesktopEnvironmentValues) {
-  SetLoginStatus(LoginStatus::NOT_LOGGED_IN);
-  EXPECT_FALSE(
-      user_metrics_recorder_test_api()->IsUserInActiveDesktopEnvironment());
+  SessionController* session = Shell::Get()->session_controller();
 
-  SetLoginStatus(LoginStatus::LOCKED);
-  EXPECT_FALSE(
-      user_metrics_recorder_test_api()->IsUserInActiveDesktopEnvironment());
+  // Environment is not active before login.
+  ASSERT_FALSE(session->IsActiveUserSessionStarted());
+  EXPECT_FALSE(test_api().IsUserInActiveDesktopEnvironment());
 
-  SetLoginStatus(LoginStatus::USER);
-  EXPECT_TRUE(
-      user_metrics_recorder_test_api()->IsUserInActiveDesktopEnvironment());
+  // Environment is active after login.
+  SetSessionStarted(true);
+  ASSERT_TRUE(session->IsActiveUserSessionStarted());
+  EXPECT_TRUE(test_api().IsUserInActiveDesktopEnvironment());
 
-  SetLoginStatus(LoginStatus::OWNER);
-  EXPECT_TRUE(
-      user_metrics_recorder_test_api()->IsUserInActiveDesktopEnvironment());
+  // Environment is not active when screen is locked.
+  test::TestSessionControllerClient* client = GetSessionControllerClient();
+  client->SetSessionState(SessionState::LOCKED);
+  ASSERT_TRUE(session->IsScreenLocked());
+  EXPECT_FALSE(test_api().IsUserInActiveDesktopEnvironment());
 
-  SetLoginStatus(LoginStatus::GUEST);
-  EXPECT_TRUE(
-      user_metrics_recorder_test_api()->IsUserInActiveDesktopEnvironment());
+  // Kiosk logins are not considered active.
+  client->Reset();
+  client->AddUserSession("user1@test.com", user_manager::USER_TYPE_KIOSK_APP);

[xiyuan, 2017/04/19 23:08:54]

nit: "user1@test.com" -> "app@kiosk-apps.device-local.localhost" to make it more
like an app. 

https://cs.chromium.org/chromium/src/chrome/browser/chromeos/policy/device_lo...

[James Cook, 2017/04/19 23:26:59]

Done.

+  client->SetSessionState(session_manager::SessionState::ACTIVE);
+  EXPECT_FALSE(test_api().IsUserInActiveDesktopEnvironment());
 
-  SetLoginStatus(LoginStatus::PUBLIC);
-  EXPECT_TRUE(
-      user_metrics_recorder_test_api()->IsUserInActiveDesktopEnvironment());
-
-  SetLoginStatus(LoginStatus::SUPERVISED);
-  EXPECT_TRUE(
-      user_metrics_recorder_test_api()->IsUserInActiveDesktopEnvironment());
-
-  SetLoginStatus(LoginStatus::KIOSK_APP);
-  EXPECT_FALSE(
-      user_metrics_recorder_test_api()->IsUserInActiveDesktopEnvironment());
+  // Arc kiosk logins are not considered active.
+  client->Reset();
+  client->AddUserSession("user1@test.com",
+                         user_manager::USER_TYPE_ARC_KIOSK_APP);

[xiyuan, 2017/04/19 23:08:54]

nit: "user1@test.com" -> "app@arc-kiosk-apps.device-local.localhost"

[James Cook, 2017/04/19 23:26:59]

Done.

+  client->SetSessionState(session_manager::SessionState::ACTIVE);
+  EXPECT_FALSE(test_api().IsUserInActiveDesktopEnvironment());
 }
 
 // Verifies that the IsUserInActiveDesktopEnvironment() dependent stats are not
 // recorded when a user is not active in a desktop environment.
 TEST_F(UserMetricsRecorderTest,
        VerifyStatsRecordedWhenUserNotInActiveDesktopEnvironment) {
-  SetUserInActiveDesktopEnvironment(false);
-  user_metrics_recorder_test_api()->RecordPeriodicMetrics();
+  ASSERT_FALSE(test_api().IsUserInActiveDesktopEnvironment());
+  test_api().RecordPeriodicMetrics();
 
   histograms().ExpectTotalCount(kAsh_NumberOfVisibleWindowsInPrimaryDisplay, 0);
   histograms().ExpectTotalCount(kAsh_Shelf_NumberOfItems, 0);
   histograms().ExpectTotalCount(kAsh_Shelf_NumberOfPinnedItems, 0);
   histograms().ExpectTotalCount(kAsh_Shelf_NumberOfUnpinnedItems, 0);
 }
 
 // Verifies that the IsUserInActiveDesktopEnvironment() dependent stats are
 // recorded when a user is active in a desktop environment.
 TEST_F(UserMetricsRecorderTest,
        VerifyStatsRecordedWhenUserInActiveDesktopEnvironment) {
-  SetUserInActiveDesktopEnvironment(true);
-  user_metrics_recorder_test_api()->RecordPeriodicMetrics();
+  SetSessionStarted(true);
+  ASSERT_TRUE(test_api().IsUserInActiveDesktopEnvironment());
+  test_api().RecordPeriodicMetrics();
 
   histograms().ExpectTotalCount(kAsh_NumberOfVisibleWindowsInPrimaryDisplay, 1);
   histograms().ExpectTotalCount(kAsh_Shelf_NumberOfItems, 1);
   histograms().ExpectTotalCount(kAsh_Shelf_NumberOfPinnedItems, 1);
   histograms().ExpectTotalCount(kAsh_Shelf_NumberOfUnpinnedItems, 1);
 }
 
 // Verifies recording of stats which are always recorded by
 // RecordPeriodicMetrics.
 TEST_F(UserMetricsRecorderTest, VerifyStatsRecordedByRecordPeriodicMetrics) {
-  SetUserInActiveDesktopEnvironment(true);
-  user_metrics_recorder_test_api()->RecordPeriodicMetrics();
+  SetSessionStarted(true);
+  test_api().RecordPeriodicMetrics();
 
   histograms().ExpectTotalCount(kAsh_ActiveWindowShowTypeOverTime, 1);
 }
 
 // Verify the shelf item counts recorded by the
 // UserMetricsRecorder::RecordPeriodicMetrics() method.
 TEST_F(UserMetricsRecorderTest, ValuesRecordedByRecordShelfItemCounts) {
   // TODO: investigate failure in mash, http://crbug.com/695629.
   if (Shell::GetAshConfig() == Config::MASH)
     return;
 
-  SetUserInActiveDesktopEnvironment(true);
+  SetSessionStarted(true);
 
   // Make sure the shelf contains the app list launcher button.
   ShelfModel* shelf_model = Shell::Get()->shelf_model();
   ASSERT_EQ(1u, shelf_model->items().size());
   ASSERT_EQ(TYPE_APP_LIST, shelf_model->items()[0].type);
 
   ShelfItem shelf_item;
   shelf_item.type = ash::TYPE_PINNED_APP;
   shelf_item.app_launch_id = AppLaunchId("app_id_1");
   shelf_model->Add(shelf_item);
   shelf_item.app_launch_id = AppLaunchId("app_id_2");
   shelf_model->Add(shelf_item);
 
   shelf_item.type = ash::TYPE_APP;
   shelf_item.app_launch_id = AppLaunchId("app_id_3");
   shelf_model->Add(shelf_item);
   shelf_item.app_launch_id = AppLaunchId("app_id_4");
   shelf_model->Add(shelf_item);
   shelf_item.app_launch_id = AppLaunchId("app_id_5");
   shelf_model->Add(shelf_item);
 
-  user_metrics_recorder_test_api()->RecordPeriodicMetrics();
+  test_api().RecordPeriodicMetrics();
   histograms().ExpectBucketCount(kAsh_Shelf_NumberOfItems, 5, 1);
   histograms().ExpectBucketCount(kAsh_Shelf_NumberOfPinnedItems, 2, 1);
   histograms().ExpectBucketCount(kAsh_Shelf_NumberOfUnpinnedItems, 3, 1);
 }
 
 }  // namespace ash