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
|
// Copyright 2014 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 "google_apis/gcm/engine/heartbeat_manager.h"
#include "base/bind.h"
#include "base/bind_helpers.h"
#include "base/memory/scoped_ptr.h"
#include "base/message_loop/message_loop.h"
#include "base/time/time.h"
#include "base/timer/timer.h"
#include "google_apis/gcm/protocol/mcs.pb.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace gcm {
namespace {
mcs_proto::HeartbeatConfig BuildHeartbeatConfig(int interval_ms) {
mcs_proto::HeartbeatConfig config;
config.set_interval_ms(interval_ms);
return config;
}
class TestHeartbeatManager : public HeartbeatManager {
public:
TestHeartbeatManager() {}
virtual ~TestHeartbeatManager() {}
// Bypass the heartbeat timer, and send the heartbeat now.
void TriggerHearbeat();
// Check for a missed heartbeat now.
void TriggerMissedHeartbeatCheck();
};
void TestHeartbeatManager::TriggerHearbeat() {
OnHeartbeatTriggered();
}
void TestHeartbeatManager::TriggerMissedHeartbeatCheck() {
CheckForMissedHeartbeat();
}
class HeartbeatManagerTest : public testing::Test {
public:
HeartbeatManagerTest();
~HeartbeatManagerTest() override {}
TestHeartbeatManager* manager() const { return manager_.get(); }
int heartbeats_sent() const { return heartbeats_sent_; }
int reconnects_triggered() const { return reconnects_triggered_; }
// Starts the heartbeat manager.
void StartManager();
private:
// Helper functions for verifying heartbeat manager effects.
void SendHeartbeatClosure();
void TriggerReconnectClosure();
scoped_ptr<TestHeartbeatManager> manager_;
int heartbeats_sent_;
int reconnects_triggered_;
base::MessageLoop message_loop_;
};
HeartbeatManagerTest::HeartbeatManagerTest()
: manager_(new TestHeartbeatManager()),
heartbeats_sent_(0),
reconnects_triggered_(0) {
}
void HeartbeatManagerTest::StartManager() {
manager_->Start(base::Bind(&HeartbeatManagerTest::SendHeartbeatClosure,
base::Unretained(this)),
base::Bind(&HeartbeatManagerTest::TriggerReconnectClosure,
base::Unretained(this)));
}
void HeartbeatManagerTest::SendHeartbeatClosure() {
heartbeats_sent_++;
}
void HeartbeatManagerTest::TriggerReconnectClosure() {
reconnects_triggered_++;
}
// Basic initialization. No heartbeat should be pending.
TEST_F(HeartbeatManagerTest, Init) {
EXPECT_TRUE(manager()->GetNextHeartbeatTime().is_null());
}
// Acknowledging a heartbeat before starting the manager should have no effect.
TEST_F(HeartbeatManagerTest, AckBeforeStart) {
manager()->OnHeartbeatAcked();
EXPECT_TRUE(manager()->GetNextHeartbeatTime().is_null());
}
// Starting the manager should start the heartbeat timer.
TEST_F(HeartbeatManagerTest, Start) {
StartManager();
EXPECT_GT(manager()->GetNextHeartbeatTime(), base::TimeTicks::Now());
EXPECT_EQ(0, heartbeats_sent());
EXPECT_EQ(0, reconnects_triggered());
}
// Acking the heartbeat should trigger a new heartbeat timer.
TEST_F(HeartbeatManagerTest, AckedHeartbeat) {
StartManager();
manager()->TriggerHearbeat();
base::TimeTicks heartbeat = manager()->GetNextHeartbeatTime();
EXPECT_GT(heartbeat, base::TimeTicks::Now());
EXPECT_EQ(1, heartbeats_sent());
EXPECT_EQ(0, reconnects_triggered());
manager()->OnHeartbeatAcked();
EXPECT_LT(heartbeat, manager()->GetNextHeartbeatTime());
EXPECT_EQ(1, heartbeats_sent());
EXPECT_EQ(0, reconnects_triggered());
manager()->TriggerHearbeat();
EXPECT_EQ(2, heartbeats_sent());
EXPECT_EQ(0, reconnects_triggered());
}
// Trigger a heartbeat when one was outstanding should reset the connection.
TEST_F(HeartbeatManagerTest, UnackedHeartbeat) {
StartManager();
manager()->TriggerHearbeat();
EXPECT_EQ(1, heartbeats_sent());
EXPECT_EQ(0, reconnects_triggered());
manager()->TriggerHearbeat();
EXPECT_EQ(1, heartbeats_sent());
EXPECT_EQ(1, reconnects_triggered());
}
// Updating the heartbeat interval before starting should result in the new
// interval being used at Start time.
TEST_F(HeartbeatManagerTest, UpdateIntervalThenStart) {
const int kIntervalMs = 60 * 1000; // 60 seconds.
manager()->UpdateHeartbeatConfig(BuildHeartbeatConfig(kIntervalMs));
EXPECT_TRUE(manager()->GetNextHeartbeatTime().is_null());
StartManager();
EXPECT_LE(manager()->GetNextHeartbeatTime() - base::TimeTicks::Now(),
base::TimeDelta::FromMilliseconds(kIntervalMs));
}
// Updating the heartbeat interval after starting should only use the new
// interval on the next heartbeat.
TEST_F(HeartbeatManagerTest, StartThenUpdateInterval) {
const int kIntervalMs = 60 * 1000; // 60 seconds.
StartManager();
base::TimeTicks heartbeat = manager()->GetNextHeartbeatTime();
EXPECT_GT(heartbeat - base::TimeTicks::Now(),
base::TimeDelta::FromMilliseconds(kIntervalMs));
// Updating the interval should not affect an outstanding heartbeat.
manager()->UpdateHeartbeatConfig(BuildHeartbeatConfig(kIntervalMs));
EXPECT_EQ(heartbeat, manager()->GetNextHeartbeatTime());
// Triggering and acking the heartbeat should result in a heartbeat being
// posted with the new interval.
manager()->TriggerHearbeat();
manager()->OnHeartbeatAcked();
EXPECT_LE(manager()->GetNextHeartbeatTime() - base::TimeTicks::Now(),
base::TimeDelta::FromMilliseconds(kIntervalMs));
EXPECT_NE(heartbeat, manager()->GetNextHeartbeatTime());
}
// Updating the timer used for heartbeats before starting should not start the
// timer.
TEST_F(HeartbeatManagerTest, UpdateTimerBeforeStart) {
manager()->UpdateHeartbeatTimer(
make_scoped_ptr(new base::Timer(true, false)));
EXPECT_TRUE(manager()->GetNextHeartbeatTime().is_null());
}
// Updating the timer used for heartbeats after starting should restart the
// timer but not increase the heartbeat time by more than a millisecond.
TEST_F(HeartbeatManagerTest, UpdateTimerAfterStart) {
StartManager();
base::TimeTicks heartbeat = manager()->GetNextHeartbeatTime();
manager()->UpdateHeartbeatTimer(
make_scoped_ptr(new base::Timer(true, false)));
EXPECT_LT(manager()->GetNextHeartbeatTime() - heartbeat,
base::TimeDelta::FromMilliseconds(5));
}
// Stopping the manager should reset the heartbeat timer.
TEST_F(HeartbeatManagerTest, Stop) {
StartManager();
EXPECT_GT(manager()->GetNextHeartbeatTime(), base::TimeTicks::Now());
manager()->Stop();
EXPECT_TRUE(manager()->GetNextHeartbeatTime().is_null());
}
// Simulate missing a heartbeat by manually invoking the check method. The
// heartbeat should only be triggered once, and only if the heartbeat timer
// is running. Because the period is several minutes, none should fire.
TEST_F(HeartbeatManagerTest, MissedHeartbeat) {
// Do nothing while stopped.
manager()->TriggerMissedHeartbeatCheck();
StartManager();
EXPECT_EQ(0, heartbeats_sent());
// Do nothing before the period is reached.
manager()->TriggerMissedHeartbeatCheck();
EXPECT_EQ(0, heartbeats_sent());
}
} // namespace
} // namespace gcm
|
