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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <stdint.h>
#include "base/strings/string_number_conversions.h"
#include "google_apis/gcm/engine/gservices_settings.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace gcm {
namespace {
const int64_t kAlternativeCheckinInterval = 16 * 60 * 60;
const char kAlternativeCheckinURL[] = "http://alternative.url/checkin";
const char kAlternativeMCSHostname[] = "alternative.gcm.host";
const int kAlternativeMCSSecurePort = 7777;
const char kAlternativeRegistrationURL[] =
"http://alternative.url/registration";
const int64_t kDefaultCheckinInterval = 2 * 24 * 60 * 60; // seconds = 2 days.
const char kDefaultCheckinURL[] = "https://android.clients.google.com/checkin";
const char kDefaultRegistrationURL[] =
"https://android.clients.google.com/c2dm/register3";
const char kDefaultSettingsDigest[] =
"1-da39a3ee5e6b4b0d3255bfef95601890afd80709";
const char kAlternativeSettingsDigest[] =
"1-7da4aa4eb38a8bd3e330e3751cc0899924499134";
void AddSettingsToResponse(
checkin_proto::AndroidCheckinResponse& checkin_response,
const GServicesSettings::SettingsMap& settings,
bool settings_diff) {
for (GServicesSettings::SettingsMap::const_iterator iter = settings.begin();
iter != settings.end();
++iter) {
checkin_proto::GservicesSetting* setting = checkin_response.add_setting();
setting->set_name(iter->first);
setting->set_value(iter->second);
}
checkin_response.set_settings_diff(settings_diff);
}
} // namespace
class GServicesSettingsTest : public testing::Test {
public:
GServicesSettingsTest();
~GServicesSettingsTest() override;
void CheckAllSetToDefault();
GServicesSettings& settings() {
return gservices_settings_;
}
private:
GServicesSettings gservices_settings_;
};
GServicesSettingsTest::GServicesSettingsTest()
: gservices_settings_() {
}
GServicesSettingsTest::~GServicesSettingsTest() {}
void GServicesSettingsTest::CheckAllSetToDefault() {
EXPECT_EQ(base::Seconds(kDefaultCheckinInterval),
settings().GetCheckinInterval());
EXPECT_EQ(GURL(kDefaultCheckinURL), settings().GetCheckinURL());
EXPECT_EQ(GURL("https://mtalk.google.com:5228"),
settings().GetMCSMainEndpoint());
EXPECT_EQ(GURL("https://mtalk.google.com:443"),
settings().GetMCSFallbackEndpoint());
EXPECT_EQ(GURL(kDefaultRegistrationURL), settings().GetRegistrationURL());
}
// Verifies default values of the G-services settings and settings digest.
TEST_F(GServicesSettingsTest, DefaultSettingsAndDigest) {
CheckAllSetToDefault();
EXPECT_EQ(kDefaultSettingsDigest, settings().digest());
EXPECT_EQ(kDefaultSettingsDigest,
GServicesSettings::CalculateDigest(settings().settings_map()));
}
// Verifies digest calculation for the sample provided by protocol owners.
TEST_F(GServicesSettingsTest, CalculateDigest) {
GServicesSettings::SettingsMap settings_map;
settings_map["android_id"] = "55XXXXXXXXXXXXXXXX0";
settings_map["checkin_interval"] = "86400";
settings_map["checkin_url"] =
"https://fake.address.google.com/canary/checkin";
settings_map["chrome_device"] = "1";
settings_map["device_country"] = "us";
settings_map["gcm_hostname"] = "fake.address.google.com";
settings_map["gcm_secure_port"] = "443";
EXPECT_EQ("1-33381ccd1cf5791dc0e6dfa234266fa9f1259197",
GServicesSettings::CalculateDigest(settings_map));
}
// Verifies that settings are not updated when load result is empty.
TEST_F(GServicesSettingsTest, UpdateFromEmptyLoadResult) {
GCMStore::LoadResult result;
result.gservices_digest = "";
settings().UpdateFromLoadResult(result);
CheckAllSetToDefault();
EXPECT_EQ(kDefaultSettingsDigest, settings().digest());
}
// Verifies that settings are not when digest value does not match.
TEST_F(GServicesSettingsTest, UpdateFromLoadResultWithSettingMissing) {
GCMStore::LoadResult result;
result.gservices_settings["checkin_internval"] = "100000";
result.gservices_digest = "digest_value";
settings().UpdateFromLoadResult(result);
CheckAllSetToDefault();
EXPECT_EQ(kDefaultSettingsDigest, settings().digest());
}
// Verifies that the settings are set correctly based on the load result.
TEST_F(GServicesSettingsTest, UpdateFromLoadResult) {
GCMStore::LoadResult result;
result.gservices_settings["checkin_interval"] =
base::NumberToString(kAlternativeCheckinInterval);
result.gservices_settings["checkin_url"] = kAlternativeCheckinURL;
result.gservices_settings["gcm_hostname"] = kAlternativeMCSHostname;
result.gservices_settings["gcm_secure_port"] =
base::NumberToString(kAlternativeMCSSecurePort);
result.gservices_settings["gcm_registration_url"] =
kAlternativeRegistrationURL;
result.gservices_digest = kAlternativeSettingsDigest;
settings().UpdateFromLoadResult(result);
EXPECT_EQ(base::Seconds(kAlternativeCheckinInterval),
settings().GetCheckinInterval());
EXPECT_EQ(GURL(kAlternativeCheckinURL), settings().GetCheckinURL());
EXPECT_EQ(GURL("https://alternative.gcm.host:7777"),
settings().GetMCSMainEndpoint());
EXPECT_EQ(GURL("https://alternative.gcm.host:443"),
settings().GetMCSFallbackEndpoint());
EXPECT_EQ(GURL(kAlternativeRegistrationURL), settings().GetRegistrationURL());
EXPECT_EQ(GServicesSettings::CalculateDigest(result.gservices_settings),
settings().digest());
}
// Verifies that the checkin interval is updated to minimum if the original
// value is less than minimum.
TEST_F(GServicesSettingsTest, CheckinResponseMinimumCheckinInterval) {
// Setting the checkin interval to less than minimum.
checkin_proto::AndroidCheckinResponse checkin_response;
GServicesSettings::SettingsMap new_settings;
new_settings["checkin_interval"] = "3600";
AddSettingsToResponse(checkin_response, new_settings, false);
EXPECT_TRUE(settings().UpdateFromCheckinResponse(checkin_response));
EXPECT_EQ(GServicesSettings::MinimumCheckinInterval(),
settings().GetCheckinInterval());
EXPECT_EQ(GServicesSettings::CalculateDigest(new_settings),
settings().digest());
}
// Verifies that default checkin interval can be selectively overwritten.
TEST_F(GServicesSettingsTest, CheckinResponseUpdateCheckinInterval) {
checkin_proto::AndroidCheckinResponse checkin_response;
GServicesSettings::SettingsMap new_settings;
new_settings["checkin_interval"] = "86400";
AddSettingsToResponse(checkin_response, new_settings, false);
EXPECT_TRUE(settings().UpdateFromCheckinResponse(checkin_response));
// Only the checkin interval was updated:
EXPECT_EQ(base::Seconds(86400), settings().GetCheckinInterval());
// Other settings still set to default.
EXPECT_EQ(GURL("https://mtalk.google.com:5228"),
settings().GetMCSMainEndpoint());
EXPECT_EQ(GURL("https://mtalk.google.com:443"),
settings().GetMCSFallbackEndpoint());
EXPECT_EQ(GURL(kDefaultCheckinURL), settings().GetCheckinURL());
EXPECT_EQ(GURL(kDefaultRegistrationURL), settings().GetRegistrationURL());
EXPECT_EQ(GServicesSettings::CalculateDigest(new_settings),
settings().digest());
}
// Verifies that default registration URL can be selectively overwritten.
TEST_F(GServicesSettingsTest, CheckinResponseUpdateRegistrationURL) {
checkin_proto::AndroidCheckinResponse checkin_response;
GServicesSettings::SettingsMap new_settings;
new_settings["gcm_registration_url"] = "https://new.registration.url";
AddSettingsToResponse(checkin_response, new_settings, false);
EXPECT_TRUE(settings().UpdateFromCheckinResponse(checkin_response));
// Only the registration URL was updated:
EXPECT_EQ(GURL("https://new.registration.url"),
settings().GetRegistrationURL());
// Other settings still set to default.
EXPECT_EQ(base::Seconds(kDefaultCheckinInterval),
settings().GetCheckinInterval());
EXPECT_EQ(GURL("https://mtalk.google.com:5228"),
settings().GetMCSMainEndpoint());
EXPECT_EQ(GURL("https://mtalk.google.com:443"),
settings().GetMCSFallbackEndpoint());
EXPECT_EQ(GURL(kDefaultCheckinURL), settings().GetCheckinURL());
EXPECT_EQ(GServicesSettings::CalculateDigest(new_settings),
settings().digest());
}
// Verifies that default checkin URL can be selectively overwritten.
TEST_F(GServicesSettingsTest, CheckinResponseUpdateCheckinURL) {
checkin_proto::AndroidCheckinResponse checkin_response;
GServicesSettings::SettingsMap new_settings;
new_settings["checkin_url"] = "https://new.checkin.url";
AddSettingsToResponse(checkin_response, new_settings, false);
EXPECT_TRUE(settings().UpdateFromCheckinResponse(checkin_response));
// Only the checkin URL was updated:
EXPECT_EQ(GURL("https://new.checkin.url"), settings().GetCheckinURL());
// Other settings still set to default.
EXPECT_EQ(base::Seconds(kDefaultCheckinInterval),
settings().GetCheckinInterval());
EXPECT_EQ(GURL("https://mtalk.google.com:5228"),
settings().GetMCSMainEndpoint());
EXPECT_EQ(GURL("https://mtalk.google.com:443"),
settings().GetMCSFallbackEndpoint());
EXPECT_EQ(GURL(kDefaultRegistrationURL), settings().GetRegistrationURL());
EXPECT_EQ(GServicesSettings::CalculateDigest(new_settings),
settings().digest());
}
// Verifies that default MCS hostname can be selectively overwritten.
TEST_F(GServicesSettingsTest, CheckinResponseUpdateMCSHostname) {
checkin_proto::AndroidCheckinResponse checkin_response;
GServicesSettings::SettingsMap new_settings;
new_settings["gcm_hostname"] = "new.gcm.hostname";
AddSettingsToResponse(checkin_response, new_settings, false);
EXPECT_TRUE(settings().UpdateFromCheckinResponse(checkin_response));
// Only the MCS endpoints were updated:
EXPECT_EQ(GURL("https://new.gcm.hostname:5228"),
settings().GetMCSMainEndpoint());
EXPECT_EQ(GURL("https://new.gcm.hostname:443"),
settings().GetMCSFallbackEndpoint());
// Other settings still set to default.
EXPECT_EQ(base::Seconds(kDefaultCheckinInterval),
settings().GetCheckinInterval());
EXPECT_EQ(GURL(kDefaultCheckinURL), settings().GetCheckinURL());
EXPECT_EQ(GURL(kDefaultRegistrationURL), settings().GetRegistrationURL());
EXPECT_EQ(GServicesSettings::CalculateDigest(new_settings),
settings().digest());
}
// Verifies that default MCS secure port can be selectively overwritten.
TEST_F(GServicesSettingsTest, CheckinResponseUpdateMCSSecurePort) {
checkin_proto::AndroidCheckinResponse checkin_response;
GServicesSettings::SettingsMap new_settings;
new_settings["gcm_secure_port"] = "5229";
AddSettingsToResponse(checkin_response, new_settings, false);
EXPECT_TRUE(settings().UpdateFromCheckinResponse(checkin_response));
// Only the main MCS endpoint was updated:
EXPECT_EQ(GURL("https://mtalk.google.com:5229"),
settings().GetMCSMainEndpoint());
// Other settings still set to default.
EXPECT_EQ(base::Seconds(kDefaultCheckinInterval),
settings().GetCheckinInterval());
EXPECT_EQ(GURL(kDefaultCheckinURL), settings().GetCheckinURL());
EXPECT_EQ(GURL("https://mtalk.google.com:443"),
settings().GetMCSFallbackEndpoint());
EXPECT_EQ(GURL(kDefaultRegistrationURL), settings().GetRegistrationURL());
EXPECT_EQ(GServicesSettings::CalculateDigest(new_settings),
settings().digest());
}
// Update from checkin response should also do incremental update for both cases
// where some settings are removed or added.
TEST_F(GServicesSettingsTest, UpdateFromCheckinResponseSettingsDiff) {
checkin_proto::AndroidCheckinResponse checkin_response;
// Only the new settings will be included in the response with settings diff.
GServicesSettings::SettingsMap settings_diff;
settings_diff["new_setting_1"] = "new_setting_1_value";
settings_diff["new_setting_2"] = "new_setting_2_value";
settings_diff["gcm_secure_port"] = "5229";
// Full settings are necessary to calculate digest.
GServicesSettings::SettingsMap full_settings(settings_diff);
std::string digest = GServicesSettings::CalculateDigest(full_settings);
checkin_response.Clear();
AddSettingsToResponse(checkin_response, settings_diff, true);
EXPECT_TRUE(settings().UpdateFromCheckinResponse(checkin_response));
EXPECT_EQ(full_settings, settings().settings_map());
// Default setting overwritten by settings diff.
EXPECT_EQ(GURL("https://mtalk.google.com:5229"),
settings().GetMCSMainEndpoint());
// Setting up diff removing some of the values (including default setting).
settings_diff.clear();
settings_diff["delete_new_setting_1"] = "";
settings_diff["delete_gcm_secure_port"] = "";
settings_diff["new_setting_3"] = "new_setting_3_value";
// Updating full settings to calculate digest.
full_settings.erase(full_settings.find("new_setting_1"));
full_settings.erase(full_settings.find("gcm_secure_port"));
full_settings["new_setting_3"] = "new_setting_3_value";
digest = GServicesSettings::CalculateDigest(full_settings);
checkin_response.Clear();
AddSettingsToResponse(checkin_response, settings_diff, true);
EXPECT_TRUE(settings().UpdateFromCheckinResponse(checkin_response));
EXPECT_EQ(full_settings, settings().settings_map());
// Default setting back to norm.
EXPECT_EQ(GURL("https://mtalk.google.com:5228"),
settings().GetMCSMainEndpoint());
}
} // namespace gcm
|
