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/message_loop/message_loop.h"
+#include "base/test/simple_test_clock.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;
+
+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":"\u003cstyle\u003e\u003c\/style\u003e",
+      "interactive_js":"(function(){}).call(this);",
+      "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";
+
+// Required to instantiate a GoogleUrlTracker in UNIT_TEST_MODE.
+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)),
+        context_getter(
+            new net::TestURLRequestContextGetter(message_loop_.task_runner())),
+        google_url_tracker_(base::MakeUnique<GoogleURLTrackerClientStub>(),
+                            GoogleURLTracker::UNIT_TEST_MODE),
+        doodle_fetcher_(context_getter.get(),
+                        &google_url_tracker_,
+                        base::Bind(ParseJson)) {
+    // Random difference to 0 ensures that expiry_dates are really relative.

[Marc Treib, 2017/02/09 10:36:25]

s/ensures/ensure/

[fhorschig, 2017/02/09 13:23:56]

Done.

+    auto clock = base::MakeUnique<base::SimpleTestClock>();
+    clock_ = clock.get();
+    clock_->Advance(base::TimeDelta::FromMilliseconds(1123581321));
+    doodle_fetcher_.SetClockForTesting(std::move(clock));
+  }
+
+  void RespondWithData(const std::string& data) {
+    RespondToFetcherWithData(GetRunningFetcher(), data);
+  }
+
+  void RespondToFetcherWithData(net::TestURLFetcher* url_fetcher,
+                                const std::string& data) {
+    url_fetcher->set_status(net::URLRequestStatus());
+    url_fetcher->set_response_code(net::HTTP_OK);
+    url_fetcher->SetResponseString(data);
+    // Call the URLFetcher delegate to continue the test.
+    url_fetcher->delegate()->OnURLFetchComplete(url_fetcher);
+  }
+
+  void RespondWithError(int error_code) {
+    net::TestURLFetcher* url_fetcher = GetRunningFetcher();
+    url_fetcher->set_status(net::URLRequestStatus::FromError(error_code));
+    url_fetcher->SetResponseString("");
+    // Call the URLFetcher delegate to continue the test.
+    url_fetcher->delegate()->OnURLFetchComplete(url_fetcher);
+  }
+
+  net::TestURLFetcher* GetRunningFetcher() {
+    // All created TestURLFetchers have ID 0 by default.
+    net::TestURLFetcher* url_fetcher = url_fetcher_factory_.GetFetcherByID(0);
+    DCHECK(url_fetcher);
+    return url_fetcher;
+  }
+
+  DoodleFetcher::FinishedCallback CreateResponseSavingCallback(
+      DoodleState* state_out,
+      base::Optional<DoodleConfig>* config_out) {
+    return base::BindOnce(
+        [](DoodleState* state_out, base::Optional<DoodleConfig>* config_out,
+           DoodleState state, const base::Optional<DoodleConfig>& config) {
+          if (state_out) {
+            *state_out = state;
+          }
+          if (config_out) {
+            *config_out = config;
+          }
+        },
+        state_out, config_out);
+  }
+
+  DoodleFetcher* doodle_fetcher() { return &doodle_fetcher_; }
+
+  GURL GoogleTrackerBaseUrl() { return GURL(google_url_tracker_.google_url()); }

[Marc Treib, 2017/02/09 10:36:24]

GetGoogleBaseURL?
Also .google_url() is already a GURL, no need for GURL(..)

[fhorschig, 2017/02/09 13:23:56]

Thanks.

