| OLD | NEW |
| 1 // Copyright (c) 2015 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2015 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #include "chrome/browser/chromeos/policy/heartbeat_scheduler.h" | 5 #include "chrome/browser/chromeos/policy/heartbeat_scheduler.h" |
| 6 | 6 |
| 7 #include "base/strings/string_number_conversions.h" | 7 #include "base/strings/string_number_conversions.h" |
| 8 #include "base/test/test_simple_task_runner.h" | 8 #include "base/test/test_simple_task_runner.h" |
| 9 #include "chrome/browser/chromeos/settings/cros_settings.h" | 9 #include "chrome/browser/chromeos/settings/scoped_cros_settings_test_helper.h" |
| 10 #include "chrome/browser/chromeos/settings/device_settings_service.h" | |
| 11 #include "chrome/browser/chromeos/settings/stub_cros_settings_provider.h" | |
| 12 #include "chromeos/settings/cros_settings_names.h" | 10 #include "chromeos/settings/cros_settings_names.h" |
| 13 #include "components/gcm_driver/fake_gcm_driver.h" | 11 #include "components/gcm_driver/fake_gcm_driver.h" |
| 14 #include "content/public/test/test_utils.h" | 12 #include "content/public/test/test_utils.h" |
| 15 #include "testing/gmock/include/gmock/gmock.h" | 13 #include "testing/gmock/include/gmock/gmock.h" |
| 16 #include "testing/gtest/include/gtest/gtest.h" | 14 #include "testing/gtest/include/gtest/gtest.h" |
| 17 | 15 |
| 18 using ::testing::_; | 16 using ::testing::_; |
| 19 using ::testing::SaveArg; | 17 using ::testing::SaveArg; |
| 20 | 18 |
| 21 namespace { | 19 namespace { |
| (...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 56 | 54 |
| 57 class HeartbeatSchedulerTest : public testing::Test { | 55 class HeartbeatSchedulerTest : public testing::Test { |
| 58 public: | 56 public: |
| 59 HeartbeatSchedulerTest() | 57 HeartbeatSchedulerTest() |
| 60 : task_runner_(new base::TestSimpleTaskRunner()), | 58 : task_runner_(new base::TestSimpleTaskRunner()), |
| 61 scheduler_( | 59 scheduler_( |
| 62 &gcm_driver_, kFakeEnrollmentDomain, kFakeDeviceId, task_runner_) { | 60 &gcm_driver_, kFakeEnrollmentDomain, kFakeDeviceId, task_runner_) { |
| 63 } | 61 } |
| 64 | 62 |
| 65 void SetUp() override { | 63 void SetUp() override { |
| 66 // Swap out the DeviceSettingsProvider with our stub settings provider | 64 settings_helper_.ReplaceProvider(chromeos::kHeartbeatEnabled); |
| 67 // so we can set values for the heartbeat frequency. | |
| 68 chromeos::CrosSettings* cros_settings = chromeos::CrosSettings::Get(); | |
| 69 device_settings_provider_ = | |
| 70 cros_settings->GetProvider(chromeos::kReportDeviceVersionInfo); | |
| 71 EXPECT_TRUE(device_settings_provider_); | |
| 72 EXPECT_TRUE( | |
| 73 cros_settings->RemoveSettingsProvider(device_settings_provider_)); | |
| 74 cros_settings->AddSettingsProvider(&stub_settings_provider_); | |
| 75 } | 65 } |
| 76 | 66 |
| 77 void TearDown() override { | 67 void TearDown() override { |
| 78 content::RunAllBlockingPoolTasksUntilIdle(); | 68 content::RunAllBlockingPoolTasksUntilIdle(); |
| 79 // Restore the real DeviceSettingsProvider. | |
| 80 chromeos::CrosSettings* cros_settings = chromeos::CrosSettings::Get(); | |
| 81 EXPECT_TRUE(cros_settings->RemoveSettingsProvider( | |
| 82 &stub_settings_provider_)); | |
| 83 cros_settings->AddSettingsProvider(device_settings_provider_); | |
| 84 } | 69 } |
| 85 | 70 |
| 86 void CheckPendingTaskDelay(base::Time last_heartbeat, | 71 void CheckPendingTaskDelay(base::Time last_heartbeat, |
| 87 base::TimeDelta expected_delay) { | 72 base::TimeDelta expected_delay) { |
| 88 EXPECT_FALSE(last_heartbeat.is_null()); | 73 EXPECT_FALSE(last_heartbeat.is_null()); |
| 89 base::Time now = base::Time::NowFromSystemTime(); | 74 base::Time now = base::Time::NowFromSystemTime(); |
| 90 EXPECT_GE(now, last_heartbeat); | 75 EXPECT_GE(now, last_heartbeat); |
| 91 base::TimeDelta actual_delay = task_runner_->NextPendingTaskDelay(); | 76 base::TimeDelta actual_delay = task_runner_->NextPendingTaskDelay(); |
| 92 | 77 |
| 93 // NextPendingTaskDelay() returns the exact original delay value the task | 78 // NextPendingTaskDelay() returns the exact original delay value the task |
| 94 // was posted with. The heartbeat task would have been calculated to fire at | 79 // was posted with. The heartbeat task would have been calculated to fire at |
| 95 // |last_heartbeat| + |expected_delay|, but we don't know the exact time | 80 // |last_heartbeat| + |expected_delay|, but we don't know the exact time |
| 96 // when the task was posted (if it was a couple of milliseconds after | 81 // when the task was posted (if it was a couple of milliseconds after |
| 97 // |last_heartbeat|, then |actual_delay| would be a couple of milliseconds | 82 // |last_heartbeat|, then |actual_delay| would be a couple of milliseconds |
| 98 // smaller than |expected_delay|. | 83 // smaller than |expected_delay|. |
| 99 // | 84 // |
| 100 // We do know that the task was posted sometime between |last_heartbeat| | 85 // We do know that the task was posted sometime between |last_heartbeat| |
| 101 // and |now|, so we know that 0 <= |expected_delay| - |actual_delay| <= | 86 // and |now|, so we know that 0 <= |expected_delay| - |actual_delay| <= |
| 102 // |now| - |last_heartbeat|. | 87 // |now| - |last_heartbeat|. |
| 103 base::TimeDelta delta = expected_delay - actual_delay; | 88 base::TimeDelta delta = expected_delay - actual_delay; |
| 104 EXPECT_LE(base::TimeDelta(), delta); | 89 EXPECT_LE(base::TimeDelta(), delta); |
| 105 EXPECT_GE(now - last_heartbeat, delta); | 90 EXPECT_GE(now - last_heartbeat, delta); |
| 106 } | 91 } |
| 107 | 92 |
| 108 base::MessageLoop loop_; | 93 base::MessageLoop loop_; |
| 109 | |
| 110 // Helpers used to mock out cros settings. | |
| 111 chromeos::ScopedTestDeviceSettingsService test_device_settings_service_; | |
| 112 chromeos::ScopedTestCrosSettings test_cros_settings_; | |
| 113 chromeos::CrosSettingsProvider* device_settings_provider_; | |
| 114 chromeos::StubCrosSettingsProvider stub_settings_provider_; | |
| 115 | |
| 116 MockGCMDriver gcm_driver_; | 94 MockGCMDriver gcm_driver_; |
| 95 chromeos::ScopedCrosSettingsTestHelper settings_helper_; |
| 117 | 96 |
| 118 // TaskRunner used to run individual tests. | 97 // TaskRunner used to run individual tests. |
| 119 scoped_refptr<base::TestSimpleTaskRunner> task_runner_; | 98 scoped_refptr<base::TestSimpleTaskRunner> task_runner_; |
| 120 | 99 |
| 121 // The HeartbeatScheduler instance under test. | 100 // The HeartbeatScheduler instance under test. |
| 122 policy::HeartbeatScheduler scheduler_; | 101 policy::HeartbeatScheduler scheduler_; |
| 123 }; | 102 }; |
| 124 | 103 |
| 125 TEST_F(HeartbeatSchedulerTest, Basic) { | 104 TEST_F(HeartbeatSchedulerTest, Basic) { |
| 126 // Just makes sure we can spin up and shutdown the scheduler with | 105 // Just makes sure we can spin up and shutdown the scheduler with |
| 127 // heartbeats disabled. | 106 // heartbeats disabled. |
| 128 chromeos::CrosSettings::Get()->SetBoolean( | 107 settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, false); |
| 129 chromeos::kHeartbeatEnabled, false); | |
| 130 ASSERT_TRUE(task_runner_->GetPendingTasks().empty()); | 108 ASSERT_TRUE(task_runner_->GetPendingTasks().empty()); |
| 131 } | 109 } |
| 132 | 110 |
| 133 TEST_F(HeartbeatSchedulerTest, PermanentlyFailedGCMRegistration) { | 111 TEST_F(HeartbeatSchedulerTest, PermanentlyFailedGCMRegistration) { |
| 134 // If heartbeats are enabled, we should register with GCMDriver. | 112 // If heartbeats are enabled, we should register with GCMDriver. |
| 135 EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _)); | 113 EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _)); |
| 136 chromeos::CrosSettings::Get()->SetBoolean( | 114 settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true); |
| 137 chromeos::kHeartbeatEnabled, true); | |
| 138 gcm_driver_.CompleteRegistration( | 115 gcm_driver_.CompleteRegistration( |
| 139 kHeartbeatGCMAppID, gcm::GCMClient::GCM_DISABLED); | 116 kHeartbeatGCMAppID, gcm::GCMClient::GCM_DISABLED); |
| 140 | 117 |
| 141 // There should be no heartbeat tasks pending, because registration failed. | 118 // There should be no heartbeat tasks pending, because registration failed. |
| 142 ASSERT_TRUE(task_runner_->GetPendingTasks().empty()); | 119 ASSERT_TRUE(task_runner_->GetPendingTasks().empty()); |
| 143 } | 120 } |
| 144 | 121 |
| 145 TEST_F(HeartbeatSchedulerTest, TemporarilyFailedGCMRegistration) { | 122 TEST_F(HeartbeatSchedulerTest, TemporarilyFailedGCMRegistration) { |
| 146 EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _)); | 123 EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _)); |
| 147 chromeos::CrosSettings::Get()->SetBoolean( | 124 settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true); |
| 148 chromeos::kHeartbeatEnabled, true); | |
| 149 gcm_driver_.CompleteRegistration( | 125 gcm_driver_.CompleteRegistration( |
| 150 kHeartbeatGCMAppID, gcm::GCMClient::SERVER_ERROR); | 126 kHeartbeatGCMAppID, gcm::GCMClient::SERVER_ERROR); |
| 151 testing::Mock::VerifyAndClearExpectations(&gcm_driver_); | 127 testing::Mock::VerifyAndClearExpectations(&gcm_driver_); |
| 152 | 128 |
| 153 // Should have a pending task to try registering again. | 129 // Should have a pending task to try registering again. |
| 154 ASSERT_FALSE(task_runner_->GetPendingTasks().empty()); | 130 ASSERT_FALSE(task_runner_->GetPendingTasks().empty()); |
| 155 EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _)); | 131 EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _)); |
| 156 task_runner_->RunPendingTasks(); | 132 task_runner_->RunPendingTasks(); |
| 157 testing::Mock::VerifyAndClearExpectations(&gcm_driver_); | 133 testing::Mock::VerifyAndClearExpectations(&gcm_driver_); |
| 158 | 134 |
| 159 // Once we have successfully registered, we should send a heartbeat. | 135 // Once we have successfully registered, we should send a heartbeat. |
| 160 EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _)); | 136 EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _)); |
| 161 gcm_driver_.CompleteRegistration( | 137 gcm_driver_.CompleteRegistration( |
| 162 kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS); | 138 kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS); |
| 163 task_runner_->RunPendingTasks(); | 139 task_runner_->RunPendingTasks(); |
| 164 } | 140 } |
| 165 | 141 |
| 166 TEST_F(HeartbeatSchedulerTest, ChangeHeartbeatFrequency) { | 142 TEST_F(HeartbeatSchedulerTest, ChangeHeartbeatFrequency) { |
| 167 EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _)); | 143 EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _)); |
| 168 chromeos::CrosSettings::Get()->SetBoolean( | 144 settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true); |
| 169 chromeos::kHeartbeatEnabled, true); | |
| 170 gcm_driver_.CompleteRegistration( | 145 gcm_driver_.CompleteRegistration( |
| 171 kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS); | 146 kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS); |
| 172 | 147 |
| 173 EXPECT_EQ(1U, task_runner_->GetPendingTasks().size()); | 148 EXPECT_EQ(1U, task_runner_->GetPendingTasks().size()); |
| 174 // Should have a heartbeat task posted with zero delay on startup. | 149 // Should have a heartbeat task posted with zero delay on startup. |
| 175 EXPECT_EQ(base::TimeDelta(), task_runner_->NextPendingTaskDelay()); | 150 EXPECT_EQ(base::TimeDelta(), task_runner_->NextPendingTaskDelay()); |
| 176 testing::Mock::VerifyAndClearExpectations(&gcm_driver_); | 151 testing::Mock::VerifyAndClearExpectations(&gcm_driver_); |
| 177 | 152 |
| 178 const int new_delay = 1234*1000; // 1234 seconds. | 153 const int new_delay = 1234*1000; // 1234 seconds. |
| 179 chromeos::CrosSettings::Get()->SetInteger(chromeos::kHeartbeatFrequency, | 154 settings_helper_.SetInteger(chromeos::kHeartbeatFrequency, new_delay); |
| 180 new_delay); | |
| 181 // Now run pending heartbeat task, should send a heartbeat. | 155 // Now run pending heartbeat task, should send a heartbeat. |
| 182 gcm::GCMClient::OutgoingMessage message; | 156 gcm::GCMClient::OutgoingMessage message; |
| 183 EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _)) | 157 EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _)) |
| 184 .WillOnce(SaveArg<2>(&message)); | 158 .WillOnce(SaveArg<2>(&message)); |
| 185 task_runner_->RunPendingTasks(); | 159 task_runner_->RunPendingTasks(); |
| 186 EXPECT_TRUE(task_runner_->GetPendingTasks().empty()); | 160 EXPECT_TRUE(task_runner_->GetPendingTasks().empty()); |
| 187 | 161 |
| 188 // Complete sending a message - we should queue up the next heartbeat | 162 // Complete sending a message - we should queue up the next heartbeat |
| 189 // even if the previous attempt failed. | 163 // even if the previous attempt failed. |
| 190 gcm_driver_.CompleteSend( | 164 gcm_driver_.CompleteSend( |
| 191 kHeartbeatGCMAppID, message.id, gcm::GCMClient::SERVER_ERROR); | 165 kHeartbeatGCMAppID, message.id, gcm::GCMClient::SERVER_ERROR); |
| 192 EXPECT_EQ(1U, task_runner_->GetPendingTasks().size()); | 166 EXPECT_EQ(1U, task_runner_->GetPendingTasks().size()); |
| 193 CheckPendingTaskDelay(scheduler_.last_heartbeat(), | 167 CheckPendingTaskDelay(scheduler_.last_heartbeat(), |
| 194 base::TimeDelta::FromMilliseconds(new_delay)); | 168 base::TimeDelta::FromMilliseconds(new_delay)); |
| 195 } | 169 } |
| 196 | 170 |
| 197 TEST_F(HeartbeatSchedulerTest, DisableHeartbeats) { | 171 TEST_F(HeartbeatSchedulerTest, DisableHeartbeats) { |
| 198 // Makes sure that we can disable heartbeats on the fly. | 172 // Makes sure that we can disable heartbeats on the fly. |
| 199 EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _)); | 173 EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _)); |
| 200 chromeos::CrosSettings::Get()->SetBoolean( | 174 settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true); |
| 201 chromeos::kHeartbeatEnabled, true); | |
| 202 gcm::GCMClient::OutgoingMessage message; | 175 gcm::GCMClient::OutgoingMessage message; |
| 203 EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _)) | 176 EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _)) |
| 204 .WillOnce(SaveArg<2>(&message)); | 177 .WillOnce(SaveArg<2>(&message)); |
| 205 gcm_driver_.CompleteRegistration( | 178 gcm_driver_.CompleteRegistration( |
| 206 kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS); | 179 kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS); |
| 207 // Should have a heartbeat task posted. | 180 // Should have a heartbeat task posted. |
| 208 EXPECT_EQ(1U, task_runner_->GetPendingTasks().size()); | 181 EXPECT_EQ(1U, task_runner_->GetPendingTasks().size()); |
| 209 task_runner_->RunPendingTasks(); | 182 task_runner_->RunPendingTasks(); |
| 210 | 183 |
| 211 // Complete sending a message - we should queue up the next heartbeat. | 184 // Complete sending a message - we should queue up the next heartbeat. |
| 212 gcm_driver_.CompleteSend( | 185 gcm_driver_.CompleteSend( |
| 213 kHeartbeatGCMAppID, message.id, gcm::GCMClient::SUCCESS); | 186 kHeartbeatGCMAppID, message.id, gcm::GCMClient::SUCCESS); |
| 214 | 187 |
| 215 // Should have a new heartbeat task posted. | 188 // Should have a new heartbeat task posted. |
| 216 ASSERT_EQ(1U, task_runner_->GetPendingTasks().size()); | 189 ASSERT_EQ(1U, task_runner_->GetPendingTasks().size()); |
| 217 CheckPendingTaskDelay( | 190 CheckPendingTaskDelay( |
| 218 scheduler_.last_heartbeat(), | 191 scheduler_.last_heartbeat(), |
| 219 base::TimeDelta::FromMilliseconds( | 192 base::TimeDelta::FromMilliseconds( |
| 220 policy::HeartbeatScheduler::kDefaultHeartbeatIntervalMs)); | 193 policy::HeartbeatScheduler::kDefaultHeartbeatIntervalMs)); |
| 221 testing::Mock::VerifyAndClearExpectations(&gcm_driver_); | 194 testing::Mock::VerifyAndClearExpectations(&gcm_driver_); |
| 222 | 195 |
| 223 // Now disable heartbeats. Should get no more heartbeats sent. | 196 // Now disable heartbeats. Should get no more heartbeats sent. |
| 224 chromeos::CrosSettings::Get()->SetBoolean( | 197 settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, false); |
| 225 chromeos::kHeartbeatEnabled, false); | |
| 226 task_runner_->RunPendingTasks(); | 198 task_runner_->RunPendingTasks(); |
| 227 EXPECT_TRUE(task_runner_->GetPendingTasks().empty()); | 199 EXPECT_TRUE(task_runner_->GetPendingTasks().empty()); |
| 228 } | 200 } |
| 229 | 201 |
| 230 TEST_F(HeartbeatSchedulerTest, CheckMessageContents) { | 202 TEST_F(HeartbeatSchedulerTest, CheckMessageContents) { |
| 231 gcm::GCMClient::OutgoingMessage message; | 203 gcm::GCMClient::OutgoingMessage message; |
| 232 EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _)); | 204 EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _)); |
| 233 EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _)) | 205 EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _)) |
| 234 .WillOnce(SaveArg<2>(&message)); | 206 .WillOnce(SaveArg<2>(&message)); |
| 235 chromeos::CrosSettings::Get()->SetBoolean( | 207 settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true); |
| 236 chromeos::kHeartbeatEnabled, true); | |
| 237 gcm_driver_.CompleteRegistration( | 208 gcm_driver_.CompleteRegistration( |
| 238 kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS); | 209 kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS); |
| 239 task_runner_->RunPendingTasks(); | 210 task_runner_->RunPendingTasks(); |
| 240 | 211 |
| 241 // Heartbeats should have a time-to-live equivalent to the heartbeat frequency | 212 // Heartbeats should have a time-to-live equivalent to the heartbeat frequency |
| 242 // so we don't have more than one heartbeat queued at a time. | 213 // so we don't have more than one heartbeat queued at a time. |
| 243 EXPECT_EQ(policy::HeartbeatScheduler::kDefaultHeartbeatIntervalMs/1000, | 214 EXPECT_EQ(policy::HeartbeatScheduler::kDefaultHeartbeatIntervalMs/1000, |
| 244 message.time_to_live); | 215 message.time_to_live); |
| 245 | 216 |
| 246 // Check the values in the message payload. | 217 // Check the values in the message payload. |
| 247 EXPECT_EQ("hb", message.data["type"]); | 218 EXPECT_EQ("hb", message.data["type"]); |
| 248 int64 timestamp; | 219 int64 timestamp; |
| 249 EXPECT_TRUE(base::StringToInt64(message.data["timestamp"], ×tamp)); | 220 EXPECT_TRUE(base::StringToInt64(message.data["timestamp"], ×tamp)); |
| 250 EXPECT_EQ(kFakeEnrollmentDomain, message.data["domain_name"]); | 221 EXPECT_EQ(kFakeEnrollmentDomain, message.data["domain_name"]); |
| 251 EXPECT_EQ(kFakeDeviceId, message.data["device_id"]); | 222 EXPECT_EQ(kFakeDeviceId, message.data["device_id"]); |
| 252 } | 223 } |
| 253 | 224 |
| 254 } // namespace | 225 } // namespace |
| OLD | NEW |