Source code
Revision control
Copy as Markdown
Other Tools
Test Info: Warnings
- This test gets skipped with pattern: os != 'win'
- Manifest: browser/components/defaultwindowslaunchonlogin/tests/xpcshell.toml
/* Any copyright is dedicated to the Public Domain.
"use strict";
/* import-globals-from ../../../../testing/xpcshell/head.js */
const { sinon } = ChromeUtils.importESModule(
);
const { AppConstants } = ChromeUtils.importESModule(
"resource://gre/modules/AppConstants.sys.mjs"
);
const {
DefaultWindowsLaunchOnLogin,
DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_NIMBUS_FEATURE_ID,
DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_PREF,
} = ChromeUtils.importESModule(
"resource:///modules/DefaultWindowsLaunchOnLogin.sys.mjs"
);
const { WindowsLaunchOnLogin } = ChromeUtils.importESModule(
"resource://gre/modules/WindowsLaunchOnLogin.sys.mjs"
);
const { NimbusTestUtils } = ChromeUtils.importESModule(
);
const { updateAppInfo } = ChromeUtils.importESModule(
);
const { MockRegistry } = ChromeUtils.importESModule(
);
const CATEGORY_NAME = "browser-before-ui-startup";
const MODULE_URI = "resource:///modules/DefaultWindowsLaunchOnLogin.sys.mjs";
NimbusTestUtils.init(this);
let registry = null;
add_setup(async () => {
// FOG needs a profile
do_get_profile();
registry = new MockRegistry();
// It's expected that these keys exist
registry.setValue(
Ci.nsIWindowsRegKey.ROOT_KEY_CURRENT_USER,
"SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Run",
"",
""
);
registry.setValue(
Ci.nsIWindowsRegKey.ROOT_KEY_CURRENT_USER,
"Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\StartupApproved\\Run",
"",
""
);
Services.fog.initializeFOG();
Services.fog.testResetFOG();
updateAppInfo();
const { cleanup: nimbusTestCleanup } = await NimbusTestUtils.setupTest();
registerCleanupFunction(() => {
nimbusTestCleanup();
registry.shutdown();
});
});
// Runs enableOnFirstRunIfNeeded with the Nimbus wait stubbed out and the
// WindowsLaunchOnLogin side effects stubbed. Sets the defaultEnabled pref to
// prefValue -- in production Nimbus writes that pref via setPref, so driving the
// pref directly exercises the module's decision logic; the Nimbus -> pref
// linkage is covered separately by test_nimbus_enrollment_sets_pref.
async function runWith(isFirstRun, isOfficialBuild, approved, prefValue) {
let sandbox = sinon.createSandbox();
sandbox.stub(DefaultWindowsLaunchOnLogin, "waitForNimbusReady").resolves();
let approvedStub = sandbox
.stub(WindowsLaunchOnLogin, "getLaunchOnLoginApproved")
.resolves(approved);
let createStub = sandbox
.stub(WindowsLaunchOnLogin, "createLaunchOnLogin")
.resolves();
Services.prefs.setBoolPref(DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_PREF, prefValue);
try {
await DefaultWindowsLaunchOnLogin.enableOnFirstRunIfNeeded(
isFirstRun,
isOfficialBuild
);
return { approvedStub, createStub };
} finally {
sandbox.restore();
Services.prefs.clearUserPref(DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_PREF);
}
}
add_task(async function test_is_registered_in_before_ui_startup() {
const entry = Services.catMan.getCategoryEntry(CATEGORY_NAME, MODULE_URI);
Assert.equal(
entry,
"DefaultWindowsLaunchOnLogin.maybeEnableOnFirstRun",
"Entry should point to `maybeEnableOnFirstRun` in `browser-before-ui-startup`"
);
});
add_task(
{
skip_if: () =>
!AppConstants.MOZ_NORMANDY || AppConstants.platform !== "win",
},
async function test_disabled_when_pref_off() {
let { createStub } = await runWith(true, true, true, false);
Assert.ok(
!createStub.called,
"createLaunchOnLogin should not be called when the pref is off"
);
}
);
add_task(
{
skip_if: () =>
!AppConstants.MOZ_NORMANDY || AppConstants.platform !== "win",
},
async function test_enabled_when_pref_on() {
let { createStub } = await runWith(true, true, true, true);
Assert.ok(
createStub.calledOnce,
"createLaunchOnLogin should be called when the pref is on"
);
}
);
// The Nimbus -> pref linkage: enrolling in the feature should write the
// defaultEnabled pref via the setPref mapping in FeatureManifest.yaml.
add_task(
{
skip_if: () =>
!AppConstants.MOZ_NORMANDY || AppConstants.platform !== "win",
},
async function test_nimbus_enrollment_sets_pref() {
let cleanup = await NimbusTestUtils.enrollWithFeatureConfig(
{
featureId: DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_NIMBUS_FEATURE_ID,
value: { enabled: true },
},
{ isRollout: true }
);
Assert.ok(
Services.prefs.getBoolPref(DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_PREF, false),
"enrolling with enabled:true sets the defaultEnabled pref to true"
);
await cleanup();
cleanup = await NimbusTestUtils.enrollWithFeatureConfig(
{
featureId: DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_NIMBUS_FEATURE_ID,
value: { enabled: false },
},
{ isRollout: true }
);
Assert.ok(
!Services.prefs.getBoolPref(DEFAULT_WINDOWS_LAUNCH_ON_LOGIN_PREF, true),
"enrolling with enabled:false sets the defaultEnabled pref to false"
);
await cleanup();
}
);
add_task(async function test_skips_when_not_first_run() {
let { createStub } = await runWith(false, true, true, true);
Assert.ok(
!createStub.called,
"createLaunchOnLogin should not be called when isFirstRun is false"
);
});
add_task(async function test_skips_on_unofficial_build() {
let { createStub } = await runWith(true, false, true, true);
Assert.ok(
!createStub.called,
"createLaunchOnLogin should not be called on developer builds"
);
});
add_task(
{
skip_if: () =>
!AppConstants.MOZ_NORMANDY || AppConstants.platform !== "win",
},
async function test_skips_when_windows_policy_denies() {
let { createStub, approvedStub } = await runWith(true, true, false, true);
Assert.ok(
approvedStub.calledOnce,
"policy approval should be consulted when first run and the pref is on"
);
Assert.ok(
!createStub.called,
"createLaunchOnLogin should not be called when Windows policy denies"
);
}
);