1 // Copyright 2013 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 "components/update_client/ping_manager.h"
6
7 #include <stdint.h>
8
9 #include <limits>
10 #include <memory>
11 #include <string>
12 #include <utility>
13 #include <vector>
14
15 #include "base/bind.h"
16 #include "base/json/json_reader.h"
17 #include "base/memory/ref_counted.h"
18 #include "base/run_loop.h"
19 #include "base/test/task_environment.h"
20 #include "base/threading/thread_task_runner_handle.h"
21 #include "base/version.h"
22 #include "components/update_client/component.h"
23 #include "components/update_client/net/url_loader_post_interceptor.h"
24 #include "components/update_client/protocol_definition.h"
25 #include "components/update_client/protocol_serializer.h"
26 #include "components/update_client/test_configurator.h"
27 #include "components/update_client/update_engine.h"
28 #include "testing/gtest/include/gtest/gtest.h"
29 #include "third_party/re2/src/re2/re2.h"
30
31 using std::string;
32
33 namespace update_client {
34
35 class PingManagerTest : public testing::Test,
36 public testing::WithParamInterface<bool> {
37 public:
38 PingManagerTest();
39 ~PingManagerTest() override = default;
40
41 PingManager::Callback MakePingCallback();
42 scoped_refptr<UpdateContext> MakeMockUpdateContext() const;
43
44 // Overrides from testing::Test.
45 void SetUp() override;
46 void TearDown() override;
47
48 void PingSentCallback(int error, const std::string& response);
49
50 protected:
51 void Quit();
52 void RunThreads();
53
54 scoped_refptr<TestConfigurator> config_;
55 scoped_refptr<PingManager> ping_manager_;
56
57 int error_ = -1;
58 std::string response_;
59
60 private:
61 base::test::TaskEnvironment task_environment_;
62 base::OnceClosure quit_closure_;
63 };
64
PingManagerTest()65 PingManagerTest::PingManagerTest()
66 : task_environment_(base::test::TaskEnvironment::MainThreadType::IO) {
67 config_ = base::MakeRefCounted<TestConfigurator>();
68 }
69
SetUp()70 void PingManagerTest::SetUp() {
71 ping_manager_ = base::MakeRefCounted<PingManager>(config_);
72 }
73
TearDown()74 void PingManagerTest::TearDown() {
75 // Run the threads until they are idle to allow the clean up
76 // of the network interceptors on the IO thread.
77 task_environment_.RunUntilIdle();
78 ping_manager_ = nullptr;
79 }
80
RunThreads()81 void PingManagerTest::RunThreads() {
82 base::RunLoop runloop;
83 quit_closure_ = runloop.QuitClosure();
84 runloop.Run();
85 }
86
Quit()87 void PingManagerTest::Quit() {
88 if (!quit_closure_.is_null())
89 std::move(quit_closure_).Run();
90 }
91
MakePingCallback()92 PingManager::Callback PingManagerTest::MakePingCallback() {
93 return base::BindOnce(&PingManagerTest::PingSentCallback,
94 base::Unretained(this));
95 }
96
PingSentCallback(int error,const std::string & response)97 void PingManagerTest::PingSentCallback(int error, const std::string& response) {
98 error_ = error;
99 response_ = response;
100 Quit();
101 }
102
MakeMockUpdateContext() const103 scoped_refptr<UpdateContext> PingManagerTest::MakeMockUpdateContext() const {
104 return base::MakeRefCounted<UpdateContext>(
105 config_, false, std::vector<std::string>(),
106 UpdateClient::CrxStateChangeCallback(),
107 UpdateEngine::NotifyObserversCallback(), UpdateEngine::Callback(),
108 nullptr);
109 }
110
111 // This test is parameterized for using JSON or XML serialization. |true| means
112 // JSON serialization is used.
113 INSTANTIATE_TEST_SUITE_P(Parameterized, PingManagerTest, testing::Bool());
114
TEST_P(PingManagerTest,SendPing)115 TEST_P(PingManagerTest, SendPing) {
116 auto interceptor = std::make_unique<URLLoaderPostInterceptor>(
117 config_->test_url_loader_factory());
118 EXPECT_TRUE(interceptor);
119
120 const auto update_context = MakeMockUpdateContext();
121 {
122 // Test eventresult="1" is sent for successful updates.
123 Component component(*update_context, "abc");
124 component.crx_component_ = CrxComponent();
125 component.crx_component_->version = base::Version("1.0");
126 component.state_ = std::make_unique<Component::StateUpdated>(&component);
127 component.previous_version_ = base::Version("1.0");
128 component.next_version_ = base::Version("2.0");
129 component.AppendEvent(component.MakeEventUpdateComplete());
130
131 EXPECT_TRUE(interceptor->ExpectRequest(std::make_unique<AnyMatch>()));
132 ping_manager_->SendPing(component, MakePingCallback());
133 RunThreads();
134
135 EXPECT_EQ(1, interceptor->GetCount()) << interceptor->GetRequestsAsString();
136 const auto msg = interceptor->GetRequestBody(0);
137 const auto root = base::JSONReader::Read(msg);
138 ASSERT_TRUE(root);
139 const auto* request = root->FindKey("request");
140 ASSERT_TRUE(request);
141 EXPECT_TRUE(request->FindKey("@os"));
142 EXPECT_EQ("fake_prodid", request->FindKey("@updater")->GetString());
143 EXPECT_EQ("crx2,crx3", request->FindKey("acceptformat")->GetString());
144 EXPECT_TRUE(request->FindKey("arch"));
145 EXPECT_EQ("cr", request->FindKey("dedup")->GetString());
146 EXPECT_LT(0, request->FindPath({"hw", "physmemory"})->GetInt());
147 EXPECT_EQ("fake_lang", request->FindKey("lang")->GetString());
148 EXPECT_TRUE(request->FindKey("nacl_arch"));
149 EXPECT_EQ("fake_channel_string",
150 request->FindKey("prodchannel")->GetString());
151 EXPECT_EQ("30.0", request->FindKey("prodversion")->GetString());
152 EXPECT_EQ("3.1", request->FindKey("protocol")->GetString());
153 EXPECT_TRUE(request->FindKey("requestid"));
154 EXPECT_TRUE(request->FindKey("sessionid"));
155 EXPECT_EQ("fake_channel_string",
156 request->FindKey("updaterchannel")->GetString());
157 EXPECT_EQ("30.0", request->FindKey("updaterversion")->GetString());
158
159 EXPECT_TRUE(request->FindPath({"os", "arch"})->is_string());
160 EXPECT_EQ("Fake Operating System",
161 request->FindPath({"os", "platform"})->GetString());
162 EXPECT_TRUE(request->FindPath({"os", "version"})->is_string());
163
164 const auto& app = request->FindKey("app")->GetList()[0];
165 EXPECT_EQ("abc", app.FindKey("appid")->GetString());
166 EXPECT_EQ("1.0", app.FindKey("version")->GetString());
167 const auto& event = app.FindKey("event")->GetList()[0];
168 EXPECT_EQ(1, event.FindKey("eventresult")->GetInt());
169 EXPECT_EQ(3, event.FindKey("eventtype")->GetInt());
170 EXPECT_EQ("2.0", event.FindKey("nextversion")->GetString());
171 EXPECT_EQ("1.0", event.FindKey("previousversion")->GetString());
172
173 // Check the ping request does not carry the specific extra request headers.
174 const auto headers = std::get<1>(interceptor->GetRequests()[0]);
175 EXPECT_FALSE(headers.HasHeader("X-Goog-Update-Interactivity"));
176 EXPECT_FALSE(headers.HasHeader("X-Goog-Update-Updater"));
177 EXPECT_FALSE(headers.HasHeader("X-Goog-Update-AppId"));
178 interceptor->Reset();
179 }
180
181 {
182 // Test eventresult="0" is sent for failed updates.
183 Component component(*update_context, "abc");
184 component.crx_component_ = CrxComponent();
185 component.crx_component_->version = base::Version("1.0");
186 component.state_ =
187 std::make_unique<Component::StateUpdateError>(&component);
188 component.previous_version_ = base::Version("1.0");
189 component.next_version_ = base::Version("2.0");
190 component.AppendEvent(component.MakeEventUpdateComplete());
191
192 EXPECT_TRUE(interceptor->ExpectRequest(std::make_unique<AnyMatch>()));
193 ping_manager_->SendPing(component, MakePingCallback());
194 RunThreads();
195
196 EXPECT_EQ(1, interceptor->GetCount()) << interceptor->GetRequestsAsString();
197 const auto msg = interceptor->GetRequestBody(0);
198 const auto root = base::JSONReader::Read(msg);
199 ASSERT_TRUE(root);
200 const auto* request = root->FindKey("request");
201 const auto& app = request->FindKey("app")->GetList()[0];
202 EXPECT_EQ("abc", app.FindKey("appid")->GetString());
203 EXPECT_EQ("1.0", app.FindKey("version")->GetString());
204 const auto& event = app.FindKey("event")->GetList()[0];
205 EXPECT_EQ(0, event.FindKey("eventresult")->GetInt());
206 EXPECT_EQ(3, event.FindKey("eventtype")->GetInt());
207 EXPECT_EQ("2.0", event.FindKey("nextversion")->GetString());
208 EXPECT_EQ("1.0", event.FindKey("previousversion")->GetString());
209 interceptor->Reset();
210 }
211
212 {
213 // Test the error values and the fingerprints.
214 Component component(*update_context, "abc");
215 component.crx_component_ = CrxComponent();
216 component.crx_component_->version = base::Version("1.0");
217 component.state_ =
218 std::make_unique<Component::StateUpdateError>(&component);
219 component.previous_version_ = base::Version("1.0");
220 component.next_version_ = base::Version("2.0");
221 component.previous_fp_ = "prev fp";
222 component.next_fp_ = "next fp";
223 component.error_category_ = ErrorCategory::kDownload;
224 component.error_code_ = 2;
225 component.extra_code1_ = -1;
226 component.diff_error_category_ = ErrorCategory::kService;
227 component.diff_error_code_ = 20;
228 component.diff_extra_code1_ = -10;
229 component.crx_diffurls_.push_back(GURL("http://host/path"));
230 component.AppendEvent(component.MakeEventUpdateComplete());
231
232 EXPECT_TRUE(interceptor->ExpectRequest(std::make_unique<AnyMatch>()));
233 ping_manager_->SendPing(component, MakePingCallback());
234 RunThreads();
235
236 EXPECT_EQ(1, interceptor->GetCount()) << interceptor->GetRequestsAsString();
237 const auto msg = interceptor->GetRequestBody(0);
238 const auto root = base::JSONReader::Read(msg);
239 ASSERT_TRUE(root);
240 const auto* request = root->FindKey("request");
241 const auto& app = request->FindKey("app")->GetList()[0];
242 EXPECT_EQ("abc", app.FindKey("appid")->GetString());
243 EXPECT_EQ("1.0", app.FindKey("version")->GetString());
244 const auto& event = app.FindKey("event")->GetList()[0];
245 EXPECT_EQ(0, event.FindKey("eventresult")->GetInt());
246 EXPECT_EQ(3, event.FindKey("eventtype")->GetInt());
247 EXPECT_EQ("2.0", event.FindKey("nextversion")->GetString());
248 EXPECT_EQ("1.0", event.FindKey("previousversion")->GetString());
249 EXPECT_EQ(4, event.FindKey("differrorcat")->GetInt());
250 EXPECT_EQ(20, event.FindKey("differrorcode")->GetInt());
251 EXPECT_EQ(-10, event.FindKey("diffextracode1")->GetInt());
252 EXPECT_EQ(0, event.FindKey("diffresult")->GetInt());
253 EXPECT_EQ(1, event.FindKey("errorcat")->GetInt());
254 EXPECT_EQ(2, event.FindKey("errorcode")->GetInt());
255 EXPECT_EQ(-1, event.FindKey("extracode1")->GetInt());
256 EXPECT_EQ("next fp", event.FindKey("nextfp")->GetString());
257 EXPECT_EQ("prev fp", event.FindKey("previousfp")->GetString());
258 interceptor->Reset();
259 }
260
261 {
262 // Test an invalid |next_version| is not serialized.
263 Component component(*update_context, "abc");
264 component.crx_component_ = CrxComponent();
265 component.crx_component_->version = base::Version("1.0");
266 component.state_ =
267 std::make_unique<Component::StateUpdateError>(&component);
268 component.previous_version_ = base::Version("1.0");
269
270 component.AppendEvent(component.MakeEventUpdateComplete());
271
272 EXPECT_TRUE(interceptor->ExpectRequest(std::make_unique<AnyMatch>()));
273 ping_manager_->SendPing(component, MakePingCallback());
274 RunThreads();
275
276 EXPECT_EQ(1, interceptor->GetCount()) << interceptor->GetRequestsAsString();
277 const auto msg = interceptor->GetRequestBody(0);
278 const auto root = base::JSONReader::Read(msg);
279 ASSERT_TRUE(root);
280 const auto* request = root->FindKey("request");
281 const auto& app = request->FindKey("app")->GetList()[0];
282 EXPECT_EQ("abc", app.FindKey("appid")->GetString());
283 EXPECT_EQ("1.0", app.FindKey("version")->GetString());
284 const auto& event = app.FindKey("event")->GetList()[0];
285 EXPECT_EQ(0, event.FindKey("eventresult")->GetInt());
286 EXPECT_EQ(3, event.FindKey("eventtype")->GetInt());
287 EXPECT_EQ("1.0", event.FindKey("previousversion")->GetString());
288 interceptor->Reset();
289 }
290
291 {
292 // Test a valid |previouversion| and |next_version| = base::Version("0")
293 // are serialized correctly under <event...> for uninstall.
294 Component component(*update_context, "abc");
295 component.crx_component_ = CrxComponent();
296 component.Uninstall(base::Version("1.2.3.4"), 0);
297 component.AppendEvent(component.MakeEventUninstalled());
298
299 EXPECT_TRUE(interceptor->ExpectRequest(std::make_unique<AnyMatch>()));
300 ping_manager_->SendPing(component, MakePingCallback());
301 RunThreads();
302
303 EXPECT_EQ(1, interceptor->GetCount()) << interceptor->GetRequestsAsString();
304 const auto msg = interceptor->GetRequestBody(0);
305 const auto root = base::JSONReader::Read(msg);
306 ASSERT_TRUE(root);
307 const auto* request = root->FindKey("request");
308 const auto& app = request->FindKey("app")->GetList()[0];
309 EXPECT_EQ("abc", app.FindKey("appid")->GetString());
310 EXPECT_EQ("1.2.3.4", app.FindKey("version")->GetString());
311 const auto& event = app.FindKey("event")->GetList()[0];
312 EXPECT_EQ(1, event.FindKey("eventresult")->GetInt());
313 EXPECT_EQ(4, event.FindKey("eventtype")->GetInt());
314 EXPECT_EQ("1.2.3.4", event.FindKey("previousversion")->GetString());
315 EXPECT_EQ("0", event.FindKey("nextversion")->GetString());
316 interceptor->Reset();
317 }
318
319 {
320 // Test registrationEvent.
321 Component component(*update_context, "abc");
322 component.crx_component_ = CrxComponent();
323 component.Registration(base::Version("1.2.3.4"));
324 component.AppendEvent(component.MakeEventRegistration());
325
326 EXPECT_TRUE(interceptor->ExpectRequest(std::make_unique<AnyMatch>()));
327 ping_manager_->SendPing(component, MakePingCallback());
328 RunThreads();
329
330 EXPECT_EQ(1, interceptor->GetCount()) << interceptor->GetRequestsAsString();
331 const auto msg = interceptor->GetRequestBody(0);
332
333 const auto root = base::JSONReader::Read(msg);
334 ASSERT_TRUE(root);
335 const auto* request = root->FindKey("request");
336 const auto& app = request->FindKey("app")->GetList()[0];
337 EXPECT_EQ("abc", app.FindKey("appid")->GetString());
338 EXPECT_EQ("1.2.3.4", app.FindKey("version")->GetString());
339 const auto& event = app.FindKey("event")->GetList()[0];
340 EXPECT_EQ(1, event.FindKey("eventresult")->GetInt());
341 EXPECT_EQ(2, event.FindKey("eventtype")->GetInt());
342 EXPECT_EQ("1.2.3.4", event.FindKey("nextversion")->GetString());
343 interceptor->Reset();
344 }
345
346 {
347 // Test the download metrics.
348 Component component(*update_context, "abc");
349 component.crx_component_ = CrxComponent();
350 component.crx_component_->version = base::Version("1.0");
351 component.state_ = std::make_unique<Component::StateUpdated>(&component);
352 component.previous_version_ = base::Version("1.0");
353 component.next_version_ = base::Version("2.0");
354 component.AppendEvent(component.MakeEventUpdateComplete());
355
356 CrxDownloader::DownloadMetrics download_metrics;
357 download_metrics.url = GURL("http://host1/path1");
358 download_metrics.downloader = CrxDownloader::DownloadMetrics::kUrlFetcher;
359 download_metrics.error = -1;
360 download_metrics.downloaded_bytes = 123;
361 download_metrics.total_bytes = 456;
362 download_metrics.download_time_ms = 987;
363 component.AppendEvent(component.MakeEventDownloadMetrics(download_metrics));
364
365 download_metrics = CrxDownloader::DownloadMetrics();
366 download_metrics.url = GURL("http://host2/path2");
367 download_metrics.downloader = CrxDownloader::DownloadMetrics::kBits;
368 download_metrics.error = 0;
369 download_metrics.downloaded_bytes = 1230;
370 download_metrics.total_bytes = 4560;
371 download_metrics.download_time_ms = 9870;
372 component.AppendEvent(component.MakeEventDownloadMetrics(download_metrics));
373
374 download_metrics = CrxDownloader::DownloadMetrics();
375 download_metrics.url = GURL("http://host3/path3");
376 download_metrics.downloader = CrxDownloader::DownloadMetrics::kBits;
377 download_metrics.error = 0;
378 download_metrics.downloaded_bytes = kProtocolMaxInt;
379 download_metrics.total_bytes = kProtocolMaxInt - 1;
380 download_metrics.download_time_ms = kProtocolMaxInt - 2;
381 component.AppendEvent(component.MakeEventDownloadMetrics(download_metrics));
382
383 EXPECT_TRUE(interceptor->ExpectRequest(std::make_unique<AnyMatch>()));
384 ping_manager_->SendPing(component, MakePingCallback());
385 RunThreads();
386
387 EXPECT_EQ(1, interceptor->GetCount()) << interceptor->GetRequestsAsString();
388 const auto msg = interceptor->GetRequestBody(0);
389 const auto root = base::JSONReader::Read(msg);
390 ASSERT_TRUE(root);
391 const auto* request = root->FindKey("request");
392 const auto& app = request->FindKey("app")->GetList()[0];
393 EXPECT_EQ("abc", app.FindKey("appid")->GetString());
394 EXPECT_EQ("1.0", app.FindKey("version")->GetString());
395 EXPECT_EQ(4u, app.FindKey("event")->GetList().size());
396 {
397 const auto& event = app.FindKey("event")->GetList()[0];
398 EXPECT_EQ(1, event.FindKey("eventresult")->GetInt());
399 EXPECT_EQ(3, event.FindKey("eventtype")->GetInt());
400 EXPECT_EQ("2.0", event.FindKey("nextversion")->GetString());
401 EXPECT_EQ("1.0", event.FindKey("previousversion")->GetString());
402 }
403 {
404 const auto& event = app.FindKey("event")->GetList()[1];
405 EXPECT_EQ(0, event.FindKey("eventresult")->GetInt());
406 EXPECT_EQ(14, event.FindKey("eventtype")->GetInt());
407 EXPECT_EQ(987, event.FindKey("download_time_ms")->GetDouble());
408 EXPECT_EQ(123, event.FindKey("downloaded")->GetDouble());
409 EXPECT_EQ("direct", event.FindKey("downloader")->GetString());
410 EXPECT_EQ(-1, event.FindKey("errorcode")->GetInt());
411 EXPECT_EQ("2.0", event.FindKey("nextversion")->GetString());
412 EXPECT_EQ("1.0", event.FindKey("previousversion")->GetString());
413 EXPECT_EQ(456, event.FindKey("total")->GetDouble());
414 EXPECT_EQ("http://host1/path1", event.FindKey("url")->GetString());
415 }
416 {
417 const auto& event = app.FindKey("event")->GetList()[2];
418 EXPECT_EQ(1, event.FindKey("eventresult")->GetInt());
419 EXPECT_EQ(14, event.FindKey("eventtype")->GetInt());
420 EXPECT_EQ(9870, event.FindKey("download_time_ms")->GetDouble());
421 EXPECT_EQ(1230, event.FindKey("downloaded")->GetDouble());
422 EXPECT_EQ("bits", event.FindKey("downloader")->GetString());
423 EXPECT_EQ("2.0", event.FindKey("nextversion")->GetString());
424 EXPECT_EQ("1.0", event.FindKey("previousversion")->GetString());
425 EXPECT_EQ(4560, event.FindKey("total")->GetDouble());
426 EXPECT_EQ("http://host2/path2", event.FindKey("url")->GetString());
427 }
428 {
429 const auto& event = app.FindKey("event")->GetList()[3];
430 EXPECT_EQ(1, event.FindKey("eventresult")->GetInt());
431 EXPECT_EQ(14, event.FindKey("eventtype")->GetInt());
432 EXPECT_EQ(9007199254740990,
433 event.FindKey("download_time_ms")->GetDouble());
434 EXPECT_EQ(9007199254740992, event.FindKey("downloaded")->GetDouble());
435 EXPECT_EQ("bits", event.FindKey("downloader")->GetString());
436 EXPECT_EQ("2.0", event.FindKey("nextversion")->GetString());
437 EXPECT_EQ("1.0", event.FindKey("previousversion")->GetString());
438 EXPECT_EQ(9007199254740991, event.FindKey("total")->GetDouble());
439 EXPECT_EQ("http://host3/path3", event.FindKey("url")->GetString());
440 }
441 interceptor->Reset();
442 }
443 }
444
445 // Tests that sending the ping fails when the component requires encryption but
446 // the ping URL is unsecure.
TEST_P(PingManagerTest,RequiresEncryption)447 TEST_P(PingManagerTest, RequiresEncryption) {
448 config_->SetPingUrl(GURL("http:\\foo\bar"));
449
450 const auto update_context = MakeMockUpdateContext();
451
452 Component component(*update_context, "abc");
453 component.crx_component_ = CrxComponent();
454 component.crx_component_->version = base::Version("1.0");
455
456 // The default value for |requires_network_encryption| is true.
457 EXPECT_TRUE(component.crx_component_->requires_network_encryption);
458
459 component.state_ = std::make_unique<Component::StateUpdated>(&component);
460 component.previous_version_ = base::Version("1.0");
461 component.next_version_ = base::Version("2.0");
462 component.AppendEvent(component.MakeEventUpdateComplete());
463
464 ping_manager_->SendPing(component, MakePingCallback());
465 RunThreads();
466
467 EXPECT_EQ(-2, error_);
468 }
469
470 } // namespace update_client
471