chrome/browser/chromeos/power/extension_event_observer_unittest.cc

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "chrome/browser/chromeos/power/extension_event_observer.h"
   6
   7 #include <string>
   8
   9 #include "base/macros.h"
  10 #include "base/memory/scoped_ptr.h"
  11 #include "base/message_loop/message_loop.h"
  12 #include "base/run_loop.h"
  13 #include "chrome/browser/chromeos/login/users/fake_chrome_user_manager.h"
  14 #include "chrome/browser/chromeos/login/users/scoped_user_manager_enabler.h"
  15 #include "chrome/browser/chromeos/settings/cros_settings.h"
  16 #include "chrome/browser/chromeos/settings/device_settings_service.h"
  17 #include "chrome/common/extensions/api/gcm.h"
  18 #include "chrome/test/base/testing_browser_process.h"
  19 #include "chrome/test/base/testing_profile.h"
  20 #include "chrome/test/base/testing_profile_manager.h"
  21 #include "chromeos/dbus/dbus_thread_manager.h"
  22 #include "chromeos/dbus/fake_power_manager_client.h"
  23 #include "content/public/test/test_browser_thread_bundle.h"
  24 #include "content/public/test/test_renderer_host.h"
  25 #include "extensions/browser/extension_host.h"
  26 #include "extensions/browser/extension_host_observer.h"
  27 #include "extensions/browser/process_manager.h"
  28 #include "extensions/common/extension.h"
  29 #include "extensions/common/extension_builder.h"
  30 #include "extensions/common/manifest_handlers/background_info.h"
  31 #include "extensions/common/value_builder.h"
  32 #include "testing/gtest/include/gtest/gtest.h"
  33
  34 namespace chromeos {
  35
  36 class ExtensionEventObserverTest : public ::testing::Test {
  37  public:
  38   ExtensionEventObserverTest()
  39       : power_manager_client_(new FakePowerManagerClient()),
  40         fake_user_manager_(new FakeChromeUserManager()),
  41         scoped_user_manager_enabler_(fake_user_manager_) {
  42     DBusThreadManager::GetSetterForTesting()->SetPowerManagerClient(
  43         make_scoped_ptr(power_manager_client_));
  44
  45     profile_manager_.reset(
  46         new TestingProfileManager(TestingBrowserProcess::GetGlobal()));
  47
  48     extension_event_observer_.reset(new ExtensionEventObserver());
  49     test_api_ = extension_event_observer_->CreateTestApi();
  50   }
  51
  52   ~ExtensionEventObserverTest() override {
  53     extension_event_observer_.reset();
  54     profile_manager_.reset();
  55     DBusThreadManager::Shutdown();
  56   }
  57
  58   // ::testing::Test overrides.
  59   void SetUp() override {
  60     ::testing::Test::SetUp();
  61
  62     // Must be called from ::testing::Test::SetUp.
  63     ASSERT_TRUE(profile_manager_->SetUp());
  64
  65     const char kUserProfile[] = "profile1@example.com";
  66     fake_user_manager_->AddUser(kUserProfile);
  67     fake_user_manager_->LoginUser(kUserProfile);
  68     profile_ = profile_manager_->CreateTestingProfile(kUserProfile);
  69
  70     profile_manager_->SetLoggedIn(true);
  71   }
  72   void TearDown() override {
  73     profile_ = NULL;
  74     profile_manager_->DeleteAllTestingProfiles();
  75
  76     ::testing::Test::TearDown();
  77   }
  78
  79  protected:
  80   scoped_refptr<extensions::Extension> CreateApp(const std::string& name,
  81                                                  bool uses_gcm) {
  82     scoped_refptr<extensions::Extension> app =
  83         extensions::ExtensionBuilder()
  84             .SetManifest(
  85                  extensions::DictionaryBuilder()
  86                      .Set("name", name)
  87                      .Set("version", "1.0.0")
  88                      .Set("manifest_version", 2)
  89                      .Set("app",
  90                           extensions::DictionaryBuilder().Set(
  91                               "background",
  92                               extensions::DictionaryBuilder().Set(
  93                                   "scripts", extensions::ListBuilder().Append(
  94                                                  "background.js"))))
  95                      .Set("permissions", extensions::ListBuilder().Append(
  96                                              uses_gcm ? "gcm" : "")))
  97             .Build();
  98
  99     created_apps_.push_back(app);
 100
 101     return app;
 102   }
 103
 104   extensions::ExtensionHost* CreateHostForApp(Profile* profile,
 105                                               extensions::Extension* app) {
 106     extensions::ProcessManager::Get(profile)->CreateBackgroundHost(
 107         app, extensions::BackgroundInfo::GetBackgroundURL(app));
 108     base::RunLoop().RunUntilIdle();
 109
 110     return extensions::ProcessManager::Get(profile)
 111         ->GetBackgroundHostForExtension(app->id());
 112   }
 113
 114   // Owned by DBusThreadManager.
 115   FakePowerManagerClient* power_manager_client_;
 116
 117   scoped_ptr<ExtensionEventObserver> extension_event_observer_;
 118   scoped_ptr<ExtensionEventObserver::TestApi> test_api_;
 119
 120   // Owned by |profile_manager_|.
 121   TestingProfile* profile_;
 122   scoped_ptr<TestingProfileManager> profile_manager_;
 123
 124  private:
 125   content::TestBrowserThreadBundle browser_thread_bundle_;
 126
 127   // Needed to ensure we don't end up creating actual RenderViewHosts
 128   // and RenderProcessHosts.
 129   content::RenderViewHostTestEnabler render_view_host_test_enabler_;
 130
 131   // Chrome OS needs extra services to run in the following order.
 132   ScopedTestDeviceSettingsService test_device_settings_service_;
 133   ScopedTestCrosSettings test_cros_settings_;
 134
 135   // Owned by |scoped_user_manager_enabler_|.
 136   FakeChromeUserManager* fake_user_manager_;
 137   ScopedUserManagerEnabler scoped_user_manager_enabler_;
 138
 139   std::vector<scoped_refptr<extensions::Extension>> created_apps_;
 140
 141   DISALLOW_COPY_AND_ASSIGN(ExtensionEventObserverTest);
 142 };
 143
 144 // Tests that the ExtensionEventObserver reports readiness for suspend when
 145 // there is nothing interesting going on.
 146 TEST_F(ExtensionEventObserverTest, BasicSuspendAndDarkSuspend) {
 147   power_manager_client_->SendSuspendImminent();
 148   EXPECT_EQ(1, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 149
 150   EXPECT_TRUE(test_api_->MaybeRunSuspendReadinessCallback());
 151   EXPECT_EQ(0, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 152
 153   power_manager_client_->SendDarkSuspendImminent();
 154   EXPECT_EQ(1, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 155
 156   EXPECT_TRUE(test_api_->MaybeRunSuspendReadinessCallback());
 157   EXPECT_EQ(0, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 158 }
 159
 160 // Tests that the ExtensionEventObserver properly handles a canceled suspend
 161 // attempt.
 162 TEST_F(ExtensionEventObserverTest, CanceledSuspend) {
 163   power_manager_client_->SendSuspendImminent();
 164   EXPECT_EQ(1, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 165
 166   power_manager_client_->SendSuspendDone();
 167   EXPECT_FALSE(test_api_->MaybeRunSuspendReadinessCallback());
 168 }
 169
 170 // Tests that the ExtensionEventObserver delays suspends and dark suspends while
 171 // there is a push message pending for an app that uses GCM.
 172 TEST_F(ExtensionEventObserverTest, PushMessagesDelaySuspend) {
 173   scoped_refptr<extensions::Extension> gcm_app =
 174       CreateApp("DelaysSuspendForPushMessages", true /* uses_gcm */);
 175   extensions::ExtensionHost* host = CreateHostForApp(profile_, gcm_app.get());
 176   ASSERT_TRUE(host);
 177   EXPECT_TRUE(test_api_->WillDelaySuspendForExtensionHost(host));
 178
 179   // Test that a push message received before a suspend attempt delays the
 180   // attempt.
 181   const int kSuspendPushId = 23874;
 182   extension_event_observer_->OnBackgroundEventDispatched(
 183       host, extensions::api::gcm::OnMessage::kEventName, kSuspendPushId);
 184   power_manager_client_->SendSuspendImminent();
 185
 186   EXPECT_TRUE(test_api_->MaybeRunSuspendReadinessCallback());
 187   EXPECT_EQ(1, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 188
 189   extension_event_observer_->OnBackgroundEventAcked(host, kSuspendPushId);
 190   EXPECT_EQ(0, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 191
 192   // Now test receiving the suspend attempt before the push message.
 193   const int kDarkSuspendPushId = 56674;
 194   power_manager_client_->SendDarkSuspendImminent();
 195   extension_event_observer_->OnBackgroundEventDispatched(
 196       host, extensions::api::gcm::OnMessage::kEventName, kDarkSuspendPushId);
 197
 198   EXPECT_TRUE(test_api_->MaybeRunSuspendReadinessCallback());
 199   EXPECT_EQ(1, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 200
 201   extension_event_observer_->OnBackgroundEventAcked(host, kDarkSuspendPushId);
 202   EXPECT_EQ(0, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 203
 204   // Test that non-push messages do not delay the suspend.
 205   const int kNonPushId = 5687;
 206   power_manager_client_->SendDarkSuspendImminent();
 207   extension_event_observer_->OnBackgroundEventDispatched(host, "FakeMessage",
 208                                                          kNonPushId);
 209
 210   EXPECT_TRUE(test_api_->MaybeRunSuspendReadinessCallback());
 211   EXPECT_EQ(0, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 212 }
 213
 214 // Tests that messages sent for apps that don't use GCM are ignored.
 215 TEST_F(ExtensionEventObserverTest, IgnoresNonGCMApps) {
 216   scoped_refptr<extensions::Extension> app = CreateApp("Non-GCM", false);
 217   extensions::ExtensionHost* host = CreateHostForApp(profile_, app.get());
 218   ASSERT_TRUE(host);
 219
 220   EXPECT_FALSE(test_api_->WillDelaySuspendForExtensionHost(host));
 221
 222   power_manager_client_->SendSuspendImminent();
 223   EXPECT_TRUE(test_api_->MaybeRunSuspendReadinessCallback());
 224   EXPECT_EQ(0, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 225 }
 226
 227 // Tests that network requests started by an app while it is processing a push
 228 // message delay any suspend attempt.
 229 TEST_F(ExtensionEventObserverTest, NetworkRequestsMayDelaySuspend) {
 230   scoped_refptr<extensions::Extension> app = CreateApp("NetworkRequests", true);
 231   extensions::ExtensionHost* host = CreateHostForApp(profile_, app.get());
 232   ASSERT_TRUE(host);
 233   EXPECT_TRUE(test_api_->WillDelaySuspendForExtensionHost(host));
 234
 235   // Test that network requests started while there is no pending push message
 236   // are ignored.
 237   const uint64 kNonPushRequestId = 5170725;
 238   extension_event_observer_->OnNetworkRequestStarted(host, kNonPushRequestId);
 239   power_manager_client_->SendSuspendImminent();
 240
 241   EXPECT_TRUE(test_api_->MaybeRunSuspendReadinessCallback());
 242   EXPECT_EQ(0, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 243
 244   // Test that network requests started while a push message is pending delay
 245   // the suspend even after the push message has been acked.
 246   const int kPushMessageId = 178674;
 247   const uint64 kNetworkRequestId = 78917089;
 248   power_manager_client_->SendDarkSuspendImminent();
 249   extension_event_observer_->OnBackgroundEventDispatched(
 250       host, extensions::api::gcm::OnMessage::kEventName, kPushMessageId);
 251
 252   EXPECT_TRUE(test_api_->MaybeRunSuspendReadinessCallback());
 253   EXPECT_EQ(1, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 254
 255   extension_event_observer_->OnNetworkRequestStarted(host, kNetworkRequestId);
 256   extension_event_observer_->OnBackgroundEventAcked(host, kPushMessageId);
 257   EXPECT_EQ(1, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 258
 259   extension_event_observer_->OnNetworkRequestDone(host, kNetworkRequestId);
 260   EXPECT_EQ(0, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 261 }
 262
 263 // Tests that any outstanding push messages or network requests for an
 264 // ExtensionHost that is destroyed do not end up blocking system suspend.
 265 TEST_F(ExtensionEventObserverTest, DeletedExtensionHostDoesNotBlockSuspend) {
 266   scoped_refptr<extensions::Extension> app =
 267       CreateApp("DeletedExtensionHost", true);
 268
 269   // The easiest way to delete an extension host is to delete the Profile it is
 270   // associated with so we create a new Profile here.
 271   const char kProfileName[] = "DeletedExtensionHostProfile";
 272   Profile* new_profile = profile_manager_->CreateTestingProfile(kProfileName);
 273
 274   extensions::ExtensionHost* host = CreateHostForApp(new_profile, app.get());
 275   ASSERT_TRUE(host);
 276   EXPECT_TRUE(test_api_->WillDelaySuspendForExtensionHost(host));
 277
 278   const int kPushId = 156178;
 279   const uint64 kNetworkId = 791605;
 280   extension_event_observer_->OnBackgroundEventDispatched(
 281       host, extensions::api::gcm::OnMessage::kEventName, kPushId);
 282   extension_event_observer_->OnNetworkRequestStarted(host, kNetworkId);
 283
 284   // Now delete the Profile.  This has the side-effect of also deleting all the
 285   // ExtensionHosts.
 286   profile_manager_->DeleteTestingProfile(kProfileName);
 287
 288   power_manager_client_->SendSuspendImminent();
 289   EXPECT_TRUE(test_api_->MaybeRunSuspendReadinessCallback());
 290   EXPECT_EQ(0, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 291 }
 292
 293 // Tests that the ExtensionEventObserver does not delay suspend attempts when it
 294 // is disabled.
 295 TEST_F(ExtensionEventObserverTest, DoesNotDelaySuspendWhenDisabled) {
 296   scoped_refptr<extensions::Extension> app =
 297       CreateApp("NoDelayWhenDisabled", true);
 298   extensions::ExtensionHost* host = CreateHostForApp(profile_, app.get());
 299   ASSERT_TRUE(host);
 300   EXPECT_TRUE(test_api_->WillDelaySuspendForExtensionHost(host));
 301
 302   // Test that disabling the suspend delay while a suspend is pending will cause
 303   // the ExtensionEventObserver to immediately report readiness.
 304   const int kPushId = 416753;
 305   extension_event_observer_->OnBackgroundEventDispatched(
 306       host, extensions::api::gcm::OnMessage::kEventName, kPushId);
 307   power_manager_client_->SendSuspendImminent();
 308   EXPECT_EQ(1, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 309
 310   extension_event_observer_->SetShouldDelaySuspend(false);
 311   EXPECT_FALSE(test_api_->MaybeRunSuspendReadinessCallback());
 312   EXPECT_EQ(0, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 313
 314   // Test that the ExtensionEventObserver does not delay suspend attempts when
 315   // it is disabled.
 316   power_manager_client_->SendDarkSuspendImminent();
 317   EXPECT_EQ(0, power_manager_client_->GetNumPendingSuspendReadinessCallbacks());
 318 }
 319
 320 }  // namespace chromeos