| // Copyright 2013 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. |
| |
| #import "ios/chrome/browser/ui/settings/search_engine_table_view_controller.h" |
| |
| #include <memory> |
| |
| #include "base/compiler_specific.h" |
| #include "base/mac/foundation_util.h" |
| #include "base/strings/sys_string_conversions.h" |
| #include "base/strings/utf_string_conversions.h" |
| #include "base/test/metrics/histogram_tester.h" |
| #include "components/search_engines/template_url_data_util.h" |
| #include "components/search_engines/template_url_prepopulate_data.h" |
| #include "components/search_engines/template_url_service.h" |
| #include "components/sync_preferences/testing_pref_service_syncable.h" |
| #include "ios/chrome/browser/browser_state/test_chrome_browser_state.h" |
| #include "ios/chrome/browser/search_engines/template_url_service_factory.h" |
| #import "ios/chrome/browser/ui/table_view/cells/table_view_detail_text_item.h" |
| #import "ios/chrome/browser/ui/table_view/chrome_table_view_controller_test.h" |
| #include "ios/web/public/test/test_web_thread_bundle.h" |
| #include "testing/gtest/include/gtest/gtest.h" |
| #import "testing/gtest_mac.h" |
| |
| #if !defined(__has_feature) || !__has_feature(objc_arc) |
| #error "This file requires ARC support." |
| #endif |
| |
| using TemplateURLPrepopulateData::GetAllPrepopulatedEngines; |
| using TemplateURLPrepopulateData::PrepopulatedEngine; |
| |
| namespace { |
| |
| const char kUmaSelectDefaultSearchEngine[] = |
| "Search.iOS.SelectDefaultSearchEngine"; |
| |
| class SearchEngineTableViewControllerTest |
| : public ChromeTableViewControllerTest { |
| protected: |
| void SetUp() override { |
| ChromeTableViewControllerTest::SetUp(); |
| TestChromeBrowserState::Builder test_cbs_builder; |
| test_cbs_builder.AddTestingFactory( |
| ios::TemplateURLServiceFactory::GetInstance(), |
| ios::TemplateURLServiceFactory::GetDefaultFactory()); |
| chrome_browser_state_ = test_cbs_builder.Build(); |
| DefaultSearchManager::SetFallbackSearchEnginesDisabledForTesting(true); |
| template_url_service_ = ios::TemplateURLServiceFactory::GetForBrowserState( |
| chrome_browser_state_.get()); |
| template_url_service_->Load(); |
| } |
| |
| ChromeTableViewController* InstantiateController() override { |
| return [[SearchEngineTableViewController alloc] |
| initWithBrowserState:chrome_browser_state_.get()]; |
| } |
| |
| // Adds a prepopulated search engine to TemplateURLService. |
| TemplateURL* AddPriorSearchEngine(const std::string& short_name, |
| const std::string& keyword, |
| int prepopulate_id, |
| bool set_default) { |
| TemplateURLData data; |
| data.SetShortName(base::ASCIIToUTF16(short_name)); |
| data.SetURL("https://chromium.test/index.php?q={searchTerms}"); |
| data.SetKeyword(base::ASCIIToUTF16(keyword)); |
| data.prepopulate_id = prepopulate_id; |
| TemplateURL* url = |
| template_url_service_->Add(std::make_unique<TemplateURL>(data)); |
| if (set_default) |
| template_url_service_->SetUserSelectedDefaultSearchProvider(url); |
| return url; |
| } |
| |
| // Adds a custom search engine to TemplateURLService. |
| TemplateURL* AddCustomSearchEngine(const std::string& short_name, |
| const std::string& keyword, |
| base::Time last_visited_time, |
| bool set_default) { |
| TemplateURLData data; |
| data.SetShortName(base::ASCIIToUTF16(short_name)); |
| data.SetURL("https://chromium.test/index.php?q={searchTerms}"); |
| data.SetKeyword(base::ASCIIToUTF16(keyword)); |
| data.last_visited = last_visited_time; |
| TemplateURL* url = |
| template_url_service_->Add(std::make_unique<TemplateURL>(data)); |
| if (set_default) |
| template_url_service_->SetUserSelectedDefaultSearchProvider(url); |
| return url; |
| } |
| |
| // Checks if a text cell in the TableView has a check mark. |
| void CheckTextCellChecked(bool expect_checked, int section, int item) { |
| TableViewDetailTextItem* text_item = |
| base::mac::ObjCCastStrict<TableViewDetailTextItem>( |
| GetTableViewItem(section, item)); |
| ASSERT_TRUE(text_item); |
| EXPECT_EQ(expect_checked ? UITableViewCellAccessoryCheckmark |
| : UITableViewCellAccessoryNone, |
| text_item.accessoryType); |
| } |
| |
| web::TestWebThreadBundle thread_bundle_; |
| std::unique_ptr<TestChromeBrowserState> chrome_browser_state_; |
| base::HistogramTester histogram_tester_; |
| TemplateURLService* template_url_service_; // weak |
| }; |
| |
| // Tests that no items are shown if TemplateURLService is empty. |
| TEST_F(SearchEngineTableViewControllerTest, TestNoUrl) { |
| CreateController(); |
| CheckController(); |
| EXPECT_EQ(0, NumberOfSections()); |
| } |
| |
| // Tests that items are displayed correctly when TemplateURLService is filled |
| // and a prepopulated search engine is selected as default. |
| TEST_F(SearchEngineTableViewControllerTest, |
| TestUrlsLoadedWithPrepopulatedSearchEngineAsDefault) { |
| AddPriorSearchEngine("prepopulated-3", "p3.com", 3, false); |
| AddPriorSearchEngine("prepopulated-1", "p1.com", 1, false); |
| AddPriorSearchEngine("prepopulated-2", "p2.com", 2, true); |
| |
| AddCustomSearchEngine("custom-4", "c4.com", |
| base::Time::Now() - base::TimeDelta::FromDays(10), |
| false); |
| AddCustomSearchEngine("custom-1", "c1.com", |
| base::Time::Now() - base::TimeDelta::FromSeconds(10), |
| false); |
| AddCustomSearchEngine("custom-3", "c3.com", |
| base::Time::Now() - base::TimeDelta::FromHours(10), |
| false); |
| AddCustomSearchEngine("custom-2", "c2.com", |
| base::Time::Now() - base::TimeDelta::FromMinutes(10), |
| false); |
| |
| CreateController(); |
| CheckController(); |
| |
| ASSERT_EQ(2, NumberOfSections()); |
| ASSERT_EQ(3, NumberOfItemsInSection(0)); |
| CheckTextCellTextAndDetailText(@"prepopulated-1", @"p1.com", 0, 0); |
| CheckTextCellChecked(false, 0, 0); |
| CheckTextCellTextAndDetailText(@"prepopulated-2", @"p2.com", 0, 1); |
| CheckTextCellChecked(true, 0, 1); |
| CheckTextCellTextAndDetailText(@"prepopulated-3", @"p3.com", 0, 2); |
| CheckTextCellChecked(false, 0, 2); |
| |
| ASSERT_EQ(3, NumberOfItemsInSection(1)); |
| CheckTextCellTextAndDetailText(@"custom-1", @"c1.com", 1, 0); |
| CheckTextCellChecked(false, 1, 0); |
| CheckTextCellTextAndDetailText(@"custom-2", @"c2.com", 1, 1); |
| CheckTextCellChecked(false, 1, 1); |
| CheckTextCellTextAndDetailText(@"custom-3", @"c3.com", 1, 2); |
| CheckTextCellChecked(false, 1, 2); |
| } |
| |
| // Tests that items are displayed correctly when TemplateURLService is filled |
| // and a custom search engine is selected as default. |
| TEST_F(SearchEngineTableViewControllerTest, |
| TestUrlsLoadedWithCustomSearchEngineAsDefault) { |
| AddPriorSearchEngine("prepopulated-3", "p3.com", 3, false); |
| AddPriorSearchEngine("prepopulated-1", "p1.com", 1, false); |
| AddPriorSearchEngine("prepopulated-2", "p2.com", 2, false); |
| |
| AddCustomSearchEngine("custom-4", "c4.com", |
| base::Time::Now() - base::TimeDelta::FromDays(10), |
| false); |
| AddCustomSearchEngine("custom-1", "c1.com", |
| base::Time::Now() - base::TimeDelta::FromSeconds(10), |
| false); |
| AddCustomSearchEngine("custom-3", "c3.com", |
| base::Time::Now() - base::TimeDelta::FromHours(10), |
| false); |
| AddCustomSearchEngine("custom-2", "c2.com", |
| base::Time::Now() - base::TimeDelta::FromMinutes(10), |
| true); |
| |
| CreateController(); |
| CheckController(); |
| |
| ASSERT_EQ(2, NumberOfSections()); |
| ASSERT_EQ(4, NumberOfItemsInSection(0)); |
| CheckTextCellTextAndDetailText(@"prepopulated-1", @"p1.com", 0, 0); |
| CheckTextCellChecked(false, 0, 0); |
| CheckTextCellTextAndDetailText(@"prepopulated-2", @"p2.com", 0, 1); |
| CheckTextCellChecked(false, 0, 1); |
| CheckTextCellTextAndDetailText(@"prepopulated-3", @"p3.com", 0, 2); |
| CheckTextCellChecked(false, 0, 2); |
| CheckTextCellTextAndDetailText(@"custom-2", @"c2.com", 0, 3); |
| CheckTextCellChecked(true, 0, 3); |
| |
| ASSERT_EQ(2, NumberOfItemsInSection(1)); |
| CheckTextCellTextAndDetailText(@"custom-1", @"c1.com", 1, 0); |
| CheckTextCellChecked(false, 1, 0); |
| CheckTextCellTextAndDetailText(@"custom-3", @"c3.com", 1, 1); |
| CheckTextCellChecked(false, 1, 1); |
| } |
| |
| // Tests that when TemplateURLService add or remove TemplateURLs, or update |
| // default search engine, the controller will update the displayed items. |
| TEST_F(SearchEngineTableViewControllerTest, TestUrlModifiedByService) { |
| TemplateURL* url_p1 = |
| AddPriorSearchEngine("prepopulated-1", "p1.com", 1, true); |
| |
| CreateController(); |
| CheckController(); |
| |
| ASSERT_EQ(1, NumberOfSections()); |
| ASSERT_EQ(1, NumberOfItemsInSection(0)); |
| CheckTextCellTextAndDetailText(@"prepopulated-1", @"p1.com", 0, 0); |
| CheckTextCellChecked(true, 0, 0); |
| |
| TemplateURL* url_p2 = |
| AddPriorSearchEngine("prepopulated-2", "p2.com", 2, false); |
| |
| ASSERT_EQ(1, NumberOfSections()); |
| ASSERT_EQ(2, NumberOfItemsInSection(0)); |
| CheckTextCellTextAndDetailText(@"prepopulated-1", @"p1.com", 0, 0); |
| CheckTextCellChecked(true, 0, 0); |
| CheckTextCellTextAndDetailText(@"prepopulated-2", @"p2.com", 0, 1); |
| CheckTextCellChecked(false, 0, 1); |
| |
| template_url_service_->SetUserSelectedDefaultSearchProvider(url_p2); |
| |
| ASSERT_EQ(1, NumberOfSections()); |
| ASSERT_EQ(2, NumberOfItemsInSection(0)); |
| CheckTextCellTextAndDetailText(@"prepopulated-1", @"p1.com", 0, 0); |
| CheckTextCellChecked(false, 0, 0); |
| CheckTextCellTextAndDetailText(@"prepopulated-2", @"p2.com", 0, 1); |
| CheckTextCellChecked(true, 0, 1); |
| |
| template_url_service_->SetUserSelectedDefaultSearchProvider(url_p1); |
| template_url_service_->Remove(url_p2); |
| |
| ASSERT_EQ(1, NumberOfSections()); |
| ASSERT_EQ(1, NumberOfItemsInSection(0)); |
| CheckTextCellTextAndDetailText(@"prepopulated-1", @"p1.com", 0, 0); |
| CheckTextCellChecked(true, 0, 0); |
| } |
| |
| // Tests that when user change default search engine, all items can be displayed |
| // correctly and the change can be synced to the prefs. |
| TEST_F(SearchEngineTableViewControllerTest, TestChangeProvider) { |
| // This test also needs to test the UMA, so load some real prepopulated search |
| // engines to ensure the SearchEngineType is logged correctly. Don't use any |
| // literal symbol(e.g. "google" or "AOL") from |
| // "components/search_engines/prepopulated_engines.h" since it's a generated |
| // file. |
| std::vector<const PrepopulatedEngine*> prepopulated_engines = |
| GetAllPrepopulatedEngines(); |
| ASSERT_LE(2UL, prepopulated_engines.size()); |
| |
| TemplateURL* url_p1 = |
| template_url_service_->Add(std::make_unique<TemplateURL>( |
| *TemplateURLDataFromPrepopulatedEngine(*prepopulated_engines[0]))); |
| ASSERT_TRUE(url_p1); |
| TemplateURL* url_p2 = |
| template_url_service_->Add(std::make_unique<TemplateURL>( |
| *TemplateURLDataFromPrepopulatedEngine(*prepopulated_engines[1]))); |
| ASSERT_TRUE(url_p2); |
| |
| // Expected indexes of prepopulated engines in the list. |
| int url_p1_index = 0; |
| int url_p2_index = 1; |
| if (url_p1->prepopulate_id() > url_p2->prepopulate_id()) |
| std::swap(url_p1_index, url_p2_index); |
| |
| // Also add some custom search engines. |
| TemplateURL* url_c1 = |
| AddCustomSearchEngine("custom-1", "c1.com", base::Time::Now(), false); |
| AddCustomSearchEngine("custom-2", "c2.com", |
| base::Time::Now() - base::TimeDelta::FromSeconds(10), |
| false); |
| |
| CreateController(); |
| CheckController(); |
| |
| // Choose url_p1 as default. |
| [controller() tableView:[controller() tableView] |
| didSelectRowAtIndexPath:[NSIndexPath indexPathForRow:url_p1_index |
| inSection:0]]; |
| |
| ASSERT_EQ(2, NumberOfSections()); |
| // Check first list. |
| ASSERT_EQ(2, NumberOfItemsInSection(0)); |
| CheckTextCellTextAndDetailText(base::SysUTF16ToNSString(url_p1->short_name()), |
| base::SysUTF16ToNSString(url_p1->keyword()), 0, |
| url_p1_index); |
| CheckTextCellChecked(true, 0, url_p1_index); |
| CheckTextCellTextAndDetailText(base::SysUTF16ToNSString(url_p2->short_name()), |
| base::SysUTF16ToNSString(url_p2->keyword()), 0, |
| url_p2_index); |
| CheckTextCellChecked(false, 0, url_p2_index); |
| // Check second list. |
| ASSERT_EQ(2, NumberOfItemsInSection(1)); |
| CheckTextCellTextAndDetailText(@"custom-1", @"c1.com", 1, 0); |
| CheckTextCellChecked(false, 1, 0); |
| CheckTextCellTextAndDetailText(@"custom-2", @"c2.com", 1, 1); |
| CheckTextCellChecked(false, 1, 1); |
| // Check default search engine. |
| EXPECT_EQ(url_p1, template_url_service_->GetDefaultSearchProvider()); |
| // Check UMA. |
| histogram_tester_.ExpectUniqueSample( |
| kUmaSelectDefaultSearchEngine, |
| url_p1->GetEngineType(template_url_service_->search_terms_data()), 1); |
| |
| // Choose url_p2 as default. |
| [controller() tableView:[controller() tableView] |
| didSelectRowAtIndexPath:[NSIndexPath indexPathForRow:url_p2_index |
| inSection:0]]; |
| |
| ASSERT_EQ(2, NumberOfSections()); |
| // Check first list. |
| ASSERT_EQ(2, NumberOfItemsInSection(0)); |
| CheckTextCellTextAndDetailText(base::SysUTF16ToNSString(url_p1->short_name()), |
| base::SysUTF16ToNSString(url_p1->keyword()), 0, |
| url_p1_index); |
| CheckTextCellChecked(false, 0, url_p1_index); |
| CheckTextCellTextAndDetailText(base::SysUTF16ToNSString(url_p2->short_name()), |
| base::SysUTF16ToNSString(url_p2->keyword()), 0, |
| url_p2_index); |
| CheckTextCellChecked(true, 0, url_p2_index); |
| // Check second list. |
| ASSERT_EQ(2, NumberOfItemsInSection(1)); |
| CheckTextCellTextAndDetailText(@"custom-1", @"c1.com", 1, 0); |
| CheckTextCellChecked(false, 1, 0); |
| CheckTextCellTextAndDetailText(@"custom-2", @"c2.com", 1, 1); |
| CheckTextCellChecked(false, 1, 1); |
| // Check default search engine. |
| EXPECT_EQ(url_p2, template_url_service_->GetDefaultSearchProvider()); |
| // Check UMA. |
| histogram_tester_.ExpectBucketCount( |
| kUmaSelectDefaultSearchEngine, |
| url_p1->GetEngineType(template_url_service_->search_terms_data()), 1); |
| histogram_tester_.ExpectBucketCount( |
| kUmaSelectDefaultSearchEngine, |
| url_p2->GetEngineType(template_url_service_->search_terms_data()), 1); |
| histogram_tester_.ExpectTotalCount(kUmaSelectDefaultSearchEngine, 2); |
| |
| // Choose url_c1 as default. |
| [controller() tableView:[controller() tableView] |
| didSelectRowAtIndexPath:[NSIndexPath indexPathForRow:0 inSection:1]]; |
| |
| ASSERT_EQ(2, NumberOfSections()); |
| // Check first list. |
| ASSERT_EQ(2, NumberOfItemsInSection(0)); |
| CheckTextCellTextAndDetailText(base::SysUTF16ToNSString(url_p1->short_name()), |
| base::SysUTF16ToNSString(url_p1->keyword()), 0, |
| url_p1_index); |
| CheckTextCellChecked(false, 0, url_p1_index); |
| CheckTextCellTextAndDetailText(base::SysUTF16ToNSString(url_p2->short_name()), |
| base::SysUTF16ToNSString(url_p2->keyword()), 0, |
| url_p2_index); |
| CheckTextCellChecked(false, 0, url_p2_index); |
| // Check second list. |
| ASSERT_EQ(2, NumberOfItemsInSection(1)); |
| CheckTextCellTextAndDetailText(@"custom-1", @"c1.com", 1, 0); |
| CheckTextCellChecked(true, 1, 0); |
| CheckTextCellTextAndDetailText(@"custom-2", @"c2.com", 1, 1); |
| CheckTextCellChecked(false, 1, 1); |
| // Check default search engine. |
| EXPECT_EQ(url_c1, template_url_service_->GetDefaultSearchProvider()); |
| // Check UMA. |
| histogram_tester_.ExpectBucketCount( |
| kUmaSelectDefaultSearchEngine, |
| url_p1->GetEngineType(template_url_service_->search_terms_data()), 1); |
| histogram_tester_.ExpectBucketCount( |
| kUmaSelectDefaultSearchEngine, |
| url_p2->GetEngineType(template_url_service_->search_terms_data()), 1); |
| histogram_tester_.ExpectBucketCount(kUmaSelectDefaultSearchEngine, |
| SEARCH_ENGINE_OTHER, 1); |
| histogram_tester_.ExpectTotalCount(kUmaSelectDefaultSearchEngine, 3); |
| |
| // Check that the selection was written back to the prefs. |
| const base::DictionaryValue* searchProviderDict = |
| chrome_browser_state_->GetTestingPrefService()->GetDictionary( |
| DefaultSearchManager::kDefaultSearchProviderDataPrefName); |
| ASSERT_TRUE(searchProviderDict); |
| base::string16 short_name; |
| EXPECT_TRUE(searchProviderDict->GetString(DefaultSearchManager::kShortName, |
| &short_name)); |
| EXPECT_EQ(url_c1->short_name(), short_name); |
| } |
| |
| } // namespace |
