| OLD | NEW |
|---|
| (Empty) |
| 1 // Copyright 2016 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/doodle/doodle_fetcher.h" | |
| 6 | |
| 7 #include <string> | |
| 8 #include <utility> | |
| 9 | |
| 10 #include "base/bind.h" | |
| 11 #include "base/command_line.h" | |
| 12 #include "base/json/json_reader.h" | |
| 13 #include "base/memory/ptr_util.h" | |
| 14 #include "base/message_loop/message_loop.h" | |
| 15 #include "base/test/simple_test_clock.h" | |
| 16 #include "base/values.h" | |
| 17 #include "components/google/core/browser/google_switches.h" | |
| 18 #include "components/google/core/browser/google_url_tracker.h" | |
| 19 #include "net/http/http_status_code.h" | |
| 20 #include "net/url_request/test_url_fetcher_factory.h" | |
| 21 #include "net/url_request/url_request_status.h" | |
| 22 #include "net/url_request/url_request_test_util.h" | |
| 23 #include "testing/gmock/include/gmock/gmock.h" | |
| 24 #include "testing/gtest/include/gtest/gtest.h" | |
| 25 | |
| 26 using testing::Eq; | |
| 27 | |
| 28 namespace doodle { | |
| 29 | |
| 30 namespace { | |
| 31 | |
| 32 const char kDoodleConfigPath[] = "/async/ddljson"; | |
| 33 | |
| 34 // Required to instantiate a GoogleUrlTracker in UNIT_TEST_MODE. | |
| 35 class GoogleURLTrackerClientStub : public GoogleURLTrackerClient { | |
| 36 public: | |
| 37 GoogleURLTrackerClientStub() {} | |
| 38 ~GoogleURLTrackerClientStub() override {} | |
| 39 | |
| 40 bool IsBackgroundNetworkingEnabled() override { return true; } | |
| 41 | |
| 42 PrefService* GetPrefs() override { return nullptr; } | |
| 43 | |
| 44 net::URLRequestContextGetter* GetRequestContext() override { return nullptr; } | |
| 45 | |
| 46 private: | |
| 47 DISALLOW_COPY_AND_ASSIGN(GoogleURLTrackerClientStub); | |
| 48 }; | |
| 49 | |
| 50 std::string Resolve(const std::string& relative_url) { | |
| 51 return GURL(GoogleURLTracker::kDefaultGoogleHomepage) | |
| 52 .Resolve(relative_url) | |
| 53 .spec(); | |
| 54 } | |
| 55 | |
| 56 void ParseJson( | |
| 57 const std::string& json, | |
| 58 const base::Callback<void(std::unique_ptr<base::Value> json)>& success, | |
| 59 const base::Callback<void(const std::string&)>& error) { | |
| 60 base::JSONReader json_reader; | |
| 61 std::unique_ptr<base::Value> value = json_reader.ReadToValue(json); | |
| 62 if (value) { | |
| 63 success.Run(std::move(value)); | |
| 64 } else { | |
| 65 error.Run(json_reader.GetErrorMessage()); | |
| 66 } | |
| 67 } | |
| 68 | |
| 69 } // namespace | |
| 70 | |
| 71 class DoodleFetcherTest : public testing::Test { | |
| 72 public: | |
| 73 DoodleFetcherTest() | |
| 74 : url_(GURL(GoogleURLTracker::kDefaultGoogleHomepage)), | |
| 75 google_url_tracker_(base::MakeUnique<GoogleURLTrackerClientStub>(), | |
| 76 GoogleURLTracker::UNIT_TEST_MODE), | |
| 77 doodle_fetcher_( | |
| 78 new net::TestURLRequestContextGetter(message_loop_.task_runner()), | |
| 79 &google_url_tracker_, | |
| 80 base::Bind(ParseJson)) { | |
| 81 // Random difference to ensure that expiry_dates are really relative. | |
| 82 auto clock = base::MakeUnique<base::SimpleTestClock>(); | |
| 83 clock_ = clock.get(); | |
| 84 clock_->Advance(base::TimeDelta::FromMilliseconds(1123581321)); | |
| 85 doodle_fetcher_.SetClockForTesting(std::move(clock)); | |
| 86 } | |
| 87 | |
| 88 void RespondWithData(const std::string& data) { | |
| 89 RespondToFetcherWithData(GetRunningFetcher(), data); | |
| 90 } | |
| 91 | |
| 92 void RespondToFetcherWithData(net::TestURLFetcher* url_fetcher, | |
| 93 const std::string& data) { | |
| 94 url_fetcher->set_status(net::URLRequestStatus()); | |
| 95 url_fetcher->set_response_code(net::HTTP_OK); | |
| 96 url_fetcher->SetResponseString(data); | |
| 97 // Call the URLFetcher delegate to continue the test. | |
| 98 url_fetcher->delegate()->OnURLFetchComplete(url_fetcher); | |
| 99 } | |
| 100 | |
| 101 void RespondWithError(int error_code) { | |
| 102 net::TestURLFetcher* url_fetcher = GetRunningFetcher(); | |
| 103 url_fetcher->set_status(net::URLRequestStatus::FromError(error_code)); | |
| 104 url_fetcher->SetResponseString(""); | |
| 105 // Call the URLFetcher delegate to continue the test. | |
| 106 url_fetcher->delegate()->OnURLFetchComplete(url_fetcher); | |
| 107 } | |
| 108 | |
| 109 net::TestURLFetcher* GetRunningFetcher() { | |
| 110 // All created TestURLFetchers have ID 0 by default. | |
| 111 net::TestURLFetcher* url_fetcher = url_fetcher_factory_.GetFetcherByID(0); | |
| 112 DCHECK(url_fetcher); | |
| 113 return url_fetcher; | |
| 114 } | |
| 115 | |
| 116 DoodleFetcher::FinishedCallback CreateResponseSavingCallback( | |
| 117 DoodleState* state_out, | |
| 118 base::Optional<DoodleConfig>* config_out) { | |
| 119 return base::BindOnce( | |
| 120 [](DoodleState* state_out, base::Optional<DoodleConfig>* config_out, | |
| 121 DoodleState state, const base::Optional<DoodleConfig>& config) { | |
| 122 if (state_out) { | |
| 123 *state_out = state; | |
| 124 } | |
| 125 if (config_out) { | |
| 126 *config_out = config; | |
| 127 } | |
| 128 }, | |
| 129 state_out, config_out); | |
| 130 } | |
| 131 | |
| 132 DoodleFetcher* doodle_fetcher() { return &doodle_fetcher_; } | |
| 133 | |
| 134 GURL GetGoogleBaseURL() { return google_url_tracker_.google_url(); } | |
| 135 | |
| 136 base::Time TimeFromNow(uint64_t milliseconds) { | |
| 137 return clock_->Now() + base::TimeDelta::FromMilliseconds(milliseconds); | |
| 138 } | |
| 139 | |
| 140 private: | |
| 141 base::MessageLoop message_loop_; | |
| 142 GURL url_; | |
| 143 net::TestURLFetcherFactory url_fetcher_factory_; | |
| 144 base::SimpleTestClock* clock_; // Owned by the doodle_fetcher. | |
| 145 GoogleURLTracker google_url_tracker_; | |
| 146 DoodleFetcher doodle_fetcher_; | |
| 147 }; | |
| 148 | |
| 149 TEST_F(DoodleFetcherTest, ReturnsFromFetchWithoutError) { | |
| 150 DoodleState state(DoodleState::NO_DOODLE); | |
| 151 base::Optional<DoodleConfig> response; | |
| 152 | |
| 153 doodle_fetcher()->FetchDoodle( | |
| 154 CreateResponseSavingCallback(&state, &response)); | |
| 155 RespondWithData(R"json({"ddljson": { | |
| 156 "time_to_live_ms":55000, | |
| 157 "large_image": {"url":"/logos/doodles/2015/some.gif"} | |
| 158 }})json"); | |
| 159 | |
| 160 EXPECT_THAT(state, Eq(DoodleState::AVAILABLE)); | |
| 161 EXPECT_TRUE(response.has_value()); | |
| 162 } | |
| 163 | |
| 164 TEST_F(DoodleFetcherTest, ReturnsFrom404FetchWithError) { | |
| 165 DoodleState state(DoodleState::NO_DOODLE); | |
| 166 base::Optional<DoodleConfig> response; | |
| 167 | |
| 168 doodle_fetcher()->FetchDoodle( | |
| 169 CreateResponseSavingCallback(&state, &response)); | |
| 170 RespondWithError(net::ERR_FILE_NOT_FOUND); | |
| 171 | |
| 172 EXPECT_THAT(state, Eq(DoodleState::DOWNLOAD_ERROR)); | |
| 173 EXPECT_FALSE(response.has_value()); | |
| 174 } | |
| 175 | |
| 176 TEST_F(DoodleFetcherTest, ReturnsErrorForInvalidJson) { | |
| 177 DoodleState state(DoodleState::NO_DOODLE); | |
| 178 base::Optional<DoodleConfig> response; | |
| 179 | |
| 180 doodle_fetcher()->FetchDoodle( | |
| 181 CreateResponseSavingCallback(&state, &response)); | |
| 182 RespondWithData("}"); | |
| 183 | |
| 184 EXPECT_THAT(state, Eq(DoodleState::PARSING_ERROR)); | |
| 185 EXPECT_FALSE(response.has_value()); | |
| 186 } | |
| 187 | |
| 188 TEST_F(DoodleFetcherTest, ReturnsErrorForIncompleteJson) { | |
| 189 DoodleState state(DoodleState::NO_DOODLE); | |
| 190 base::Optional<DoodleConfig> response; | |
| 191 | |
| 192 doodle_fetcher()->FetchDoodle( | |
| 193 CreateResponseSavingCallback(&state, &response)); | |
| 194 RespondWithData("{}"); | |
| 195 | |
| 196 EXPECT_THAT(state, Eq(DoodleState::PARSING_ERROR)); | |
| 197 EXPECT_FALSE(response.has_value()); | |
| 198 } | |
| 199 | |
| 200 TEST_F(DoodleFetcherTest, ResponseContainsValidBaseInformation) { | |
| 201 DoodleState state(DoodleState::NO_DOODLE); | |
| 202 base::Optional<DoodleConfig> response; | |
| 203 | |
| 204 doodle_fetcher()->FetchDoodle( | |
| 205 CreateResponseSavingCallback(&state, &response)); | |
| 206 RespondWithData(R"json()]}'{ | |
| 207 "ddljson": { | |
| 208 "alt_text":"Mouseover Text", | |
| 209 "doodle_type":"SIMPLE", | |
| 210 "interactive_html":"\u003cstyle\u003e\u003c\/style\u003e", | |
| 211 "search_url":"/search?q\u003dtest", | |
| 212 "target_url":"/search?q\u003dtest\u0026sa\u003dX\u0026ved\u003d0ahUKEw", | |
| 213 "time_to_live_ms":55000, | |
| 214 "large_image": { | |
| 215 "url":"/logos/doodles/2015/new-years-eve-2015-59854387958251-hp.gif" | |
| 216 } | |
| 217 }})json"); | |
| 218 | |
| 219 EXPECT_THAT(state, Eq(DoodleState::AVAILABLE)); | |
| 220 ASSERT_TRUE(response.has_value()); | |
| 221 DoodleConfig config = response.value(); | |
| 222 | |
| 223 EXPECT_TRUE(config.search_url.is_valid()); | |
| 224 EXPECT_THAT(config.search_url, Eq(Resolve("/search?q\u003dtest"))); | |
| 225 EXPECT_TRUE(config.fullpage_interactive_url.is_empty()); | |
| 226 EXPECT_TRUE(config.target_url.is_valid()); | |
| 227 EXPECT_THAT(config.target_url, | |
| 228 Eq(Resolve("/search?q\u003dtest\u0026sa\u003dX\u0026ved\u003d" | |
| 229 "0ahUKEw"))); | |
| 230 EXPECT_THAT(config.doodle_type, Eq(DoodleType::SIMPLE)); | |
| 231 EXPECT_THAT(config.alt_text, Eq("Mouseover Text")); | |
| 232 EXPECT_THAT(config.interactive_html, | |
| 233 Eq("\u003cstyle\u003e\u003c/style\u003e")); | |
| 234 | |
| 235 EXPECT_THAT(config.expiry_date, Eq(TimeFromNow(55000))); | |
| 236 } | |
| 237 | |
| 238 TEST_F(DoodleFetcherTest, DoodleExpiresWithinThirtyDaysForTooLargeTTL) { | |
| 239 DoodleState state(DoodleState::NO_DOODLE); | |
| 240 base::Optional<DoodleConfig> response; | |
| 241 | |
| 242 doodle_fetcher()->FetchDoodle( | |
| 243 CreateResponseSavingCallback(&state, &response)); | |
| 244 RespondWithData(R"json({"ddljson": { | |
| 245 "time_to_live_ms":5184000000, | |
| 246 "large_image": {"url":"/logos/doodles/2015/some.gif"} | |
| 247 }})json"); // 60 days | |
| 248 | |
| 249 EXPECT_THAT(state, Eq(DoodleState::AVAILABLE)); | |
| 250 ASSERT_TRUE(response.has_value()); | |
| 251 EXPECT_THAT(response.value().expiry_date, | |
| 252 Eq(TimeFromNow(30ul * 24 * 60 * 60 * 1000 /* ms */))); // 30 days | |
| 253 } | |
| 254 | |
| 255 TEST_F(DoodleFetcherTest, DoodleExpiresNowWithNegativeTTL) { | |
| 256 DoodleState state(DoodleState::NO_DOODLE); | |
| 257 base::Optional<DoodleConfig> response; | |
| 258 | |
| 259 doodle_fetcher()->FetchDoodle( | |
| 260 CreateResponseSavingCallback(&state, &response)); | |
| 261 RespondWithData(R"json({"ddljson": { | |
| 262 "time_to_live_ms":-1, | |
| 263 "large_image": {"url":"/logos/doodles/2015/some.gif"} | |
| 264 }})json"); | |
| 265 | |
| 266 EXPECT_THAT(state, Eq(DoodleState::AVAILABLE)); | |
| 267 ASSERT_TRUE(response.has_value()); | |
| 268 EXPECT_THAT(response.value().expiry_date, Eq(TimeFromNow(0))); | |
| 269 } | |
| 270 | |
| 271 TEST_F(DoodleFetcherTest, DoodleExpiresNowWithoutValidTTL) { | |
| 272 DoodleState state(DoodleState::NO_DOODLE); | |
| 273 base::Optional<DoodleConfig> response; | |
| 274 | |
| 275 doodle_fetcher()->FetchDoodle( | |
| 276 CreateResponseSavingCallback(&state, &response)); | |
| 277 RespondWithData(R"json({"ddljson": { | |
| 278 "large_image": {"url":"/logos/doodles/2015/some.gif"} | |
| 279 }})json"); | |
| 280 | |
| 281 EXPECT_THAT(state, Eq(DoodleState::AVAILABLE)); | |
| 282 ASSERT_TRUE(response.has_value()); | |
| 283 EXPECT_THAT(response.value().expiry_date, Eq(TimeFromNow(0))); | |
| 284 } | |
| 285 | |
| 286 TEST_F(DoodleFetcherTest, ReturnsNoDoodleForMissingLargeImageUrl) { | |
| 287 DoodleState state(DoodleState::AVAILABLE); | |
| 288 base::Optional<DoodleConfig> response; | |
| 289 | |
| 290 doodle_fetcher()->FetchDoodle( | |
| 291 CreateResponseSavingCallback(&state, &response)); | |
| 292 RespondWithData(R"json({"ddljson": { | |
| 293 "time_to_live_ms":55000, | |
| 294 "large_image": {} | |
| 295 }})json"); | |
| 296 | |
| 297 EXPECT_THAT(state, Eq(DoodleState::NO_DOODLE)); | |
| 298 EXPECT_FALSE(response.has_value()); | |
| 299 } | |
| 300 | |
| 301 TEST_F(DoodleFetcherTest, EmptyResponsesCausesNoDoodleState) { | |
| 302 DoodleState state(DoodleState::AVAILABLE); | |
| 303 base::Optional<DoodleConfig> response; | |
| 304 | |
| 305 doodle_fetcher()->FetchDoodle( | |
| 306 CreateResponseSavingCallback(&state, &response)); | |
| 307 RespondWithData("{\"ddljson\":{}}"); | |
| 308 | |
| 309 EXPECT_THAT(state, Eq(DoodleState::NO_DOODLE)); | |
| 310 EXPECT_FALSE(response.has_value()); | |
| 311 } | |
| 312 | |
| 313 TEST_F(DoodleFetcherTest, ResponseContainsExactlyTheSampleImages) { | |
| 314 DoodleState state(DoodleState::NO_DOODLE); | |
| 315 base::Optional<DoodleConfig> response; | |
| 316 | |
| 317 doodle_fetcher()->FetchDoodle( | |
| 318 CreateResponseSavingCallback(&state, &response)); | |
| 319 RespondWithData(R"json()]}'{ | |
| 320 "ddljson": { | |
| 321 "time_to_live_ms":55000, | |
| 322 "large_image": { | |
| 323 "height":225, | |
| 324 "is_animated_gif":true, | |
| 325 "is_cta":false, | |
| 326 "url":"/logos/doodles/2015/new-years-eve-2015-59854387958251-hp.gif", | |
| 327 "width":489 | |
| 328 }, | |
| 329 "large_cta_image": { | |
| 330 "height":225, | |
| 331 "is_animated_gif":true, | |
| 332 "is_cta":true, | |
| 333 "url":"/logos/doodles/2015/new-years-eve-2015-59854387958251-cta.gif", | |
| 334 "width":489 | |
| 335 }, | |
| 336 "transparent_large_image": { | |
| 337 "height":225, | |
| 338 "is_animated_gif":false, | |
| 339 "is_cta":false, | |
| 340 "url":"/logos/doodles/2015/new-years-eve-2015-59854387958251-thp.png", | |
| 341 "width":510 | |
| 342 } | |
| 343 }})json"); | |
| 344 | |
| 345 EXPECT_THAT(state, Eq(DoodleState::AVAILABLE)); | |
| 346 ASSERT_TRUE(response.has_value()); | |
| 347 DoodleConfig config = response.value(); | |
| 348 | |
| 349 EXPECT_TRUE(config.transparent_large_image.url.is_valid()); | |
| 350 EXPECT_THAT(config.transparent_large_image.url.spec(), | |
| 351 Eq(Resolve("/logos/doodles/2015/new-years-eve-2015-5985438795" | |
| 352 "8251-thp.png"))); | |
| 353 EXPECT_THAT(config.transparent_large_image.width, Eq(510)); | |
| 354 EXPECT_THAT(config.transparent_large_image.height, Eq(225)); | |
| 355 EXPECT_FALSE(config.transparent_large_image.is_animated_gif); | |
| 356 EXPECT_FALSE(config.transparent_large_image.is_cta); | |
| 357 | |
| 358 EXPECT_TRUE(config.large_image.url.is_valid()); | |
| 359 EXPECT_THAT(config.large_image.url.spec(), | |
| 360 Eq(Resolve("/logos/doodles/2015/new-years-eve-2015-5985438795" | |
| 361 "8251-hp.gif"))); | |
| 362 EXPECT_THAT(config.large_image.width, Eq(489)); | |
| 363 EXPECT_THAT(config.large_image.height, Eq(225)); | |
| 364 EXPECT_TRUE(config.large_image.is_animated_gif); | |
| 365 EXPECT_FALSE(config.large_image.is_cta); | |
| 366 | |
| 367 EXPECT_TRUE(config.large_cta_image.url.is_valid()); | |
| 368 EXPECT_THAT(config.large_cta_image.url.spec(), | |
| 369 Eq(Resolve("/logos/doodles/2015/new-years-eve-2015-5985438795" | |
| 370 "8251-cta.gif"))); | |
| 371 EXPECT_THAT(config.large_cta_image.width, Eq(489)); | |
| 372 EXPECT_THAT(config.large_cta_image.height, Eq(225)); | |
| 373 EXPECT_TRUE(config.large_cta_image.is_animated_gif); | |
| 374 EXPECT_TRUE(config.large_cta_image.is_cta); | |
| 375 } | |
| 376 | |
| 377 TEST_F(DoodleFetcherTest, RespondsToMultipleRequestsWithSameFetcher) { | |
| 378 DoodleState state1(DoodleState::NO_DOODLE); | |
| 379 DoodleState state2(DoodleState::NO_DOODLE); | |
| 380 base::Optional<DoodleConfig> response1; | |
| 381 base::Optional<DoodleConfig> response2; | |
| 382 | |
| 383 // Trigger two requests. | |
| 384 doodle_fetcher()->FetchDoodle( | |
| 385 CreateResponseSavingCallback(&state1, &response1)); | |
| 386 net::URLFetcher* first_created_fetcher = GetRunningFetcher(); | |
| 387 doodle_fetcher()->FetchDoodle( | |
| 388 CreateResponseSavingCallback(&state2, &response2)); | |
| 389 net::URLFetcher* second_created_fetcher = GetRunningFetcher(); | |
| 390 | |
| 391 // Expect that only one fetcher handles both requests. | |
| 392 EXPECT_THAT(first_created_fetcher, Eq(second_created_fetcher)); | |
| 393 | |
| 394 RespondWithData(R"json({"ddljson": { | |
| 395 "time_to_live_ms":55000, | |
| 396 "large_image": {"url":"/logos/doodles/2015/some.gif"} | |
| 397 }})json"); | |
| 398 | |
| 399 // Ensure that both requests received a response. | |
| 400 EXPECT_THAT(state1, Eq(DoodleState::AVAILABLE)); | |
| 401 EXPECT_TRUE(response1.has_value()); | |
| 402 EXPECT_THAT(state2, Eq(DoodleState::AVAILABLE)); | |
| 403 EXPECT_TRUE(response2.has_value()); | |
| 404 } | |
| 405 | |
| 406 TEST_F(DoodleFetcherTest, ReceivesBaseUrlFromTracker) { | |
| 407 doodle_fetcher()->FetchDoodle( | |
| 408 CreateResponseSavingCallback(/*state=*/nullptr, /*response=*/nullptr)); | |
| 409 | |
| 410 EXPECT_THAT(GetRunningFetcher()->GetOriginalURL(), | |
| 411 Eq(GetGoogleBaseURL().Resolve(kDoodleConfigPath))); | |
| 412 } | |
| 413 | |
| 414 TEST_F(DoodleFetcherTest, OverridesBaseUrlWithCommandLineArgument) { | |
| 415 base::CommandLine::ForCurrentProcess()->AppendSwitchASCII( | |
| 416 switches::kGoogleBaseURL, "http://www.google.kz"); | |
| 417 | |
| 418 doodle_fetcher()->FetchDoodle( | |
| 419 CreateResponseSavingCallback(/*state=*/nullptr, /*response=*/nullptr)); | |
| 420 | |
| 421 EXPECT_THAT(GetRunningFetcher()->GetOriginalURL(), | |
| 422 Eq(GURL("http://www.google.kz").Resolve(kDoodleConfigPath))); | |
| 423 } | |
| 424 | |
| 425 } // namespace doodle | |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 2707293002:
[Doodle] Split DoodleFetcher into interface + Impl (Closed)
