1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
|
// 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 "chrome/browser/search_engines/template_url_service_test_util.h"
#include "base/bind.h"
#include "base/files/scoped_temp_dir.h"
#include "base/message_loop.h"
#include "base/path_service.h"
#include "base/synchronization/waitable_event.h"
#include "base/threading/thread.h"
#include "chrome/browser/google/google_url_tracker.h"
#include "chrome/browser/search_engines/search_terms_data.h"
#include "chrome/browser/search_engines/template_url_service.h"
#include "chrome/browser/search_engines/template_url_service_factory.h"
#include "chrome/browser/webdata/web_data_service_factory.h"
#include "chrome/common/chrome_notification_types.h"
#include "chrome/common/pref_names.h"
#include "chrome/test/base/testing_pref_service.h"
#include "chrome/test/base/testing_profile.h"
#include "content/public/browser/notification_service.h"
#include "content/public/test/test_browser_thread.h"
#include "testing/gtest/include/gtest/gtest.h"
#if defined(OS_CHROMEOS)
#include "chrome/browser/google/google_util_chromeos.h"
#endif
using content::BrowserThread;
namespace {
// A callback used to coordinate when the database has finished processing
// requests. See note in BlockTillServiceProcessesRequests for details.
//
// Schedules a QuitClosure on the message loop it was created with.
void QuitCallback(MessageLoop* message_loop) {
message_loop->PostTask(FROM_HERE, MessageLoop::QuitClosure());
}
// Blocks the caller until thread has finished servicing all pending
// requests.
static void WaitForThreadToProcessRequests(BrowserThread::ID identifier) {
// Schedule a task on the thread that is processed after all
// pending requests on the thread.
BrowserThread::PostTask(identifier, FROM_HERE,
base::Bind(&QuitCallback, MessageLoop::current()));
MessageLoop::current()->Run();
}
} // namespace
// Subclass the TestingProfile so that it can return a WebDataService.
class TemplateURLServiceTestingProfile : public TestingProfile {
public:
TemplateURLServiceTestingProfile()
: TestingProfile(),
db_thread_(BrowserThread::DB),
io_thread_(BrowserThread::IO) {
}
void SetUp();
void TearDown();
// Starts the I/O thread. This isn't done automatically because not every test
// needs this.
void StartIOThread() {
io_thread_.StartIOThread();
}
static scoped_refptr<RefcountedProfileKeyedService>
GetWebDataServiceForTemplateURLServiceTestingProfile(Profile* profile);
private:
scoped_refptr<WebDataService> service_;
base::ScopedTempDir temp_dir_;
content::TestBrowserThread db_thread_;
content::TestBrowserThread io_thread_;
};
// Trivial subclass of TemplateURLService that records the last invocation of
// SetKeywordSearchTermsForURL.
class TestingTemplateURLService : public TemplateURLService {
public:
static ProfileKeyedService* Build(Profile* profile) {
return new TestingTemplateURLService(profile);
}
explicit TestingTemplateURLService(Profile* profile)
: TemplateURLService(profile) {
}
string16 GetAndClearSearchTerm() {
string16 search_term;
search_term.swap(search_term_);
return search_term;
}
protected:
virtual void SetKeywordSearchTermsForURL(const TemplateURL* t_url,
const GURL& url,
const string16& term) {
search_term_ = term;
}
private:
string16 search_term_;
DISALLOW_COPY_AND_ASSIGN(TestingTemplateURLService);
};
void TemplateURLServiceTestingProfile::SetUp() {
db_thread_.Start();
// Make unique temp directory.
ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
FilePath path = temp_dir_.path().AppendASCII("TestDataService.db");
service_ = new WebDataService;
ASSERT_TRUE(service_->InitWithPath(path));
}
void TemplateURLServiceTestingProfile::TearDown() {
// Clear the request context so it will get deleted. This should be done
// before shutting down the I/O thread to avoid memory leaks.
ResetRequestContext();
// Wait for the delete of the request context to happen.
if (io_thread_.IsRunning())
TemplateURLServiceTestUtil::BlockTillIOThreadProcessesRequests();
// The I/O thread must be shutdown before the DB thread.
io_thread_.Stop();
// Clean up the test directory.
if (service_.get()) {
service_->ShutdownOnUIThread();
service_ = NULL;
}
// Note that we must ensure the DB thread is stopped after WDS
// shutdown (so it can commit pending transactions) but before
// deleting the test profile directory, otherwise we may not be
// able to delete it due to an open transaction.
// Schedule another task on the DB thread to notify us that it's safe to
// carry on with the test.
base::WaitableEvent done(false, false);
BrowserThread::PostTask(BrowserThread::DB, FROM_HERE,
base::Bind(&base::WaitableEvent::Signal, base::Unretained(&done)));
done.Wait();
db_thread_.Stop();
}
scoped_refptr<RefcountedProfileKeyedService>
TemplateURLServiceTestingProfile::
GetWebDataServiceForTemplateURLServiceTestingProfile(Profile* profile) {
TemplateURLServiceTestingProfile* test_profile =
reinterpret_cast<TemplateURLServiceTestingProfile*>(profile);
return test_profile->service_;
}
TemplateURLServiceTestUtil::TemplateURLServiceTestUtil()
: ui_thread_(BrowserThread::UI, &message_loop_),
changed_count_(0) {
}
TemplateURLServiceTestUtil::~TemplateURLServiceTestUtil() {
}
void TemplateURLServiceTestUtil::SetUp() {
profile_.reset(new TemplateURLServiceTestingProfile());
WebDataServiceFactory::GetInstance()->SetTestingFactory(
profile_.get(), TemplateURLServiceTestingProfile::
GetWebDataServiceForTemplateURLServiceTestingProfile);
profile_->SetUp();
TemplateURLService* service = static_cast<TemplateURLService*>(
TemplateURLServiceFactory::GetInstance()->SetTestingFactoryAndUse(
profile_.get(), TestingTemplateURLService::Build));
service->AddObserver(this);
#if defined(OS_CHROMEOS)
google_util::chromeos::ClearBrandForCurrentSession();
#endif
}
void TemplateURLServiceTestUtil::TearDown() {
if (profile_.get()) {
profile_->TearDown();
profile_.reset();
}
UIThreadSearchTermsData::SetGoogleBaseURL(std::string());
// Flush the message loop to make application verifiers happy.
message_loop_.RunUntilIdle();
}
void TemplateURLServiceTestUtil::OnTemplateURLServiceChanged() {
changed_count_++;
}
int TemplateURLServiceTestUtil::GetObserverCount() {
return changed_count_;
}
void TemplateURLServiceTestUtil::ResetObserverCount() {
changed_count_ = 0;
}
void TemplateURLServiceTestUtil::BlockTillServiceProcessesRequests() {
WaitForThreadToProcessRequests(BrowserThread::DB);
}
void TemplateURLServiceTestUtil::BlockTillIOThreadProcessesRequests() {
WaitForThreadToProcessRequests(BrowserThread::IO);
}
void TemplateURLServiceTestUtil::VerifyLoad() {
ASSERT_FALSE(model()->loaded());
model()->Load();
BlockTillServiceProcessesRequests();
EXPECT_EQ(1, GetObserverCount());
ResetObserverCount();
}
void TemplateURLServiceTestUtil::ChangeModelToLoadState() {
model()->ChangeToLoadedState();
// Initialize the web data service so that the database gets updated with
// any changes made.
model()->service_ = WebDataServiceFactory::GetForProfile(
profile_.get(), Profile::EXPLICIT_ACCESS);
}
void TemplateURLServiceTestUtil::ClearModel() {
TemplateURLServiceFactory::GetInstance()->SetTestingFactory(
profile_.get(), NULL);
}
void TemplateURLServiceTestUtil::ResetModel(bool verify_load) {
TemplateURLServiceFactory::GetInstance()->SetTestingFactoryAndUse(
profile_.get(), TestingTemplateURLService::Build);
model()->AddObserver(this);
changed_count_ = 0;
if (verify_load)
VerifyLoad();
}
string16 TemplateURLServiceTestUtil::GetAndClearSearchTerm() {
return
static_cast<TestingTemplateURLService*>(model())->GetAndClearSearchTerm();
}
void TemplateURLServiceTestUtil::SetGoogleBaseURL(const GURL& base_url) const {
DCHECK(base_url.is_valid());
UIThreadSearchTermsData data(profile_.get());
GoogleURLTracker::UpdatedDetails urls(GURL(data.GoogleBaseURLValue()),
base_url);
UIThreadSearchTermsData::SetGoogleBaseURL(base_url.spec());
content::NotificationService::current()->Notify(
chrome::NOTIFICATION_GOOGLE_URL_UPDATED,
content::Source<Profile>(profile_.get()),
content::Details<GoogleURLTracker::UpdatedDetails>(&urls));
}
void TemplateURLServiceTestUtil::SetManagedDefaultSearchPreferences(
bool enabled,
const std::string& name,
const std::string& keyword,
const std::string& search_url,
const std::string& suggest_url,
const std::string& icon_url,
const std::string& encodings) {
TestingPrefServiceSyncable* pref_service = profile_->GetTestingPrefService();
pref_service->SetManagedPref(prefs::kDefaultSearchProviderEnabled,
Value::CreateBooleanValue(enabled));
pref_service->SetManagedPref(prefs::kDefaultSearchProviderName,
Value::CreateStringValue(name));
pref_service->SetManagedPref(prefs::kDefaultSearchProviderKeyword,
Value::CreateStringValue(keyword));
pref_service->SetManagedPref(prefs::kDefaultSearchProviderSearchURL,
Value::CreateStringValue(search_url));
pref_service->SetManagedPref(prefs::kDefaultSearchProviderSuggestURL,
Value::CreateStringValue(suggest_url));
pref_service->SetManagedPref(prefs::kDefaultSearchProviderIconURL,
Value::CreateStringValue(icon_url));
pref_service->SetManagedPref(prefs::kDefaultSearchProviderEncodings,
Value::CreateStringValue(encodings));
model()->Observe(chrome::NOTIFICATION_DEFAULT_SEARCH_POLICY_CHANGED,
content::NotificationService::AllSources(),
content::NotificationService::NoDetails());
}
void TemplateURLServiceTestUtil::RemoveManagedDefaultSearchPreferences() {
TestingPrefServiceSyncable* pref_service = profile_->GetTestingPrefService();
pref_service->RemoveManagedPref(prefs::kDefaultSearchProviderEnabled);
pref_service->RemoveManagedPref(prefs::kDefaultSearchProviderName);
pref_service->RemoveManagedPref(prefs::kDefaultSearchProviderKeyword);
pref_service->RemoveManagedPref(prefs::kDefaultSearchProviderSearchURL);
pref_service->RemoveManagedPref(prefs::kDefaultSearchProviderSuggestURL);
pref_service->RemoveManagedPref(prefs::kDefaultSearchProviderIconURL);
pref_service->RemoveManagedPref(prefs::kDefaultSearchProviderEncodings);
pref_service->RemoveManagedPref(prefs::kDefaultSearchProviderID);
pref_service->RemoveManagedPref(prefs::kDefaultSearchProviderPrepopulateID);
model()->Observe(chrome::NOTIFICATION_DEFAULT_SEARCH_POLICY_CHANGED,
content::NotificationService::AllSources(),
content::NotificationService::NoDetails());
}
TemplateURLService* TemplateURLServiceTestUtil::model() const {
return TemplateURLServiceFactory::GetForProfile(profile_.get());
}
TestingProfile* TemplateURLServiceTestUtil::profile() const {
return profile_.get();
}
void TemplateURLServiceTestUtil::StartIOThread() {
profile_->StartIOThread();
}
void TemplateURLServiceTestUtil::PumpLoop() {
message_loop_.RunUntilIdle();
}
|