template_url_service_test_util.h revision 5821806d5e7f356e8fa4b058a389a808ea183019
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CHROME_BROWSER_SEARCH_ENGINES_TEMPLATE_URL_SERVICE_TEST_UTIL_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_BROWSER_SEARCH_ENGINES_TEMPLATE_URL_SERVICE_TEST_UTIL_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/ref_counted.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/message_loop.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/string16.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/search_engines/template_url_service_observer.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/test/base/testing_browser_process.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/test/test_browser_thread.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class GURL; 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class TemplateURLService; 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class TemplateURLServiceTestingProfile; 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class TestingTemplateURLService; 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class TestingProfile; 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class WebDataService; 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Implements functionality to make it easier to test TemplateURLService and 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// make changes to it. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class TemplateURLServiceTestUtil : public TemplateURLServiceObserver { 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURLServiceTestUtil(); 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~TemplateURLServiceTestUtil(); 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets up the data structures for this class (mirroring gtest standard 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // methods). 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetUp(); 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Cleans up data structures for this class (mirroring gtest standard 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // methods). 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void TearDown(); 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TemplateURLServiceObserver implemementation. 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnTemplateURLServiceChanged() OVERRIDE; 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets the observer count. 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int GetObserverCount(); 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets the observer count to 0. 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ResetObserverCount(); 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Blocks the caller until the service has finished servicing all pending 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // requests. 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void BlockTillServiceProcessesRequests(); 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Blocks the caller until the I/O thread has finished servicing all pending 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // requests. 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void BlockTillIOThreadProcessesRequests(); 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Makes sure the load was successful and sent the correct notification. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void VerifyLoad(); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Makes the model believe it has been loaded (without actually doing the 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // load). Since this avoids setting the built-in keyword version, the next 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // load will do a merge from prepopulated data. 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ChangeModelToLoadState(); 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Deletes the current model (and doesn't create a new one). 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ClearModel(); 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a new TemplateURLService. 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ResetModel(bool verify_load); 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the search term from the last invocation of 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TemplateURLService::SetKeywordSearchTermsForURL and clears the search term. 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string16 GetAndClearSearchTerm(); 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Set the google base url. |base_url| must be valid. 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetGoogleBaseURL(const GURL& base_url) const; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Set the managed preferences for the default search provider and trigger 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // notification. 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetManagedDefaultSearchPreferences(bool enabled, 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& name, 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& keyword, 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& search_url, 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& suggest_url, 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& icon_url, 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& encodings); 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Remove all the managed preferences for the default search provider and 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // trigger notification. 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveManagedDefaultSearchPreferences(); 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the TemplateURLService. 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TemplateURLService* model() const; 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the TestingProfile. 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TestingProfile* profile() const; 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Starts an I/O thread. 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void StartIOThread(); 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Runs all pending tasks on the UI loop. 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void PumpLoop(); 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MessageLoopForUI message_loop_; 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Needed to make the DeleteOnUIThread trait of WebDataService work 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // properly. 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::TestBrowserThread ui_thread_; 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<TemplateURLServiceTestingProfile> profile_; 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int changed_count_; 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(TemplateURLServiceTestUtil); 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_SEARCH_ENGINES_TEMPLATE_URL_SERVICE_TEST_UTIL_H_ 118