Introduce a Doodle Fetcher for NTP

components/doodle/doodle_fetcher_unittest.cc

+// Copyright 2016 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 "components/doodle/doodle_fetcher.h"
+
+#include <string>
+#include <utility>
+
+#include "base/bind.h"
+#include "base/command_line.h"
+#include "base/json/json_reader.h"
+#include "base/memory/ptr_util.h"
+#include "base/test/test_mock_time_task_runner.h"
+#include "base/threading/sequenced_task_runner_handle.h"
+#include "base/threading/thread_task_runner_handle.h"
+#include "base/values.h"
+#include "components/google/core/browser/google_switches.h"
+#include "components/google/core/browser/google_url_tracker.h"
+#include "net/http/http_status_code.h"
+#include "net/url_request/test_url_fetcher_factory.h"
+#include "net/url_request/url_request_status.h"
+#include "net/url_request/url_request_test_util.h"
+#include "testing/gmock/include/gmock/gmock.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+using testing::Eq;
+using testing::IsEmpty;
+
+namespace doodle {
+
+namespace {
+
+const char kDoodleConfigPath[] = "/async/ddljson";
+
+const char kSampleResponse[] = R"json()]}'{
+      "ddljson": {
+      "alt_text":"Mouseover Text",
+      "doodle_type":"SIMPLE",
+      "id":0,
+      "interactive_html":"\u003cscript\u003e\u003c\/script\u003e",

[Marc Treib, 2017/02/06 17:26:36]

Are the Unicode escape sequences required?!

[fhorschig, 2017/02/08 09:10:24]

No. But they are part of the response and have to work anyway.

+      "search_url":"/search?q\u003dtest",
+      "share_text":"Share Text #GoogleDoodle\nhttps://g.co/doodle/8hfqzq",
+      "short_link":"//g.co/doodle/8hfqzq",
+      "show_now_header_search_affordance":false,
+      "show_now_header_share_button":true,
+      "target_url":"/search?q\u003dtest\u0026sa\u003dX\u0026ved\u003d0ahUKEwjm",
+      "time_to_live_ms":55000,
+      "large_image": {
+        "background_color":"#ffffff",
+        "height":225,
+        "image_id":0,
+        "is_animated_gif":true,
+        "is_cta":false,
+        "slot":1,
+        "url":"/logos/doodles/2015/new-years-eve-2015-5985438795825152-hp.gif",
+        "width":489
+      },
+      "large_cta_image": {
+        "background_color":"#ffffff",
+        "height":225,
+        "image_id":0,
+        "is_animated_gif":true,
+        "is_cta":true,
+        "slot":8,
+        "url":"/logos/doodles/2015/new-years-eve-2015-5985438795825152-cta.gif",
+        "width":489
+      },
+      "transparent_large_image": {
+        "background_color":"",
+        "height":225,
+        "image_id":0,
+        "is_animated_gif":false,
+        "is_cta":false,
+        "slot":2,
+        "url":"/logos/doodles/2015/new-years-eve-2015-5985438795825152-thp.png",
+        "width":510
+      }
+    }})json";
+
+const char kMinimalAvailableDoodleResponse[] = R"json({"ddljson": {
+      "large_image": {
+        "url":"/logos/doodles/2015/new-years-eve-2015-5985438795825152-hp.gif"
+      }}})json";
+
+const char kMalformedImageUrlResponse[] = R"json({"ddljson": {
+      "time_to_live_ms":55000,
+      "large_image": {
+        "height":225,
+        "width":489
+      }}})json";
+
+// Default Factory for FakeURLFetcherFactory that always fails.
+class FailingURLFetcherFactory : public net::URLFetcherFactory {
+ public:
+  std::unique_ptr<net::URLFetcher> CreateURLFetcher(
+      int id,
+      const GURL& url,
+      net::URLFetcher::RequestType request_type,
+      net::URLFetcherDelegate* d) override {
+    return base::MakeUnique<net::FakeURLFetcher>(
+        url, d, /*response_data=*/std::string(), net::HTTP_NOT_FOUND,
+        net::URLRequestStatus::FAILED);
+  }
+};
+
+// Required to instantiate a BaseUrlTracker in GoogleURLTracker::UNIT_TEST_MODE.