+
+  base::Time TimeFromNow(uint64_t milliseconds) {
+    return clock_->Now() + base::TimeDelta::FromMilliseconds(milliseconds);
+  }
+
+ private:
+  base::MessageLoop message_loop_;
+  GURL url_;
+  net::TestURLFetcherFactory url_fetcher_factory_;
+  base::SimpleTestClock* clock_;  // Owned by the doodle_fetcher.
+  scoped_refptr<net::TestURLRequestContextGetter> context_getter;
+  GoogleURLTracker google_url_tracker_;
+  DoodleFetcher doodle_fetcher_;
+};
+
+TEST_F(DoodleFetcherTest, ReturnsFromFetchWithoutError) {
+  DoodleState state(DoodleState::NO_DOODLE);
+  base::Optional<DoodleConfig> response;
+
+  doodle_fetcher()->FetchDoodle(
+      CreateResponseSavingCallback(&state, &response));
+  RespondWithData(kSampleResponse);
+
+  EXPECT_THAT(state, Eq(DoodleState::AVAILABLE));
+  EXPECT_TRUE(response.has_value());
+}
+
+TEST_F(DoodleFetcherTest, ReturnsFrom404FetchWithError) {
+  DoodleState state(DoodleState::NO_DOODLE);
+  base::Optional<DoodleConfig> response;
+
+  doodle_fetcher()->FetchDoodle(
+      CreateResponseSavingCallback(&state, &response));
+  RespondWithError(net::ERR_FILE_NOT_FOUND);
+
+  EXPECT_THAT(state, Eq(DoodleState::DOWNLOAD_ERROR));
+  EXPECT_FALSE(response.has_value());
+}
+
+TEST_F(DoodleFetcherTest, ReturnsErrorForInvalidJson) {
+  DoodleState state(DoodleState::NO_DOODLE);
+  base::Optional<DoodleConfig> response;
+
+  doodle_fetcher()->FetchDoodle(
+      CreateResponseSavingCallback(&state, &response));
+  RespondWithData("{}");

[Marc Treib, 2017/02/09 10:36:24]

nit: I think this is technically valid json :D

[fhorschig, 2017/02/09 13:23:56]

Invalid with regards to our specification ;)

You are if course right:
Renamed that one.
Added a separate test for invalid JSON.

