Source code
Revision control
Copy as Markdown
Other Tools
Test Info:
/* Any copyright is dedicated to the Public Domain.
*/
// Tests that upgrading bootstrapped add-ons behaves correctly while the
// manager is open
const { AddonTestUtils } = ChromeUtils.importESModule(
);
const ID = "reinstall@tests.mozilla.org";
const testIdSuffix = "@tests.mozilla.org";
let gManagerWindow, xpi1, xpi2;
function htmlDoc() {
return gManagerWindow.document;
}
function get_list_item_count() {
return htmlDoc().querySelectorAll(`addon-card[addon-id$="${testIdSuffix}"]`)
.length;
}
function removeItem(item) {
let button = item.querySelector('[action="remove"]');
button.click();
}
function hasPendingMessage(item, msg) {
let messageBar = htmlDoc().querySelector(
`moz-message-bar[addon-id="${item.addon.id}"`
);
is_element_visible(messageBar, msg);
}
async function install_addon(xpi) {
let install = await AddonManager.getInstallForFile(
xpi,
"application/x-xpinstall"
);
return install.install();
}
async function check_addon(aAddon, aVersion) {
is(get_list_item_count(), 1, "Should be one item in the list");
is(aAddon.version, aVersion, "Add-on should have the right version");
let item = getAddonCard(gManagerWindow, ID);
ok(!!item, "Should see the add-on in the list");
// Force XBL to apply
item.clientTop;
let { version } = await get_tooltip_info(item, gManagerWindow);
is(version, aVersion, "Version should be correct");
const l10nAttrs = item.ownerDocument.l10n.getAttributes(item.addonNameEl);
if (aAddon.userDisabled) {
Assert.deepEqual(
l10nAttrs,
{ id: "addon-name-disabled", args: { name: aAddon.name } },
"localized addon name is marked as disabled"
);
} else {
Assert.deepEqual(
l10nAttrs,
{ id: null, args: null },
"localized addon name is not marked as disabled"
);
}
}
async function wait_for_addon_item_added(addonId) {
await BrowserTestUtils.waitForEvent(
htmlDoc().querySelector("addon-list"),
"add"
);
const item = getAddonCard(gManagerWindow, addonId);
ok(item, `Found addon card for ${addonId}`);
}
async function wait_for_addon_item_removed(addonId) {
await BrowserTestUtils.waitForEvent(
htmlDoc().querySelector("addon-list"),
"remove"
);
const item = getAddonCard(gManagerWindow, addonId);
ok(!item, `There shouldn't be an addon card for ${addonId}`);
}
function wait_for_addon_item_updated(addonId) {
return BrowserTestUtils.waitForEvent(
getAddonCard(gManagerWindow, addonId),
"update"
);
}
// Install version 1 then upgrade to version 2 with the manager open
async function test_upgrade_v1_to_v2() {
let promiseItemAdded = wait_for_addon_item_added(ID);
await install_addon(xpi1);
await promiseItemAdded;
let addon = await promiseAddonByID(ID);
await check_addon(addon, "1.0");
ok(!addon.userDisabled, "Add-on should not be disabled");
let promiseItemUpdated = wait_for_addon_item_updated(ID);
await install_addon(xpi2);
await promiseItemUpdated;
addon = await promiseAddonByID(ID);
await check_addon(addon, "2.0");
ok(!addon.userDisabled, "Add-on should not be disabled");
let promiseItemRemoved = wait_for_addon_item_removed(ID);
await addon.uninstall();
await promiseItemRemoved;
is(get_list_item_count(), 0, "Should be no items in the list");
}
// Install version 1 mark it as disabled then upgrade to version 2 with the
// manager open
async function test_upgrade_disabled_v1_to_v2() {
let promiseItemAdded = wait_for_addon_item_added(ID);
await install_addon(xpi1);
await promiseItemAdded;
let promiseItemUpdated = wait_for_addon_item_updated(ID);
let addon = await promiseAddonByID(ID);
await addon.disable();
await promiseItemUpdated;
await check_addon(addon, "1.0");
ok(addon.userDisabled, "Add-on should be disabled");
promiseItemUpdated = wait_for_addon_item_updated(ID);
await install_addon(xpi2);
await promiseItemUpdated;
addon = await promiseAddonByID(ID);
await check_addon(addon, "2.0");
ok(addon.userDisabled, "Add-on should be disabled");
let promiseItemRemoved = wait_for_addon_item_removed(ID);
await addon.uninstall();
await promiseItemRemoved;
is(get_list_item_count(), 0, "Should be no items in the list");
}
// Install version 1 click the remove button and then upgrade to version 2 with
// the manager open
async function test_upgrade_pending_uninstall_v1_to_v2() {
let promiseItemAdded = wait_for_addon_item_added(ID);
await install_addon(xpi1);
await promiseItemAdded;
let addon = await promiseAddonByID(ID);
await check_addon(addon, "1.0");
ok(!addon.userDisabled, "Add-on should not be disabled");
let item = getAddonCard(gManagerWindow, ID);
let promiseItemRemoved = wait_for_addon_item_removed(ID);
removeItem(item);
// Force XBL to apply
item.clientTop;
await promiseItemRemoved;
ok(
!!(addon.pendingOperations & AddonManager.PENDING_UNINSTALL),
"Add-on should be pending uninstall"
);
hasPendingMessage(item, "Pending message should be visible");
promiseItemAdded = wait_for_addon_item_added(ID);
await install_addon(xpi2);
await promiseItemAdded;
addon = await promiseAddonByID(ID);
await check_addon(addon, "2.0");
ok(!addon.userDisabled, "Add-on should not be disabled");
promiseItemRemoved = wait_for_addon_item_removed(ID);
await addon.uninstall();
await promiseItemRemoved;
is(get_list_item_count(), 0, "Should be no items in the list");
}
// Install version 1, disable it, click the remove button and then upgrade to
// version 2 with the manager open
async function test_upgrade_pending_uninstall_disabled_v1_to_v2() {
let promiseItemAdded = wait_for_addon_item_added(ID);
await install_addon(xpi1);
await promiseItemAdded;
let promiseItemUpdated = wait_for_addon_item_updated(ID);
let addon = await promiseAddonByID(ID);
await addon.disable();
await promiseItemUpdated;
await check_addon(addon, "1.0");
ok(addon.userDisabled, "Add-on should be disabled");
let item = getAddonCard(gManagerWindow, ID);
let promiseItemRemoved = wait_for_addon_item_removed(ID);
removeItem(item);
// Force XBL to apply
item.clientTop;
await promiseItemRemoved;
ok(
!!(addon.pendingOperations & AddonManager.PENDING_UNINSTALL),
"Add-on should be pending uninstall"
);
hasPendingMessage(item, "Pending message should be visible");
promiseItemAdded = wait_for_addon_item_added(ID);
await install_addon(xpi2);
addon = await promiseAddonByID(ID);
await promiseItemAdded;
await check_addon(addon, "2.0");
ok(addon.userDisabled, "Add-on should be disabled");
promiseItemRemoved = wait_for_addon_item_removed(ID);
await addon.uninstall();
await promiseItemRemoved;
is(get_list_item_count(), 0, "Should be no items in the list");
}
add_setup(async function () {
xpi1 = await AddonTestUtils.createTempWebExtensionFile({
manifest: {
version: "1.0",
browser_specific_settings: { gecko: { id: ID } },
},
});
xpi2 = await AddonTestUtils.createTempWebExtensionFile({
manifest: {
version: "2.0",
browser_specific_settings: { gecko: { id: ID } },
},
});
// Accept all prompts.
mockPromptService()._response = 0;
});
add_task(async function test_upgrades() {
// Close existing about:addons tab if a test failure has
// prevented it from being closed.
if (gManagerWindow) {
await close_manager(gManagerWindow);
}
await test_upgrade_v1_to_v2();
await test_upgrade_disabled_v1_to_v2();
await test_upgrade_pending_uninstall_v1_to_v2();
await test_upgrade_pending_uninstall_disabled_v1_to_v2();
await close_manager(gManagerWindow);
gManagerWindow = null;
});