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
|
// Copyright (c) 2010 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/string_util.h"
#include "base/time.h"
#include "base/utf_string_conversions.h"
#include "build/build_config.h"
#include "chrome/browser/autocomplete/search_provider.h"
#include "chrome/browser/browser_thread.h"
#include "chrome/browser/history/history.h"
#include "chrome/browser/search_engines/template_url.h"
#include "chrome/browser/search_engines/template_url_model.h"
#include "chrome/common/net/test_url_fetcher_factory.h"
#include "chrome/test/testing_profile.h"
#include "net/url_request/url_request_status.h"
#include "testing/gtest/include/gtest/gtest.h"
// The following environment is configured for these tests:
// . The TemplateURL default_t_url_ is set as the default provider.
// . The TemplateURL keyword_t_url_ is added to the TemplateURLModel. This
// TemplateURL has a valid suggest and search URL.
// . The URL created by using the search term term1_ with default_t_url_ is
// added to history.
// . The URL created by using the search term keyword_term_ with keyword_t_url_
// is added to history.
// . test_factory_ is set as the URLFetcher::Factory.
class SearchProviderTest : public testing::Test,
public AutocompleteProvider::ACProviderListener {
public:
SearchProviderTest()
: default_t_url_(NULL),
term1_(UTF8ToUTF16("term1")),
keyword_t_url_(NULL),
keyword_term_(UTF8ToUTF16("keyword")),
io_thread_(BrowserThread::IO),
quit_when_done_(false) {
io_thread_.Start();
}
// See description above class for what this registers.
virtual void SetUp();
virtual void TearDown();
protected:
// Returns an AutocompleteMatch in provider_'s set of matches that matches
// |url|. If there is no matching URL, an empty match is returned.
AutocompleteMatch FindMatchWithDestination(const GURL& url);
// ACProviderListener method. If we're waiting for the provider to finish,
// this exits the message loop.
virtual void OnProviderUpdate(bool updated_matches);
// Runs a nested message loop until provider_ is done. The message loop is
// exited by way of OnProviderUPdate.
void RunTillProviderDone();
// Invokes Start on provider_, then runs all pending tasks.
void QueryForInput(const string16& text);
// See description above class for details of these fields.
TemplateURL* default_t_url_;
const string16 term1_;
GURL term1_url_;
TemplateURL* keyword_t_url_;
const string16 keyword_term_;
GURL keyword_url_;
MessageLoopForUI message_loop_;
BrowserThread io_thread_;
// URLFetcher::Factory implementation registered.
TestURLFetcherFactory test_factory_;
// Profile we use.
TestingProfile profile_;
// The provider.
scoped_refptr<SearchProvider> provider_;
// If true, OnProviderUpdate exits out of the current message loop.
bool quit_when_done_;
DISALLOW_COPY_AND_ASSIGN(SearchProviderTest);
};
void SearchProviderTest::SetUp() {
SearchProvider::set_query_suggest_immediately(true);
// We need both the history service and template url model loaded.
profile_.CreateHistoryService(true, false);
profile_.CreateTemplateURLModel();
TemplateURLModel* turl_model = profile_.GetTemplateURLModel();
// Reset the default TemplateURL.
default_t_url_ = new TemplateURL();
default_t_url_->SetURL("http://defaultturl/{searchTerms}", 0, 0);
default_t_url_->SetSuggestionsURL("http://defaultturl2/{searchTerms}", 0, 0);
turl_model->Add(default_t_url_);
turl_model->SetDefaultSearchProvider(default_t_url_);
TemplateURLID default_provider_id = default_t_url_->id();
ASSERT_NE(0, default_provider_id);
// Add url1, with search term term1_.
HistoryService* history =
profile_.GetHistoryService(Profile::EXPLICIT_ACCESS);
term1_url_ = GURL(default_t_url_->url()->ReplaceSearchTerms(
*default_t_url_, UTF16ToWide(term1_), 0, std::wstring()));
history->AddPageWithDetails(term1_url_, string16(), 1, 1,
base::Time::Now(), false,
history::SOURCE_BROWSED);
history->SetKeywordSearchTermsForURL(term1_url_, default_t_url_->id(),
term1_);
// Create another TemplateURL.
keyword_t_url_ = new TemplateURL();
keyword_t_url_->set_keyword(L"k");
keyword_t_url_->SetURL("http://keyword/{searchTerms}", 0, 0);
keyword_t_url_->SetSuggestionsURL("http://suggest_keyword/{searchTerms}", 0,
0);
profile_.GetTemplateURLModel()->Add(keyword_t_url_);
ASSERT_NE(0, keyword_t_url_->id());
// Add a page and search term for keyword_t_url_.
keyword_url_ = GURL(keyword_t_url_->url()->ReplaceSearchTerms(
*keyword_t_url_, UTF16ToWide(keyword_term_), 0, std::wstring()));
history->AddPageWithDetails(keyword_url_, string16(), 1, 1,
base::Time::Now(), false,
history::SOURCE_BROWSED);
history->SetKeywordSearchTermsForURL(keyword_url_, keyword_t_url_->id(),
keyword_term_);
provider_ = new SearchProvider(this, &profile_);
URLFetcher::set_factory(&test_factory_);
}
void SearchProviderTest::OnProviderUpdate(bool updated_matches) {
if (quit_when_done_ && provider_->done()) {
quit_when_done_ = false;
message_loop_.Quit();
}
}
void SearchProviderTest::RunTillProviderDone() {
if (provider_->done())
return;
quit_when_done_ = true;
#if defined(OS_MACOSX)
message_loop_.Run();
#else
message_loop_.Run(NULL);
#endif
}
void SearchProviderTest::QueryForInput(const string16& text) {
// Start a query.
AutocompleteInput input(UTF16ToWide(text), std::wstring(),
false, false, false);
provider_->Start(input, false);
// RunAllPending so that the task scheduled by SearchProvider to create the
// URLFetchers runs.
message_loop_.RunAllPending();
}
void SearchProviderTest::TearDown() {
message_loop_.RunAllPending();
URLFetcher::set_factory(NULL);
// Shutdown the provider before the profile.
provider_ = NULL;
}
AutocompleteMatch SearchProviderTest::FindMatchWithDestination(
const GURL& url) {
for (ACMatches::const_iterator i = provider_->matches().begin();
i != provider_->matches().end(); ++i) {
if (i->destination_url == url)
return *i;
}
return AutocompleteMatch(NULL, 1, false, AutocompleteMatch::HISTORY_URL);
}
// Tests -----------------------------------------------------------------------
// Make sure we query history for the default provider and a URLFetcher is
// created for the default provider suggest results.
TEST_F(SearchProviderTest, QueryDefaultProvider) {
string16 term = term1_.substr(0, term1_.size() - 1);
QueryForInput(term);
// Make sure the default providers suggest service was queried.
TestURLFetcher* fetcher = test_factory_.GetFetcherByID(
SearchProvider::kDefaultProviderURLFetcherID);
ASSERT_TRUE(fetcher);
// And the URL matches what we expected.
GURL expected_url = GURL(default_t_url_->suggestions_url()->
ReplaceSearchTerms(*default_t_url_, UTF16ToWide(term),
0, std::wstring()));
ASSERT_TRUE(fetcher->original_url() == expected_url);
// Tell the SearchProvider the suggest query is done.
fetcher->delegate()->OnURLFetchComplete(
fetcher, GURL(), URLRequestStatus(), 200, ResponseCookies(),
std::string());
fetcher = NULL;
// Run till the history results complete.
RunTillProviderDone();
// The SearchProvider is done. Make sure it has a result for the history
// term term1.
AutocompleteMatch match = FindMatchWithDestination(term1_url_);
ASSERT_TRUE(!match.destination_url.is_empty());
}
// Issues a query that matches the registered keyword and makes sure history
// is queried as well as URLFetchers getting created.
TEST_F(SearchProviderTest, QueryKeywordProvider) {
string16 term = keyword_term_.substr(0, keyword_term_.size() - 1);
QueryForInput(WideToUTF16(keyword_t_url_->keyword()) +
UTF8ToUTF16(" ") + term);
// Make sure the default providers suggest service was queried.
TestURLFetcher* default_fetcher = test_factory_.GetFetcherByID(
SearchProvider::kDefaultProviderURLFetcherID);
ASSERT_TRUE(default_fetcher);
// Tell the SearchProvider the default suggest query is done.
default_fetcher->delegate()->OnURLFetchComplete(
default_fetcher, GURL(), URLRequestStatus(), 200, ResponseCookies(),
std::string());
default_fetcher = NULL;
// Make sure the keyword providers suggest service was queried.
TestURLFetcher* keyword_fetcher = test_factory_.GetFetcherByID(
SearchProvider::kKeywordProviderURLFetcherID);
ASSERT_TRUE(keyword_fetcher);
// And the URL matches what we expected.
GURL expected_url = GURL(keyword_t_url_->suggestions_url()->
ReplaceSearchTerms(*keyword_t_url_, UTF16ToWide(term), 0,
std::wstring()));
ASSERT_TRUE(keyword_fetcher->original_url() == expected_url);
// Tell the SearchProvider the keyword suggest query is done.
keyword_fetcher->delegate()->OnURLFetchComplete(
keyword_fetcher, GURL(), URLRequestStatus(), 200, ResponseCookies(),
std::string());
keyword_fetcher = NULL;
// Run till the history results complete.
RunTillProviderDone();
// The SearchProvider is done. Make sure it has a result for the history
// term keyword.
AutocompleteMatch match = FindMatchWithDestination(keyword_url_);
ASSERT_TRUE(!match.destination_url.is_empty());
// The match should have a TemplateURL.
EXPECT_TRUE(match.template_url);
// The fill into edit should contain the keyword.
EXPECT_EQ(keyword_t_url_->keyword() + L" " + UTF16ToWide(keyword_term_),
match.fill_into_edit);
}
TEST_F(SearchProviderTest, DontSendPrivateDataToSuggest) {
// None of the following input strings should be sent to the suggest server,
// because they may contain private data.
const char* inputs[] = {
"username:password",
"http://username:password",
"https://username:password",
"username:password@hostname",
"http://username:password@hostname/",
"file://filename",
"data://data",
"unknownscheme:anything",
"http://hostname/?query=q",
"http://hostname/path#ref",
"https://hostname/path",
};
for (size_t i = 0; i < arraysize(inputs); ++i) {
QueryForInput(ASCIIToUTF16(inputs[i]));
// Make sure the default providers suggest service was not queried.
ASSERT_TRUE(test_factory_.GetFetcherByID(
SearchProvider::kDefaultProviderURLFetcherID) == NULL);
// Run till the history results complete.
RunTillProviderDone();
}
}
|