+
+  EXPECT_THAT(state, Eq(DoodleState::PARSING_ERROR));
+  EXPECT_FALSE(response.has_value());
+}
+
+TEST_F(DoodleFetcherTest, ResponseContainsValidBaseInformation) {
+  DoodleState state(DoodleState::NO_DOODLE);
+  base::Optional<DoodleConfig> response;
+
+  doodle_fetcher()->FetchDoodle(
+      CreateResponseSavingCallback(&state, &response));
+  RespondWithData(kSampleResponse);
+
+  EXPECT_THAT(state, 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")));

[Marc Treib, 2017/02/09 10:36:24]

This is another case where the test "input" (kSampleResponse) is far away from
the expectations. Not sure what's the best thing to do about this. Maybe a
BuildSampleResponse helper, which takes the things that are verified here as
parameters? It'd be a lot of parameters though, so I don't know... or maybe just
inline the json response in the test? Then kSampleResponse could contain only
the minimal required fields, for those tests that don't really care.

[fhorschig, 2017/02/09 13:23:56]

Cropped JSON strings inlined. They are sufficiently readable.
The reason why I dumped this huge sample request in there was just, that I
wanted to test with data as close to the actually used as possible.

+  EXPECT_TRUE(config.fullpage_interactive_url.is_empty());
+  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("\u003cstyle\u003e\u003c/style\u003e"));
+  EXPECT_THAT(config.interactive_js, Eq("(function(){}).call(this);"));
+
+  EXPECT_THAT(config.expiry_date, Eq(TimeFromNow(55000)));
+}
+
+TEST_F(DoodleFetcherTest, ResponseContainsExpiresWithinThirtyDays) {

[Marc Treib, 2017/02/09 10:36:24]

I don't understand the test name

[fhorschig, 2017/02/09 13:23:56]

Me neither. Renamed.

+  DoodleState state(DoodleState::NO_DOODLE);
+  base::Optional<DoodleConfig> response;
+
+  doodle_fetcher()->FetchDoodle(
+      CreateResponseSavingCallback(&state, &response));
+  RespondWithData(R"json({"ddljson": {
+      "time_to_live_ms":5184000000,
+      "large_image": {"url":"/logos/doodles/2015/some.gif"}
+    }})json");  // 60 days
+
+  EXPECT_THAT(state, 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, AvailableDoodleExpiresNowWithNegativeTTL) {
+  DoodleState state(DoodleState::NO_DOODLE);
+  base::Optional<DoodleConfig> response;
+
+  doodle_fetcher()->FetchDoodle(
+      CreateResponseSavingCallback(&state, &response));
+  RespondWithData(R"json({"ddljson": {
+      "time_to_live_ms":-1,
+      "large_image": {"url":"/logos/doodles/2015/some.gif"}
+    }})json");
+
+  EXPECT_THAT(state, Eq(DoodleState::AVAILABLE));
+  ASSERT_TRUE(response.has_value());
+  EXPECT_THAT(response.value().expiry_date, Eq(TimeFromNow(0)));
+}
+
+TEST_F(DoodleFetcherTest, AvailableDoodleExpiresNowWithoutValidTTL) {
+  DoodleState state(DoodleState::NO_DOODLE);
+  base::Optional<DoodleConfig> response;
+
+  doodle_fetcher()->FetchDoodle(
+      CreateResponseSavingCallback(&state, &response));
+  RespondWithData(kMinimalAvailableDoodleResponse);
+
+  EXPECT_THAT(state, Eq(DoodleState::AVAILABLE));
+  ASSERT_TRUE(response.has_value());
+  EXPECT_THAT(response.value().expiry_date, Eq(TimeFromNow(0)));
+}
+
+TEST_F(DoodleFetcherTest, ExpectToReturnNoDoodleForMalfomedImageUrls) {

[Marc Treib, 2017/02/09 10:36:24]

ReturnsNoDoodleForMalfomedImageUrls ?

[fhorschig, 2017/02/09 13:23:56]

Done.

+  DoodleState state(DoodleState::AVAILABLE);
+  base::Optional<DoodleConfig> response;
+
+  doodle_fetcher()->FetchDoodle(
+      CreateResponseSavingCallback(&state, &response));
+  RespondWithData(kMalformedImageUrlResponse);
+
+  EXPECT_THAT(state, Eq(DoodleState::NO_DOODLE));
+  EXPECT_FALSE(response.has_value());
+}
+
+TEST_F(DoodleFetcherTest, EmptyResponsesCausesNoDoodleState) {
+  DoodleState state(DoodleState::AVAILABLE);
+  base::Optional<DoodleConfig> response;
+
+  doodle_fetcher()->FetchDoodle(
+      CreateResponseSavingCallback(&state, &response));
+  RespondWithData("{\"ddljson\":{}}");
+
+  EXPECT_THAT(state, Eq(DoodleState::NO_DOODLE));
+  EXPECT_FALSE(response.has_value());
+}
+
+TEST_F(DoodleFetcherTest, ResponseContainsExactlyTheSampleImages) {
+  DoodleState state(DoodleState::NO_DOODLE);
+  base::Optional<DoodleConfig> response;
+
+  doodle_fetcher()->FetchDoodle(
+      CreateResponseSavingCallback(&state, &response));
+  RespondWithData(kSampleResponse);
+
+  EXPECT_THAT(state, 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, RespondsToMultipleRequestsWithSameFetcher) {
+  doodle_fetcher()->FetchDoodle(
+      CreateResponseSavingCallback(/*state=*/nullptr, /*response=*/nullptr));
+
+  net::URLFetcher* first_created_fetcher = GetRunningFetcher();
+
+  doodle_fetcher()->FetchDoodle(
+      CreateResponseSavingCallback(/*state=*/nullptr, /*response=*/nullptr));
+
+  net::URLFetcher* second_created_fetcher = GetRunningFetcher();
+
+  EXPECT_THAT(first_created_fetcher, Eq(second_created_fetcher));

[Marc Treib, 2017/02/09 10:36:24]

Maybe add a test that both callbacks get called?

[fhorschig, 2017/02/09 13:23:56]

Done.

+}
+
+TEST_F(DoodleFetcherTest, ReceivesBaseUrlFromTracker) {
+  doodle_fetcher()->FetchDoodle(
+      CreateResponseSavingCallback(/*state=*/nullptr, /*response=*/nullptr));
+
+  EXPECT_THAT(GetRunningFetcher()->GetOriginalURL(),
+              Eq(GoogleTrackerBaseUrl().Resolve(kDoodleConfigPath)));
+}
+
+TEST_F(DoodleFetcherTest, OverridesBaseUrlWithCommandLineArgument) {
+  base::CommandLine::ForCurrentProcess()->AppendSwitchASCII(
+      switches::kGoogleBaseURL, "http://www.google.kz");
+
+  doodle_fetcher()->FetchDoodle(
+      CreateResponseSavingCallback(/*state=*/nullptr, /*response=*/nullptr));
+
+  EXPECT_THAT(GetRunningFetcher()->GetOriginalURL(),
+              Eq(GURL("http://www.google.kz").Resolve(kDoodleConfigPath)));
+}
+
+}  // namespace doodle