Add a class to parse answer json.

components/omnibox/suggestion_answer_unittest.cc

Index: components/omnibox/suggestion_answer_unittest.cc
diff --git a/components/omnibox/suggestion_answer_unittest.cc b/components/omnibox/suggestion_answer_unittest.cc
new file mode 100644
index 0000000000000000000000000000000000000000..180ac04dc3fb8595519b79409869f66a0822f730
--- /dev/null
+++ b/components/omnibox/suggestion_answer_unittest.cc
@@ -0,0 +1,341 @@
+// 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_EQ(answer1, answer2);
+}
+
+TEST(SuggestionAnswerTest, CopiesAreEqual) {
+  SuggestionAnswer answer1;
+  SuggestionAnswer answer1copy(answer1);
+  EXPECT_EQ(answer1, answer1copy);
+
+  SuggestionAnswer answer2;
+  answer2.SetType(base::ASCIIToUTF16("832345"));
+  SuggestionAnswer answer2copy1(answer2);
+  EXPECT_EQ(answer2, answer2copy1);

[Peter Kasting, 2014/10/24 22:38:11]

Nit: Instead of answer2 + answer2copy1 and answer2copy2, why not just
answer2[copy] and answer3[copy]?

[Justin Donnelly, 2014/10/27 21:41:16]

Done.

+
+  std::string json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }] } } "
+      "] }";
+  SuggestionAnswer::ParseAnswer(json, &answer2);
+  EXPECT_TRUE(answer2.is_valid());
+  SuggestionAnswer answer2copy2(answer2);
+  EXPECT_EQ(answer2, answer2copy2);
+}
+
+TEST(SuggestionAnswerTest, DifferentValusAreUnequal) {

[Peter Kasting, 2014/10/24 22:38:11]

Nit: Values

[Justin Donnelly, 2014/10/27 21:41:16]

Done.

+  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 } } } "
+      "] }";
+  SuggestionAnswer answer1;
+  answer1.SetType(base::ASCIIToUTF16("4"));
+  SuggestionAnswer::ParseAnswer(json, &answer1);
+  EXPECT_TRUE(answer1.is_valid());
+
+  // 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 } } } "
+      "] }";
+  SuggestionAnswer answer2;
+  answer2.SetType(base::ASCIIToUTF16("4"));
+  SuggestionAnswer::ParseAnswer(json, &answer2);
+  EXPECT_TRUE(answer2.is_valid());
+
+  EXPECT_NE(answer1, answer2);
+}
+
+TEST(SuggestionAnswerTest, EmptyAnswerIsInvalid) {
+  SuggestionAnswer answer;
+  EXPECT_FALSE(answer.is_valid());
+}
+
+TEST(SuggestionAnswerTest, AnswerWithTypeOnlyIsInvalid) {
+  SuggestionAnswer answer;
+  answer.SetType(base::ASCIIToUTF16("2940"));
+  EXPECT_FALSE(answer.is_valid());
+}
+
+TEST(SuggestionAnswerTest, EmptyJsonIsInvalid) {
+  std::string json = "";

[Peter Kasting, 2014/10/24 22:38:11]

Nit: = "" not necessary

[Justin Donnelly, 2014/10/27 21:41:16]

Done.

+  SuggestionAnswer answer;
+  answer.SetType(base::ASCIIToUTF16("1"));
+  SuggestionAnswer::ParseAnswer(json, &answer);
+  EXPECT_FALSE(answer.is_valid());
+}
+
+TEST(SuggestionAnswerTest, MalformedJsonIsInvalid) {
+  std::string json = "} malformed json {";
+  SuggestionAnswer answer;
+  answer.SetType(base::ASCIIToUTF16("921"));
+  SuggestionAnswer::ParseAnswer(json, &answer);
+  EXPECT_FALSE(answer.is_valid());
+}
+
+TEST(SuggestionAnswerTest, AnswerWithoutTypeIsInvalid) {
+  std::string json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }] } } "
+      "] }";
+  SuggestionAnswer answer;
+  SuggestionAnswer::ParseAnswer(json, &answer);
+  EXPECT_FALSE(answer.is_valid());
+}
+
+TEST(SuggestionAnswerTest, TypeMustBeNonNegativeToBeValid) {
+  std::string json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }] } } "
+      "] }";
+  SuggestionAnswer answer;
+  answer.SetType(base::ASCIIToUTF16("-238"));
+  SuggestionAnswer::ParseAnswer(json, &answer);
+  EXPECT_FALSE(answer.is_valid());
+
+  answer.SetType(base::ASCIIToUTF16("-1"));
+  EXPECT_FALSE(answer.is_valid());
+
+  answer.SetType(base::ASCIIToUTF16("-14982"));
+  EXPECT_FALSE(answer.is_valid());
+
+  answer.SetType(base::ASCIIToUTF16("0"));
+  EXPECT_TRUE(answer.is_valid());
+
+  answer.SetType(base::ASCIIToUTF16("1"));
+  EXPECT_TRUE(answer.is_valid());
+
+  answer.SetType(base::ASCIIToUTF16("3284327"));
+  EXPECT_TRUE(answer.is_valid());
+}
+
+TEST(SuggestionAnswerTest, ClearedAnswerIsInvalid) {
+  std::string json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }] } } "
+      "] }";
+  SuggestionAnswer answer;
+  answer.SetType(base::ASCIIToUTF16("921"));
+  SuggestionAnswer::ParseAnswer(json, &answer);
+  EXPECT_TRUE(answer.is_valid());
+
+  answer.Clear();
+  EXPECT_FALSE(answer.is_valid());
+}
+
+TEST(SuggestionAnswerTest, TextFieldsRequireBothTextAndType) {
+  std::string json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\" }] } }, "
+      "] }";
+  SuggestionAnswer answer1;
+  answer1.SetType(base::ASCIIToUTF16("894"));
+  SuggestionAnswer::ParseAnswer(json, &answer1);
+  EXPECT_FALSE(answer1.is_valid());
+
+  json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"tt\": 8 }] } }, "
+      "] }";
+  SuggestionAnswer answer2;
+  answer2.SetType(base::ASCIIToUTF16("12"));
+  SuggestionAnswer::ParseAnswer(json, &answer2);
+  EXPECT_FALSE(answer2.is_valid());
+}
+
+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 } } } "
+      "] }";
+  SuggestionAnswer answer;
+  answer.SetType(base::ASCIIToUTF16("205"));
+  SuggestionAnswer::ParseAnswer(json, &answer);
+  EXPECT_FALSE(answer.is_valid());
+}
+
+TEST(SuggestionAnswerTest, ExactlyTwoLinesRequired) {
+  std::string json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "] }";
+  SuggestionAnswer answer1;
+  answer1.SetType(base::ASCIIToUTF16("8943"));
+  SuggestionAnswer::ParseAnswer(json, &answer1);
+  EXPECT_FALSE(answer1.is_valid());
+
+  json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }] } } "
+      "] }";
+  SuggestionAnswer answer2;
+  answer2.SetType(base::ASCIIToUTF16("4028023"));
+  SuggestionAnswer::ParseAnswer(json, &answer2);
+  EXPECT_TRUE(answer2.is_valid());
+
+  json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }] } } "
+      "  { \"il\": { \"t\": [{ \"t\": \"yet more text\", \"tt\": 13 }] } } "
+      "] }";
+  SuggestionAnswer answer3;
+  answer3.SetType(base::ASCIIToUTF16("23"));
+  SuggestionAnswer::ParseAnswer(json, &answer3);
+  EXPECT_FALSE(answer3.is_valid());
+}
+
+TEST(SuggestionAnswerTest, URLPresent) {
+  std::string json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }], "
+      "              \"i\": { \"d\": \"\" } } } "
+      "] }";
+  SuggestionAnswer answer1;
+  answer1.SetType(base::ASCIIToUTF16("1"));
+  SuggestionAnswer::ParseAnswer(json, &answer1);
+  EXPECT_FALSE(answer1.is_valid());
+
+  json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }], "
+      "              \"i\": { \"d\": \"https://example.com/foo.jpg\" } } } "
+      "] }";
+  SuggestionAnswer answer2;
+  answer2.SetType(base::ASCIIToUTF16("8"));
+  SuggestionAnswer::ParseAnswer(json, &answer2);
+  EXPECT_TRUE(answer2.is_valid());
+
+  json =
+      "{ \"l\": ["
+      "  { \"il\": { \"t\": [{ \"t\": \"text\", \"tt\": 8 }] } }, "
+      "  { \"il\": { \"t\": [{ \"t\": \"other text\", \"tt\": 5 }], "
+      "              \"i\": { \"d\": \"//example.com/foo.jpg\" } } } "
+      "] }";
+  SuggestionAnswer answer3;
+  answer3.SetType(base::ASCIIToUTF16("4"));
+  SuggestionAnswer::ParseAnswer(json, &answer3);
+  EXPECT_TRUE(answer3.is_valid());
+}
+
+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 } } } "
+      "] }";
+  SuggestionAnswer answer;
+  answer.SetType(base::ASCIIToUTF16("420527"));
+  SuggestionAnswer::ParseAnswer(json, &answer);
+  EXPECT_TRUE(answer.is_valid());
+
+  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.has_additional_text());
+  EXPECT_FALSE(first_line.has_status_text());
+
+  EXPECT_TRUE(first_line.has_image_url());
+  EXPECT_EQ("https://example.com/foo.jpg", first_line.image_url().spec());
+
+  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.has_additional_text());
+  EXPECT_EQ("slatfatf", second_line.additional_text().text());
+  EXPECT_EQ(42, second_line.additional_text().type());
+
+  EXPECT_TRUE(second_line.has_status_text());
+  EXPECT_EQ("oh hi, Mark", second_line.status_text().text());
+  EXPECT_EQ(729347, second_line.status_text().type());
+
+  EXPECT_FALSE(second_line.has_image_url());
+}
+
+TEST(SuggestionAnswerTest, GetImageURLsWithoutImagelines) {
+  std::vector<GURL> urls;
+
+  // No "l" entry in the dictionary.
+  SuggestionAnswer answer;
+  SuggestionAnswer::ParseAnswer("", &answer);
+  answer.GetImageURLs(&urls);
+  EXPECT_TRUE(urls.empty());
+
+  // Empty "l" entry in the dictionary.
+  SuggestionAnswer::ParseAnswer("{ \"l\" : {} }", &answer);
+  answer.GetImageURLs(&urls);
+  EXPECT_TRUE(urls.empty());
+}
+
+TEST(SuggestionAnswerTest, GetImageURLsWithValidImageLines) {
+  std::vector<GURL> urls;
+  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 }}}]}";
+
+  SuggestionAnswer answer1;
+  answer1.SetType(base::ASCIIToUTF16("532"));
+  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 }}}]}";
+
+  SuggestionAnswer answer2;
+  answer2.SetType(base::ASCIIToUTF16("15"));
+  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());
+}