[Marc Treib, 2017/02/06 17:26:36]

s/BaseUrlTracker/GoogleURLTracker/ ?

UNIT_TEST_MODE brrrrr... but since we do have a tracker in tests, it looks like
the null check in the fetcher isn't actually required?
(If any other tests want to instantiate a fetcher, then they'll also have to
provide a tracker. IMO that's fine.)

[fhorschig, 2017/02/08 09:10:24]

Okay, removed.

+class GoogleURLTrackerClientStub : public GoogleURLTrackerClient {
+ public:
+  GoogleURLTrackerClientStub() {}
+  ~GoogleURLTrackerClientStub() override {}
+
+  bool IsBackgroundNetworkingEnabled() override { return true; }
+
+  PrefService* GetPrefs() override { return nullptr; }
+
+  net::URLRequestContextGetter* GetRequestContext() override { return nullptr; }
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(GoogleURLTrackerClientStub);
+};
+
+std::string Resolve(const std::string& relative_url) {
+  return GURL(GoogleURLTracker::kDefaultGoogleHomepage)
+      .Resolve(relative_url)
+      .spec();
+}
+
+void ParseJson(
+    const std::string& json,
+    const base::Callback<void(std::unique_ptr<base::Value> json)>& success,
+    const base::Callback<void(const std::string&)>& error) {
+  base::JSONReader json_reader;
+  std::unique_ptr<base::Value> value = json_reader.ReadToValue(json);
+  if (value) {
+    success.Run(std::move(value));
+  } else {
+    error.Run(json_reader.GetErrorMessage());
+  }
+}
+
+}  // namespace
+
+class DoodleFetcherTest : public ::testing::Test {
+ public:
+  DoodleFetcherTest()
+      : url_(GURL(GoogleURLTracker::kDefaultGoogleHomepage)),
+        // Constructor of FakeURLFetcherFactory uses FailingURLFetcherFactory
+        // as fallback for instantiating fetchers for undefined paths.
+        url_fetcher_factory_(
+            /*default_implementation=*/&failing_fetcher_factory_),
+        mock_task_runner_(new base::TestMockTimeTaskRunner()),
+        mock_task_runner_handle_(mock_task_runner_),
+        context_getter(
+            new net::TestURLRequestContextGetter(mock_task_runner_.get())),
+        google_url_tracker_(base::MakeUnique<GoogleURLTrackerClientStub>(),
+                            GoogleURLTracker::UNIT_TEST_MODE) {
+    // Random difference to 0 ensures that expiry_dates are really relative.
+    mock_task_runner_->FastForwardBy(base::TimeDelta::FromMilliseconds(80082));

[Marc Treib, 2017/02/06 17:26:35]

I just now understood this particular number. Might want to choose a different
one... ;)

[fhorschig, 2017/02/08 09:10:24]

Changed. Sorry, couldn't resist...

+  }
+
+  void SetResponse(const std::string& data) { SetResponseForUrl(url_, data); }
+
+  void SetResponseForUrl(const GURL& url, const std::string& data) {
+    url_fetcher_factory_.ClearFakeResponses();
+    url_fetcher_factory_.SetFakeResponse(url.Resolve(kDoodleConfigPath), data,
+                                         net::HTTP_OK,
+                                         net::URLRequestStatus::SUCCESS);
+  }
+
+  void SetResponseToError() {
+    url_fetcher_factory_.ClearFakeResponses();
+    url_fetcher_factory_.SetFakeResponse(url_, "", net::HTTP_NOT_FOUND,
+                                         net::URLRequestStatus::FAILED);
+  }
+
+  DoodleState FetchDoodle(base::Optional<DoodleConfig>* config) {
+    DoodleState state;
+    std::unique_ptr<DoodleFetcher> fetcher = CreateDoodleFetcher();
+    TriggerFetch(fetcher.get(), &state, config);
+    WaitForCallbacksToReturn();
+    return state;
+  }
+
+  std::unique_ptr<DoodleFetcher> CreateDoodleFetcher() {
+    return CreateDoodleFetcherWithTracker(&google_url_tracker_);
+  }
+
+  std::unique_ptr<DoodleFetcher> CreateDoodleFetcherWithTracker(
+      GoogleURLTracker* google_url_tracker) {
+    std::unique_ptr<DoodleFetcher> fetcher = base::MakeUnique<DoodleFetcher>(
+        context_getter.get(), google_url_tracker, base::Bind(ParseJson));
+    fetcher->SetClockForTesting(mock_task_runner_->GetMockClock());
+    return fetcher;
+  }
+
+  void TriggerFetch(DoodleFetcher* fetcher,
+                    DoodleState* state,
+                    base::Optional<DoodleConfig>* config) {
+    fetcher->FetchDoodle(base::BindOnce(
+        [](DoodleState* state_out, base::Optional<DoodleConfig>* config_out,
+           DoodleState state, const base::Optional<DoodleConfig>& config) {
+          *state_out = std::move(state);
+          *config_out = config;
+        },
+        state, config));
+  }
+
+  base::Time TimeFromNow(uint64_t milliseconds) {
+    return mock_task_runner_->GetMockClock()->Now() +
+           base::TimeDelta::FromMilliseconds(milliseconds);
+  }
+
+  void WaitForCallbacksToReturn() {
+    mock_task_runner_->FastForwardUntilNoTasksRemain();
+  }
+
+  size_t NumberOfPendingTasks() {
+    return mock_task_runner_->GetPendingTaskCount();
+  }
+
+ private:
+  GURL url_;
+  net::FakeURLFetcherFactory url_fetcher_factory_;
+  FailingURLFetcherFactory failing_fetcher_factory_;
+  scoped_refptr<base::TestMockTimeTaskRunner> mock_task_runner_;
+  base::ThreadTaskRunnerHandle mock_task_runner_handle_;
+  scoped_refptr<net::TestURLRequestContextGetter> context_getter;
+  GoogleURLTracker google_url_tracker_;
+};
+
+TEST_F(DoodleFetcherTest, ReturnsFromFetchWithoutError) {
+  SetResponse(kSampleResponse);
+
+  base::Optional<DoodleConfig> response;
+  EXPECT_THAT(FetchDoodle(&response), Eq(DoodleState::AVAILABLE));
+  EXPECT_TRUE(response.has_value());
+}
+
+TEST_F(DoodleFetcherTest, ReturnsFrom404FetchWithError) {
+  SetResponseToError();
+
+  base::Optional<DoodleConfig> response;
+  EXPECT_THAT(FetchDoodle(&response), Eq(DoodleState::DOWNLOAD_ERROR));
+  EXPECT_FALSE(response.has_value());
+}
+
+TEST_F(DoodleFetcherTest, ReturnsErrorForInvalidJson) {
+  SetResponse("{}");
+
+  base::Optional<DoodleConfig> response;
+  EXPECT_THAT(FetchDoodle(&response), Eq(DoodleState::PARSING_ERROR));
+  EXPECT_FALSE(response.has_value());
+}
+
+TEST_F(DoodleFetcherTest, ResponseContainsValidBaseInformation) {
+  SetResponse(kSampleResponse);
+
+  base::Optional<DoodleConfig> response;
+  EXPECT_THAT(FetchDoodle(&response), Eq(DoodleState::AVAILABLE));
+  ASSERT_TRUE(response.has_value());
+  DoodleConfig config = response.value();
+
+  EXPECT_TRUE(config.search_url.is_valid());
+  EXPECT_THAT(config.search_url, Eq(Resolve("/search?q\u003dtest")));
+  EXPECT_THAT(config.fullpage_interactive_url, Eq(GURL()));
+  EXPECT_TRUE(config.target_url.is_valid());
+  EXPECT_THAT(config.target_url,
+              Eq(Resolve("/search?q\u003dtest\u0026sa\u003dX\u0026ved\u003d"
+                         "0ahUKEwjm")));
+  EXPECT_THAT(config.doodle_type, Eq(DoodleType::SIMPLE));
+  EXPECT_THAT(config.alt_text, Eq("Mouseover Text"));
+  EXPECT_THAT(config.interactive_html,
+              Eq("\u003cscript\u003e\u003c/script\u003e"));
+
+  EXPECT_THAT(config.expiry_date, Eq(TimeFromNow(55000)));
+}
+
+TEST_F(DoodleFetcherTest, ResponseContainsExpiresWithinThirtyDays) {
+  base::Optional<DoodleConfig> response;
+  SetResponse(R"json({"ddljson": {
+      "time_to_live_ms":5184000000,
+      "large_image": {"url":"/logos/doodles/2015/some.gif"}
+    }})json");  // 60 days
+
+  EXPECT_THAT(FetchDoodle(&response), Eq(DoodleState::AVAILABLE));
+  ASSERT_TRUE(response.has_value());
+  EXPECT_THAT(response.value().expiry_date,
+              Eq(TimeFromNow(30ul * 24 * 60 * 60 * 1000 /* ms */)));  // 30 days
+}
+
+TEST_F(DoodleFetcherTest, AvailableDoodleExpiresNowWithoutValidTTL) {
+  base::Optional<DoodleConfig> response;
+  SetResponse(R"json({"ddljson": {
+      "time_to_live_ms":-1,
+      "large_image": {"url":"/logos/doodles/2015/some.gif"}
+    }})json");
+
+  EXPECT_THAT(FetchDoodle(&response), Eq(DoodleState::AVAILABLE));
+  ASSERT_TRUE(response.has_value());
+  EXPECT_THAT(response.value().expiry_date, Eq(TimeFromNow(0)));
+
+  SetResponse(kMinimalAvailableDoodleResponse);
+
+  EXPECT_THAT(FetchDoodle(&response), Eq(DoodleState::AVAILABLE));
+  ASSERT_TRUE(response.has_value());
+  DoodleConfig config = response.value();
+
+  EXPECT_THAT(config.expiry_date, Eq(TimeFromNow(0)));
+}
+
+TEST_F(DoodleFetcherTest, ExpectToReturnNoDoodleForMalfomedImageUrls) {
+  SetResponse(kMalformedImageUrlResponse);
+
+  base::Optional<DoodleConfig> response;
+  EXPECT_THAT(FetchDoodle(&response), Eq(DoodleState::NO_DOODLE));
+  EXPECT_FALSE(response.has_value());
+}
+
+TEST_F(DoodleFetcherTest, EmptyResponsesCausesNoDoodleState) {
+  SetResponse("{\"ddljson\":{}}");
+
+  base::Optional<DoodleConfig> response;
+  EXPECT_THAT(FetchDoodle(&response), Eq(DoodleState::NO_DOODLE));
+  EXPECT_FALSE(response.has_value());
+}
+
+TEST_F(DoodleFetcherTest, ResponseContainsExactlyTheSampleImages) {
+  SetResponse(kSampleResponse);
+
+  base::Optional<DoodleConfig> response;
+  EXPECT_THAT(FetchDoodle(&response), Eq(DoodleState::AVAILABLE));
+  ASSERT_TRUE(response.has_value());
+  DoodleConfig config = response.value();
+
+  EXPECT_TRUE(config.transparent_large_image.url.is_valid());
+  EXPECT_THAT(config.transparent_large_image.url.spec(),
+              Eq(Resolve("/logos/doodles/2015/new-years-eve-2015-5985438795"
+                         "825152-thp.png")));
+  EXPECT_THAT(config.transparent_large_image.width, Eq(510));
+  EXPECT_THAT(config.transparent_large_image.height, Eq(225));
+  EXPECT_FALSE(config.transparent_large_image.is_animated_gif);
+  EXPECT_FALSE(config.transparent_large_image.is_cta);
+
+  EXPECT_TRUE(config.large_image.url.is_valid());
+  EXPECT_THAT(config.large_image.url.spec(),
+              Eq(Resolve("/logos/doodles/2015/new-years-eve-2015-5985438795"
+                         "825152-hp.gif")));
+  EXPECT_THAT(config.large_image.width, Eq(489));
+  EXPECT_THAT(config.large_image.height, Eq(225));
+  EXPECT_TRUE(config.large_image.is_animated_gif);
+  EXPECT_FALSE(config.large_image.is_cta);
+
+  EXPECT_TRUE(config.large_cta_image.url.is_valid());
+  EXPECT_THAT(config.large_cta_image.url.spec(),
+              Eq(Resolve("/logos/doodles/2015/new-years-eve-2015-5985438795"
+                         "825152-cta.gif")));
+  EXPECT_THAT(config.large_cta_image.width, Eq(489));
+  EXPECT_THAT(config.large_cta_image.height, Eq(225));
+  EXPECT_TRUE(config.large_cta_image.is_animated_gif);
+  EXPECT_TRUE(config.large_cta_image.is_cta);
+}
+
+TEST_F(DoodleFetcherTest, RespondsToMultipleRequestsWithSameResponse) {
+  SetResponse(kSampleResponse);
+
+  DoodleState state1;
+  DoodleState state2;
+  base::Optional<DoodleConfig> response1;
+  base::Optional<DoodleConfig> response2;
+  std::unique_ptr<DoodleFetcher> fetcher = CreateDoodleFetcher();
+
+  TriggerFetch(fetcher.get(), &state1, &response1);
+  TriggerFetch(fetcher.get(), &state2, &response2);
+
+  EXPECT_THAT(NumberOfPendingTasks(), Eq(1ul));
+  WaitForCallbacksToReturn();
+
+  EXPECT_THAT(state1, Eq(DoodleState::AVAILABLE));
+  EXPECT_THAT(state2, Eq(DoodleState::AVAILABLE));
+  EXPECT_TRUE(response1.has_value());
+  EXPECT_TRUE(response2.has_value());
+}
+
+TEST_F(DoodleFetcherTest, DefaultsToTrackerBaseUrlWithoutGoogleUrlTracker) {
+  DoodleState state;
+  base::Optional<DoodleConfig> response;
+  SetResponseForUrl(GURL(GoogleURLTracker::kDefaultGoogleHomepage),
+                    kSampleResponse);
+
+  std::unique_ptr<DoodleFetcher> fetcher =
+      CreateDoodleFetcherWithTracker(/*google_url_tracker=*/nullptr);
+  TriggerFetch(fetcher.get(), &state, &response);
+  WaitForCallbacksToReturn();
+
+  EXPECT_THAT(state, Eq(DoodleState::AVAILABLE));
+  EXPECT_TRUE(response.has_value());
+}
+
+TEST_F(DoodleFetcherTest, OverridesBaseUrlWithCommandLineArgument) {
+  base::CommandLine::ForCurrentProcess()->AppendSwitchASCII(
+      switches::kGoogleBaseURL, "http://www.google.kz");
+  SetResponseForUrl(GURL("http://www.google.kz"), kSampleResponse);
+  base::Optional<DoodleConfig> response;
+  EXPECT_THAT(FetchDoodle(&response), Eq(DoodleState::AVAILABLE));
+  EXPECT_TRUE(response.has_value());
+}
+
+}  // namespace doodle