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
|
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";
const { AddonTestUtils } = ChromeUtils.importESModule(
"resource://testing-common/AddonTestUtils.sys.mjs"
);
const { SearchTestUtils } = ChromeUtils.importESModule(
"resource://testing-common/SearchTestUtils.sys.mjs"
);
const { NimbusFeatures } = ChromeUtils.importESModule(
"resource://nimbus/ExperimentAPI.sys.mjs"
);
const { sinon } = ChromeUtils.importESModule(
"resource://testing-common/Sinon.sys.mjs"
);
AddonTestUtils.init(this);
AddonTestUtils.overrideCertDB();
AddonTestUtils.createAppInfo(
"xpcshell@tests.mozilla.org",
"XPCShell",
"42",
"42"
);
let { promiseShutdownManager, promiseStartupManager } = AddonTestUtils;
// Note: these lists should be kept in sync with the lists in
// browser/components/extensions/test/xpcshell/data/test/manifest.json
// These params are conditional based on how search is initiated.
const mozParams = [
{
name: "test-0",
condition: "purpose",
purpose: "contextmenu",
value: "0",
},
{ name: "test-1", condition: "purpose", purpose: "searchbar", value: "1" },
{ name: "test-2", condition: "purpose", purpose: "homepage", value: "2" },
{ name: "test-3", condition: "purpose", purpose: "keyword", value: "3" },
{ name: "test-4", condition: "purpose", purpose: "newtab", value: "4" },
];
// These params are always included.
const params = [
{ name: "simple", value: "5" },
{ name: "term", value: "{searchTerms}" },
{ name: "lang", value: "{language}" },
{ name: "locale", value: "{moz:locale}" },
{ name: "prefval", condition: "pref", pref: "code" },
];
add_task(async function setup() {
let readyStub = sinon.stub(NimbusFeatures.search, "ready").resolves();
let updateStub = sinon.stub(NimbusFeatures.search, "onUpdate");
await promiseStartupManager();
await SearchTestUtils.useTestEngines("data", null, [
{
webExtension: {
id: "test@search.mozilla.org",
},
appliesTo: [
{
included: { everywhere: true },
default: "yes",
},
],
},
]);
await Services.search.init();
registerCleanupFunction(async () => {
await promiseShutdownManager();
readyStub.restore();
updateStub.restore();
});
});
/* This tests setting moz params. */
add_task(async function test_extension_setting_moz_params() {
let defaultBranch = Services.prefs.getDefaultBranch("browser.search.");
defaultBranch.setCharPref("param.code", "good");
let engine = Services.search.getEngineByName("MozParamsTest");
let extraParams = [];
for (let p of params) {
if (p.condition == "pref") {
extraParams.push(`${p.name}=good`);
} else if (p.value == "{searchTerms}") {
extraParams.push(`${p.name}=test`);
} else if (p.value == "{language}") {
extraParams.push(`${p.name}=${Services.locale.requestedLocale || "*"}`);
} else if (p.value == "{moz:locale}") {
extraParams.push(`${p.name}=${Services.locale.requestedLocale}`);
} else {
extraParams.push(`${p.name}=${p.value}`);
}
}
let paramStr = extraParams.join("&");
for (let p of mozParams) {
let expectedURL = engine.getSubmission(
"test",
null,
p.condition == "purpose" ? p.purpose : null
).uri.spec;
equal(
expectedURL,
`https://example.com/?q=test&${p.name}=${p.value}&${paramStr}`,
"search url is expected"
);
}
defaultBranch.setCharPref("param.code", "");
});
add_task(async function test_nimbus_params() {
let sandbox = sinon.createSandbox();
let stub = sandbox.stub(NimbusFeatures.search, "getVariable");
// These values should match the nimbusParams below and the data/test/manifest.json
// search engine configuration
stub.withArgs("extraParams").returns([
{
key: "nimbus-key-1",
value: "nimbus-value-1",
},
{
key: "nimbus-key-2",
value: "nimbus-value-2",
},
]);
Assert.ok(
NimbusFeatures.search.onUpdate.called,
"Called to initialize the cache"
);
// Populate the cache with the `getVariable` mock values
NimbusFeatures.search.onUpdate.firstCall.args[0]();
let engine = Services.search.getEngineByName("MozParamsTest");
// Note: these lists should be kept in sync with the lists in
// browser/components/extensions/test/xpcshell/data/test/manifest.json
// These params are conditional based on how search is initiated.
const nimbusParams = [
{ name: "experimenter-1", condition: "pref", pref: "nimbus-key-1" },
{ name: "experimenter-2", condition: "pref", pref: "nimbus-key-2" },
];
const experimentCache = {
"nimbus-key-1": "nimbus-value-1",
"nimbus-key-2": "nimbus-value-2",
};
let extraParams = [];
for (let p of params) {
if (p.value == "{searchTerms}") {
extraParams.push(`${p.name}=test`);
} else if (p.value == "{language}") {
extraParams.push(`${p.name}=${Services.locale.requestedLocale || "*"}`);
} else if (p.value == "{moz:locale}") {
extraParams.push(`${p.name}=${Services.locale.requestedLocale}`);
} else if (p.condition !== "pref") {
// Ignoring pref parameters
extraParams.push(`${p.name}=${p.value}`);
}
}
for (let p of nimbusParams) {
if (p.condition == "pref") {
extraParams.push(`${p.name}=${experimentCache[p.pref]}`);
}
}
let paramStr = extraParams.join("&");
for (let p of mozParams) {
let expectedURL = engine.getSubmission(
"test",
null,
p.condition == "purpose" ? p.purpose : null
).uri.spec;
equal(
expectedURL,
`https://example.com/?q=test&${p.name}=${p.value}&${paramStr}`,
"search url is expected"
);
}
sandbox.restore();
});
add_task(async function test_extension_setting_moz_params_fail() {
// Ensure that the test infra does not automatically make
// this privileged.
AddonTestUtils.usePrivilegedSignatures = false;
Services.prefs.setCharPref(
"extensions.installedDistroAddon.test@mochitest",
""
);
let extension = ExtensionTestUtils.loadExtension({
manifest: {
browser_specific_settings: {
gecko: { id: "test1@mochitest" },
},
chrome_settings_overrides: {
search_provider: {
name: "MozParamsTest1",
search_url: "https://example.com/",
params: [
{
name: "testParam",
condition: "purpose",
purpose: "contextmenu",
value: "0",
},
{ name: "prefval", condition: "pref", pref: "code" },
{ name: "q", value: "{searchTerms}" },
],
},
},
},
useAddonManager: "permanent",
});
await extension.startup();
await AddonTestUtils.waitForSearchProviderStartup(extension);
equal(
extension.extension.isPrivileged,
false,
"extension is not priviledged"
);
let engine = Services.search.getEngineByName("MozParamsTest1");
let expectedURL = engine.getSubmission("test", null, "contextmenu").uri.spec;
equal(
expectedURL,
"https://example.com/?q=test",
"engine cannot have conditional or pref params"
);
await extension.unload();
});
|
