gecko/toolkit/mozapps/extensions/test/xpcshell/test_disable.js

/* Any copyright is dedicated to the Public Domain.
 * http://creativecommons.org/publicdomain/zero/1.0/
 */

Components.utils.import("resource://gre/modules/NetUtil.jsm");

// This verifies that add-ons can be disabled and enabled.

var addon1 = {
  id: "addon1@tests.mozilla.org",
  version: "1.0",
  name: "Test 1",
  optionsURL: "chrome://foo/content/options.xul",
  aboutURL: "chrome://foo/content/about.xul",
  iconURL: "chrome://foo/content/icon.png",
  targetApplications: [{
    id: "xpcshell@tests.mozilla.org",
    minVersion: "1",
    maxVersion: "1"
  }]
};

const profileDir = gProfD.clone();
profileDir.append("extensions");

var gIconURL = null;

// Sets up the profile by installing an add-on.
function run_test() {
  do_test_pending();
  createAppInfo("xpcshell@tests.mozilla.org", "XPCShell", "1", "1.9.2");

  startupManager();

  AddonManager.getAddonByID("addon1@tests.mozilla.org", function(a1) {
    do_check_eq(a1, null);
    do_check_not_in_crash_annotation(addon1.id, addon1.version);

    writeInstallRDFForExtension(addon1, profileDir, addon1.id, "icon.png");
    gIconURL = do_get_addon_root_uri(profileDir.clone(), addon1.id) + "icon.png";

    restartManager();

    AddonManager.getAddonByID("addon1@tests.mozilla.org", function(newa1) {
      do_check_neq(newa1, null);
      do_check_true(newa1.isActive);
      do_check_false(newa1.userDisabled);
      do_check_eq(newa1.aboutURL, "chrome://foo/content/about.xul");
      do_check_eq(newa1.optionsURL, "chrome://foo/content/options.xul");
      do_check_eq(newa1.iconURL, "chrome://foo/content/icon.png");
      do_check_true(isExtensionInAddonsList(profileDir, newa1.id));
      do_check_true(hasFlag(newa1.permissions, AddonManager.PERM_CAN_DISABLE));
      do_check_false(hasFlag(newa1.permissions, AddonManager.PERM_CAN_ENABLE));
      do_check_eq(newa1.operationsRequiringRestart, AddonManager.OP_NEEDS_RESTART_DISABLE |
                                                    AddonManager.OP_NEEDS_RESTART_UNINSTALL);
      do_check_in_crash_annotation(addon1.id, addon1.version);

      run_test_1();
    });
  });
}

// Disabling an add-on should work
function run_test_1() {
  prepare_test({
    "addon1@tests.mozilla.org": [
      "onDisabling"
    ]
  });

  AddonManager.getAddonByID("addon1@tests.mozilla.org", function(a1) {
    do_check_neq(a1.operationsRequiringRestart &
                 AddonManager.OP_NEEDS_RESTART_DISABLE, 0);
    a1.userDisabled = true;
    do_check_eq(a1.aboutURL, "chrome://foo/content/about.xul");
    do_check_eq(a1.optionsURL, "chrome://foo/content/options.xul");
    do_check_eq(a1.iconURL, "chrome://foo/content/icon.png");
    do_check_false(hasFlag(a1.permissions, AddonManager.PERM_CAN_DISABLE));
    do_check_true(hasFlag(a1.permissions, AddonManager.PERM_CAN_ENABLE));
    do_check_eq(a1.operationsRequiringRestart, AddonManager.OP_NEEDS_RESTART_DISABLE |
                                               AddonManager.OP_NEEDS_RESTART_UNINSTALL);
    do_check_in_crash_annotation(addon1.id, addon1.version);

    ensure_test_completed();

    AddonManager.getAddonsWithOperationsByTypes(null, function(list) {
      do_check_eq(list.length, 1);
      do_check_eq(list[0].id, "addon1@tests.mozilla.org");

      restartManager();

      AddonManager.getAddonByID("addon1@tests.mozilla.org", function(newa1) {
        do_check_neq(newa1, null);
        do_check_false(newa1.isActive);
        do_check_true(newa1.userDisabled);
        do_check_eq(newa1.aboutURL, null);
        do_check_eq(newa1.optionsURL, null);
        do_check_eq(newa1.iconURL, gIconURL);
        do_check_false(isExtensionInAddonsList(profileDir, newa1.id));
        do_check_false(hasFlag(newa1.permissions, AddonManager.PERM_CAN_DISABLE));
        do_check_true(hasFlag(newa1.permissions, AddonManager.PERM_CAN_ENABLE));
        do_check_eq(newa1.operationsRequiringRestart, AddonManager.OP_NEEDS_RESTART_ENABLE);
        do_check_not_in_crash_annotation(addon1.id, addon1.version);

        run_test_2();
      });
    });
  });
}

