[TTS] Decode Now on Tap results for v1 integration.

chrome/browser/android/contextualsearch/contextual_search_delegate_unittest.cc

 // Copyright 2015 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 "chrome/browser/android/contextualsearch/contextual_search_delegate.h"
 
 #include <stddef.h>
 
+#include <algorithm>
 #include <memory>
+#include <string>
 
 #include "base/base64.h"
 #include "base/macros.h"
 #include "base/memory/ptr_util.h"
 #include "base/message_loop/message_loop.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/values.h"
 #include "chrome/browser/android/contextualsearch/contextual_search_context.h"
+#include "chrome/browser/android/contextualsearch/contextual_search_field_trial.h"
 #include "chrome/browser/android/contextualsearch/resolved_search_term.h"
 #include "chrome/browser/android/proto/client_discourse_context.pb.h"
 #include "components/search_engines/template_url_service.h"
 #include "net/base/escape.h"
 #include "net/url_request/test_url_fetcher_factory.h"
 #include "net/url_request/url_request_test_util.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using base::ListValue;
 
 namespace {
 
 const char kSomeSpecificBasePage[] = "http://some.specific.host.name.com/";
 const char kDiscourseContextHeaderName[] = "X-Additional-Discourse-Context";
 
 }  // namespace
 
 class ContextualSearchDelegateTest : public testing::Test {
  public:
   ContextualSearchDelegateTest() {}
   ~ContextualSearchDelegateTest() override {}
 
+  // Inner class that enables Now on Tap Bar integration.
+  class ContextualSearchFieldTrialStubbed : public ContextualSearchFieldTrial {
+   public:
+    bool IsNowOnTapBarIntegrationEnabled() override { return true; }

[Theresa, 2016/09/20 19:51:40]

I don't think this is necessary. There should be a way to set command line flags
for unit tests just like do for Java.

Maybe something like:
  base::CommandLine::ForCurrentProcess()->AppendSwitch(...);

[Donn Denman, 2016/09/20 21:16:37]

Oh, I feel bad that I didn't figure this out on my own.  That simplifies this CL
a lot.  THANKS!

+  };
+
  protected:
   void SetUp() override {
     request_context_ =
         new net::TestURLRequestContextGetter(io_message_loop_.task_runner());
     template_url_service_.reset(CreateTemplateURLService());
     delegate_.reset(new ContextualSearchDelegate(
         request_context_.get(), template_url_service_.get(),
         base::Bind(
             &ContextualSearchDelegateTest::recordSearchTermResolutionResponse,
             base::Unretained(this)),
         base::Bind(&ContextualSearchDelegateTest::recordSurroundingText,
                    base::Unretained(this)),
         base::Bind(&ContextualSearchDelegateTest::recordIcingSelectionAvailable,
-                   base::Unretained(this))));
+                   base::Unretained(this)),
+        std::unique_ptr<ContextualSearchFieldTrial>(
+            new ContextualSearchFieldTrialStubbed())));
   }
 
   void TearDown() override {
     fetcher_ = NULL;
     is_invalid_ = true;
     response_code_ = -1;
     search_term_ = "invalid";
     mid_ = "";
     display_text_ = "unknown";
     context_language_ = "";
@@ skipping 30 matching lines @@
     test_context_->start_offset = start_offset;
     test_context_->end_offset = end_offset;
     test_context_->surrounding_text = surrounding_text;
     delegate_->ContinueSearchTermResolutionRequest();
     fetcher_ = test_factory_.GetFetcherByID(
         ContextualSearchDelegate::kContextualSearchURLFetcherID);
     ASSERT_TRUE(fetcher_);
     ASSERT_TRUE(fetcher());
   }
 
