Add policies to control power management on the Chrome OS login screen

chrome/browser/chromeos/power/power_prefs_unittest.cc

+// Copyright (c) 2013 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 "chrome/browser/chromeos/power/power_prefs.h"
+
+#include <string>
+
+#include "base/command_line.h"
+#include "base/files/file_path.h"

[Mattias Nissler (ping if slow), 2013/07/03 16:52:18]

needed?

[bartfab (slow), 2013/07/03 19:11:04]

If I strictly follow IWYU, yes:

profile_manager_.profiles_dir() returns a base::FilePath& and I pass the value
on to another method.

+#include "base/memory/ref_counted.h"
+#include "base/prefs/pref_change_registrar.h"
+#include "base/prefs/pref_service.h"
+#include "chrome/browser/extensions/extension_special_storage_policy.h"
+#include "chrome/browser/prefs/browser_prefs.h"
+#include "chrome/browser/prefs/pref_service_syncable.h"
+#include "chrome/browser/profiles/profile.h"
+#include "chrome/browser/profiles/profile_manager.h"
+#include "chrome/common/chrome_constants.h"
+#include "chrome/common/chrome_notification_types.h"
+#include "chrome/common/pref_names.h"
+#include "chrome/test/base/testing_browser_process.h"
+#include "chrome/test/base/testing_pref_service_syncable.h"
+#include "chrome/test/base/testing_profile.h"
+#include "chrome/test/base/testing_profile_manager.h"
+#include "chromeos/chromeos_switches.h"
+#include "chromeos/dbus/fake_power_manager_client.h"
+#include "chromeos/dbus/mock_dbus_thread_manager_without_gmock.h"
+#include "chromeos/dbus/power_manager/policy.pb.h"
+#include "chromeos/dbus/power_policy_controller.h"
+#include "components/user_prefs/pref_registry_syncable.h"
+#include "content/public/browser/notification_details.h"
+#include "content/public/browser/notification_service.h"
+#include "content/public/browser/notification_source.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace chromeos {
+
+class PowerPrefsTest : public testing::Test {
+ protected:
+  PowerPrefsTest();
+
+  // testing::Test:
+  virtual void SetUp() OVERRIDE;
+  virtual void TearDown() OVERRIDE;
+
+  const Profile* GetProfileUsedByPowerPrefs() const;
+  const PrefChangeRegistrar* GetPrefChangeRegistrarUsedByPowerPrefs() const;

[Mattias Nissler (ping if slow), 2013/07/03 16:52:18]

Feel free to drop the -UsedByPowerPrefs suffixes unless you do really want them.

[bartfab (slow), 2013/07/03 19:11:04]

Done.

+
+  std::string GetExpectedPowerPolicyForProfile(Profile* profile) const;
+  std::string GetCurrentPowerPolicy() const;
+  bool GetExpectedAllowScreenWakeLocksForProfile(Profile* profile) const;
+  bool GetCurrentAllowScreenWakeLocks() const;
+
+  TestingProfileManager profile_manager_;
+  MockDBusThreadManagerWithoutGMock mock_dbus_thread_manager_;
+  PowerPolicyController* power_policy_controller_;     // Not owned.
+  FakePowerManagerClient* fake_power_manager_client_;  // Not owned.
+
+  scoped_ptr<PowerPrefs> power_prefs_;
+
+  DISALLOW_COPY_AND_ASSIGN(PowerPrefsTest);
+};
+
+PowerPrefsTest::PowerPrefsTest()
+    : profile_manager_(TestingBrowserProcess::GetGlobal()),
+      power_policy_controller_(
+          mock_dbus_thread_manager_.GetPowerPolicyController()),
+      fake_power_manager_client_(
+          mock_dbus_thread_manager_.fake_power_manager_client()) {
+}
+
+void PowerPrefsTest::SetUp() {
+  testing::Test::SetUp();
+  ASSERT_TRUE(profile_manager_.SetUp());
+
+  power_prefs_.reset(new PowerPrefs(power_policy_controller_));
+  EXPECT_FALSE(GetProfileUsedByPowerPrefs());
+  EXPECT_FALSE(GetPrefChangeRegistrarUsedByPowerPrefs());
+  EXPECT_EQ(PowerPolicyController::GetPolicyDebugString(
+                power_manager::PowerManagementPolicy()),
+            GetCurrentPowerPolicy());
+}
+
+void PowerPrefsTest::TearDown() {
+  power_prefs_.reset();
+  testing::Test::TearDown();
+}
+
+const Profile* PowerPrefsTest::GetProfileUsedByPowerPrefs() const {
+  return power_prefs_->profile_;
+}
+
+const PrefChangeRegistrar*
+    PowerPrefsTest::GetPrefChangeRegistrarUsedByPowerPrefs() const {
+  return power_prefs_->pref_change_registrar_.get();
+}
+
+std::string PowerPrefsTest::GetExpectedPowerPolicyForProfile(
+    Profile* profile) const {
+  const PrefService* prefs = profile->GetPrefs();
+  power_manager::PowerManagementPolicy expected_policy;
+  expected_policy.mutable_ac_delays()->set_screen_dim_ms(
+      prefs->GetInteger(prefs::kPowerAcScreenDimDelayMs));
+  expected_policy.mutable_ac_delays()->set_screen_off_ms(
+      prefs->GetInteger(prefs::kPowerAcScreenOffDelayMs));
+  expected_policy.mutable_ac_delays()->set_screen_lock_ms(
+      prefs->GetInteger(prefs::kPowerAcScreenLockDelayMs));
+  expected_policy.mutable_ac_delays()->set_idle_warning_ms(
+      prefs->GetInteger(prefs::kPowerAcIdleWarningDelayMs));
+  expected_policy.mutable_ac_delays()->set_idle_ms(
+      prefs->GetInteger(prefs::kPowerAcIdleDelayMs));
+  expected_policy.mutable_battery_delays()->set_screen_dim_ms(
+      prefs->GetInteger(prefs::kPowerBatteryScreenDimDelayMs));
+  expected_policy.mutable_battery_delays()->set_screen_off_ms(
+      prefs->GetInteger(prefs::kPowerBatteryScreenOffDelayMs));
+  expected_policy.mutable_battery_delays()->set_screen_lock_ms(
+      prefs->GetInteger(prefs::kPowerBatteryScreenLockDelayMs));
+  expected_policy.mutable_battery_delays()->set_idle_warning_ms(
+      prefs->GetInteger(prefs::kPowerBatteryIdleWarningDelayMs));
+  expected_policy.mutable_battery_delays()->set_idle_ms(
+      prefs->GetInteger(prefs::kPowerBatteryIdleDelayMs));
+  expected_policy.set_ac_idle_action(
+      static_cast<power_manager::PowerManagementPolicy_Action>(
+            prefs->GetInteger(prefs::kPowerAcIdleAction)));
+  expected_policy.set_battery_idle_action(
+      static_cast<power_manager::PowerManagementPolicy_Action>(
+            prefs->GetInteger(prefs::kPowerBatteryIdleAction)));
+  expected_policy.set_lid_closed_action(
+      static_cast<power_manager::PowerManagementPolicy_Action>(
+            prefs->GetInteger(prefs::kPowerLidClosedAction)));
+  expected_policy.set_use_audio_activity(
+      prefs->GetBoolean(prefs::kPowerUseAudioActivity));
+  expected_policy.set_use_video_activity(
+      prefs->GetBoolean(prefs::kPowerUseVideoActivity));
+  expected_policy.set_presentation_screen_dim_delay_factor(
+      prefs->GetDouble(prefs::kPowerPresentationScreenDimDelayFactor));
+  expected_policy.set_user_activity_screen_dim_delay_factor(
+      prefs->GetDouble(prefs::kPowerUserActivityScreenDimDelayFactor));
+  expected_policy.set_reason("Prefs");
+  return PowerPolicyController::GetPolicyDebugString(expected_policy);
+}
+
+std::string PowerPrefsTest::GetCurrentPowerPolicy() const {
+  return PowerPolicyController::GetPolicyDebugString(
+      fake_power_manager_client_->get_policy());
+}
+
+bool PowerPrefsTest::GetCurrentAllowScreenWakeLocks() const {
+  return power_policy_controller_->honor_screen_wake_locks_;
+}
+
+bool PowerPrefsTest::GetExpectedAllowScreenWakeLocksForProfile(
+    Profile* profile) const {
+  return profile->GetPrefs()->GetBoolean(prefs::kPowerAllowScreenWakeLocks);
+}
+
+TEST_F(PowerPrefsTest, LoginScreen) {
+  // Set up login profile.
+  scoped_ptr<TestingPrefServiceSyncable> login_profile_prefs(
+      new TestingPrefServiceSyncable);
+  chrome::RegisterUserPrefs(login_profile_prefs->registry(), true);
+  scoped_ptr<TestingProfile> login_profile_owner(new TestingProfile(
+      profile_manager_.profiles_dir().AppendASCII(chrome::kInitialProfile),
+      NULL,
+      scoped_refptr<ExtensionSpecialStoragePolicy>(),
+      scoped_ptr<PrefServiceSyncable>(login_profile_prefs.release())));
+  TestingProfile* login_profile = login_profile_owner.get();
+  TestingProfile* login_profile_parent = profile_manager_.CreateTestingProfile(
+      chrome::kInitialProfile);
+  login_profile_parent->SetOffTheRecordProfile(login_profile_owner.release());
+  login_profile->SetOriginalProfile(login_profile_parent);
+  login_profile->set_incognito(true);
+
+  // Inform power_prefs_ that the login screen is being shown.
+  power_prefs_->Observe(chrome::NOTIFICATION_LOGIN_WEBUI_VISIBLE,
+                        content::Source<PowerPrefsTest>(this),
+                        content::NotificationService::NoDetails());
+
+  EXPECT_EQ(login_profile, GetProfileUsedByPowerPrefs());
+  const PrefChangeRegistrar* pref_change_registrar =
+        GetPrefChangeRegistrarUsedByPowerPrefs();
+  ASSERT_TRUE(pref_change_registrar);
+  EXPECT_EQ(login_profile->GetPrefs(), pref_change_registrar->prefs());

[Mattias Nissler (ping if slow), 2013/07/03 16:52:18]

The PrefChangeRegistrar seems to be an internal implementation detail of the
class, I wouldn't test for this explicitly but rely on the fact that the prefs
must have come from the right profile which you check below.

[bartfab (slow), 2013/07/03 19:11:04]

Done.

+  EXPECT_EQ(GetExpectedPowerPolicyForProfile(login_profile),
+            GetCurrentPowerPolicy());
+  EXPECT_EQ(GetExpectedAllowScreenWakeLocksForProfile(login_profile),
+            GetCurrentAllowScreenWakeLocks());
+
+  TestingProfile* other_profile =
+      profile_manager_.CreateTestingProfile("other");
+
+  // Inform power_prefs_ that an unrelated profile has been destroyed.
+  power_prefs_->Observe(chrome::NOTIFICATION_PROFILE_DESTROYED,
+                        content::Source<Profile>(other_profile),
+                        content::NotificationService::NoDetails());
+
+  // Verify that the login profile's power prefs are still being used.
+  EXPECT_EQ(login_profile, GetProfileUsedByPowerPrefs());
+  pref_change_registrar = GetPrefChangeRegistrarUsedByPowerPrefs();
+  ASSERT_TRUE(pref_change_registrar);
+  EXPECT_EQ(login_profile->GetPrefs(), pref_change_registrar->prefs());
+  EXPECT_EQ(GetExpectedPowerPolicyForProfile(login_profile),
+            GetCurrentPowerPolicy());
+  EXPECT_EQ(GetExpectedAllowScreenWakeLocksForProfile(login_profile),
+            GetCurrentAllowScreenWakeLocks());
+
+  // Inform power_prefs_ that the login profile has been destroyed.
+  power_prefs_->Observe(chrome::NOTIFICATION_PROFILE_DESTROYED,
+                        content::Source<Profile>(login_profile),
+                        content::NotificationService::NoDetails());
+
+  EXPECT_FALSE(GetProfileUsedByPowerPrefs());
+  EXPECT_FALSE(GetPrefChangeRegistrarUsedByPowerPrefs());
+  EXPECT_EQ(PowerPolicyController::GetPolicyDebugString(
+                power_manager::PowerManagementPolicy()),
+            GetCurrentPowerPolicy());
+}
+
+
+TEST_F(PowerPrefsTest, UserSession) {
+  // Set up user profile.
+  TestingProfile* user_profile = profile_manager_.CreateTestingProfile("user");
+  CommandLine::ForCurrentProcess()->AppendSwitchASCII(switches::kLoginProfile,
+                                                      "user");
+  profile_manager_.SetLoggedIn(true);
+  ProfileManager::AllowGetDefaultProfile();
+
+  // Inform power_prefs_ that a session has started.
+  power_prefs_->Observe(chrome::NOTIFICATION_SESSION_STARTED,
+                        content::Source<PowerPrefsTest>(this),
+                        content::NotificationService::NoDetails());
+
+  EXPECT_EQ(user_profile, GetProfileUsedByPowerPrefs());
+  const PrefChangeRegistrar* pref_change_registrar =
+        GetPrefChangeRegistrarUsedByPowerPrefs();
+  ASSERT_TRUE(pref_change_registrar);
+  EXPECT_EQ(user_profile->GetPrefs(), pref_change_registrar->prefs());
+  EXPECT_EQ(GetExpectedPowerPolicyForProfile(user_profile),
+            GetCurrentPowerPolicy());
+  EXPECT_EQ(GetExpectedAllowScreenWakeLocksForProfile(user_profile),
+            GetCurrentAllowScreenWakeLocks());
+
+  TestingProfile* other_profile =
+      profile_manager_.CreateTestingProfile("other");
+
+  // Inform power_prefs_ that an unrelated profile has been destroyed.
+  power_prefs_->Observe(chrome::NOTIFICATION_PROFILE_DESTROYED,
+                        content::Source<Profile>(other_profile),
+                        content::NotificationService::NoDetails());
+
+  // Verify that the user profile's power prefs are still being used.
+  EXPECT_EQ(user_profile, GetProfileUsedByPowerPrefs());
+  pref_change_registrar = GetPrefChangeRegistrarUsedByPowerPrefs();
+  ASSERT_TRUE(pref_change_registrar);
+  EXPECT_EQ(user_profile->GetPrefs(), pref_change_registrar->prefs());
+  EXPECT_EQ(GetExpectedPowerPolicyForProfile(user_profile),
+            GetCurrentPowerPolicy());
+  EXPECT_EQ(GetExpectedAllowScreenWakeLocksForProfile(user_profile),
+            GetCurrentAllowScreenWakeLocks());
+
+  // Inform power_prefs_ that the session has ended and the user profile has
+  // been destroyed.
+  power_prefs_->Observe(chrome::NOTIFICATION_PROFILE_DESTROYED,
+                        content::Source<Profile>(user_profile),
+                        content::NotificationService::NoDetails());
+
+  EXPECT_FALSE(GetProfileUsedByPowerPrefs());
+  EXPECT_FALSE(GetPrefChangeRegistrarUsedByPowerPrefs());
+  EXPECT_EQ(PowerPolicyController::GetPolicyDebugString(
+                power_manager::PowerManagementPolicy()),
+            GetCurrentPowerPolicy());
+}
+
+}  // namespace chromeos