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
|
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/ */
/*
* Tests that Enterprise Policy Engines can be installed correctly.
*/
"use strict";
const { EnterprisePolicyTesting } = ChromeUtils.importESModule(
"resource://testing-common/EnterprisePolicyTesting.sys.mjs"
);
SearchSettings.SETTINGS_INVALIDATION_DELAY = 100;
/**
* Loads a new enterprise policy, and re-initialise the search service
* with the new policy. Also waits for the search service to write the settings
* file to disk.
*
* @param {object} policy
* The enterprise policy to use.
*/
async function setupPolicyEngineWithJson(policy) {
Services.search.wrappedJSObject.reset();
await EnterprisePolicyTesting.setupPolicyEngineWithJson(policy);
let settingsWritten = SearchTestUtils.promiseSearchNotification(
"write-settings-to-disk-complete"
);
await Services.search.init();
await settingsWritten;
}
add_setup(async function () {
// This initializes the policy engine for xpcshell tests
let policies = Cc["@mozilla.org/enterprisepolicies;1"].getService(
Ci.nsIObserver
);
policies.observe(null, "policies-startup", null);
Services.fog.initializeFOG();
await AddonTestUtils.promiseStartupManager();
await SearchTestUtils.useTestEngines();
SearchUtils.GENERAL_SEARCH_ENGINE_IDS = new Set([
"engine-resourceicon@search.mozilla.org",
]);
});
add_task(async function test_enterprise_policy_engine() {
await setupPolicyEngineWithJson({
policies: {
SearchEngines: {
Add: [
{
Name: "policy",
Description: "Test policy engine",
IconURL: "data:image/gif;base64,R0lGODl",
Alias: "p",
URLTemplate: "https://example.com?q={searchTerms}",
SuggestURLTemplate: "https://example.com/suggest/?q={searchTerms}",
},
],
},
},
});
let engine = Services.search.getEngineByName("policy");
Assert.ok(engine, "Should have installed the engine.");
Assert.equal(engine.name, "policy", "Should have the correct name");
Assert.equal(
engine.description,
"Test policy engine",
"Should have a description"
);
Assert.deepEqual(engine.aliases, ["p"], "Should have the correct alias");
let submission = engine.getSubmission("foo");
Assert.equal(
submission.uri.spec,
"https://example.com/?q=foo",
"Should have the correct search url"
);
submission = engine.getSubmission("foo", SearchUtils.URL_TYPE.SUGGEST_JSON);
Assert.equal(
submission.uri.spec,
"https://example.com/suggest/?q=foo",
"Should have the correct suggest url"
);
Services.search.defaultEngine = engine;
await assertGleanDefaultEngine({
normal: {
engineId: "other-policy",
displayName: "policy",
loadPath: "[policy]",
submissionUrl: "blank:",
verified: "verified",
},
});
});
add_task(async function test_enterprise_policy_engine_hidden_persisted() {
// Set the engine alias, and wait for the settings to be written.
let settingsWritten = SearchTestUtils.promiseSearchNotification(
"write-settings-to-disk-complete"
);
let engine = Services.search.getEngineByName("policy");
engine.hidden = "p1";
engine.alias = "p1";
await settingsWritten;
// This will reset and re-initialise the search service.
await setupPolicyEngineWithJson({
policies: {
SearchEngines: {
Add: [
{
Name: "policy",
Description: "Test policy engine",
IconURL: "data:image/gif;base64,R0lGODl",
Alias: "p",
URLTemplate: "https://example.com?q={searchTerms}",
SuggestURLTemplate: "https://example.com/suggest/?q={searchTerms}",
},
],
},
},
});
engine = Services.search.getEngineByName("policy");
Assert.equal(engine.alias, "p1", "Should have retained the engine alias");
Assert.ok(engine.hidden, "Should have kept the engine hidden");
});
add_task(async function test_enterprise_policy_engine_remove() {
// This will reset and re-initialise the search service.
await setupPolicyEngineWithJson({
policies: {},
});
Assert.ok(
!Services.search.getEngineByName("policy"),
"Should not have the policy engine installed"
);
let settings = await promiseSettingsData();
Assert.ok(
!settings.engines.find(e => e.name == "p1"),
"Should not have the engine settings stored"
);
});
add_task(async function test_enterprise_policy_hidden_default() {
await setupPolicyEngineWithJson({
policies: {
SearchEngines: {
Remove: ["Test search engine"],
},
},
});
Services.search.resetToAppDefaultEngine();
Assert.equal(Services.search.defaultEngine.name, "engine-resourceicon");
});
add_task(async function test_enterprise_policy_default() {
await setupPolicyEngineWithJson({
policies: {
SearchEngines: {
Default: "engine-pref",
},
},
});
Services.search.resetToAppDefaultEngine();
Assert.equal(Services.search.defaultEngine.name, "engine-pref");
});
|
