summaryrefslogtreecommitdiffstats
path: root/browser/components/extensions/test/xpcshell/test_ext_settings_validate.js
blob: edccc7d80c4903260ea5bd787f41c004d4b52900 (plain)
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
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";

const { AddonTestUtils } = ChromeUtils.importESModule(
  "resource://testing-common/AddonTestUtils.sys.mjs"
);

const { AddonManager } = ChromeUtils.importESModule(
  "resource://gre/modules/AddonManager.sys.mjs"
);

const { AboutNewTab } = ChromeUtils.import(
  "resource:///modules/AboutNewTab.jsm"
);

// Lazy load to avoid having Services.appinfo cached first.
ChromeUtils.defineESModuleGetters(this, {
  ExtensionParent: "resource://gre/modules/ExtensionParent.sys.mjs",
});

const { HomePage } = ChromeUtils.import("resource:///modules/HomePage.jsm");

AddonTestUtils.init(this);

// Allow for unsigned addons.
AddonTestUtils.overrideCertDB();

AddonTestUtils.createAppInfo(
  "xpcshell@tests.mozilla.org",
  "XPCShell",
  "42",
  "42"
);

add_task(async function test_settings_modules_not_loaded() {
  await ExtensionParent.apiManager.lazyInit();
  // Test that no settings modules are loaded.
  let modules = Array.from(ExtensionParent.apiManager.settingsModules);
  ok(modules.length, "we have settings modules");
  for (let name of modules) {
    ok(
      !ExtensionParent.apiManager.getModule(name).loaded,
      `${name} is not loaded`
    );
  }
});

add_task(async function test_settings_validated() {
  let defaultNewTab = AboutNewTab.newTabURL;
  equal(defaultNewTab, "about:newtab", "Newtab url is default.");
  let defaultHomepageURL = HomePage.get();
  equal(defaultHomepageURL, "about:home", "Home page url is default.");

  let xpi = await AddonTestUtils.createTempWebExtensionFile({
    manifest: {
      version: "1.0",
      browser_specific_settings: { gecko: { id: "test@mochi" } },
      chrome_url_overrides: {
        newtab: "/newtab",
      },
      chrome_settings_overrides: {
        homepage: "https://example.com/",
      },
    },
  });
  let extension = ExtensionTestUtils.expectExtension("test@mochi");
  let file = await AddonTestUtils.manuallyInstall(xpi);
  await AddonTestUtils.promiseStartupManager();
  await extension.awaitStartup();

  equal(
    HomePage.get(),
    "https://example.com/",
    "Home page url is extension controlled."
  );
  ok(
    AboutNewTab.newTabURL.endsWith("/newtab"),
    "newTabURL is extension controlled."
  );

  await AddonTestUtils.promiseShutdownManager();
  // After shutdown, delete the xpi file.
  Services.obs.notifyObservers(xpi, "flush-cache-entry");
  try {
    file.remove(true);
  } catch (e) {
    ok(false, e);
  }
  await AddonTestUtils.cleanupTempXPIs();

  // Restart everything, the ExtensionAddonObserver should handle updating state.
  let prefChanged = TestUtils.waitForPrefChange("browser.startup.homepage");
  await AddonTestUtils.promiseStartupManager();
  await prefChanged;

  equal(HomePage.get(), defaultHomepageURL, "Home page url is default.");
  equal(AboutNewTab.newTabURL, defaultNewTab, "newTabURL is reset to default.");
  await AddonTestUtils.promiseShutdownManager();
});

add_task(async function test_settings_validated_safemode() {
  let defaultNewTab = AboutNewTab.newTabURL;
  equal(defaultNewTab, "about:newtab", "Newtab url is default.");
  let defaultHomepageURL = HomePage.get();
  equal(defaultHomepageURL, "about:home", "Home page url is default.");

  function isDefaultSettings(postfix) {
    equal(
      HomePage.get(),
      defaultHomepageURL,
      `Home page url is default ${postfix}.`
    );
    equal(
      AboutNewTab.newTabURL,
      defaultNewTab,
      `newTabURL is default ${postfix}.`
    );
  }

  function isExtensionSettings(postfix) {
    equal(
      HomePage.get(),
      "https://example.com/",
      `Home page url is extension controlled ${postfix}.`
    );
    ok(
      AboutNewTab.newTabURL.endsWith("/newtab"),
      `newTabURL is extension controlled ${postfix}.`
    );
  }

  async function switchSafeMode(inSafeMode) {
    await AddonTestUtils.promiseShutdownManager();
    AddonTestUtils.appInfo.inSafeMode = inSafeMode;
    await AddonTestUtils.promiseStartupManager();
    return AddonManager.getAddonByID("test@mochi");
  }

  let xpi = await AddonTestUtils.createTempWebExtensionFile({
    manifest: {
      version: "1.0",
      browser_specific_settings: { gecko: { id: "test@mochi" } },
      chrome_url_overrides: {
        newtab: "/newtab",
      },
      chrome_settings_overrides: {
        homepage: "https://example.com/",
      },
    },
  });
  let extension = ExtensionTestUtils.expectExtension("test@mochi");
  await AddonTestUtils.manuallyInstall(xpi);
  await AddonTestUtils.promiseStartupManager();
  await extension.awaitStartup();

  isExtensionSettings("on extension startup");

  // Disable in safemode and verify settings are removed in normal mode.
  let addon = await switchSafeMode(true);
  await addon.disable();
  addon = await switchSafeMode(false);
  isDefaultSettings("after disabling addon during safemode");

  // Enable in safemode and verify settings are back in normal mode.
  addon = await switchSafeMode(true);
  await addon.enable();
  addon = await switchSafeMode(false);
  isExtensionSettings("after enabling addon during safemode");

  // Uninstall in safemode and verify settings are removed in normal mode.
  addon = await switchSafeMode(true);
  await addon.uninstall();
  addon = await switchSafeMode(false);
  isDefaultSettings("after uninstalling addon during safemode");

  await AddonTestUtils.promiseShutdownManager();
  await AddonTestUtils.cleanupTempXPIs();
});

// There are more settings modules than used in this test file, they should have been
// loaded during the test extensions uninstall.  Ensure that all settings modules have
// been loaded.
add_task(async function test_settings_modules_loaded() {
  // Test that all settings modules are loaded.
  let modules = Array.from(ExtensionParent.apiManager.settingsModules);
  ok(modules.length, "we have settings modules");
  for (let name of modules) {
    ok(ExtensionParent.apiManager.getModule(name).loaded, `${name} was loaded`);
  }
});