js/xpconnect/tests/unit/test_xpcomutils.js

   1 /* -*- indent-tabs-mode: nil; js-indent-level: 4 -*-
   2  * vim: sw=4 ts=4 sts=4 et
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 /**
   8  * This file tests the methods on XPCOMUtils.sys.mjs.
   9  * Also on ComponentUtils.jsm. Which is deprecated.
  10  */
  11
  12 const {AppConstants} = ChromeUtils.importESModule("resource://gre/modules/AppConstants.sys.mjs");
  13 const {ComponentUtils} = ChromeUtils.importESModule("resource://gre/modules/ComponentUtils.sys.mjs");
  14 const {Preferences} = ChromeUtils.importESModule("resource://gre/modules/Preferences.sys.mjs");
  15 const {TestUtils} = ChromeUtils.importESModule("resource://testing-common/TestUtils.sys.mjs");
  16 const {XPCOMUtils} = ChromeUtils.importESModule("resource://gre/modules/XPCOMUtils.sys.mjs");
  17
  18 ////////////////////////////////////////////////////////////////////////////////
  19 //// Tests
  20
  21 add_test(function test_generateQI_string_names()
  22 {
  23     var x = {
  24         QueryInterface: ChromeUtils.generateQI([
  25             "nsIClassInfo",
  26             "nsIObserver"
  27         ])
  28     };
  29
  30     try {
  31         x.QueryInterface(Ci.nsIClassInfo);
  32     } catch(e) {
  33         do_throw("Should QI to nsIClassInfo");
  34     }
  35     try {
  36         x.QueryInterface(Ci.nsIObserver);
  37     } catch(e) {
  38         do_throw("Should QI to nsIObserver");
  39     }
  40     try {
  41         x.QueryInterface(Ci.nsIObserverService);
  42         do_throw("QI should not have succeeded!");
  43     } catch(e) {}
  44     run_next_test();
  45 });
  46
  47 add_test(function test_defineLazyServiceGetter()
  48 {
  49     let obj = { };
  50     XPCOMUtils.defineLazyServiceGetter(obj, "service",
  51                                        "@mozilla.org/consoleservice;1",
  52                                        "nsIConsoleService");
  53     let service = Cc["@mozilla.org/consoleservice;1"].
  54                   getService(Ci.nsIConsoleService);
  55
  56     // Check that the lazy service getter and the actual service have the same
  57     // properties.
  58     for (let prop in obj.service)
  59         Assert.ok(prop in service);
  60     for (let prop in service)
  61         Assert.ok(prop in obj.service);
  62     run_next_test();
  63 });
  64
  65
  66 add_test(function test_defineLazyPreferenceGetter()
  67 {
  68     const PREF = "xpcomutils.test.pref";
  69
  70     let obj = {};
  71     XPCOMUtils.defineLazyPreferenceGetter(obj, "pref", PREF, "defaultValue");
  72
  73
  74     equal(obj.pref, "defaultValue", "Should return the default value before pref is set");
  75
  76     Preferences.set(PREF, "currentValue");
  77
  78
  79     info("Create second getter on new object");
  80
  81     obj = {};
  82     XPCOMUtils.defineLazyPreferenceGetter(obj, "pref", PREF, "defaultValue");
  83
  84
  85     equal(obj.pref, "currentValue", "Should return the current value on initial read when pref is already set");
  86
  87     Preferences.set(PREF, "newValue");
  88
  89     equal(obj.pref, "newValue", "Should return new value after preference change");
  90
  91     Preferences.set(PREF, "currentValue");
  92
  93     equal(obj.pref, "currentValue", "Should return new value after second preference change");
  94
  95
  96     Preferences.reset(PREF);
  97
  98     equal(obj.pref, "defaultValue", "Should return default value after pref is reset");
  99
 100     obj = {};
 101     XPCOMUtils.defineLazyPreferenceGetter(obj, "pref", PREF, "a,b",
 102                                           null, value => value.split(","));
 103
 104     deepEqual(obj.pref, ["a", "b"], "transform is applied to default value");
 105
 106     Preferences.set(PREF, "x,y,z");
 107     deepEqual(obj.pref, ["x", "y", "z"], "transform is applied to updated value");
 108
 109     Preferences.reset(PREF);
 110     deepEqual(obj.pref, ["a", "b"], "transform is applied to reset default");
 111
 112     if (AppConstants.DEBUG) {
 113       // Need to use a 'real' pref so it will have a valid prefType
 114       obj = {};
 115       Assert.throws(
 116         () => XPCOMUtils.defineLazyPreferenceGetter(obj, "pref", "javascript.enabled", 1),
 117         /Default value does not match preference type/,
 118         "Providing a default value of a different type than the preference throws an exception"
 119       );
 120     }
 121
 122     run_next_test();
 123 });
 124
 125
 126 add_test(function test_categoryRegistration()
 127 {
 128   const CATEGORY_NAME = "test-cat";
 129   const XULAPPINFO_CONTRACTID = "@mozilla.org/xre/app-info;1";
 130   const XULAPPINFO_CID = Components.ID("{fc937916-656b-4fb3-a395-8c63569e27a8}");
 131
 132   // Create a fake app entry for our category registration apps filter.
 133   let { newAppInfo } = ChromeUtils.importESModule("resource://testing-common/AppInfo.sys.mjs");
 134   let XULAppInfo = newAppInfo({
 135     name: "catRegTest",
 136     ID: "{adb42a9a-0d19-4849-bf4d-627614ca19be}",
 137     version: "1",
 138     platformVersion: "",
 139   });
 140   let XULAppInfoFactory = {
 141     createInstance: function (iid) {
 142       return XULAppInfo.QueryInterface(iid);
 143     }
 144   };
 145   let registrar = Components.manager.QueryInterface(Ci.nsIComponentRegistrar);
 146   registrar.registerFactory(
 147     XULAPPINFO_CID,
 148     "XULAppInfo",
 149     XULAPPINFO_CONTRACTID,
 150     XULAppInfoFactory
 151   );
 152
 153   // Load test components.
 154   do_load_manifest("CatRegistrationComponents.manifest");
 155
 156   const expectedEntries = new Map([
 157     ["CatRegisteredComponent", "@unit.test.com/cat-registered-component;1"],
 158     ["CatAppRegisteredComponent", "@unit.test.com/cat-app-registered-component;1"],
 159   ]);
 160
 161   // Verify the correct entries are registered in the "test-cat" category.
 162   for (let {entry, value} of Services.catMan.enumerateCategory(CATEGORY_NAME)) {
 163     ok(expectedEntries.has(entry), `${entry} is expected`);
 164     Assert.equal(value, expectedEntries.get(entry), "${entry} has correct value.");
 165     expectedEntries.delete(entry);
 166   }
 167   Assert.deepEqual(
 168     Array.from(expectedEntries.keys()),
 169     [],
 170     "All expected entries have been deleted."
 171   );
 172   run_next_test();
 173 });
 174
 175 add_test(function test_categoryBackgroundTaskRegistration()
 176 {
 177   const CATEGORY_NAME = "test-cat1";
 178
 179   // Note that this test should succeed whether or not MOZ_BACKGROUNDTASKS is
 180   // defined.  If it's defined, there's no active task so the `backgroundtask`
 181   // directive is processed, dropped, and always succeeds.  If it's not defined,
 182   // then the `backgroundtask` directive is processed and ignored.
 183
 184   // Load test components.
 185   do_load_manifest("CatBackgroundTaskRegistrationComponents.manifest");
 186
 187   let expectedEntriesList = [
 188     ["Cat1RegisteredComponent", "@unit.test.com/cat1-registered-component;1"],
 189     ["Cat1BackgroundTaskNotRegisteredComponent", "@unit.test.com/cat1-backgroundtask-notregistered-component;1"],
 190   ];
 191   if (!AppConstants.MOZ_BACKGROUNDTASKS) {
 192     expectedEntriesList.push(...[
 193       ["Cat1BackgroundTaskRegisteredComponent", "@unit.test.com/cat1-backgroundtask-registered-component;1"],
 194       ["Cat1BackgroundTaskAlwaysRegisteredComponent", "@unit.test.com/cat1-backgroundtask-alwaysregistered-component;1"],
 195     ]);
 196   }
 197   const expectedEntries = new Map(expectedEntriesList);
 198
 199   // Verify the correct entries are registered in the "test-cat" category.
 200   for (let {entry, value} of Services.catMan.enumerateCategory(CATEGORY_NAME)) {
 201     ok(expectedEntries.has(entry), `${entry} is expected`);
 202     Assert.equal(value, expectedEntries.get(entry), "Verify that the value is correct in the expected entries.");
 203     expectedEntries.delete(entry);
 204   }
 205   Assert.deepEqual(
 206     Array.from(expectedEntries.keys()),
 207     [],
 208     "All expected entries have been deleted."
 209   );
 210   run_next_test();
 211 });
 212
 213 add_test(function test_generateSingletonFactory()
 214 {
 215   const XPCCOMPONENT_CONTRACTID = "@mozilla.org/singletonComponentTest;1";
 216   const XPCCOMPONENT_CID = Components.ID("{31031c36-5e29-4dd9-9045-333a5d719a3e}");
 217
 218   function XPCComponent() {}
 219   XPCComponent.prototype = {
 220     classID: XPCCOMPONENT_CID,
 221     QueryInterface: ChromeUtils.generateQI([])
 222   };
 223   let registrar = Components.manager.QueryInterface(Ci.nsIComponentRegistrar);
 224   registrar.registerFactory(
 225     XPCCOMPONENT_CID,
 226     "XPCComponent",
 227     XPCCOMPONENT_CONTRACTID,
 228     ComponentUtils.generateSingletonFactory(XPCComponent)
 229   );
 230
 231   // First, try to instance the component.
 232   let instance = Cc[XPCCOMPONENT_CONTRACTID].createInstance(Ci.nsISupports);
 233   // Try again, check that it returns the same instance as before.
 234   Assert.equal(instance,
 235                Cc[XPCCOMPONENT_CONTRACTID].createInstance(Ci.nsISupports));
 236   // Now, for sanity, check that getService is also returning the same instance.
 237   Assert.equal(instance,
 238                Cc[XPCCOMPONENT_CONTRACTID].getService(Ci.nsISupports));
 239
 240   run_next_test();
 241 });
 242
 243 ////////////////////////////////////////////////////////////////////////////////
 244 //// Test Runner
 245
 246 function run_test()
 247 {
 248   run_next_test();
 249 }