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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/
*/
/* globals end_test */
/* eslint no-unused-vars: ["error", {vars: "local", args: "none"}] */
var { NetUtil } = ChromeUtils.import("resource://gre/modules/NetUtil.jsm");
const { TelemetryTestUtils } = ChromeUtils.import(
"resource://testing-common/TelemetryTestUtils.jsm"
);
var tmp = {};
ChromeUtils.import("resource://gre/modules/AddonManager.jsm", tmp);
ChromeUtils.import("resource://gre/modules/Log.jsm", tmp);
var AddonManager = tmp.AddonManager;
var AddonManagerPrivate = tmp.AddonManagerPrivate;
var Log = tmp.Log;
var pathParts = gTestPath.split("/");
// Drop the test filename
pathParts.splice(pathParts.length - 1, pathParts.length);
const RELATIVE_DIR = pathParts.slice(4).join("/") + "/";
const TESTROOT = "http://example.com/" + RELATIVE_DIR;
const SECURE_TESTROOT = "https://example.com/" + RELATIVE_DIR;
const TESTROOT2 = "http://example.org/" + RELATIVE_DIR;
const SECURE_TESTROOT2 = "https://example.org/" + RELATIVE_DIR;
const CHROMEROOT = pathParts.join("/") + "/";
const PREF_DISCOVER_ENABLED = "extensions.getAddons.showPane";
const PREF_XPI_ENABLED = "xpinstall.enabled";
const PREF_UPDATEURL = "extensions.update.url";
const PREF_GETADDONS_CACHE_ENABLED = "extensions.getAddons.cache.enabled";
const PREF_UI_LASTCATEGORY = "extensions.ui.lastCategory";
const MANAGER_URI = "about:addons";
const PREF_LOGGING_ENABLED = "extensions.logging.enabled";
const PREF_STRICT_COMPAT = "extensions.strictCompatibility";
var PREF_CHECK_COMPATIBILITY;
(function() {
var channel = Services.prefs.getCharPref("app.update.channel", "default");
if (
channel != "aurora" &&
channel != "beta" &&
channel != "release" &&
channel != "esr"
) {
var version = "nightly";
} else {
version = Services.appinfo.version.replace(
/^([^\.]+\.[0-9]+[a-z]*).*/gi,
"$1"
);
}
PREF_CHECK_COMPATIBILITY = "extensions.checkCompatibility." + version;
})();
var gPendingTests = [];
var gTestsRun = 0;
var gTestStart = null;
var gRestorePrefs = [
{ name: PREF_LOGGING_ENABLED },
{ name: "extensions.webservice.discoverURL" },
{ name: "extensions.update.url" },
{ name: "extensions.update.background.url" },
{ name: "extensions.update.enabled" },
{ name: "extensions.update.autoUpdateDefault" },
{ name: "extensions.getAddons.get.url" },
{ name: "extensions.getAddons.getWithPerformance.url" },
{ name: "extensions.getAddons.cache.enabled" },
{ name: "devtools.chrome.enabled" },
{ name: PREF_STRICT_COMPAT },
{ name: PREF_CHECK_COMPATIBILITY },
];
for (let pref of gRestorePrefs) {
if (!Services.prefs.prefHasUserValue(pref.name)) {
pref.type = "clear";
continue;
}
pref.type = Services.prefs.getPrefType(pref.name);
if (pref.type == Services.prefs.PREF_BOOL) {
pref.value = Services.prefs.getBoolPref(pref.name);
} else if (pref.type == Services.prefs.PREF_INT) {
pref.value = Services.prefs.getIntPref(pref.name);
} else if (pref.type == Services.prefs.PREF_STRING) {
pref.value = Services.prefs.getCharPref(pref.name);
}
}
// Turn logging on for all tests
Services.prefs.setBoolPref(PREF_LOGGING_ENABLED, true);
function promiseFocus(window) {
return new Promise(resolve => waitForFocus(resolve, window));
}
// Helper to register test failures and close windows if any are left open
function checkOpenWindows(aWindowID) {
let found = false;
for (let win of Services.wm.getEnumerator(aWindowID)) {
if (!win.closed) {
found = true;
win.close();
}
}
if (found) {
ok(false, "Found unexpected " + aWindowID + " window still open");
}
}
// Tools to disable and re-enable the background update and blocklist timers
// so that tests can protect themselves from unwanted timer events.
var gCatMan = Services.catMan;
// Default value from toolkit/mozapps/extensions/extensions.manifest, but disable*UpdateTimer()
// records the actual value so we can put it back in enable*UpdateTimer()
var backgroundUpdateConfig =
"@mozilla.org/addons/integration;1,getService,addon-background-update-timer,extensions.update.interval,86400";
var UTIMER = "update-timer";
var AMANAGER = "addonManager";
var BLOCKLIST = "nsBlocklistService";
function disableBackgroundUpdateTimer() {
info("Disabling " + UTIMER + " " + AMANAGER);
backgroundUpdateConfig = gCatMan.getCategoryEntry(UTIMER, AMANAGER);
gCatMan.deleteCategoryEntry(UTIMER, AMANAGER, true);
}
function enableBackgroundUpdateTimer() {
info("Enabling " + UTIMER + " " + AMANAGER);
gCatMan.addCategoryEntry(
UTIMER,
AMANAGER,
backgroundUpdateConfig,
false,
true
);
}
registerCleanupFunction(function() {
// Restore prefs
for (let pref of gRestorePrefs) {
if (pref.type == "clear") {
Services.prefs.clearUserPref(pref.name);
} else if (pref.type == Services.prefs.PREF_BOOL) {
Services.prefs.setBoolPref(pref.name, pref.value);
} else if (pref.type == Services.prefs.PREF_INT) {
Services.prefs.setIntPref(pref.name, pref.value);
} else if (pref.type == Services.prefs.PREF_STRING) {
Services.prefs.setCharPref(pref.name, pref.value);
}
}
// Throw an error if the add-ons manager window is open anywhere
checkOpenWindows("Addons:Manager");
checkOpenWindows("Addons:Compatibility");
checkOpenWindows("Addons:Install");
return AddonManager.getAllInstalls().then(aInstalls => {
for (let install of aInstalls) {
if (install instanceof MockInstall) {
continue;
}
ok(
false,
"Should not have seen an install of " +
install.sourceURI.spec +
" in state " +
install.state
);
install.cancel();
}
});
});
function log_exceptions(aCallback, ...aArgs) {
try {
return aCallback.apply(null, aArgs);
} catch (e) {
info("Exception thrown: " + e);
throw e;
}
}
function log_callback(aPromise, aCallback) {
aPromise.then(aCallback).catch(e => info("Exception thrown: " + e));
return aPromise;
}
function add_test(test) {
gPendingTests.push(test);
}
function run_next_test() {
// Make sure we're not calling run_next_test from inside an add_task() test
// We're inside the browser_test.js 'testScope' here
if (this.__tasks) {
throw new Error(
"run_next_test() called from an add_task() test function. " +
"run_next_test() should not be called from inside add_task() " +
"under any circumstances!"
);
}
if (gTestsRun > 0) {
info("Test " + gTestsRun + " took " + (Date.now() - gTestStart) + "ms");
}
if (!gPendingTests.length) {
executeSoon(end_test);
return;
}
gTestsRun++;
var test = gPendingTests.shift();
if (test.name) {
info("Running test " + gTestsRun + " (" + test.name + ")");
} else {
info("Running test " + gTestsRun);
}
gTestStart = Date.now();
executeSoon(() => log_exceptions(test));
}
var get_tooltip_info = async function(addonEl, managerWindow) {
// Extract from title attribute.
const { addon } = addonEl;
const name = addon.name;
let nameWithVersion = addonEl.addonNameEl.title;
if (addonEl.addon.userDisabled) {
// TODO - Bug 1558077: Currently Fluent is clearing the addon title
// when the addon is disabled, fixing it requires changes to the
// HTML about:addons localized strings, and then remove this
// workaround.
nameWithVersion = `${name} ${addon.version}`;
}
return {
name,
version: nameWithVersion.substring(name.length + 1),
};
};
function get_addon_file_url(aFilename) {
try {
var cr = Cc["@mozilla.org/chrome/chrome-registry;1"].getService(
Ci.nsIChromeRegistry
);
var fileurl = cr.convertChromeURL(
makeURI(CHROMEROOT + "addons/" + aFilename)
);
return fileurl.QueryInterface(Ci.nsIFileURL);
} catch (ex) {
var jar = getJar(CHROMEROOT + "addons/" + aFilename);
var tmpDir = extractJarToTmp(jar);
tmpDir.append(aFilename);
return Services.io.newFileURI(tmpDir).QueryInterface(Ci.nsIFileURL);
}
}
function check_all_in_list(aManager, aIds, aIgnoreExtras) {
var doc = aManager.document;
var list = doc.getElementById("addon-list");
var inlist = [];
var node = list.firstChild;
while (node) {
if (node.value) {
inlist.push(node.value);
}
node = node.nextSibling;
}
for (let id of aIds) {
if (!inlist.includes(id)) {
ok(false, "Should find " + id + " in the list");
}
}
if (aIgnoreExtras) {
return;
}
for (let inlistItem of inlist) {
if (!aIds.includes(inlistItem)) {
ok(false, "Shouldn't have seen " + inlistItem + " in the list");
}
}
}
function get_addon_element(aManager, aId) {
const win = aManager.getHtmlBrowser().contentWindow;
return getAddonCard(win, aId);
}
function getAddonCard(win, id) {
return win.document.querySelector(`addon-card[addon-id="${id}"]`);
}
function wait_for_view_load(
aManagerWindow,
aCallback,
aForceWait,
aLongerTimeout
) {
let p = new Promise(resolve => {
requestLongerTimeout(aLongerTimeout ? aLongerTimeout : 2);
if (!aForceWait && !aManagerWindow.gViewController.isLoading) {
resolve(aManagerWindow);
return;
}
aManagerWindow.document.addEventListener(
"ViewChanged",
function() {
resolve(aManagerWindow);
},
{ once: true }
);
});
return log_callback(p, aCallback);
}
function wait_for_manager_load(aManagerWindow, aCallback) {
let p = new Promise(resolve => {
if (!aManagerWindow.gIsInitializing) {
resolve(aManagerWindow);
return;
}
info("Waiting for initialization");
aManagerWindow.document.addEventListener(
"Initialized",
function() {
resolve(aManagerWindow);
},
{ once: true }
);
});
return log_callback(p, aCallback);
}
function open_manager(
aView,
aCallback,
aLoadCallback,
aLongerTimeout,
aWin = window
) {
let p = new Promise((resolve, reject) => {
async function setup_manager(aManagerWindow) {
if (aLoadCallback) {
log_exceptions(aLoadCallback, aManagerWindow);
}
if (aView) {
aManagerWindow.loadView(aView);
}
ok(aManagerWindow != null, "Should have an add-ons manager window");
is(
aManagerWindow.location.href,
MANAGER_URI,
"Should be displaying the correct UI"
);
await promiseFocus(aManagerWindow);
info("window has focus, waiting for manager load");
await wait_for_manager_load(aManagerWindow);
info("Manager waiting for view load");
await wait_for_view_load(aManagerWindow, null, null, aLongerTimeout);
resolve(aManagerWindow);
}
info("Loading manager window in tab");
Services.obs.addObserver(function observer(aSubject, aTopic, aData) {
Services.obs.removeObserver(observer, aTopic);
if (aSubject.location.href != MANAGER_URI) {
info("Ignoring load event for " + aSubject.location.href);
return;
}
setup_manager(aSubject);
}, "EM-loaded");
aWin.gBrowser.selectedTab = BrowserTestUtils.addTab(aWin.gBrowser);
aWin.switchToTabHavingURI(MANAGER_URI, true, {
triggeringPrincipal: Services.scriptSecurityManager.getSystemPrincipal(),
});
});
// The promise resolves with the manager window, so it is passed to the callback
return log_callback(p, aCallback);
}
function close_manager(aManagerWindow, aCallback, aLongerTimeout) {
let p = new Promise((resolve, reject) => {
requestLongerTimeout(aLongerTimeout ? aLongerTimeout : 2);
ok(
aManagerWindow != null,
"Should have an add-ons manager window to close"
);
is(
aManagerWindow.location.href,
MANAGER_URI,
"Should be closing window with correct URI"
);
aManagerWindow.addEventListener("unload", function listener() {
try {
dump("Manager window unload handler\n");
this.removeEventListener("unload", listener);
resolve();
} catch (e) {
reject(e);
}
});
});
info("Telling manager window to close");
aManagerWindow.close();
info("Manager window close() call returned");
return log_callback(p, aCallback);
}
function restart_manager(aManagerWindow, aView, aCallback, aLoadCallback) {
if (!aManagerWindow) {
return open_manager(aView, aCallback, aLoadCallback);
}
return close_manager(aManagerWindow).then(() =>
open_manager(aView, aCallback, aLoadCallback)
);
}
function wait_for_window_open(aCallback) {
let p = new Promise(resolve => {
Services.wm.addListener({
onOpenWindow(aXulWin) {
Services.wm.removeListener(this);
let domwindow = aXulWin.docShell.domWindow;
domwindow.addEventListener(
"load",
function() {
executeSoon(function() {
resolve(domwindow);
});
},
{ once: true }
);
},
onCloseWindow(aWindow) {},
});
});
return log_callback(p, aCallback);
}
function get_string(aName, ...aArgs) {
var bundle = Services.strings.createBundle(
"chrome://mozapps/locale/extensions/extensions.properties"
);
if (!aArgs.length) {
return bundle.GetStringFromName(aName);
}
return bundle.formatStringFromName(aName, aArgs);
}
function formatDate(aDate) {
const dtOptions = { year: "numeric", month: "long", day: "numeric" };
return aDate.toLocaleDateString(undefined, dtOptions);
}
function is_hidden(aElement) {
var style = aElement.ownerGlobal.getComputedStyle(aElement);
if (style.display == "none") {
return true;
}
if (style.visibility != "visible") {
return true;
}
// Hiding a parent element will hide all its children
if (aElement.parentNode != aElement.ownerDocument) {
return is_hidden(aElement.parentNode);
}
return false;
}
function is_element_visible(aElement, aMsg) {
isnot(aElement, null, "Element should not be null, when checking visibility");
ok(!is_hidden(aElement), aMsg || aElement + " should be visible");
}
function is_element_hidden(aElement, aMsg) {
isnot(aElement, null, "Element should not be null, when checking visibility");
ok(is_hidden(aElement), aMsg || aElement + " should be hidden");
}
function promiseAddonByID(aId) {
return AddonManager.getAddonByID(aId);
}
function promiseAddonsByIDs(aIDs) {
return AddonManager.getAddonsByIDs(aIDs);
}
/**
* Install an add-on and call a callback when complete.
*
* The callback will receive the Addon for the installed add-on.
*/
async function install_addon(path, cb, pathPrefix = TESTROOT) {
let install = await AddonManager.getInstallForURL(pathPrefix + path);
let p = new Promise((resolve, reject) => {
install.addListener({
onInstallEnded: () => resolve(install.addon),
});
install.install();
});
return log_callback(p, cb);
}
function CategoryUtilities(aManagerWindow) {
this.window = aManagerWindow.getHtmlBrowser().contentWindow;
this.managerWindow = aManagerWindow;
this.window.addEventListener("unload", () => (this.window = null), {
once: true,
});
this.managerWindow.addEventListener(
"unload",
() => (this.managerWindow = null),
{ once: true }
);
}
CategoryUtilities.prototype = {
window: null,
managerWindow: null,
get _categoriesBox() {
return this.window.document.querySelector("categories-box");
},
getSelectedViewId() {
let selectedItem = this._categoriesBox.querySelector("[selected]");
isnot(selectedItem, null, "A category should be selected");
return selectedItem.getAttribute("viewid");
},
get selectedCategory() {
isnot(
this.window,
null,
"Should not get selected category when manager window is not loaded"
);
let viewId = this.getSelectedViewId();
let view = this.managerWindow.gViewController.parseViewId(viewId);
return view.type == "list" ? view.param : view.type;
},
get(categoryType) {
isnot(
this.window,
null,
"Should not get category when manager window is not loaded"
);
let button = this._categoriesBox.querySelector(`[name="${categoryType}"]`);
if (button) {
return button;
}
ok(false, "Should have found a category with type " + categoryType);
return null;
},
isVisible(categoryButton) {
isnot(
this.window,
null,
"Should not check visible state when manager window is not loaded"
);
// There are some tests checking this before the categories have loaded.
if (!categoryButton) {
return false;
}
if (categoryButton.disabled || categoryButton.hidden) {
return false;
}
return !is_hidden(categoryButton);
},
isTypeVisible(categoryType) {
return this.isVisible(this.get(categoryType));
},
open(categoryButton) {
isnot(
this.window,
null,
"Should not open category when manager window is not loaded"
);
ok(
this.isVisible(categoryButton),
"Category should be visible if attempting to open it"
);
EventUtils.synthesizeMouseAtCenter(categoryButton, {}, this.window);
// Use wait_for_view_load until all open_manager calls are gone.
return wait_for_view_load(this.managerWindow);
},
openType(categoryType) {
return this.open(this.get(categoryType));
},
};
// Returns a promise that will resolve when the certificate error override has been added, or reject
// if there is some failure.
function addCertOverride(host, bits) {
return new Promise((resolve, reject) => {
let req = new XMLHttpRequest();
req.open("GET", "https://" + host + "/");
req.onload = reject;
req.onerror = () => {
if (req.channel && req.channel.securityInfo) {
let securityInfo = req.channel.securityInfo.QueryInterface(
Ci.nsITransportSecurityInfo
);
if (securityInfo.serverCert) {
let cos = Cc["@mozilla.org/security/certoverride;1"].getService(
Ci.nsICertOverrideService
);
cos.rememberValidityOverride(
host,
-1,
securityInfo.serverCert,
bits,
false
);
resolve();
return;
}
}
reject();
};
req.send(null);
});
}
// Returns a promise that will resolve when the necessary certificate overrides have been added.
function addCertOverrides() {
return Promise.all([
addCertOverride(
"nocert.example.com",
Ci.nsICertOverrideService.ERROR_MISMATCH
),
addCertOverride(
"self-signed.example.com",
Ci.nsICertOverrideService.ERROR_UNTRUSTED
),
addCertOverride(
"untrusted.example.com",
Ci.nsICertOverrideService.ERROR_UNTRUSTED
),
addCertOverride(
"expired.example.com",
Ci.nsICertOverrideService.ERROR_TIME
),
]);
}
/** *** Mock Provider *****/
function MockProvider() {
this.addons = [];
this.installs = [];
this.types = [
{
id: "extension",
name: "Extensions",
uiPriority: 4000,
flags:
AddonManager.TYPE_UI_VIEW_LIST |
AddonManager.TYPE_SUPPORTS_UNDO_RESTARTLESS_UNINSTALL,
},
];
var self = this;
registerCleanupFunction(function() {
if (self.started) {
self.unregister();
}
});
this.register();
}
MockProvider.prototype = {
addons: null,
installs: null,
started: null,
types: null,
queryDelayPromise: Promise.resolve(),
blockQueryResponses() {
this.queryDelayPromise = new Promise(resolve => {
this._unblockQueries = resolve;
});
},
unblockQueryResponses() {
if (this._unblockQueries) {
this._unblockQueries();
this._unblockQueries = null;
} else {
throw new Error("Queries are not blocked");
}
},
/** *** Utility functions *****/
/**
* Register this provider with the AddonManager
*/
register: function MP_register() {
info("Registering mock add-on provider");
AddonManagerPrivate.registerProvider(this, this.types);
},
/**
* Unregister this provider with the AddonManager
*/
unregister: function MP_unregister() {
info("Unregistering mock add-on provider");
AddonManagerPrivate.unregisterProvider(this);
},
/**
* Adds an add-on to the list of add-ons that this provider exposes to the
* AddonManager, dispatching appropriate events in the process.
*
* @param aAddon
* The add-on to add
*/
addAddon: function MP_addAddon(aAddon) {
var oldAddons = this.addons.filter(aOldAddon => aOldAddon.id == aAddon.id);
var oldAddon = oldAddons.length ? oldAddons[0] : null;
this.addons = this.addons.filter(aOldAddon => aOldAddon.id != aAddon.id);
this.addons.push(aAddon);
aAddon._provider = this;
if (!this.started) {
return;
}
let requiresRestart =
(aAddon.operationsRequiringRestart &
AddonManager.OP_NEEDS_RESTART_INSTALL) !=
0;
AddonManagerPrivate.callInstallListeners(
"onExternalInstall",
null,
aAddon,
oldAddon,
requiresRestart
);
},
/**
* Removes an add-on from the list of add-ons that this provider exposes to
* the AddonManager, dispatching the onUninstalled event in the process.
*
* @param aAddon
* The add-on to add
*/
removeAddon: function MP_removeAddon(aAddon) {
var pos = this.addons.indexOf(aAddon);
if (pos == -1) {
ok(
false,
"Tried to remove an add-on that wasn't registered with the mock provider"
);
return;
}
this.addons.splice(pos, 1);
if (!this.started) {
return;
}
AddonManagerPrivate.callAddonListeners("onUninstalled", aAddon);
},
/**
* Adds an add-on install to the list of installs that this provider exposes
* to the AddonManager, dispatching appropriate events in the process.
*
* @param aInstall
* The add-on install to add
*/
addInstall: function MP_addInstall(aInstall) {
this.installs.push(aInstall);
aInstall._provider = this;
if (!this.started) {
return;
}
aInstall.callListeners("onNewInstall");
},
removeInstall: function MP_removeInstall(aInstall) {
var pos = this.installs.indexOf(aInstall);
if (pos == -1) {
ok(
false,
"Tried to remove an install that wasn't registered with the mock provider"
);
return;
}
this.installs.splice(pos, 1);
},
/**
* Creates a set of mock add-on objects and adds them to the list of add-ons
* managed by this provider.
*
* @param aAddonProperties
* An array of objects containing properties describing the add-ons
* @return Array of the new MockAddons
*/
createAddons: function MP_createAddons(aAddonProperties) {
var newAddons = [];
for (let addonProp of aAddonProperties) {
let addon = new MockAddon(addonProp.id);
for (let prop in addonProp) {
if (prop == "id") {
continue;
}
if (prop == "applyBackgroundUpdates") {
addon._applyBackgroundUpdates = addonProp[prop];
} else if (prop == "appDisabled") {
addon._appDisabled = addonProp[prop];
} else if (prop == "userDisabled") {
addon.setUserDisabled(addonProp[prop]);
} else {
addon[prop] = addonProp[prop];
}
}
if (!addon.optionsType && !!addon.optionsURL) {
addon.optionsType = AddonManager.OPTIONS_TYPE_DIALOG;
}
// Make sure the active state matches the passed in properties
addon.isActive = addon.shouldBeActive;
this.addAddon(addon);
newAddons.push(addon);
}
return newAddons;
},
/**
* Creates a set of mock add-on install objects and adds them to the list
* of installs managed by this provider.
*
* @param aInstallProperties
* An array of objects containing properties describing the installs
* @return Array of the new MockInstalls
*/
createInstalls: function MP_createInstalls(aInstallProperties) {
var newInstalls = [];
for (let installProp of aInstallProperties) {
let install = new MockInstall(
installProp.name || null,
installProp.type || null,
null
);
for (let prop in installProp) {
switch (prop) {
case "name":
case "type":
break;
case "sourceURI":
install[prop] = NetUtil.newURI(installProp[prop]);
break;
default:
install[prop] = installProp[prop];
}
}
this.addInstall(install);
newInstalls.push(install);
}
return newInstalls;
},
/** *** AddonProvider implementation *****/
/**
* Called to initialize the provider.
*/
startup: function MP_startup() {
this.started = true;
},
/**
* Called when the provider should shutdown.
*/
shutdown: function MP_shutdown() {
this.started = false;
},
/**
* Called to get an Addon with a particular ID.
*
* @param aId
* The ID of the add-on to retrieve
*/
async getAddonByID(aId) {
await this.queryDelayPromise;
for (let addon of this.addons) {
if (addon.id == aId) {
return addon;
}
}
return null;
},
/**
* Called to get Addons of a particular type.
*
* @param aTypes
* An array of types to fetch. Can be null to get all types.
*/
async getAddonsByTypes(aTypes) {
await this.queryDelayPromise;
var addons = this.addons.filter(function(aAddon) {
if (aTypes && !!aTypes.length && !aTypes.includes(aAddon.type)) {
return false;
}
return true;
});
return addons;
},
/**
* Called to get the current AddonInstalls, optionally restricting by type.
*
* @param aTypes
* An array of types or null to get all types
*/
async getInstallsByTypes(aTypes) {
await this.queryDelayPromise;
var installs = this.installs.filter(function(aInstall) {
// Appear to have actually removed cancelled installs from the provider
if (aInstall.state == AddonManager.STATE_CANCELLED) {
return false;
}
if (aTypes && !!aTypes.length && !aTypes.includes(aInstall.type)) {
return false;
}
return true;
});
return installs;
},
/**
* Called when a new add-on has been enabled when only one add-on of that type
* can be enabled.
*
* @param aId
* The ID of the newly enabled add-on
* @param aType
* The type of the newly enabled add-on
* @param aPendingRestart
* true if the newly enabled add-on will only become enabled after a
* restart
*/
addonChanged: function MP_addonChanged(aId, aType, aPendingRestart) {
// Not implemented
},
/**
* Update the appDisabled property for all add-ons.
*/
updateAddonAppDisabledStates: function MP_updateAddonAppDisabledStates() {
// Not needed
},
/**
* Called to get an AddonInstall to download and install an add-on from a URL.
*
* @param {string} aUrl
* The URL to be installed
* @param {object} aOptions
* Options for the install
*/
getInstallForURL: function MP_getInstallForURL(aUrl, aOptions) {
// Not yet implemented
},
/**
* Called to get an AddonInstall to install an add-on from a local file.
*
* @param aFile
* The file to be installed
*/
getInstallForFile: function MP_getInstallForFile(aFile) {
// Not yet implemented
},
/**
* Called to test whether installing add-ons is enabled.
*
* @return true if installing is enabled
*/
isInstallEnabled: function MP_isInstallEnabled() {
return false;
},
/**
* Called to test whether this provider supports installing a particular
* mimetype.
*
* @param aMimetype
* The mimetype to check for
* @return true if the mimetype is supported
*/
supportsMimetype: function MP_supportsMimetype(aMimetype) {
return false;
},
/**
* Called to test whether installing add-ons from a URI is allowed.
*
* @param aUri
* The URI being installed from
* @return true if installing is allowed
*/
isInstallAllowed: function MP_isInstallAllowed(aUri) {
return false;
},
};
/** *** Mock Addon object for the Mock Provider *****/
function MockAddon(aId, aName, aType, aOperationsRequiringRestart) {
// Only set required attributes.
this.id = aId || "";
this.name = aName || "";
this.type = aType || "extension";
this.version = "";
this.isCompatible = true;
this.providesUpdatesSecurely = true;
this.blocklistState = 0;
this._appDisabled = false;
this._userDisabled = false;
this._applyBackgroundUpdates = AddonManager.AUTOUPDATE_ENABLE;
this.scope = AddonManager.SCOPE_PROFILE;
this.isActive = true;
this.creator = "";
this.pendingOperations = 0;
this._permissions =
AddonManager.PERM_CAN_UNINSTALL |
AddonManager.PERM_CAN_ENABLE |
AddonManager.PERM_CAN_DISABLE |
AddonManager.PERM_CAN_UPGRADE |
AddonManager.PERM_CAN_CHANGE_PRIVATEBROWSING_ACCESS;
this.operationsRequiringRestart =
aOperationsRequiringRestart != undefined
? aOperationsRequiringRestart
: AddonManager.OP_NEEDS_RESTART_INSTALL |
AddonManager.OP_NEEDS_RESTART_UNINSTALL |
AddonManager.OP_NEEDS_RESTART_ENABLE |
AddonManager.OP_NEEDS_RESTART_DISABLE;
}
MockAddon.prototype = {
get isCorrectlySigned() {
if (this.signedState === AddonManager.SIGNEDSTATE_NOT_REQUIRED) {
return true;
}
return this.signedState > AddonManager.SIGNEDSTATE_MISSING;
},
get shouldBeActive() {
return (
!this.appDisabled &&
!this._userDisabled &&
!(this.pendingOperations & AddonManager.PENDING_UNINSTALL)
);
},
get appDisabled() {
return this._appDisabled;
},
set appDisabled(val) {
if (val == this._appDisabled) {
return val;
}
AddonManagerPrivate.callAddonListeners("onPropertyChanged", this, [
"appDisabled",
]);
var currentActive = this.shouldBeActive;
this._appDisabled = val;
var newActive = this.shouldBeActive;
this._updateActiveState(currentActive, newActive);
return val;
},
get userDisabled() {
return this._userDisabled;
},
set userDisabled(val) {
throw new Error("No. Bad.");
},
setUserDisabled(val) {
if (val == this._userDisabled) {
return;
}
var currentActive = this.shouldBeActive;
this._userDisabled = val;
var newActive = this.shouldBeActive;
this._updateActiveState(currentActive, newActive);
},
async enable() {
await new Promise(resolve => Services.tm.dispatchToMainThread(resolve));
this.setUserDisabled(false);
},
async disable() {
await new Promise(resolve => Services.tm.dispatchToMainThread(resolve));
this.setUserDisabled(true);
},
get permissions() {
let permissions = this._permissions;
if (this.appDisabled || !this._userDisabled) {
permissions &= ~AddonManager.PERM_CAN_ENABLE;
}
if (this.appDisabled || this._userDisabled) {
permissions &= ~AddonManager.PERM_CAN_DISABLE;
}
return permissions;
},
set permissions(val) {
return (this._permissions = val);
},
get applyBackgroundUpdates() {
return this._applyBackgroundUpdates;
},
set applyBackgroundUpdates(val) {
if (
val != AddonManager.AUTOUPDATE_DEFAULT &&
val != AddonManager.AUTOUPDATE_DISABLE &&
val != AddonManager.AUTOUPDATE_ENABLE
) {
ok(false, "addon.applyBackgroundUpdates set to an invalid value: " + val);
}
this._applyBackgroundUpdates = val;
AddonManagerPrivate.callAddonListeners("onPropertyChanged", this, [
"applyBackgroundUpdates",
]);
},
isCompatibleWith(aAppVersion, aPlatformVersion) {
return true;
},
findUpdates(aListener, aReason, aAppVersion, aPlatformVersion) {
// Tests can implement this if they need to
},
async getBlocklistURL() {
return this.blocklistURL;
},
uninstall(aAlwaysAllowUndo = false) {
if (
this.operationsRequiringRestart &
AddonManager.OP_NEED_RESTART_UNINSTALL &&
this.pendingOperations & AddonManager.PENDING_UNINSTALL
) {
throw Components.Exception("Add-on is already pending uninstall");
}
var needsRestart =
aAlwaysAllowUndo ||
!!(
this.operationsRequiringRestart &
AddonManager.OP_NEEDS_RESTART_UNINSTALL
);
this.pendingOperations |= AddonManager.PENDING_UNINSTALL;
AddonManagerPrivate.callAddonListeners(
"onUninstalling",
this,
needsRestart
);
if (!needsRestart) {
this.pendingOperations -= AddonManager.PENDING_UNINSTALL;
this._provider.removeAddon(this);
} else if (
!(this.operationsRequiringRestart & AddonManager.OP_NEEDS_RESTART_DISABLE)
) {
this.isActive = false;
}
},
cancelUninstall() {
if (!(this.pendingOperations & AddonManager.PENDING_UNINSTALL)) {
throw Components.Exception("Add-on is not pending uninstall");
}
this.pendingOperations -= AddonManager.PENDING_UNINSTALL;
this.isActive = this.shouldBeActive;
AddonManagerPrivate.callAddonListeners("onOperationCancelled", this);
},
markAsSeen() {
this.seen = true;
},
_updateActiveState(currentActive, newActive) {
if (currentActive == newActive) {
return;
}
if (newActive == this.isActive) {
this.pendingOperations -= newActive
? AddonManager.PENDING_DISABLE
: AddonManager.PENDING_ENABLE;
AddonManagerPrivate.callAddonListeners("onOperationCancelled", this);
} else if (newActive) {
let needsRestart = !!(
this.operationsRequiringRestart & AddonManager.OP_NEEDS_RESTART_ENABLE
);
this.pendingOperations |= AddonManager.PENDING_ENABLE;
AddonManagerPrivate.callAddonListeners("onEnabling", this, needsRestart);
if (!needsRestart) {
this.isActive = newActive;
this.pendingOperations -= AddonManager.PENDING_ENABLE;
AddonManagerPrivate.callAddonListeners("onEnabled", this);
}
} else {
let needsRestart = !!(
this.operationsRequiringRestart & AddonManager.OP_NEEDS_RESTART_DISABLE
);
this.pendingOperations |= AddonManager.PENDING_DISABLE;
AddonManagerPrivate.callAddonListeners("onDisabling", this, needsRestart);
if (!needsRestart) {
this.isActive = newActive;
this.pendingOperations -= AddonManager.PENDING_DISABLE;
AddonManagerPrivate.callAddonListeners("onDisabled", this);
}
}
},
};
/** *** Mock AddonInstall object for the Mock Provider *****/
function MockInstall(aName, aType, aAddonToInstall) {
this.name = aName || "";
// Don't expose type until download completed
this._type = aType || "extension";
this.type = null;
this.version = "1.0";
this.iconURL = "";
this.infoURL = "";
this.state = AddonManager.STATE_AVAILABLE;
this.error = 0;
this.sourceURI = null;
this.file = null;
this.progress = 0;
this.maxProgress = -1;
this.certificate = null;
this.certName = "";
this.existingAddon = null;
this.addon = null;
this._addonToInstall = aAddonToInstall;
this.listeners = [];
// Another type of install listener for tests that want to check the results
// of code run from standard install listeners
this.testListeners = [];
}
MockInstall.prototype = {
install() {
switch (this.state) {
case AddonManager.STATE_AVAILABLE:
this.state = AddonManager.STATE_DOWNLOADING;
if (!this.callListeners("onDownloadStarted")) {
this.state = AddonManager.STATE_CANCELLED;
this.callListeners("onDownloadCancelled");
return;
}
this.type = this._type;
// Adding addon to MockProvider to be implemented when needed
if (this._addonToInstall) {
this.addon = this._addonToInstall;
} else {
this.addon = new MockAddon("", this.name, this.type);
this.addon.version = this.version;
this.addon.pendingOperations = AddonManager.PENDING_INSTALL;
}
this.addon.install = this;
if (this.existingAddon) {
if (!this.addon.id) {
this.addon.id = this.existingAddon.id;
}
this.existingAddon.pendingUpgrade = this.addon;
this.existingAddon.pendingOperations |= AddonManager.PENDING_UPGRADE;
}
this.state = AddonManager.STATE_DOWNLOADED;
this.callListeners("onDownloadEnded");
// fall through
case AddonManager.STATE_DOWNLOADED:
this.state = AddonManager.STATE_INSTALLING;
if (!this.callListeners("onInstallStarted")) {
this.state = AddonManager.STATE_CANCELLED;
this.callListeners("onInstallCancelled");
return;
}
let needsRestart =
this.operationsRequiringRestart &
AddonManager.OP_NEEDS_RESTART_INSTALL;
AddonManagerPrivate.callAddonListeners(
"onInstalling",
this.addon,
needsRestart
);
if (!needsRestart) {
AddonManagerPrivate.callAddonListeners("onInstalled", this.addon);
}
this.state = AddonManager.STATE_INSTALLED;
this.callListeners("onInstallEnded");
break;
case AddonManager.STATE_DOWNLOADING:
case AddonManager.STATE_CHECKING_UPDATE:
case AddonManager.STATE_INSTALLING:
// Installation is already running
return;
default:
ok(false, "Cannot start installing when state = " + this.state);
}
},
cancel() {
switch (this.state) {
case AddonManager.STATE_AVAILABLE:
this.state = AddonManager.STATE_CANCELLED;
break;
case AddonManager.STATE_INSTALLED:
this.state = AddonManager.STATE_CANCELLED;
this._provider.removeInstall(this);
this.callListeners("onInstallCancelled");
break;
default:
// Handling cancelling when downloading to be implemented when needed
ok(false, "Cannot cancel when state = " + this.state);
}
},
addListener(aListener) {
if (!this.listeners.some(i => i == aListener)) {
this.listeners.push(aListener);
}
},
removeListener(aListener) {
this.listeners = this.listeners.filter(i => i != aListener);
},
addTestListener(aListener) {
if (!this.testListeners.some(i => i == aListener)) {
this.testListeners.push(aListener);
}
},
removeTestListener(aListener) {
this.testListeners = this.testListeners.filter(i => i != aListener);
},
callListeners(aMethod) {
var result = AddonManagerPrivate.callInstallListeners(
aMethod,
this.listeners,
this,
this.addon
);
// Call test listeners after standard listeners to remove race condition
// between standard and test listeners
for (let listener of this.testListeners) {
try {
if (aMethod in listener) {
if (listener[aMethod](this, this.addon) === false) {
result = false;
}
}
} catch (e) {
ok(false, "Test listener threw exception: " + e);
}
}
return result;
},
};
function waitForCondition(condition, nextTest, errorMsg) {
let tries = 0;
let interval = setInterval(function() {
if (tries >= 30) {
ok(false, errorMsg);
moveOn();
}
var conditionPassed;
try {
conditionPassed = condition();
} catch (e) {
ok(false, e + "\n" + e.stack);
conditionPassed = false;
}
if (conditionPassed) {
moveOn();
}
tries++;
}, 100);
let moveOn = function() {
clearInterval(interval);
nextTest();
};
}
function getTestPluginTag() {
let ph = Cc["@mozilla.org/plugin/host;1"].getService(Ci.nsIPluginHost);
let tags = ph.getPluginTags();
// Find the test plugin
for (let i = 0; i < tags.length; i++) {
if (tags[i].name == "Test Plug-in") {
return tags[i];
}
}
ok(false, "Unable to find plugin");
return null;
}
// Wait for and then acknowledge (by pressing the primary button) the
// given notification.
function promiseNotification(id = "addon-webext-permissions") {
if (
!Services.prefs.getBoolPref("extensions.webextPermissionPrompts", false)
) {
return Promise.resolve();
}
return new Promise(resolve => {
function popupshown() {
let notification = PopupNotifications.getNotification(id);
if (notification) {
PopupNotifications.panel.removeEventListener("popupshown", popupshown);
PopupNotifications.panel.firstElementChild.button.click();
resolve();
}
}
PopupNotifications.panel.addEventListener("popupshown", popupshown);
});
}
/**
* Wait for the given PopupNotification to display
*
* @param {string} name
* The name of the notification to wait for.
*
* @returns {Promise}
* Resolves with the notification window.
*/
function promisePopupNotificationShown(name = "addon-webext-permissions") {
return new Promise(resolve => {
function popupshown() {
let notification = PopupNotifications.getNotification(name);
if (!notification) {
return;
}
ok(notification, `${name} notification shown`);
ok(PopupNotifications.isPanelOpen, "notification panel open");
PopupNotifications.panel.removeEventListener("popupshown", popupshown);
resolve(PopupNotifications.panel.firstChild);
}
PopupNotifications.panel.addEventListener("popupshown", popupshown);
});
}
function waitAppMenuNotificationShown(
id,
addonId,
accept = false,
win = window
) {
const { AppMenuNotifications } = ChromeUtils.import(
"resource://gre/modules/AppMenuNotifications.jsm"
);
return new Promise(resolve => {
let { document, PanelUI } = win;
async function popupshown() {
let notification = AppMenuNotifications.activeNotification;
if (!notification) {
return;
}
is(notification.id, id, `${id} notification shown`);
ok(PanelUI.isNotificationPanelOpen, "notification panel open");
PanelUI.notificationPanel.removeEventListener("popupshown", popupshown);
if (id == "addon-installed" && addonId) {
let addon = await AddonManager.getAddonByID(addonId);
if (!addon) {
ok(false, `Addon with id "${addonId}" not found`);
}
let hidden = !(
addon.permissions &
AddonManager.PERM_CAN_CHANGE_PRIVATEBROWSING_ACCESS
);
let checkbox = document.getElementById("addon-incognito-checkbox");
is(checkbox.hidden, hidden, "checkbox visibility is correct");
}
if (accept) {
let popupnotificationID = PanelUI._getPopupId(notification);
let popupnotification = document.getElementById(popupnotificationID);
popupnotification.button.click();
}
resolve();
}
// If it's already open just run the test.
let notification = AppMenuNotifications.activeNotification;
if (notification && PanelUI.isNotificationPanelOpen) {
popupshown();
return;
}
PanelUI.notificationPanel.addEventListener("popupshown", popupshown);
});
}
function acceptAppMenuNotificationWhenShown(id, addonId) {
return waitAppMenuNotificationShown(id, addonId, true);
}
const ABOUT_ADDONS_METHODS = new Set(["action", "view", "link"]);
function assertAboutAddonsTelemetryEvents(events, filters = {}) {
TelemetryTestUtils.assertEvents(events, {
category: "addonsManager",
method: actual =>
filters.methods
? filters.methods.includes(actual)
: ABOUT_ADDONS_METHODS.has(actual),
object: "aboutAddons",
});
}
/* HTML view helpers */
async function loadInitialView(type, opts) {
if (type) {
// Force the first page load to be the view we want.
let viewId;
if (type.startsWith("addons://")) {
viewId = type;
} else {
viewId =
type == "discover" ? "addons://discover/" : `addons://list/${type}`;
}
Services.prefs.setCharPref(PREF_UI_LASTCATEGORY, viewId);
}
let loadCallback;
let loadCallbackDone = Promise.resolve();
if (opts && opts.loadCallback) {
// Make sure the HTML browser is loaded and pass its window to the callback
// function instead of the XUL window.
loadCallback = managerWindow => {
loadCallbackDone = managerWindow
.promiseHtmlBrowserLoaded()
.then(async browser => {
let win = browser.contentWindow;
win.managerWindow = managerWindow;
// Wait for the test code to finish running before proceeding.
await opts.loadCallback(win);
});
};
}
let managerWindow = await open_manager(null, null, loadCallback);
let browser = managerWindow.document.getElementById("html-view-browser");
let win = browser.contentWindow;
if (!opts || !opts.withAnimations) {
win.document.body.setAttribute("skip-animations", "");
}
win.managerWindow = managerWindow;
// Let any load callback code to run before the rest of the test continues.
await loadCallbackDone;
return win;
}
function waitForViewLoad(win) {
return wait_for_view_load(win.managerWindow, undefined, true);
}
function closeView(win) {
return close_manager(win.managerWindow);
}
function switchView(win, type) {
return new CategoryUtilities(win.managerWindow).openType(type);
}
function isCategoryVisible(win, type) {
return new CategoryUtilities(win.managerWindow).isTypeVisible(type);
}
function mockPromptService() {
let { prompt } = Services;
let promptService = {
// The prompt returns 1 for cancelled and 0 for accepted.
_response: 1,
QueryInterface: ChromeUtils.generateQI(["nsIPromptService"]),
confirmEx: () => promptService._response,
};
Services.prompt = promptService;
registerCleanupFunction(() => {
Services.prompt = prompt;
});
return promptService;
}
function assertHasPendingUninstalls(addonList, expectedPendingUninstallsCount) {
const pendingUninstalls = addonList.querySelector(
"message-bar-stack.pending-uninstall"
);
ok(pendingUninstalls, "Got a pending-uninstall message-bar-stack");
is(
pendingUninstalls.childElementCount,
expectedPendingUninstallsCount,
"Got a message bar in the pending-uninstall message-bar-stack"
);
}
function assertHasPendingUninstallAddon(addonList, addon) {
const pendingUninstalls = addonList.querySelector(
"message-bar-stack.pending-uninstall"
);
const addonPendingUninstall = addonList.getPendingUninstallBar(addon);
ok(
addonPendingUninstall,
"Got expected message-bar for the pending uninstall test extension"
);
is(
addonPendingUninstall.parentNode,
pendingUninstalls,
"pending uninstall bar should be part of the message-bar-stack"
);
is(
addonPendingUninstall.getAttribute("addon-id"),
addon.id,
"Got expected addon-id attribute on the pending uninstall message-bar"
);
}
async function testUndoPendingUninstall(addonList, addon) {
const addonPendingUninstall = addonList.getPendingUninstallBar(addon);
const undoButton = addonPendingUninstall.querySelector("button[action=undo]");
ok(undoButton, "Got undo action button in the pending uninstall message-bar");
info(
"Clicking the pending uninstall undo button and wait for addon card rendered"
);
const updated = BrowserTestUtils.waitForEvent(addonList, "add");
undoButton.click();
await updated;
ok(
addon && !(addon.pendingOperations & AddonManager.PENDING_UNINSTALL),
"The addon pending uninstall cancelled"
);
}
function loadTestSubscript(filePath) {
Services.scriptloader.loadSubScript(new URL(filePath, gTestPath).href, this);
}
function cleanupPendingNotifications() {
const { ExtensionsUI } = ChromeUtils.import(
"resource:///modules/ExtensionsUI.jsm"
);
info("Cleanup any pending notification before exiting the test");
const keys = ChromeUtils.nondeterministicGetWeakSetKeys(
ExtensionsUI.pendingNotifications
);
if (keys) {
keys.forEach(key => ExtensionsUI.pendingNotifications.delete(key));
}
}
function promisePermissionPrompt(addonId) {
return BrowserUtils.promiseObserved(
"webextension-permission-prompt",
subject => {
const { info } = subject.wrappedJSObject || {};
return !addonId || (info.addon && info.addon.id === addonId);
}
).then(({ subject }) => {
return subject.wrappedJSObject.info;
});
}
async function handlePermissionPrompt({
addonId,
reject = false,
assertIcon = true,
} = {}) {
const info = await promisePermissionPrompt(addonId);
// Assert that info.addon and info.icon are defined as expected.
is(
info.addon && info.addon.id,
addonId,
"Got the AddonWrapper in the permission prompt info"
);
if (assertIcon) {
ok(info.icon != null, "Got an addon icon in the permission prompt info");
}
if (reject) {
info.reject();
} else {
info.resolve();
}
}
async function switchToDetailView({ id, win }) {
let card = getAddonCard(win, id);
ok(card, `Addon card found for ${id}`);
ok(!card.querySelector("addon-details"), "The card doesn't have details");
let loaded = waitForViewLoad(win);
EventUtils.synthesizeMouseAtCenter(card, { clickCount: 1 }, win);
await loaded;
card = getAddonCard(win, id);
ok(card.querySelector("addon-details"), "The card does have details");
return card;
}
|