// Enabling an add-on should work.
function run_test_2() {
  prepare_test({
    "addon1@tests.mozilla.org": [
      "onEnabling"
    ]
  });

  AddonManager.getAddonByID("addon1@tests.mozilla.org", function(a1) {
    a1.userDisabled = false;
    do_check_eq(a1.aboutURL, null);
    do_check_eq(a1.optionsURL, null);
    do_check_eq(a1.iconURL, gIconURL);
    do_check_true(hasFlag(a1.permissions, AddonManager.PERM_CAN_DISABLE));
    do_check_false(hasFlag(a1.permissions, AddonManager.PERM_CAN_ENABLE));
    do_check_eq(a1.operationsRequiringRestart, AddonManager.OP_NEEDS_RESTART_ENABLE);

    ensure_test_completed();

    AddonManager.getAddonsWithOperationsByTypes(null, function(list) {
      do_check_eq(list.length, 1);
      do_check_eq(list[0].id, "addon1@tests.mozilla.org");

      restartManager();

      AddonManager.getAddonByID("addon1@tests.mozilla.org", function(newa1) {
        do_check_neq(newa1, null);
        do_check_true(newa1.isActive);
        do_check_false(newa1.userDisabled);
        do_check_eq(newa1.aboutURL, "chrome://foo/content/about.xul");
        do_check_eq(newa1.optionsURL, "chrome://foo/content/options.xul");
        do_check_eq(newa1.iconURL, "chrome://foo/content/icon.png");
        do_check_true(isExtensionInAddonsList(profileDir, newa1.id));
        do_check_true(hasFlag(newa1.permissions, AddonManager.PERM_CAN_DISABLE));
        do_check_false(hasFlag(newa1.permissions, AddonManager.PERM_CAN_ENABLE));
        do_check_eq(newa1.operationsRequiringRestart, AddonManager.OP_NEEDS_RESTART_DISABLE |
                                                      AddonManager.OP_NEEDS_RESTART_UNINSTALL);
        do_check_in_crash_annotation(addon1.id, addon1.version);

        run_test_3();
      });
    });
  });
}

// Disabling then enabling withut restart should fire onOperationCancelled.
function run_test_3() {
  prepare_test({
    "addon1@tests.mozilla.org": [
      "onDisabling"
    ]
  });

  AddonManager.getAddonByID("addon1@tests.mozilla.org", function(a1) {
    a1.userDisabled = true;
    ensure_test_completed();
    prepare_test({
      "addon1@tests.mozilla.org": [
        "onOperationCancelled"
      ]
    });
    a1.userDisabled = false;
    do_check_true(hasFlag(a1.permissions, AddonManager.PERM_CAN_DISABLE));
    do_check_false(hasFlag(a1.permissions, AddonManager.PERM_CAN_ENABLE));

    ensure_test_completed();

    restartManager();

    AddonManager.getAddonByID("addon1@tests.mozilla.org", function(newa1) {
      do_check_neq(newa1, null);
      do_check_true(newa1.isActive);
      do_check_false(newa1.userDisabled);
      do_check_eq(newa1.aboutURL, "chrome://foo/content/about.xul");
      do_check_eq(newa1.optionsURL, "chrome://foo/content/options.xul");
      do_check_eq(newa1.iconURL, "chrome://foo/content/icon.png");
      do_check_true(isExtensionInAddonsList(profileDir, newa1.id));
      do_check_true(hasFlag(newa1.permissions, AddonManager.PERM_CAN_DISABLE));
      do_check_false(hasFlag(newa1.permissions, AddonManager.PERM_CAN_ENABLE));

      do_test_finished();
    });
  });
}