Revert 120018 - Revert 120005 - Enabled pressing TAB to traverse through the Omnibox results, rem...

chrome/browser/autocomplete/autocomplete_unittest.cc

-// Copyright (c) 2011 The Chromium Authors. All rights reserved.
+// 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 "base/bind.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop.h"
 #include "base/string16.h"
 #include "base/string_number_conversions.h"
 #include "base/string_util.h"
 #include "base/utf_string_conversions.h"
@@ skipping 11 matching lines @@
 #include "content/public/browser/notification_registrar.h"
 #include "content/public/browser/notification_source.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 static std::ostream& operator<<(std::ostream& os,
                                 const AutocompleteResult::const_iterator& it) {
   return os << static_cast<const AutocompleteMatch*>(&(*it));
 }
 
 namespace {
-
-const size_t num_results_per_provider = 3;
+const size_t kResultsPerProvider = 3;
+}
 
 // Autocomplete provider that provides known results. Note that this is
 // refcounted so that it can also be a task on the message loop.
 class TestProvider : public AutocompleteProvider {
  public:
   TestProvider(int relevance, const string16& prefix)
       : AutocompleteProvider(NULL, NULL, ""),
         relevance_(relevance),
         prefix_(prefix) {
   }
@@ skipping 27 matching lines @@
   AddResults(0, 1);
 
   if (input.matches_requested() == AutocompleteInput::ALL_MATCHES) {
     done_ = false;
     MessageLoop::current()->PostTask(FROM_HERE, base::Bind(&TestProvider::Run,
                                                            this));
   }
 }
 
 void TestProvider::Run() {
-  DCHECK_GT(num_results_per_provider, 0U);
-  AddResults(1, num_results_per_provider);
+  DCHECK_GT(kResultsPerProvider, 0U);
+  AddResults(1, kResultsPerProvider);
   done_ = true;
   DCHECK(listener_);
   listener_->OnProviderUpdate(true);
 }
 
 void TestProvider::AddResults(int start_at, int num) {
   for (int i = start_at; i < num; i++) {
     AutocompleteMatch match(this, relevance_ - i, false,
                             AutocompleteMatch::URL_WHAT_YOU_TYPED);
 
     match.fill_into_edit = prefix_ + UTF8ToUTF16(base::IntToString(i));
     match.destination_url = GURL(UTF16ToUTF8(match.fill_into_edit));
 
     match.contents = match.fill_into_edit;
     match.contents_class.push_back(
         ACMatchClassification(0, ACMatchClassification::NONE));
     match.description = match.fill_into_edit;
     match.description_class.push_back(
         ACMatchClassification(0, ACMatchClassification::NONE));
 
     matches_.push_back(match);
   }
 }
 
 class AutocompleteProviderTest : public testing::Test,
                                  public content::NotificationObserver {
  protected:
+  struct KeywordTestData {
+    const string16 fill_into_edit;
+    const string16 keyword;
+    const bool expected_keyword_result;
+  };
+
+ protected:
   void ResetControllerWithTestProviders(bool same_destinations);
 
   // Runs a query on the input "a", and makes sure both providers' input is
   // properly collected.
   void RunTest();
 
+  void RunRedundantKeywordTest(const KeywordTestData* match_data, size_t size);
+
+  void RunQuery(const string16 query);
+
   void ResetControllerWithTestProvidersWithKeywordAndSearchProviders();
+  void ResetControllerWithKeywordProvider();
   void RunExactKeymatchTest(bool allow_exact_keyword_match);
 
   // These providers are owned by the controller once it's created.
   ACProviders providers_;
 
   AutocompleteResult result_;
+  scoped_ptr<AutocompleteController> controller_;
 
  private:
   // content::NotificationObserver
   virtual void Observe(int type,
                        const content::NotificationSource& source,
                        const content::NotificationDetails& details);
 
   MessageLoopForUI message_loop_;
-  scoped_ptr<AutocompleteController> controller_;
   content::NotificationRegistrar registrar_;
   TestingProfile profile_;
 };
 
 void AutocompleteProviderTest::ResetControllerWithTestProviders(
     bool same_destinations) {
   // Forget about any existing providers.  The controller owns them and will
   // Release() them below, when we delete it during the call to reset().
   providers_.clear();
 
   // Construct two new providers, with either the same or different prefixes.
-  TestProvider* providerA = new TestProvider(num_results_per_provider,
+  TestProvider* providerA = new TestProvider(kResultsPerProvider,
                                              ASCIIToUTF16("http://a"));
   providerA->AddRef();
   providers_.push_back(providerA);
 
-  TestProvider* providerB = new TestProvider(num_results_per_provider * 2,
+  TestProvider* providerB = new TestProvider(kResultsPerProvider * 2,
       same_destinations ? ASCIIToUTF16("http://a") : ASCIIToUTF16("http://b"));
   providerB->AddRef();
   providers_.push_back(providerB);
 
   // Reset the controller to contain our new providers.
   AutocompleteController* controller =
       new AutocompleteController(providers_, &profile_);
   controller_.reset(controller);
   providerA->set_listener(controller);
   providerB->set_listener(controller);
@@ skipping 34 matching lines @@
   // Create both a keyword and search provider, and add them in that order.
   // (Order is important; see comments in RunExactKeymatchTest().)
   AutocompleteProvider* keyword_provider = new KeywordProvider(NULL,
                                                                 &profile_);
   keyword_provider->AddRef();
   providers_.push_back(keyword_provider);
   AutocompleteProvider* search_provider = new SearchProvider(NULL, &profile_);
   search_provider->AddRef();
   providers_.push_back(search_provider);
 
+  controller_.reset(new AutocompleteController(providers_, &profile_));
+}
+
+void AutocompleteProviderTest::
+    ResetControllerWithKeywordProvider() {
+  profile_.CreateTemplateURLService();
+
+  TemplateURLService* turl_model =
+      TemplateURLServiceFactory::GetForProfile(&profile_);
+
+  // Create a TemplateURL for KeywordProvider.
+  TemplateURL* keyword_t_url = new TemplateURL();
+  keyword_t_url->set_short_name(ASCIIToUTF16("foo.com"));
+  keyword_t_url->set_keyword(ASCIIToUTF16("foo.com"));
+  keyword_t_url->SetURL("http://foo.com/{searchTerms}", 0, 0);
+  turl_model->Add(keyword_t_url);
+  ASSERT_NE(0, keyword_t_url->id());
+
+  // Create another TemplateURL for KeywordProvider.
+  keyword_t_url = new TemplateURL();
+  keyword_t_url->set_short_name(ASCIIToUTF16("bar.com"));
+  keyword_t_url->set_keyword(ASCIIToUTF16("bar.com"));
+  keyword_t_url->SetURL("http://bar.com/{searchTerms}", 0, 0);
+  turl_model->Add(keyword_t_url);
+  ASSERT_NE(0, keyword_t_url->id());
+
+  // Forget about any existing providers.  The controller owns them and will
+  // Release() them below, when we delete it during the call to reset().
+  providers_.clear();
+
+  // Create both a keyword and search provider, and add them in that order.
+  // (Order is important; see comments in RunExactKeymatchTest().)
+  KeywordProvider* keyword_provider = new KeywordProvider(NULL,
+      &profile_);
+  keyword_provider->AddRef();
+  providers_.push_back(keyword_provider);
+
   AutocompleteController* controller =
       new AutocompleteController(providers_, &profile_);
+  controller->set_keyword_provider(keyword_provider);
   controller_.reset(controller);
 }
 
 void AutocompleteProviderTest::RunTest() {
+  RunQuery(ASCIIToUTF16("a"));
+}
+
+void AutocompleteProviderTest::RunRedundantKeywordTest(
+    const KeywordTestData* match_data,
+    size_t size) {
+  ACMatches matches;
+  for (size_t i = 0; i < size; ++i) {
+    AutocompleteMatch match;
+    match.fill_into_edit = match_data[i].fill_into_edit;
+    match.keyword = match_data[i].keyword;
+    matches.push_back(match);
+  }
+
+  AutocompleteResult result;
+  result.AppendMatches(matches);
+  controller_->UpdateAssociatedKeywords(&result);
+
+  for (size_t j = 0; j < result.size(); ++j) {
+    EXPECT_EQ(match_data[j].expected_keyword_result,
+        result.match_at(j).associated_keyword.get() != NULL);
+  }
+}
+
+
+void AutocompleteProviderTest::RunQuery(const string16 query) {
   result_.Reset();
-  controller_->Start(ASCIIToUTF16("a"), string16(), true, false, true,
-                     AutocompleteInput::ALL_MATCHES);
+  controller_->Start(query, string16(), true, false, true,
+      AutocompleteInput::ALL_MATCHES);
 
-  // The message loop will terminate when all autocomplete input has been
-  // collected.
-  MessageLoop::current()->Run();
+  if (!controller_->done())
+    // The message loop will terminate when all autocomplete input has been
+    // collected.
+    MessageLoop::current()->Run();
 }
 
 void AutocompleteProviderTest::RunExactKeymatchTest(
     bool allow_exact_keyword_match) {
   // Send the controller input which exactly matches the keyword provider we
   // created in ResetControllerWithKeywordAndSearchProviders().  The default
   // match should thus be a keyword match iff |allow_exact_keyword_match| is
   // true.
   controller_->Start(ASCIIToUTF16("k test"), string16(), true, false,
                      allow_exact_keyword_match,
@@ skipping 16 matching lines @@
   }
 }
 
 // Tests that the default selection is set properly when updating results.
 TEST_F(AutocompleteProviderTest, Query) {
   ResetControllerWithTestProviders(false);
   RunTest();
 
   // Make sure the default match gets set to the highest relevance match.  The
   // highest relevance matches should come from the second provider.
-  EXPECT_EQ(num_results_per_provider * 2, result_.size());  // two providers
+  EXPECT_EQ(kResultsPerProvider * 2, result_.size());  // two providers
   ASSERT_NE(result_.end(), result_.default_match());
   EXPECT_EQ(providers_[1], result_.default_match()->provider);
 }
 
 TEST_F(AutocompleteProviderTest, RemoveDuplicates) {
   ResetControllerWithTestProviders(true);
   RunTest();
 
   // Make sure all the first provider's results were eliminated by the second
   // provider's.
-  EXPECT_EQ(num_results_per_provider, result_.size());
+  EXPECT_EQ(kResultsPerProvider, result_.size());
   for (AutocompleteResult::const_iterator i(result_.begin());
        i != result_.end(); ++i)
     EXPECT_EQ(providers_[1], i->provider);
 }
 
 TEST_F(AutocompleteProviderTest, AllowExactKeywordMatch) {
   ResetControllerWithTestProvidersWithKeywordAndSearchProviders();
   RunExactKeymatchTest(true);
   RunExactKeymatchTest(false);
 }
 
+// Test that redundant associated keywords are removed.
+TEST_F(AutocompleteProviderTest, RedundantKeywordsIgnoredInResult) {
+  ResetControllerWithKeywordProvider();
+
+  // Get the controller's internal members in the correct state.
+  RunQuery(ASCIIToUTF16("fo"));
+
+  {
+    KeywordTestData duplicate_url[] = {
+      { ASCIIToUTF16("fo"), string16(), false },
+      { ASCIIToUTF16("foo.com"), string16(), true },
+      { ASCIIToUTF16("foo.com"), string16(), false }
+    };
+
+    SCOPED_TRACE("Duplicate url");
+    RunRedundantKeywordTest(duplicate_url, ARRAYSIZE_UNSAFE(duplicate_url));
+  }
+
+  {
+    KeywordTestData keyword_match[] = {
+      { ASCIIToUTF16("foo.com"), ASCIIToUTF16("foo.com"), false },
+      { ASCIIToUTF16("foo.com"), string16(), false }
+    };
+
+    SCOPED_TRACE("Duplicate url with keyword match");
+    RunRedundantKeywordTest(keyword_match, ARRAYSIZE_UNSAFE(keyword_match));
+  }
+
+  {
+    KeywordTestData multiple_keyword[] = {
+      { ASCIIToUTF16("fo"), string16(), false },
+      { ASCIIToUTF16("foo.com"), string16(), true },
+      { ASCIIToUTF16("foo.com"), string16(), false },
+      { ASCIIToUTF16("bar.com"), string16(), true },
+    };
+
+    SCOPED_TRACE("Duplicate url with multiple keywords");
+    RunRedundantKeywordTest(multiple_keyword,
+        ARRAYSIZE_UNSAFE(multiple_keyword));
+  }
+}
+
 typedef testing::Test AutocompleteTest;
 
 TEST_F(AutocompleteTest, InputType) {
   struct test_data {
     const string16 input;
     const AutocompleteInput::Type type;
   } input_cases[] = {
     { string16(), AutocompleteInput::INVALID },
     { ASCIIToUTF16("?"), AutocompleteInput::FORCED_QUERY },
     { ASCIIToUTF16("?foo"), AutocompleteInput::FORCED_QUERY },
@@ skipping 191 matching lines @@
                                                    &scheme,
                                                    &host);
     AutocompleteInput input(input_cases[i].input, string16(), true, false,
                             true, AutocompleteInput::ALL_MATCHES);
     EXPECT_EQ(input_cases[i].scheme.begin, scheme.begin);
     EXPECT_EQ(input_cases[i].scheme.len, scheme.len);
     EXPECT_EQ(input_cases[i].host.begin, host.begin);
     EXPECT_EQ(input_cases[i].host.len, host.len);
   }
 }
-
-}  // namespace