Componentize builtin_provider_unittest

chrome/browser/autocomplete/builtin_provider_unittest.cc

 // Copyright (c) 2012 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/browser/builtin_provider.h"
 
 #include <stddef.h>
 
 #include "base/format_macros.h"
 #include "base/macros.h"
 #include "base/strings/stringprintf.h"
 #include "base/strings/utf_string_conversions.h"
 #include "build/build_config.h"
-#include "chrome/browser/autocomplete/chrome_autocomplete_provider_client.h"
-#include "chrome/browser/autocomplete/chrome_autocomplete_scheme_classifier.h"
-#include "chrome/common/url_constants.h"
-#include "chrome/test/base/testing_profile.h"
 #include "components/metrics/proto/omnibox_event.pb.h"
 #include "components/omnibox/browser/autocomplete_input.h"
 #include "components/omnibox/browser/autocomplete_match.h"
 #include "components/omnibox/browser/autocomplete_provider.h"
+#include "components/omnibox/browser/mock_autocomplete_provider_client.h"
 #include "content/public/test/test_browser_thread_bundle.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "url/gurl.h"
 
 using base::ASCIIToUTF16;
 
+namespace {
+const char kChromeUIChromeURLsURL[] = "chrome://chrome-urls/";
+const char kChromeUIVersionURL[] = "chrome://version/";
+const char kChromeUISettingsURL[] = "chrome://settings/";
+const char kChromeUIScheme[] = "chrome";
+const char kChromeUIMediaInternalsHost[] = "media-internals";
+const char kChromeUIMemoryHost[] = "memory";
+const char kChromeUIMemoryInternalsHost[] = "memory-internals";
+const char kChromeUIBlobInternalsHost[] = "blob-internals";
+const char kAutofillSubPage[] = "autofill";
+const char kClearBrowserDataSubPage[] = "clearBrowserData";
+const char kSearchEnginesSubPage[] = "searchEngines";
+const char kSyncSetupSubPage[] = "syncSetup";
+const char kChromeUISettingsHost[] = "settings";
+
+const char* const kChromeHostURLs[] = {
+    kChromeUIMemoryHost, kChromeUIMemoryInternalsHost,
+    kChromeUIBlobInternalsHost, kChromeUISettingsHost,
+};
+
+const size_t kNumberOfChromeHostURLs = arraysize(kChromeHostURLs);
+
+// This list should be kept in sync with chrome/common/url_constants.h.
+// Only include useful sub-pages, confirmation alerts are not useful.
+const char* const kChromeSettingsSubPages[] = {
+    kAutofillSubPage, kClearBrowserDataSubPage,
+    /*    chrome::kContentSettingsSubPage,
+        chrome::kContentSettingsExceptionsSubPage,
+        chrome::kImportDataSubPage,
+        chrome::kLanguageOptionsSubPage,
+        chrome::kPasswordManagerSubPage,
+        chrome::kResetProfileSettingsSubPage,*/
+    kSearchEnginesSubPage, kSyncSetupSubPage,
+    //#if defined(OS_CHROMEOS)
+    //    chrome::kInternetOptionsSubPage,
+    //#endif
+};

[droger, 2016/01/08 15:00:05]

If we want to componentize this test, then it should not need all these chrome
constants.

Then you need to define some arrays of strings, like:

const char* const kTestBuiltins[] = {
  "kBuiltinFoo",
  "kBuiltinBar",
}

const char* kTestUserTypeBuiltins[] {
  "kUserBuiltinFoo",
  "kUserBuiltinBar",
}

And change GetBuiltinURLs() and GetBuiltinsToProvideAsUserTypes() to just return
these.

Then you should update the tests to use these instead of the chrome:// URLs.
This might be a bit tedious since the tests make very heavy assumptions about
the values of the builtins (like how they share prefixes and such).

You can get rid of all the android specific code.

[Abhishek, 2016/01/12 19:59:29]

Thanks! I've made all the necessary changes.
I'm checking this part, if any help, that will be a great push.
Done.

+
+class TestingSchemeClassifier : public AutocompleteSchemeClassifier {
+ public:
+  TestingSchemeClassifier() {}
+
+  metrics::OmniboxInputType::Type GetInputTypeForScheme(
+      const std::string& scheme) const override {
+    return net::URLRequest::IsHandledProtocol(scheme)
+               ? metrics::OmniboxInputType::URL
+               : metrics::OmniboxInputType::INVALID;

[droger, 2016/01/08 15:00:05]

Is this really needed? Could we just always return
metrics::OmniboxInputType::URL?

[Abhishek, 2016/01/12 19:59:29]

Done.

+  }
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(TestingSchemeClassifier);
+};
+
+class TestAutocompleteProviderClient : public MockAutocompleteProviderClient {
+ public:
+  TestAutocompleteProviderClient() {}
+
+  std::vector<base::string16> GetBuiltinURLs() override;
+  std::vector<base::string16> GetBuiltinsToProvideAsUserTypes() override;
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(TestAutocompleteProviderClient);
+};
+
+std::vector<base::string16> TestAutocompleteProviderClient::GetBuiltinURLs() {
+  LOG(INFO) << " abhishek " << __FUNCTION__;
+  // std::vector<base::string16> builtins;

[droger, 2016/01/08 15:00:05]

Cleanup comments and debug code.

[Abhishek, 2016/01/12 19:59:29]

Done.

+  std::vector<std::string> chrome_builtins(
+      kChromeHostURLs, kChromeHostURLs + kNumberOfChromeHostURLs);
+  std::sort(chrome_builtins.begin(), chrome_builtins.end());
+
+  std::vector<base::string16> builtins;
+
+  for (std::vector<std::string>::iterator i(chrome_builtins.begin());
+       i != chrome_builtins.end(); ++i)
+    builtins.push_back(base::ASCIIToUTF16(*i));
+
+#if !defined(OS_ANDROID)
+  base::string16 settings(base::ASCIIToUTF16(kChromeUISettingsHost) +
+                          base::ASCIIToUTF16("/"));
+  for (size_t i = 0; i < arraysize(kChromeSettingsSubPages); i++) {
+    builtins.push_back(settings +
+                       base::ASCIIToUTF16(kChromeSettingsSubPages[i]));
+  }
+#endif
+  return builtins;
+}
+
+std::vector<base::string16>
+TestAutocompleteProviderClient::GetBuiltinsToProvideAsUserTypes() {
+  std::vector<base::string16> builtins_to_provide;
+  builtins_to_provide.push_back(base::ASCIIToUTF16(kChromeUIChromeURLsURL));
+#if !defined(OS_ANDROID)
+  builtins_to_provide.push_back(base::ASCIIToUTF16(kChromeUISettingsURL));
+#endif
+  builtins_to_provide.push_back(base::ASCIIToUTF16(kChromeUIVersionURL));
+  return builtins_to_provide;
+}
+
+}  // namespace
+
 class BuiltinProviderTest : public testing::Test {
  protected:
   struct TestData {
     const base::string16 input;
     const size_t num_results;
     const GURL output[3];
   };
 
   BuiltinProviderTest() : provider_(NULL) {}
   ~BuiltinProviderTest() override {}
 
   void SetUp() override {
-    profile_.reset(new TestingProfile());
-    client_.reset(new ChromeAutocompleteProviderClient(profile_.get()));
+    client_.reset(new TestAutocompleteProviderClient());
     provider_ = new BuiltinProvider(client_.get());
   }
   void TearDown() override { provider_ = NULL; }
 
   void RunTest(const TestData cases[], size_t num_cases) {
     ACMatches matches;
     for (size_t i = 0; i < num_cases; ++i) {
       SCOPED_TRACE(base::StringPrintf(
           "case %" PRIuS ": %s", i, base::UTF16ToUTF8(cases[i].input).c_str()));
       const AutocompleteInput input(
           cases[i].input, base::string16::npos, std::string(), GURL(),
           metrics::OmniboxEventProto::INVALID_SPEC, true, false, true, true,
-          false, ChromeAutocompleteSchemeClassifier(NULL));
+          false, TestingSchemeClassifier());
       provider_->Start(input, false);
       EXPECT_TRUE(provider_->done());
       matches = provider_->matches();
       EXPECT_EQ(cases[i].num_results, matches.size());
       if (matches.size() == cases[i].num_results) {
         for (size_t j = 0; j < cases[i].num_results; ++j) {
           EXPECT_EQ(cases[i].output[j], matches[j].destination_url);
           EXPECT_FALSE(matches[j].allowed_to_be_default_match);
         }
       }
     }
   }
 
   content::TestBrowserThreadBundle thread_bundle_;
 
