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
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
const { Preferences } = ChromeUtils.import(
"resource://gre/modules/Preferences.jsm"
);
const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
const { OS } = ChromeUtils.import("resource://gre/modules/osfile.jsm");
const { Assert } = ChromeUtils.import("resource://testing-common/Assert.jsm");
ChromeUtils.defineModuleGetter(
this,
"FileTestUtils",
"resource://testing-common/FileTestUtils.jsm"
);
var EXPORTED_SYMBOLS = ["EnterprisePolicyTesting", "PoliciesPrefTracker"];
var EnterprisePolicyTesting = {
// |json| must be an object representing the desired policy configuration, OR a
// path to the JSON file containing the policy configuration.
setupPolicyEngineWithJson: async function setupPolicyEngineWithJson(
json,
customSchema
) {
let filePath;
if (typeof json == "object") {
filePath = FileTestUtils.getTempFile("policies.json").path;
// This file gets automatically deleted by FileTestUtils
// at the end of the test run.
await OS.File.writeAtomic(filePath, JSON.stringify(json), {
encoding: "utf-8",
});
} else {
filePath = json;
}
Services.prefs.setStringPref("browser.policies.alternatePath", filePath);
let promise = new Promise(resolve => {
Services.obs.addObserver(function observer() {
Services.obs.removeObserver(
observer,
"EnterprisePolicies:AllPoliciesApplied"
);
resolve();
}, "EnterprisePolicies:AllPoliciesApplied");
});
// Clear any previously used custom schema
Cu.unload("resource:///modules/policies/schema.jsm");
if (customSchema) {
let schemaModule = ChromeUtils.import(
"resource:///modules/policies/schema.jsm",
null
);
schemaModule.schema = customSchema;
}
Services.obs.notifyObservers(null, "EnterprisePolicies:Restart");
return promise;
},
checkPolicyPref(prefName, expectedValue, expectedLockedness) {
if (expectedLockedness !== undefined) {
Assert.equal(
Preferences.locked(prefName),
expectedLockedness,
`Pref ${prefName} is correctly locked/unlocked`
);
}
Assert.equal(
Preferences.get(prefName),
expectedValue,
`Pref ${prefName} has the correct value`
);
},
resetRunOnceState: function resetRunOnceState() {
const runOnceBaseKeys = [
"browser.policies.runonce.",
"browser.policies.runOncePerModification.",
];
for (let base of runOnceBaseKeys) {
for (let key of Services.prefs.getChildList(base)) {
if (Services.prefs.prefHasUserValue(key)) {
Services.prefs.clearUserPref(key);
}
}
}
},
};
/**
* This helper will track prefs that have been changed
* by the policy engine through the setAndLockPref and
* setDefaultPref APIs (from Policies.jsm) and make sure
* that they are restored to their original values when
* the test ends or another test case restarts the engine.
*/
var PoliciesPrefTracker = {
_originalFunc: null,
_originalValues: new Map(),
start() {
let PoliciesBackstage = ChromeUtils.import(
"resource:///modules/policies/Policies.jsm",
null
);
this._originalFunc = PoliciesBackstage.setDefaultPref;
PoliciesBackstage.setDefaultPref = this.hoistedSetDefaultPref.bind(this);
},
stop() {
this.restoreDefaultValues();
let PoliciesBackstage = ChromeUtils.import(
"resource:///modules/policies/Policies.jsm",
null
);
PoliciesBackstage.setDefaultPref = this._originalFunc;
this._originalFunc = null;
},
hoistedSetDefaultPref(prefName, prefValue, locked = false) {
// If this pref is seen multiple times, the very first
// value seen is the one that is actually the default.
if (!this._originalValues.has(prefName)) {
let defaults = new Preferences({ defaultBranch: true });
let stored = {};
if (defaults.has(prefName)) {
stored.originalDefaultValue = defaults.get(prefName);
} else {
stored.originalDefaultValue = undefined;
}
if (
Preferences.isSet(prefName) &&
Preferences.get(prefName) == prefValue
) {
// If a user value exists, and we're changing the default
// value to be th same as the user value, that will cause
// the user value to be dropped. In that case, let's also
// store it to ensure that we restore everything correctly.
stored.originalUserValue = Preferences.get(prefName);
}
this._originalValues.set(prefName, stored);
}
// Now that we've stored the original values, call the
// original setDefaultPref function.
this._originalFunc(prefName, prefValue, locked);
},
restoreDefaultValues() {
let defaults = new Preferences({ defaultBranch: true });
for (let [prefName, stored] of this._originalValues) {
// If a pref was used through setDefaultPref instead
// of setAndLockPref, it wasn't locked, but calling
// unlockPref is harmless
Preferences.unlock(prefName);
if (stored.originalDefaultValue !== undefined) {
defaults.set(prefName, stored.originalDefaultValue);
} else {
Services.prefs.getDefaultBranch("").deleteBranch(prefName);
}
if (stored.originalUserValue !== undefined) {
Preferences.set(prefName, stored.originalUserValue);
}
}
this._originalValues.clear();
},
};
|
