1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
// Copyright (c) 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 "chrome/browser/chromeos/policy/heartbeat_scheduler.h"
#include "base/strings/string_number_conversions.h"
#include "base/test/test_simple_task_runner.h"
#include "chrome/browser/chromeos/settings/scoped_cros_settings_test_helper.h"
#include "chromeos/settings/cros_settings_names.h"
#include "components/gcm_driver/fake_gcm_driver.h"
#include "content/public/test/test_utils.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using ::testing::_;
using ::testing::SaveArg;
namespace {
const char* const kFakeEnrollmentDomain = "example.com";
const char* const kFakeDeviceId = "fake_device_id";
const char* const kHeartbeatGCMAppID = "com.google.chromeos.monitoring";
class MockGCMDriver : public testing::StrictMock<gcm::FakeGCMDriver> {
public:
MockGCMDriver() {
}
~MockGCMDriver() override {
}
MOCK_METHOD2(RegisterImpl,
void(const std::string&, const std::vector<std::string>&));
MOCK_METHOD3(SendImpl,
void(const std::string&, const std::string&,
const gcm::GCMClient::OutgoingMessage& message));
// Helper function to complete a registration previously started by
// Register().
void CompleteRegistration(const std::string& app_id,
gcm::GCMClient::Result result) {
RegisterFinished(app_id, "registration_id", result);
}
// Helper function to complete a send operation previously started by
// Send().
void CompleteSend(const std::string& app_id,
const std::string& message_id,
gcm::GCMClient::Result result) {
SendFinished(app_id, message_id, result);
}
};
class HeartbeatSchedulerTest : public testing::Test {
public:
HeartbeatSchedulerTest()
: task_runner_(new base::TestSimpleTaskRunner()),
scheduler_(
&gcm_driver_, kFakeEnrollmentDomain, kFakeDeviceId, task_runner_) {
}
void SetUp() override {
settings_helper_.ReplaceProvider(chromeos::kHeartbeatEnabled);
}
void TearDown() override {
content::RunAllBlockingPoolTasksUntilIdle();
}
void CheckPendingTaskDelay(base::Time last_heartbeat,
base::TimeDelta expected_delay) {
EXPECT_FALSE(last_heartbeat.is_null());
base::Time now = base::Time::NowFromSystemTime();
EXPECT_GE(now, last_heartbeat);
base::TimeDelta actual_delay = task_runner_->NextPendingTaskDelay();
// NextPendingTaskDelay() returns the exact original delay value the task
// was posted with. The heartbeat task would have been calculated to fire at
// |last_heartbeat| + |expected_delay|, but we don't know the exact time
// when the task was posted (if it was a couple of milliseconds after
// |last_heartbeat|, then |actual_delay| would be a couple of milliseconds
// smaller than |expected_delay|.
//
// We do know that the task was posted sometime between |last_heartbeat|
// and |now|, so we know that 0 <= |expected_delay| - |actual_delay| <=
// |now| - |last_heartbeat|.
base::TimeDelta delta = expected_delay - actual_delay;
EXPECT_LE(base::TimeDelta(), delta);
EXPECT_GE(now - last_heartbeat, delta);
}
base::MessageLoop loop_;
MockGCMDriver gcm_driver_;
chromeos::ScopedCrosSettingsTestHelper settings_helper_;
// TaskRunner used to run individual tests.
scoped_refptr<base::TestSimpleTaskRunner> task_runner_;
// The HeartbeatScheduler instance under test.
policy::HeartbeatScheduler scheduler_;
};
TEST_F(HeartbeatSchedulerTest, Basic) {
// Just makes sure we can spin up and shutdown the scheduler with
// heartbeats disabled.
settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, false);
ASSERT_TRUE(task_runner_->GetPendingTasks().empty());
}
TEST_F(HeartbeatSchedulerTest, PermanentlyFailedGCMRegistration) {
// If heartbeats are enabled, we should register with GCMDriver.
EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _));
settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true);
gcm_driver_.CompleteRegistration(
kHeartbeatGCMAppID, gcm::GCMClient::GCM_DISABLED);
// There should be no heartbeat tasks pending, because registration failed.
ASSERT_TRUE(task_runner_->GetPendingTasks().empty());
}
TEST_F(HeartbeatSchedulerTest, TemporarilyFailedGCMRegistration) {
EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _));
settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true);
gcm_driver_.CompleteRegistration(
kHeartbeatGCMAppID, gcm::GCMClient::SERVER_ERROR);
testing::Mock::VerifyAndClearExpectations(&gcm_driver_);
// Should have a pending task to try registering again.
ASSERT_FALSE(task_runner_->GetPendingTasks().empty());
EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _));
task_runner_->RunPendingTasks();
testing::Mock::VerifyAndClearExpectations(&gcm_driver_);
// Once we have successfully registered, we should send a heartbeat.
EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _));
gcm_driver_.CompleteRegistration(
kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS);
task_runner_->RunPendingTasks();
}
TEST_F(HeartbeatSchedulerTest, ChangeHeartbeatFrequency) {
EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _));
settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true);
gcm_driver_.CompleteRegistration(
kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS);
EXPECT_EQ(1U, task_runner_->GetPendingTasks().size());
// Should have a heartbeat task posted with zero delay on startup.
EXPECT_EQ(base::TimeDelta(), task_runner_->NextPendingTaskDelay());
testing::Mock::VerifyAndClearExpectations(&gcm_driver_);
const int new_delay = 1234*1000; // 1234 seconds.
settings_helper_.SetInteger(chromeos::kHeartbeatFrequency, new_delay);
// Now run pending heartbeat task, should send a heartbeat.
gcm::GCMClient::OutgoingMessage message;
EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _))
.WillOnce(SaveArg<2>(&message));
task_runner_->RunPendingTasks();
EXPECT_TRUE(task_runner_->GetPendingTasks().empty());
// Complete sending a message - we should queue up the next heartbeat
// even if the previous attempt failed.
gcm_driver_.CompleteSend(
kHeartbeatGCMAppID, message.id, gcm::GCMClient::SERVER_ERROR);
EXPECT_EQ(1U, task_runner_->GetPendingTasks().size());
CheckPendingTaskDelay(scheduler_.last_heartbeat(),
base::TimeDelta::FromMilliseconds(new_delay));
}
TEST_F(HeartbeatSchedulerTest, DisableHeartbeats) {
// Makes sure that we can disable heartbeats on the fly.
EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _));
settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true);
gcm::GCMClient::OutgoingMessage message;
EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _))
.WillOnce(SaveArg<2>(&message));
gcm_driver_.CompleteRegistration(
kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS);
// Should have a heartbeat task posted.
EXPECT_EQ(1U, task_runner_->GetPendingTasks().size());
task_runner_->RunPendingTasks();
// Complete sending a message - we should queue up the next heartbeat.
gcm_driver_.CompleteSend(
kHeartbeatGCMAppID, message.id, gcm::GCMClient::SUCCESS);
// Should have a new heartbeat task posted.
ASSERT_EQ(1U, task_runner_->GetPendingTasks().size());
CheckPendingTaskDelay(
scheduler_.last_heartbeat(),
base::TimeDelta::FromMilliseconds(
policy::HeartbeatScheduler::kDefaultHeartbeatIntervalMs));
testing::Mock::VerifyAndClearExpectations(&gcm_driver_);
// Now disable heartbeats. Should get no more heartbeats sent.
settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, false);
task_runner_->RunPendingTasks();
EXPECT_TRUE(task_runner_->GetPendingTasks().empty());
}
TEST_F(HeartbeatSchedulerTest, CheckMessageContents) {
gcm::GCMClient::OutgoingMessage message;
EXPECT_CALL(gcm_driver_, RegisterImpl(kHeartbeatGCMAppID, _));
EXPECT_CALL(gcm_driver_, SendImpl(kHeartbeatGCMAppID, _, _))
.WillOnce(SaveArg<2>(&message));
settings_helper_.SetBoolean(chromeos::kHeartbeatEnabled, true);
gcm_driver_.CompleteRegistration(
kHeartbeatGCMAppID, gcm::GCMClient::SUCCESS);
task_runner_->RunPendingTasks();
// Heartbeats should have a time-to-live equivalent to the heartbeat frequency
// so we don't have more than one heartbeat queued at a time.
EXPECT_EQ(policy::HeartbeatScheduler::kDefaultHeartbeatIntervalMs/1000,
message.time_to_live);
// Check the values in the message payload.
EXPECT_EQ("hb", message.data["type"]);
int64 timestamp;
EXPECT_TRUE(base::StringToInt64(message.data["timestamp"], ×tamp));
EXPECT_EQ(kFakeEnrollmentDomain, message.data["domain_name"]);
EXPECT_EQ(kFakeDeviceId, message.data["device_id"]);
}
} // namespace
|