+  // Allows using the vertical bar "|" as a quote character, which makes
+  // test cases more readable versus the escaped double quote that is otherwise
+  // needed for JSON literals.
+  std::string escapeBarQuoted(std::string bar_quoted) {
+    std::replace(bar_quoted.begin(), bar_quoted.end(), '|', '\"');
+    return bar_quoted;
+  }
+
+  void CreateDefaultSearchWithContextualCardsData(
+      const std::string contextual_cards_data) {
+    CreateDefaultSearchContextAndRequestSearchTerm();
+    fetcher()->set_response_code(200);
+    std::string response =
+        escapeBarQuoted("{|search_term|:|obama|" + contextual_cards_data + "}");
+    fetcher()->SetResponseString(response);
+    fetcher()->delegate()->OnURLFetchComplete(fetcher());
+
+    EXPECT_FALSE(is_invalid());
+    EXPECT_EQ(200, response_code());
+    EXPECT_EQ("obama", search_term());
+  }
+
+  void CreateDefaultSearchWithContextualCardsValue(
+      const std::string contextual_cards_value) {
+    CreateDefaultSearchWithContextualCardsData(", |contextual_cards|:" +
+                                               contextual_cards_value);
+  }
+
   void SetResponseStringAndFetch(const std::string& selected_text,
                                  const std::string& mentions_start,
                                  const std::string& mentions_end) {
     fetcher()->set_response_code(200);
       fetcher()->SetResponseString(
           ")]}'\n"
           "{\"mid\":\"/m/02mjmr\", \"search_term\":\"obama\","
           "\"info_text\":\"44th U.S. President\","
           "\"display_text\":\"Barack Obama\","
           "\"mentions\":[" + mentions_start + ","+ mentions_end + "],"
@@ skipping 51 matching lines @@
     return result;
   }
 
   net::TestURLFetcher* fetcher() { return fetcher_; }
   bool is_invalid() { return is_invalid_; }
   int response_code() { return response_code_; }
   std::string search_term() { return search_term_; }
   std::string display_text() { return display_text_; }
   std::string alternate_term() { return alternate_term_; }
   std::string mid() { return mid_; }
+  std::string caption() { return caption_; }
+  std::string thumbnail_url() { return thumbnail_url_; }
   bool do_prevent_preload() { return prevent_preload_; }
   std::string after_text() { return after_text_; }
   int start_adjust() { return start_adjust_; }
   int end_adjust() { return end_adjust_; }
   std::string context_language() { return context_language_; }
 
   // The delegate under test.
   std::unique_ptr<ContextualSearchDelegate> delegate_;
 
  private:
   void recordSearchTermResolutionResponse(
       const ResolvedSearchTerm& resolved_search_term) {
     is_invalid_ = resolved_search_term.is_invalid;
     response_code_ = resolved_search_term.response_code;
     search_term_ = resolved_search_term.search_term;
     display_text_ = resolved_search_term.display_text;
     alternate_term_ = resolved_search_term.alternate_term;
     mid_ = resolved_search_term.mid;
+    thumbnail_url_ = resolved_search_term.thumbnail_url;
+    caption_ = resolved_search_term.caption;
     prevent_preload_ = resolved_search_term.prevent_preload;
     start_adjust_ = resolved_search_term.selection_start_adjust;
     end_adjust_ = resolved_search_term.selection_end_adjust;
     context_language_ = resolved_search_term.context_language;
   }
 
   void recordSurroundingText(const std::string& after_text) {
     after_text_ = after_text;
   }
 
   void recordIcingSelectionAvailable(const std::string& encoding,
                                      const base::string16& surrounding_text,
                                      size_t start_offset,
                                      size_t end_offset) {
     // unused.
   }
 
   bool is_invalid_;
   int response_code_;
   std::string search_term_;
   std::string display_text_;
   std::string alternate_term_;
   std::string mid_;
+  std::string thumbnail_url_;
+  std::string caption_;
   bool prevent_preload_;
   int start_adjust_;
   int end_adjust_;
   std::string after_text_;
   std::string context_language_;
 
   base::MessageLoopForIO io_message_loop_;
   net::TestURLFetcherFactory test_factory_;
   net::TestURLFetcher* fetcher_;
   std::unique_ptr<TemplateURLService> template_url_service_;
@@ skipping 310 matching lines @@
   EXPECT_EQ("obama", display_text());
   EXPECT_EQ("/m/02mjmr", mid());
   EXPECT_TRUE(do_prevent_preload());
   EXPECT_EQ("de", context_language());
 }
 
 TEST_F(ContextualSearchDelegateTest, HeaderContainsBasePageUrl) {
   CreateDefaultSearchContextAndRequestSearchTerm();
   EXPECT_EQ(kSomeSpecificBasePage, getBasePageUrlFromRequest());
 }
+
+// Tests a response with Now on Tap data.
+TEST_F(ContextualSearchDelegateTest, ContextualCardsResponseSingleCard) {
+  CreateDefaultSearchContextAndRequestSearchTerm();
+  fetcher()->set_response_code(200);
+  fetcher()->SetResponseString(
+      "{\"search_term\":\"obama\","

[Theresa, 2016/09/20 19:51:40]

Can we use escapeBarQuoted() here too?

[Donn Denman, 2016/09/20 21:16:37]

I'll just remove this one.

+      "\"contextual_cards\":{\"cards\":[{\"singleCard\":{ "
+      "\"subtitle\": \"president\", "
+      "\"thumbnail\":{\"uri\":\"https://t0.gstatic.com/images?q=tbn:ANd9\"}"
+      "}}]}}");
+  fetcher()->delegate()->OnURLFetchComplete(fetcher());
+
+  EXPECT_FALSE(is_invalid());
+  EXPECT_EQ(200, response_code());
+  EXPECT_EQ("obama", search_term());
+  EXPECT_EQ("president", caption());
+  EXPECT_EQ("https://t0.gstatic.com/images?q=tbn:ANd9", thumbnail_url());
+}
+
+// Same test using helpers and "|" quoting (for readability).

