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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
/*
* Tests that OpenSearch engines are installed and set up correctly.
*
* Note: simple.xml, post.xml, suggestion.xml and suggestion-alternate.xml
* all use different namespaces to reflect the possibitities that may be
* installed.
* mozilla-ns.xml uses the mozilla namespace.
*/
"use strict";
const tests = [
{
file: "simple.xml",
name: "simple",
description: "A small test engine",
searchForm: "https://example.com/",
searchUrl: "https://example.com/search?q=foo",
},
{
file: "post.xml",
name: "Post",
description: "",
// The POST method is not supported for `rel="searchform"` so we fallback
// to the `SearchForm` url.
searchForm: "http://engine-rel-searchform-post.xml/?search",
searchUrl: "https://example.com/post",
searchPostData: "searchterms=foo",
},
{
file: "suggestion.xml",
name: "suggestion",
description: "A small engine with suggestions",
queryCharset: "windows-1252",
searchForm: "http://engine-rel-searchform.xml/?search",
searchUrl: "https://example.com/search?q=foo",
suggestUrl: "https://example.com/suggest?suggestion=foo",
},
{
file: "suggestion-alternate.xml",
name: "suggestion-alternate",
description: "A small engine with suggestions",
searchForm: "https://example.com/",
searchUrl: "https://example.com/search?q=foo",
suggestUrl: "https://example.com/suggest?suggestion=foo",
},
{
file: "mozilla-ns.xml",
name: "mozilla-ns",
description: "An engine using mozilla namespace",
searchForm: "https://example.com/",
// mozilla-ns.xml also specifies a MozParam. However, they are only
// valid for app-provided engines, and hence the param should not show
// here.
searchUrl: "https://example.com/search?q=foo",
},
];
add_task(async function setup() {
Services.fog.initializeFOG();
useHttpServer("opensearch");
await AddonTestUtils.promiseStartupManager();
await Services.search.init();
});
for (const test of tests) {
add_task(async () => {
info(`Testing ${test.file}`);
let promiseEngineAdded = SearchTestUtils.promiseSearchNotification(
SearchUtils.MODIFIED_TYPE.ADDED,
SearchUtils.TOPIC_ENGINE_MODIFIED
);
let engine = await Services.search.addOpenSearchEngine(
gDataUrl + test.file,
null
);
await promiseEngineAdded;
Assert.ok(engine, "Should have installed the engine.");
Assert.equal(engine.name, test.name, "Should have the correct name");
Assert.equal(
engine.description,
test.description,
"Should have a description"
);
Assert.equal(
engine.wrappedJSObject._loadPath,
`[http]localhost/${test.file}`
);
Assert.equal(
engine.queryCharset,
test.queryCharset ?? SearchUtils.DEFAULT_QUERY_CHARSET,
"Should have the expected query charset"
);
let submission = engine.getSubmission("foo");
Assert.equal(
submission.uri.spec,
test.searchUrl,
"Should have the correct search url"
);
if (test.searchPostData) {
let sis = Cc["@mozilla.org/scriptableinputstream;1"].createInstance(
Ci.nsIScriptableInputStream
);
sis.init(submission.postData);
let data = sis.read(submission.postData.available());
Assert.equal(
decodeURIComponent(data),
test.searchPostData,
"Should have received the correct POST data"
);
} else {
Assert.equal(
submission.postData,
null,
"Should have not received any POST data"
);
}
Assert.equal(
engine.searchForm,
test.searchForm,
"Should have the correct search form url"
);
submission = engine.getSubmission("foo", SearchUtils.URL_TYPE.SUGGEST_JSON);
if (test.suggestUrl) {
Assert.equal(
submission.uri.spec,
test.suggestUrl,
"Should have the correct suggest url"
);
} else {
Assert.equal(submission, null, "Should not have a suggestion url");
}
});
}
add_task(async function test_telemetry_reporting() {
// Use an engine from the previous tests.
let engine = Services.search.getEngineByName("simple");
Services.search.defaultEngine = engine;
await assertGleanDefaultEngine({
normal: {
engineId: "other-simple",
displayName: "simple",
loadPath: "[http]localhost/simple.xml",
submissionUrl: "blank:",
verified: "verified",
},
});
});
|
