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
|
"use strict";
ChromeUtils.defineESModuleGetters(this, {
AddonManager: "resource://gre/modules/AddonManager.sys.mjs",
});
const { AddonStudies } = ChromeUtils.importESModule(
"resource://normandy/lib/AddonStudies.sys.mjs"
);
const { NormandyTestUtils } = ChromeUtils.importESModule(
"resource://testing-common/NormandyTestUtils.sys.mjs"
);
const { TestUtils } = ChromeUtils.importESModule(
"resource://testing-common/TestUtils.sys.mjs"
);
var { AddonTestUtils } = ChromeUtils.importESModule(
"resource://testing-common/AddonTestUtils.sys.mjs"
);
const { addonStudyFactory } = NormandyTestUtils.factories;
AddonTestUtils.init(this);
// All tests run privileged unless otherwise specified not to.
function createExtension(backgroundScript, permissions, isPrivileged = true) {
let extensionData = {
background: backgroundScript,
manifest: {
browser_specific_settings: {
gecko: {
id: "test@shield.mozilla.com",
},
},
permissions,
},
isPrivileged,
};
return ExtensionTestUtils.loadExtension(extensionData);
}
async function run(test) {
let extension = createExtension(
test.backgroundScript,
test.permissions || ["normandyAddonStudy"],
test.isPrivileged
);
const promiseValidation = test.validationScript
? test.validationScript(extension)
: Promise.resolve();
await extension.startup();
await promiseValidation;
if (test.doneSignal) {
await extension.awaitFinish(test.doneSignal);
}
await extension.unload();
}
add_task(async function setup() {
await ExtensionTestUtils.startAddonManager();
});
add_task(
async function test_normandyAddonStudy_without_normandyAddonStudy_permission_privileged() {
await run({
backgroundScript: () => {
browser.test.assertTrue(
!browser.normandyAddonStudy,
"'normandyAddonStudy' permission is required"
);
browser.test.notifyPass("normandyAddonStudy_permission");
},
permissions: [],
doneSignal: "normandyAddonStudy_permission",
});
}
);
add_task(async function test_normandyAddonStudy_without_privilege() {
await run({
backgroundScript: () => {
browser.test.assertTrue(
!browser.normandyAddonStudy,
"Extension must be privileged"
);
browser.test.notifyPass("normandyAddonStudy_permission");
},
isPrivileged: false,
doneSignal: "normandyAddonStudy_permission",
});
});
add_task(async function test_normandyAddonStudy_temporary_without_privilege() {
let extension = ExtensionTestUtils.loadExtension({
temporarilyInstalled: true,
isPrivileged: false,
manifest: {
permissions: ["normandyAddonStudy"],
},
});
ExtensionTestUtils.failOnSchemaWarnings(false);
let { messages } = await promiseConsoleOutput(async () => {
await Assert.rejects(
extension.startup(),
/Using the privileged permission/,
"Startup failed with privileged permission"
);
});
ExtensionTestUtils.failOnSchemaWarnings(true);
AddonTestUtils.checkMessages(
messages,
{
expected: [
{
message:
/Using the privileged permission 'normandyAddonStudy' requires a privileged add-on/,
},
],
},
true
);
});
add_task(async function test_getStudy_works() {
const study = addonStudyFactory({
addonId: "test@shield.mozilla.com",
});
const testWrapper = AddonStudies.withStudies([study]);
const test = testWrapper(async () => {
await run({
backgroundScript: async () => {
const result = await browser.normandyAddonStudy.getStudy();
browser.test.sendMessage("study", result);
},
validationScript: async extension => {
let studyResult = await extension.awaitMessage("study");
deepEqual(
studyResult,
study,
"normandyAddonStudy.getStudy returns the correct study"
);
},
});
});
await test();
});
add_task(async function test_endStudy_works() {
const study = addonStudyFactory({
addonId: "test@shield.mozilla.com",
});
const testWrapper = AddonStudies.withStudies([study]);
const test = testWrapper(async () => {
await run({
backgroundScript: async () => {
await browser.normandyAddonStudy.endStudy("test");
},
validationScript: async () => {
// Check that `AddonStudies.markAsEnded` was called
await TestUtils.topicObserved(
"shield-study-ended",
(subject, message) => {
return message === `${study.recipeId}`;
}
);
const addon = await AddonManager.getAddonByID(study.addonId);
equal(addon, undefined, "Addon should be uninstalled.");
},
});
});
await test();
});
add_task(async function test_getClientMetadata_works() {
const study = addonStudyFactory({
addonId: "test@shield.mozilla.com",
slug: "test-slug",
branch: "test-branch",
});
const testWrapper = AddonStudies.withStudies([study]);
const test = testWrapper(async () => {
await run({
backgroundScript: async () => {
const metadata = await browser.normandyAddonStudy.getClientMetadata();
browser.test.sendMessage("clientMetadata", metadata);
},
validationScript: async extension => {
let clientMetadata = await extension.awaitMessage("clientMetadata");
ok(
clientMetadata.updateChannel ===
Services.appinfo.defaultUpdateChannel,
"clientMetadata contains correct updateChannel"
);
ok(
clientMetadata.fxVersion === Services.appinfo.version,
"clientMetadata contains correct fxVersion"
);
ok("clientID" in clientMetadata, "clientMetadata contains a clientID");
},
});
});
await test();
});
add_task(async function test_onUnenroll_works() {
const study = addonStudyFactory({
addonId: "test@shield.mozilla.com",
});
const testWrapper = AddonStudies.withStudies([study]);
const test = testWrapper(async () => {
await run({
backgroundScript: () => {
browser.normandyAddonStudy.onUnenroll.addListener(reason => {
browser.test.sendMessage("unenrollReason", reason);
});
browser.test.sendMessage("bgpageReady");
},
validationScript: async extension => {
await extension.awaitMessage("bgpageReady");
await AddonStudies.markAsEnded(study, "test");
const unenrollReason = await extension.awaitMessage("unenrollReason");
equal(unenrollReason, "test", "Unenroll listener should be called.");
},
});
});
await test();
});
|