[Theresa, 2016/09/20 19:51:40]

Does duplicating the test give us any extra code coverage? If not, can we remove
the one above?

[Donn Denman, 2016/09/20 21:16:37]

Done.

+TEST_F(ContextualSearchDelegateTest,
+       ContextualCardsResponseSingleCardBarQuotedTest) {
+  CreateDefaultSearchWithContextualCardsValue(
+      "{|cards|:[{|singleCard|:{|subtitle|: |president|,"
+      "|thumbnail|:{|uri|:|https://t0.gstatic.com/images?q=tbn:ANd9|}}}]}");
+  EXPECT_EQ("president", caption());
+  EXPECT_EQ("https://t0.gstatic.com/images?q=tbn:ANd9", thumbnail_url());
+}
+
+// Missing all Now on Tap data.
+TEST_F(ContextualSearchDelegateTest, ContextualCardsResponseWithNoData) {
+  CreateDefaultSearchWithContextualCardsData("");
+  EXPECT_EQ("", caption());
+  EXPECT_EQ("", thumbnail_url());
+}
+
+// Missing subtitle (for caption).
+TEST_F(ContextualSearchDelegateTest,
+       ContextualCardsResponseWithMissingCaption) {
+  CreateDefaultSearchWithContextualCardsValue(
+      "{|cards|:[{|singleCard|:{|stubtitlemisspelled|: |president|,"
+      "|thumbnail|:{|uri|:|https://t0.gstatic.com/images?q=tbn:ANd9|}}}]}");
+  EXPECT_EQ("", caption());
+  EXPECT_EQ("https://t0.gstatic.com/images?q=tbn:ANd9", thumbnail_url());
+}
+
+// Missing the Thumbnail URI.
+TEST_F(ContextualSearchDelegateTest,
+       ContextualCardsResponseWithMissingThumbnailUri) {
+  CreateDefaultSearchWithContextualCardsValue(
+      "{|cards|:[{|singleCard|:{|subtitle|: |president|,"
+      "|thumbnail|:{}}}]}");
+  EXPECT_EQ("president", caption());
+  EXPECT_EQ("", thumbnail_url());
+}
+
+// Missing the whole Thumbnail.
+TEST_F(ContextualSearchDelegateTest,
+       ContextualCardsResponseWithMissingThumbnail) {
+  CreateDefaultSearchWithContextualCardsValue(
+      "{|cards|:[{|singleCard|:{|subtitle|: |president|,"
+      "|ignored key|:|ignored value|}}]}");
+  EXPECT_EQ("president", caption());
+  EXPECT_EQ("", thumbnail_url());
+}
+
+// Empty cards list.
+TEST_F(ContextualSearchDelegateTest,
+       ContextualCardsResponseWithMissingSingleCard) {
+  CreateDefaultSearchWithContextualCardsValue("{|cards|:[]}");
+  EXPECT_EQ("", caption());
+  EXPECT_EQ("", thumbnail_url());
+}
+
+// Tests carouselCard followed by singleCard.
+TEST_F(ContextualSearchDelegateTest,
+       ContextualCardsResponseWithSingleAndCarouselCards) {
+  CreateDefaultSearchWithContextualCardsValue(
+      "{|cards|:[{|carouselCard|:{}},{|singleCard|:{|subtitle|: |president|,"
+      "|thumbnail|:{|uri|:|https://t0.gstatic.com/images?q=tbn:ANd9|}}}]}");
+  EXPECT_EQ("president", caption());
+  EXPECT_EQ("https://t0.gstatic.com/images?q=tbn:ANd9", thumbnail_url());
+}
+
+// Missing cards.
+TEST_F(ContextualSearchDelegateTest, ContextualCardsResponseWithMissingCards) {
+  CreateDefaultSearchWithContextualCardsValue("{}");
+  EXPECT_EQ("", caption());
+  EXPECT_EQ("", thumbnail_url());
+}
+
+// Multiple cards (latter should be ignored).
+TEST_F(ContextualSearchDelegateTest, ContextualCardsResponseWithMultipleCards) {
+  CreateDefaultSearchWithContextualCardsValue(
+      "{|cards|:[{|singleCard|:{|subtitle|: |president|,"
+      "|thumbnail|:{|uri|:|https://t0.gstatic.com/images?q=tbn:ANd9|}}},"
+      "{|singleCard|:{|subtitle|:|wrong subtitle|,"
+      "|thumbnail|:{|uri|:|https://t0.gstatic.com/wrongThumbnail|}}}]}");
+  EXPECT_EQ("president", caption());
+  EXPECT_EQ("https://t0.gstatic.com/images?q=tbn:ANd9", thumbnail_url());
+}