Add a class to parse answer json.

components/omnibox/suggestion_answer_unittest.cc

+// Copyright 2014 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/omnibox/suggestion_answer.h"
+
+#include "base/strings/utf_string_conversions.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+TEST(SuggestionAnswerTest, DefaultAreEqual) {
+  SuggestionAnswer answer1;
+  SuggestionAnswer answer2;
+  EXPECT_TRUE(answer1.Equals(answer2));
+}
+
+TEST(SuggestionAnswerTest, CopiesAreEqual) {
+  SuggestionAnswer answer1;
+  EXPECT_TRUE(answer1.Equals(SuggestionAnswer(answer1)));
+
+  scoped_ptr<SuggestionAnswer> answer2(new SuggestionAnswer());
+  answer2->set_type(832345);
+  EXPECT_TRUE(answer2->Equals(SuggestionAnswer(*answer2)));
+
+  std::string json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }] } } "
+      "] }";
+  ASSERT_TRUE(SuggestionAnswer::ParseAnswer(json, &answer2));
+  EXPECT_TRUE(answer2->Equals(SuggestionAnswer(*answer2)));
+}
+
+TEST(SuggestionAnswerTest, DifferentValuesAreUnequal) {
+  std::string json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }, "
+      "                      { \"t\": \"moar text\", \"tt\": 0 }], "
+      "              \"i\": { \"d\": \"//example.com/foo.jpg\" } } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }], "
+      "              \"at\": { \"t\": \"slatfatf\", \"tt\": 42 }, "
+      "              \"st\": { \"t\": \"oh hi, Mark\", \"tt\": 729347 } } } "
+      "] }";
+  scoped_ptr<SuggestionAnswer> answer1;
+  ASSERT_TRUE(SuggestionAnswer::ParseAnswer(json, &answer1));
+
+  // Exactly the same just a different type for one of the text type values.
+  json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }, "
+      "                      { \"t\": \"moar text\", \"tt\": 1 }], "
+      "              \"i\": { \"d\": \"//example.com/foo.jpg\" } } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }], "
+      "              \"at\": { \"t\": \"slatfatf\", \"tt\": 42 }, "
+      "              \"st\": { \"t\": \"oh hi, Mark\", \"tt\": 729347 } } } "
+      "] }";
+  scoped_ptr<SuggestionAnswer> answer2;
+  ASSERT_TRUE(SuggestionAnswer::ParseAnswer(json, &answer2));
+
+  EXPECT_FALSE(answer1->Equals(*answer2));
+
+  scoped_ptr<SuggestionAnswer> answer3 = SuggestionAnswer::Copy(answer1.get());
+  EXPECT_TRUE(answer1->Equals(*answer3));
+  answer3->set_type(44);
+  EXPECT_FALSE(answer1->Equals(*answer3));
+}
+
+TEST(SuggestionAnswerTest, EmptyJsonIsInvalid) {
+  std::string json;
+  scoped_ptr<SuggestionAnswer> answer;
+  ASSERT_FALSE(SuggestionAnswer::ParseAnswer(json, &answer));
+}
+
+TEST(SuggestionAnswerTest, MalformedJsonIsInvalid) {
+  std::string json = "} malformed json {";
+  scoped_ptr<SuggestionAnswer> answer;
+  ASSERT_FALSE(SuggestionAnswer::ParseAnswer(json, &answer));
+}
+
+TEST(SuggestionAnswerTest, TextFieldsRequireBothTextAndType) {
+  std::string json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\" }] } }, "
+      "] }";
+  scoped_ptr<SuggestionAnswer> answer1;
+  ASSERT_FALSE(SuggestionAnswer::ParseAnswer(json, &answer1));
+
+  json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"tt\": 8 }] } }, "
+      "] }";
+  scoped_ptr<SuggestionAnswer> answer2;
+  ASSERT_FALSE(SuggestionAnswer::ParseAnswer(json, &answer2));
+}
+
+TEST(SuggestionAnswerTest, ImageLinesMustContainAtLeastOneTextField) {
+  std::string json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }, "
+      "                      { \"t\": \"moar text\", \"tt\": 0 }], "
+      "              \"i\": { \"d\": \"//example.com/foo.jpg\" } } }, "
+      "  { \"il\": { \"t\": [], "
+      "              \"at\": { \"t\": \"slatfatf\", \"tt\": 42 }, "
+      "              \"st\": { \"t\": \"oh hi, Mark\", \"tt\": 729347 } } } "
+      "] }";
+  scoped_ptr<SuggestionAnswer> answer;
+  ASSERT_FALSE(SuggestionAnswer::ParseAnswer(json, &answer));
+}
+
+TEST(SuggestionAnswerTest, ExactlyTwoLinesRequired) {
+  std::string json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "] }";
+  scoped_ptr<SuggestionAnswer> answer1;
+  ASSERT_FALSE(SuggestionAnswer::ParseAnswer(json, &answer1));
+
+  json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }] } } "
+      "] }";
+  scoped_ptr<SuggestionAnswer> answer2;
+  ASSERT_TRUE(SuggestionAnswer::ParseAnswer(json, &answer2));
+
+  json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }] } } "
+      "  { \"il\": { \"t\": [{ \"t\": \"yet more text\", \"tt\": 13 }] } } "
+      "] }";
+  scoped_ptr<SuggestionAnswer> answer3;
+  ASSERT_FALSE(SuggestionAnswer::ParseAnswer(json, &answer3));
+}
+
+TEST(SuggestionAnswerTest, URLPresent) {
+  std::string json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }], "
+      "              \"i\": { \"d\": \"\" } } } "
+      "] }";
+  scoped_ptr<SuggestionAnswer> answer1;
+  ASSERT_FALSE(SuggestionAnswer::ParseAnswer(json, &answer1));
+
+  json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }], "
+      "              \"i\": { \"d\": \"https://example.com/foo.jpg\" } } } "
+      "] }";
+  scoped_ptr<SuggestionAnswer> answer2;
+  ASSERT_TRUE(SuggestionAnswer::ParseAnswer(json, &answer2));
+
+  json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }], "
+      "              \"i\": { \"d\": \"//example.com/foo.jpg\" } } } "
+      "] }";
+  scoped_ptr<SuggestionAnswer> answer3;
+  ASSERT_TRUE(SuggestionAnswer::ParseAnswer(json, &answer3));
+}
+
+TEST(SuggestionAnswerTest, ValidPropertyValues) {
+  std::string json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }, "
+      "                      { \"t\": \"moar text\", \"tt\": 0 }], "
+      "              \"i\": { \"d\": \"//example.com/foo.jpg\" } } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }], "
+      "              \"at\": { \"t\": \"slatfatf\", \"tt\": 42 }, "
+      "              \"st\": { \"t\": \"oh hi, Mark\", \"tt\": 729347 } } } "
+      "] }";
+  scoped_ptr<SuggestionAnswer> answer;
+  ASSERT_TRUE(SuggestionAnswer::ParseAnswer(json, &answer));
+  answer->set_type(420527);
+  EXPECT_EQ(420527, answer->type());
+
+  const SuggestionAnswer::ImageLine& first_line = answer->first_line();
+  EXPECT_EQ(2U, first_line.text_fields().size());
+  EXPECT_EQ("text", first_line.text_fields()[0].text());
+  EXPECT_EQ(8, first_line.text_fields()[0].type());
+  EXPECT_EQ("moar text", first_line.text_fields()[1].text());
+  EXPECT_EQ(0, first_line.text_fields()[1].type());
+
+  EXPECT_FALSE(first_line.additional_text());
+  EXPECT_FALSE(first_line.status_text());
+
+  EXPECT_TRUE(first_line.image_url().is_valid());
+  EXPECT_EQ("https://example.com/foo.jpg", first_line.image_url().spec());

