[NTP::Push] Add the classes for sending a breaking news subscription request

components/ntp_snippets/breaking_news/subscription_json_request_unittest.cc

Index: components/ntp_snippets/breaking_news/subscription_json_request_unittest.cc
diff --git a/components/ntp_snippets/breaking_news/subscription_json_request_unittest.cc b/components/ntp_snippets/breaking_news/subscription_json_request_unittest.cc
new file mode 100644
index 0000000000000000000000000000000000000000..a590734868d894bd47529970fe4275f9ba3ad936
--- /dev/null
+++ b/components/ntp_snippets/breaking_news/subscription_json_request_unittest.cc
@@ -0,0 +1,196 @@
+// Copyright 2017 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/ntp_snippets/breaking_news/subscription_json_request.h"
+
+#include "base/json/json_reader.h"
+#include "base/memory/ptr_util.h"
+#include "base/message_loop/message_loop.h"
+#include "base/test/gtest_util.h"
+#include "base/test/mock_callback.h"
+#include "base/values.h"
+#include "net/url_request/test_url_fetcher_factory.h"
+#include "net/url_request/url_request_test_util.h"
+#include "testing/gmock/include/gmock/gmock.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace ntp_snippets {
+
+namespace internal {
+
+namespace {
+
+using testing::_;
+using testing::SaveArg;
+
+// TODO(mamir): Create a test_helper.cc file instead of duplicating all this
+// code.
+MATCHER_P(EqualsJSON, json, "equals JSON") {
+  std::unique_ptr<base::Value> expected = base::JSONReader::Read(json);
+  if (!expected) {
+    *result_listener << "INTERNAL ERROR: couldn't parse expected JSON";
+    return false;
+  }
+
+  std::string err_msg;
+  int err_line, err_col;
+  std::unique_ptr<base::Value> actual = base::JSONReader::ReadAndReturnError(
+      arg, base::JSON_PARSE_RFC, nullptr, &err_msg, &err_line, &err_col);
+  if (!actual) {
+    *result_listener << "input:" << err_line << ":" << err_col << ": "
+                     << "parse error: " << err_msg;
+    return false;
+  }
+  return base::Value::Equals(actual.get(), expected.get());
+}
+
+}  // namespace
+
+class SubscriptionJsonRequestTest : public testing::Test {
+ public:
+  SubscriptionJsonRequestTest()
+      : request_context_getter_(
+            new net::TestURLRequestContextGetter(message_loop_.task_runner())) {
+  }
+
+  scoped_refptr<net::URLRequestContextGetter> GetRequestContext() {
+    return request_context_getter_.get();
+  }
+
+  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;
+  }
+
+  void RespondWithData(const std::string& data) {
+    net::TestURLFetcher* url_fetcher = GetRunningFetcher();
+    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("");

[Bernhard Bauer, 2017/06/01 16:54:46]

Use std::string() instead of a literal.

[mamir, 2017/06/01 17:13:01]

Done.

+    // Call the URLFetcher delegate to continue the test.
+    url_fetcher->delegate()->OnURLFetchComplete(url_fetcher);
+  }
+
+ private:
+  base::MessageLoop message_loop_;
+  scoped_refptr<net::TestURLRequestContextGetter> request_context_getter_;
+  net::TestURLFetcherFactory url_fetcher_factory_;
+
+  DISALLOW_COPY_AND_ASSIGN(SubscriptionJsonRequestTest);
+};
+
+TEST_F(SubscriptionJsonRequestTest, BuildRequest) {

[fhorschig, 2017/06/01 16:25:22]

Nit: It would be nice if you split this test.
Besides "BuildsRequest", this also tests "InvokesCallbackWhenCancelled".

[mamir, 2017/06/01 17:13:00]

Done.

+  std::string token = "1234567890";
+  GURL url("http://valid-url.test");
+
+  base::MockCallback<SubscriptionJsonRequest::CompletedCallback> callback;
+  ntp_snippets::Status status(StatusCode::SUCCESS, "initial");
+  EXPECT_CALL(callback, Run(_)).WillOnce(SaveArg<0>(&status));
+
+  SubscriptionJsonRequest::Builder builder;
+  std::unique_ptr<SubscriptionJsonRequest> request =
+      builder.SetToken(token)
+          .SetUrl(url)
+          .SetUrlRequestContextGetter(GetRequestContext())
+          .Build();
+  request->Start(callback.Get());
+
+  net::TestURLFetcher* url_fetcher = GetRunningFetcher();
+
+  EXPECT_EQ(url, url_fetcher->GetOriginalURL());
+
+  net::HttpRequestHeaders headers;
+  url_fetcher->GetExtraRequestHeaders(&headers);
+
+  std::string header;
+  EXPECT_FALSE(headers.GetHeader("Authorization", &header));
+  EXPECT_TRUE(headers.GetHeader("Content-Type", &header));
+  EXPECT_EQ(header, "application/json; charset=UTF-8");
+
+  std::string expected_body =
+      "{"
+      "  \"token\": "
+      "    \"1234567890\""
+      "}";
+  EXPECT_THAT(url_fetcher->upload_data(), EqualsJSON(expected_body));
+  // Destroy the request before getting any response.
+  request.reset();
+
+  EXPECT_EQ(status.code, StatusCode::TEMPORARY_ERROR);
+  EXPECT_EQ(status.message, "cancelled");
+}
+
+TEST_F(SubscriptionJsonRequestTest, SubscribeWithoutErrors) {
+  std::string token = "1234567890";
+  GURL url("http://valid-url.test");
+
+  base::MockCallback<SubscriptionJsonRequest::CompletedCallback> callback;
+  ntp_snippets::Status status(StatusCode::PERMANENT_ERROR, "initial");
+  EXPECT_CALL(callback, Run(_)).WillOnce(SaveArg<0>(&status));
+
+  SubscriptionJsonRequest::Builder builder;
+  std::unique_ptr<SubscriptionJsonRequest> request =
+      builder.SetToken(token)
+          .SetUrl(url)
+          .SetUrlRequestContextGetter(GetRequestContext())
+          .Build();
+  request->Start(callback.Get());
+
+  RespondWithData("{}");
+
+  EXPECT_EQ(status.code, StatusCode::SUCCESS);
+}
+
+TEST_F(SubscriptionJsonRequestTest, SubscribeWithErrors) {
+  std::string token = "1234567890";
+  GURL url("http://valid-url.test");
+
+  base::MockCallback<SubscriptionJsonRequest::CompletedCallback> callback;
+  ntp_snippets::Status status(StatusCode::SUCCESS, "initial");
+  EXPECT_CALL(callback, Run(_)).WillOnce(SaveArg<0>(&status));
+
+  SubscriptionJsonRequest::Builder builder;
+  std::unique_ptr<SubscriptionJsonRequest> request =
+      builder.SetToken(token)
+          .SetUrl(url)
+          .SetUrlRequestContextGetter(GetRequestContext())
+          .Build();
+  request->Start(callback.Get());
+
+  RespondWithError(net::ERR_TIMED_OUT);
+
+  EXPECT_EQ(status.code, StatusCode::TEMPORARY_ERROR);
+}
+
+TEST_F(SubscriptionJsonRequestTest, StartTheRequestTwice) {
+  std::string token = "1234567890";
+  GURL url("http://valid-url.test");
+
+  base::MockCallback<SubscriptionJsonRequest::CompletedCallback> callback;
+  ntp_snippets::Status status(StatusCode::SUCCESS, "initial");
+  EXPECT_CALL(callback, Run(_)).WillOnce(SaveArg<0>(&status));
+
+  SubscriptionJsonRequest::Builder builder;
+  std::unique_ptr<SubscriptionJsonRequest> request =
+      builder.SetToken(token)
+          .SetUrl(url)
+          .SetUrlRequestContextGetter(GetRequestContext())
+          .Build();
+  request->Start(callback.Get());
+  EXPECT_DCHECK_DEATH(request->Start(callback.Get()));

[fhorschig, 2017/06/01 16:25:21]

Cool!

[Bernhard Bauer, 2017/06/01 16:54:46]

I feel like I missed a tech debt meeting ;-)