-  scoped_ptr<TestingProfile> profile_;
-  scoped_ptr<ChromeAutocompleteProviderClient> client_;
+  scoped_ptr<MockAutocompleteProviderClient> client_;
   scoped_refptr<BuiltinProvider> provider_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(BuiltinProviderTest);
 };
 
 #if !defined(OS_ANDROID)
 TEST_F(BuiltinProviderTest, TypingScheme) {
   const base::string16 kAbout = ASCIIToUTF16(url::kAboutScheme);
-  const base::string16 kChrome = ASCIIToUTF16(content::kChromeUIScheme);
+  const base::string16 kChrome = ASCIIToUTF16(kChromeUIScheme);
   const base::string16 kSeparator1 = ASCIIToUTF16(":");
   const base::string16 kSeparator2 = ASCIIToUTF16(":/");
   const base::string16 kSeparator3 =
       ASCIIToUTF16(url::kStandardSchemeSeparator);
 
   // These default URLs should correspond with those in BuiltinProvider::Start.
-  const GURL kURL1 = GURL(chrome::kChromeUIChromeURLsURL);
-  const GURL kURL2 = GURL(chrome::kChromeUISettingsURL);
-  const GURL kURL3 = GURL(chrome::kChromeUIVersionURL);
+  const GURL kURL1 = GURL(kChromeUIChromeURLsURL);
+  const GURL kURL2 = GURL(kChromeUISettingsURL);
+  const GURL kURL3 = GURL(kChromeUIVersionURL);
 
   TestData typing_scheme_cases[] = {
     // Typing an unrelated scheme should give nothing.
     {ASCIIToUTF16("h"),        0, {}},
     {ASCIIToUTF16("http"),     0, {}},
     {ASCIIToUTF16("file"),     0, {}},
     {ASCIIToUTF16("abouz"),    0, {}},
     {ASCIIToUTF16("aboutt"),   0, {}},
     {ASCIIToUTF16("aboutt:"),  0, {}},
     {ASCIIToUTF16("chroma"),   0, {}},
@@ skipping 17 matching lines @@
     {kChrome + kSeparator2,     3, {kURL1, kURL2, kURL3}},
     {kChrome + kSeparator3,     3, {kURL1, kURL2, kURL3}},
     {ASCIIToUTF16("ChRoMe://"), 3, {kURL1, kURL2, kURL3}},
   };
 
   RunTest(typing_scheme_cases, arraysize(typing_scheme_cases));
 }
 #else // Android uses a subset of the URLs
 TEST_F(BuiltinProviderTest, TypingScheme) {
   const base::string16 kAbout = ASCIIToUTF16(url::kAboutScheme);
-  const base::string16 kChrome = ASCIIToUTF16(content::kChromeUIScheme);
+  const base::string16 kChrome = ASCIIToUTF16(kChromeUIScheme);
   const base::string16 kSeparator1 = ASCIIToUTF16(":");
   const base::string16 kSeparator2 = ASCIIToUTF16(":/");
   const base::string16 kSeparator3 =
       ASCIIToUTF16(url::kStandardSchemeSeparator);
 
   // These default URLs should correspond with those in BuiltinProvider::Start.
-  const GURL kURL1 = GURL(chrome::kChromeUIChromeURLsURL);
-  const GURL kURL2 = GURL(chrome::kChromeUIVersionURL);
+  const GURL kURL1 = GURL(kChromeUIChromeURLsURL);
+  const GURL kURL2 = GURL(kChromeUIVersionURL);
 
   TestData typing_scheme_cases[] = {
     // Typing an unrelated scheme should give nothing.
     {ASCIIToUTF16("h"),        0, {}},
     {ASCIIToUTF16("http"),     0, {}},
     {ASCIIToUTF16("file"),     0, {}},
     {ASCIIToUTF16("abouz"),    0, {}},
     {ASCIIToUTF16("aboutt"),   0, {}},
     {ASCIIToUTF16("aboutt:"),  0, {}},
     {ASCIIToUTF16("chroma"),   0, {}},
@@ skipping 36 matching lines @@
     {ASCIIToUTF16("scheme://host"),                0, {}},
     {ASCIIToUTF16("scheme:host/path?query#ref"),   0, {}},
     {ASCIIToUTF16("scheme://host/path?query#ref"), 0, {}},
   };
 
   RunTest(non_chrome_url_cases, arraysize(non_chrome_url_cases));
 }
 
 TEST_F(BuiltinProviderTest, ChromeURLs) {
   const base::string16 kAbout = ASCIIToUTF16(url::kAboutScheme);
-  const base::string16 kChrome = ASCIIToUTF16(content::kChromeUIScheme);
+  const base::string16 kChrome = ASCIIToUTF16(kChromeUIScheme);
   const base::string16 kSeparator1 = ASCIIToUTF16(":");
   const base::string16 kSeparator2 = ASCIIToUTF16(":/");
   const base::string16 kSeparator3 =
       ASCIIToUTF16(url::kStandardSchemeSeparator);
 
   // This makes assumptions about the chrome URLs listed by the BuiltinProvider.
   // Currently they are derived from chrome::kChromeHostURLs[].
-  const base::string16 kHostM1 =
-      ASCIIToUTF16(content::kChromeUIMediaInternalsHost);
-  const base::string16 kHostM2 =
-      ASCIIToUTF16(chrome::kChromeUIMemoryHost);
-  const base::string16 kHostM3 =
-      ASCIIToUTF16(chrome::kChromeUIMemoryInternalsHost);
+  const base::string16 kHostM1 = ASCIIToUTF16(kChromeUIMediaInternalsHost);
+  const base::string16 kHostM2 = ASCIIToUTF16(kChromeUIMemoryHost);
+  const base::string16 kHostM3 = ASCIIToUTF16(kChromeUIMemoryInternalsHost);
   const GURL kURLM1 = GURL(kChrome + kSeparator3 + kHostM1);
   const GURL kURLM2 = GURL(kChrome + kSeparator3 + kHostM2);
   const GURL kURLM3 = GURL(kChrome + kSeparator3 + kHostM3);
 
   TestData chrome_url_cases[] = {
     // Typing an about URL with an unknown host should give nothing.
     {kAbout + kSeparator1 + ASCIIToUTF16("host"), 0, {}},
     {kAbout + kSeparator2 + ASCIIToUTF16("host"), 0, {}},
     {kAbout + kSeparator3 + ASCIIToUTF16("host"), 0, {}},
 
@@ skipping 19 matching lines @@
     {kChrome + kSeparator3 + kHostM1,              1, {kURLM1}},
     {kChrome + kSeparator2 + kHostM2,              2, {kURLM2, kURLM3}},
     {kChrome + kSeparator2 + kHostM3,              1, {kURLM3}},
   };
 
   RunTest(chrome_url_cases, arraysize(chrome_url_cases));
 }
 
 TEST_F(BuiltinProviderTest, AboutBlank) {
   const base::string16 kAbout = ASCIIToUTF16(url::kAboutScheme);
-  const base::string16 kChrome = ASCIIToUTF16(content::kChromeUIScheme);
+  const base::string16 kChrome = ASCIIToUTF16(kChromeUIScheme);
   const base::string16 kAboutBlank = ASCIIToUTF16(url::kAboutBlankURL);
   const base::string16 kBlank = ASCIIToUTF16("blank");
   const base::string16 kSeparator1 =
       ASCIIToUTF16(url::kStandardSchemeSeparator);
   const base::string16 kSeparator2 = ASCIIToUTF16(":///");
   const base::string16 kSeparator3 = ASCIIToUTF16(";///");
 
-  const GURL kURLBlob = GURL(kChrome + kSeparator1 +
-                             ASCIIToUTF16(content::kChromeUIBlobInternalsHost));
+  const GURL kURLBlob =
+      GURL(kChrome + kSeparator1 + ASCIIToUTF16(kChromeUIBlobInternalsHost));
   const GURL kURLBlank = GURL(kAboutBlank);
 
   TestData about_blank_cases[] = {
     // Typing an about:blank prefix should yield about:blank, among other URLs.
     {kAboutBlank.substr(0, 8), 2, {kURLBlank, kURLBlob}},
     {kAboutBlank.substr(0, 9), 1, {kURLBlank}},
 
     // Using any separator that is supported by fixup should yield about:blank.
     // For now, BuiltinProvider does not suggest url-what-you-typed matches for
     // for about:blank; check "about:blan" and "about;blan" substrings instead.
@@ skipping 27 matching lines @@
     {kAboutBlank.substr(0, 9) + ASCIIToUTF16("#r"), 0, {}},
   };
 
   RunTest(about_blank_cases, arraysize(about_blank_cases));
 }
 
 TEST_F(BuiltinProviderTest, DoesNotSupportMatchesOnFocus) {
   const AutocompleteInput input(
       ASCIIToUTF16("chrome://s"), base::string16::npos, std::string(), GURL(),
       metrics::OmniboxEventProto::INVALID_SPEC, true, false, true, true, true,
-      ChromeAutocompleteSchemeClassifier(NULL));
+      TestingSchemeClassifier());
   provider_->Start(input, false);
    EXPECT_TRUE(provider_->matches().empty());
 }
 
 #if !defined(OS_ANDROID)
 // Disabled on Android where we use native UI instead of chrome://settings.
 TEST_F(BuiltinProviderTest, ChromeSettingsSubpages) {
   // This makes assumptions about the chrome URLs listed by the BuiltinProvider.
   // Currently they are derived from chrome::kChromeHostURLs[].
-  const base::string16 kSettings = ASCIIToUTF16(chrome::kChromeUISettingsURL);
-  const base::string16 kDefaultPage1 = ASCIIToUTF16(chrome::kAutofillSubPage);
-  const base::string16 kDefaultPage2 =
-      ASCIIToUTF16(chrome::kClearBrowserDataSubPage);
+  const base::string16 kSettings = ASCIIToUTF16(kChromeUISettingsURL);
+  const base::string16 kDefaultPage1 = ASCIIToUTF16(kAutofillSubPage);
+  const base::string16 kDefaultPage2 = ASCIIToUTF16(kClearBrowserDataSubPage);
   const GURL kDefaultURL1 = GURL(kSettings + kDefaultPage1);
   const GURL kDefaultURL2 = GURL(kSettings + kDefaultPage2);
-  const base::string16 kPage1 = ASCIIToUTF16(chrome::kSearchEnginesSubPage);
-  const base::string16 kPage2 = ASCIIToUTF16(chrome::kSyncSetupSubPage);
+  const base::string16 kPage1 = ASCIIToUTF16(kSearchEnginesSubPage);
+  const base::string16 kPage2 = ASCIIToUTF16(kSyncSetupSubPage);
   const GURL kURL1 = GURL(kSettings + kPage1);
   const GURL kURL2 = GURL(kSettings + kPage2);
 
   TestData settings_subpage_cases[] = {
     // Typing the settings path should show settings and the first two subpages.
     {kSettings, 3, {GURL(kSettings), kDefaultURL1, kDefaultURL2}},
 
     // Typing a subpage path should return the appropriate results.
     {kSettings + kPage1.substr(0, 1),                   2, {kURL1, kURL2}},
     {kSettings + kPage1.substr(0, 2),                   1, {kURL1}},
     {kSettings + kPage1.substr(0, kPage1.length() - 1), 1, {kURL1}},
     {kSettings + kPage1,                                1, {kURL1}},
     {kSettings + kPage2,                                1, {kURL2}},
   };
 
   RunTest(settings_subpage_cases, arraysize(settings_subpage_cases));
 }
 #endif