[Peter Kasting, 2014/10/30 03:43:30]

Nit: Technically you should probably either use possibly_invalid_spec() or
ASSERT(url.is_valid()).

[groby-ooo-7-16, 2014/10/30 16:21:14]

Since it's based on json defined in the test, we should do more than just assert
validity. (Switching protocols _should_ be surfaced by the test, for example).

To sidestep the validity issue, EXPECT_EQ(GURL("https://example.com/foo.jpg"),
first_line.image_url())

[Justin Donnelly, 2014/10/30 19:23:14]

Done.

+
+  const SuggestionAnswer::ImageLine& second_line = answer->second_line();
+  EXPECT_EQ(1U, second_line.text_fields().size());
+  EXPECT_EQ("other text", second_line.text_fields()[0].text());
+  EXPECT_EQ(5, second_line.text_fields()[0].type());
+
+  EXPECT_TRUE(second_line.additional_text());
+  EXPECT_EQ("slatfatf", second_line.additional_text()->text());
+  EXPECT_EQ(42, second_line.additional_text()->type());
+
+  EXPECT_TRUE(second_line.status_text());
+  EXPECT_EQ("oh hi, Mark", second_line.status_text()->text());
+  EXPECT_EQ(729347, second_line.status_text()->type());
+
+  EXPECT_FALSE(second_line.image_url().is_valid());
+}
+
+TEST(SuggestionAnswerTest, GetImageURLsWithValidImageLines) {
+  std::vector<GURL> urls;

[Peter Kasting, 2014/10/30 03:43:30]

Nit: Use typedef

[Justin Donnelly, 2014/10/30 19:23:14]

Done.

+  std::string json =
+      "{ \"l\" : ["
+      "  { \"il\": { \"t\": [{ \"t\": \"some text\", \"tt\": 5 }] } },"
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 8 }],"
+      "              \"i\": { \"d\": \"//gstatic.com/foo.png\", \"t\": 3 }}}]}";
+
+  scoped_ptr<SuggestionAnswer> answer1;
+  ASSERT_TRUE(SuggestionAnswer::ParseAnswer(json, &answer1));
+  answer1->GetImageURLs(&urls);
+  ASSERT_EQ(1U, urls.size());
+  EXPECT_EQ("https://gstatic.com/foo.png", urls[0].spec());
+
+  json =
+      "{ \"l\" : ["
+      "  { \"il\": { \"t\": [{ \"t\": \"some text\", \"tt\": 5 }],"
+      "              \"i\": { \"d\": \"//gstatic.com/foo.png\" } } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 8 }],"
+      "              \"i\": { \"d\": \"//gstatic.com/bar.jpg\", \"t\": 3 }}}]}";
+
+  scoped_ptr<SuggestionAnswer> answer2;
+  ASSERT_TRUE(SuggestionAnswer::ParseAnswer(json, &answer2));
+  answer2->GetImageURLs(&urls);
+  ASSERT_EQ(2U, urls.size());
+  EXPECT_EQ("https://gstatic.com/foo.png", urls[0].spec());
+  EXPECT_EQ("https://gstatic.com/bar.jpg", urls[1].spec());
+}