I have to admit, I'm not a massive fan of death tests:
1) The Liskov substitution principle says you can weaken preconditions in
subclasses, so the test could be more brittle than necessary.
2) I like to think that the way a class deals with violated preconditions is an
implementation detail -- which to some extent is evidenced by the fact that in
the test you need to do something different based on whether or not DCHECKs are
enabled.
3) In a build without DCHECKs, the test is a no-op, but that's not necessarily
clear to a reader, so it might feign more test coverage than actually exists.
4) Chromium uses DCHECKs to express "this can never happen", with a very strong
"never". Writing code that makes it happen seems to violate that principle (i.e.
it would be considered a bug).

[mamir, 2017/06/01 17:13:01]

Well, I heard similar feedback about using DCHECK.
So Bernhard, what do you suggest to use instead of the DCHECK?

[Bernhard Bauer, 2017/06/01 20:34:51]

As discussed off-review, I would leave out this test completely (if necessary,
test that _clients_ don't start a request more than once), and keep the DCHECK
in the implementation.

[fhorschig, 2017/06/02 08:13:40]

Actually, death tests are on next week's meeting agenda and I didn't
even know them before.
 
So I am just going to link/steal your comment, because these arguments
are pretty compelling.

[mamir, 2017/06/02 09:06:49]

Done.

+}
+
+}  // namespace internal
+
+}  // namespace ntp_snippets