Source code
Revision control
Copy as Markdown
Other Tools
Test Info: Warnings
- This test gets skipped with pattern: os == 'android'
- Manifest: toolkit/components/search/tests/xpcshell/xpcshell.toml
/* Any copyright is dedicated to the Public Domain.
"use strict";
SearchTestUtils.initXPCShellAddonManager(this, "system");
async function restart() {
Services.search.wrappedJSObject.reset();
await AddonTestUtils.promiseRestartManager();
await Services.search.init(false);
}
const CONFIG_DEFAULT = [
{
webExtension: { id: "plainengine@search.mozilla.org" },
appliesTo: [{ included: { everywhere: true } }],
},
];
const CONFIG_UPDATED = [
{
webExtension: { id: "plainengine@search.mozilla.org" },
appliesTo: [{ included: { everywhere: true } }],
},
{
webExtension: { id: "example@search.mozilla.org" },
appliesTo: [{ included: { everywhere: true } }],
},
];
async function getEngineNames() {
let engines = await Services.search.getAppProvidedEngines();
return engines.map(engine => engine._name);
}
add_setup(
{ skip_if: () => SearchUtils.newSearchConfigEnabled },
async function () {
await SearchTestUtils.useTestEngines(
"test-extensions",
null,
CONFIG_DEFAULT
);
await AddonTestUtils.promiseStartupManager();
registerCleanupFunction(AddonTestUtils.promiseShutdownManager);
SearchTestUtils.useMockIdleService();
await Services.search.init();
}
);
// Test the situation where we receive an updated configuration
// that references an engine that doesnt exist locally as it
// will be installed by Normandy.
add_task(
{ skip_if: () => SearchUtils.newSearchConfigEnabled },
async function test_config_before_normandy() {
// Ensure initial default setup.
await SearchTestUtils.updateRemoteSettingsConfig(CONFIG_DEFAULT);
await restart();
Assert.deepEqual(await getEngineNames(), ["Plain"]);
// Updated configuration references nonexistant engine.
await SearchTestUtils.updateRemoteSettingsConfig(CONFIG_UPDATED);
Assert.deepEqual(
await getEngineNames(),
["Plain"],
"Updated engine hasnt been installed yet"
);
// Normandy then installs the engine.
let addon = await SearchTestUtils.installSystemSearchExtension();
Assert.deepEqual(
await getEngineNames(),
["Plain", "Example"],
"Both engines are now enabled"
);
await addon.unload();
}
);
// Test the situation where we receive a newly installed
// engine from Normandy followed by the update to the
// configuration that uses that engine.
add_task(
{ skip_if: () => SearchUtils.newSearchConfigEnabled },
async function test_normandy_before_config() {
// Ensure initial default setup.
await SearchTestUtils.updateRemoteSettingsConfig(CONFIG_DEFAULT);
await restart();
Assert.deepEqual(await getEngineNames(), ["Plain"]);
// Normandy installs the enigne.
let addon = await SearchTestUtils.installSystemSearchExtension();
Assert.deepEqual(
await getEngineNames(),
["Plain"],
"Normandy engine ignored as not in config yet"
);
// Configuration is updated to use the engine.
await SearchTestUtils.updateRemoteSettingsConfig(CONFIG_UPDATED);
Assert.deepEqual(
await getEngineNames(),
["Plain", "Example"],
"Both engines are now enabled"
);
await addon.unload();
}
);