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
325
326
327
328
329
330
331
332
333
334
335
336
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, you can obtain one at http://mozilla.org/MPL/2.0/. */
/**
* Common core of the test. This is complicated by how WebExtensions tests work.
*
* @param {Function} createTab - The code of this function is copied into the
* extension. It should assign a function to `window.createTab` that opens
* the tab to be tested and return the id of the tab.
* @param {Function} getBrowser - A function to get the <browser> associated
* with the tab.
*/
async function subTest(createTab, getBrowser, shouldRemove = true) {
let extension = ExtensionTestUtils.loadExtension({
files: {
"createTab.js": createTab,
"background.js": async () => {
// Open the tab to be tested.
let tabId = await window.createTab();
// Test insertCSS, removeCSS, and executeScript.
await window.sendMessage();
await browser.tabs.insertCSS(tabId, {
code: "body { background: lime }",
});
await window.sendMessage();
await browser.tabs.removeCSS(tabId, {
code: "body { background: lime }",
});
await window.sendMessage();
await browser.tabs.executeScript(tabId, {
code: `
document.body.textContent = "Hey look, the script ran!";
browser.runtime.onConnect.addListener(port =>
port.onMessage.addListener(message => {
browser.test.assertEq(message, "Sending a message.");
port.postMessage("Got your message.");
})
);
browser.runtime.onMessage.addListener(
(message, sender, sendResponse) => {
browser.test.assertEq(message, "Sending a message.");
sendResponse("Got your message.");
}
);
`,
});
await window.sendMessage();
// Test connect and sendMessage. The receivers were set up above.
let port = await browser.tabs.connect(tabId);
port.onMessage.addListener(message =>
browser.test.assertEq(message, "Got your message.")
);
port.postMessage("Sending a message.");
let response = await browser.tabs.sendMessage(
tabId,
"Sending a message."
);
browser.test.assertEq(response, "Got your message.");
// Remove the tab if required.
let [shouldRemove] = await window.sendMessage();
if (shouldRemove) {
await browser.tabs.remove(tabId);
}
browser.test.notifyPass();
},
"test.html": "<html><body>I'm a real page!</body></html>",
"utils.js": await getUtilsJS(),
},
manifest: {
background: { scripts: ["utils.js", "createTab.js", "background.js"] },
},
});
await extension.startup();
await extension.awaitMessage();
let browser = getBrowser();
await awaitBrowserLoaded(browser, url => url != "about:blank");
await checkContent(browser, {
backgroundColor: "rgba(0, 0, 0, 0)",
textContent: "I'm a real page!",
});
extension.sendMessage();
await extension.awaitMessage();
await checkContent(browser, { backgroundColor: "rgb(0, 255, 0)" });
extension.sendMessage();
await extension.awaitMessage();
await checkContent(browser, { backgroundColor: "rgba(0, 0, 0, 0)" });
extension.sendMessage();
await extension.awaitMessage();
await checkContent(browser, { textContent: "Hey look, the script ran!" });
extension.sendMessage();
await extension.awaitMessage();
extension.sendMessage(shouldRemove);
await extension.awaitFinish();
await extension.unload();
}
add_task(async function testFirstTab() {
let createTab = async () => {
window.createTab = async function () {
let tabs = await browser.tabs.query({});
browser.test.assertEq(1, tabs.length);
await browser.tabs.update(tabs[0].id, { url: "test.html" });
return tabs[0].id;
};
};
let tabmail = document.getElementById("tabmail");
function getBrowser(expected) {
return tabmail.currentTabInfo.browser;
}
let gAccount = createAccount();
tabmail.currentAbout3Pane.restoreState({
folderPaneVisible: true,
folderURI: gAccount.incomingServer.rootFolder.subFolders[0].URI,
});
return subTest(createTab, getBrowser, false);
});
add_task(async function testContentTab() {
let createTab = async () => {
window.createTab = async function () {
let tab = await browser.tabs.create({ url: "test.html" });
return tab.id;
};
};
function getBrowser(expected) {
let tabmail = document.getElementById("tabmail");
return tabmail.currentTabInfo.browser;
}
let tabmail = document.getElementById("tabmail");
Assert.equal(
tabmail.tabInfo.length,
1,
"Should find the correct number of tabs before the test."
);
// Run the subtest without removing the created tab, to check if extension tabs
// are removed automatically, when the extension is removed.
let rv = await subTest(createTab, getBrowser, false);
Assert.equal(
tabmail.tabInfo.length,
1,
"Should find the correct number of tabs after the test."
);
return rv;
});
add_task(async function testPopupWindow() {
let createTab = async () => {
window.createTab = async function () {
let popup = await browser.windows.create({
url: "test.html",
type: "popup",
});
browser.test.assertEq(1, popup.tabs.length);
return popup.tabs[0].id;
};
};
function getBrowser(expected) {
let popups = [...Services.wm.getEnumerator("mail:extensionPopup")];
Assert.equal(popups.length, 1);
let popup = popups[0];
let popupBrowser = popup.getBrowser();
Assert.ok(popupBrowser);
return popupBrowser;
}
let popups = [...Services.wm.getEnumerator("mail:extensionPopup")];
Assert.equal(
popups.length,
0,
"Should find the no extension windows before the test."
);
// Run the subtest without removing the created window, to check if extension
// windows are removed automatically, when the extension is removed.
let rv = await subTest(createTab, getBrowser, false);
Assert.equal(
popups.length,
0,
"Should find the no extension windows after the test."
);
return rv;
});
add_task(async function testMultipleContentTabs() {
let extension = ExtensionTestUtils.loadExtension({
files: {
"background.js": async () => {
let tabs = [];
let tests = [
{
url: "test.html",
expectedUrl: browser.runtime.getURL("test.html"),
},
{
url: "test.html",
expectedUrl: browser.runtime.getURL("test.html"),
},
{
url: "https://www.example.com",
expectedUrl: "https://www.example.com/",
},
{
url: "https://www.example.com",
expectedUrl: "https://www.example.com/",
},
{
url: "https://www.example.com/",
expectedUrl: "https://www.example.com/",
},
{
url: "https://www.example.com/",
expectedUrl: "https://www.example.com/",
},
{
url: "https://www.example.com/",
expectedUrl: "https://www.example.com/",
},
];
async function create(url, expectedUrl) {
let tabDonePromise = new Promise(resolve => {
let changeInfoStatus = false;
let changeInfoUrl = false;
let listener = (tabId, changeInfo) => {
if (!tab || tab.id != tabId) {
return;
}
// Looks like "complete" is reached sometimes before the url is done,
// so check for both.
if (changeInfo.status == "complete") {
changeInfoStatus = true;
}
if (changeInfo.url) {
changeInfoUrl = changeInfo.url;
}
if (changeInfoStatus && changeInfoUrl) {
browser.tabs.onUpdated.removeListener(listener);
resolve(changeInfoUrl);
}
};
browser.tabs.onUpdated.addListener(listener);
});
let tab = await browser.tabs.create({ url });
for (let otherTab of tabs) {
browser.test.assertTrue(
tab.id != otherTab.id,
"Id of created tab should be unique."
);
}
tabs.push(tab);
let changeInfoUrl = await tabDonePromise;
browser.test.assertEq(
expectedUrl,
changeInfoUrl,
"Should have seen the correct url."
);
}
for (let { url, expectedUrl } of tests) {
await create(url, expectedUrl);
}
browser.test.notifyPass();
},
"test.html": "<html><body>I'm a real page!</body></html>",
},
manifest: {
background: { scripts: ["background.js"] },
permissions: ["tabs"],
},
});
let tabmail = document.getElementById("tabmail");
Assert.equal(
tabmail.tabInfo.length,
1,
"Should find the correct number of tabs before the test."
);
await extension.startup();
await extension.awaitFinish();
Assert.equal(
tabmail.tabInfo.length,
8,
"Should find the correct number of tabs after the test."
);
await extension.unload();
// After unload, the two extension tabs should be closed.
Assert.equal(
tabmail.tabInfo.length,
6,
"Should find the correct number of tabs after extension unload."
);
for (let i = tabmail.tabInfo.length; i > 0; i--) {
let nativeTabInfo = tabmail.tabInfo[i - 1];
let uri = nativeTabInfo.browser?.browsingContext.currentURI;
if (uri && ["https", "http"].includes(uri.scheme)) {
tabmail.closeTab(nativeTabInfo);
}
}
Assert.equal(
tabmail.tabInfo.length,
1,
"Should find the correct number of tabs after test has finished."
);
});
|
