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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/* 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";
ChromeUtils.import("resource://normandy/lib/AddonStudies.jsm", this);
ChromeUtils.import("resource://normandy/lib/NormandyUtils.jsm", this);
ChromeUtils.import("resource://normandy/lib/RecipeRunner.jsm", this);
const FIXTURE_ADDON_ID = "normandydriver-a@example.com";
const UUID_REGEX = /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/i;
var EXPORTED_SYMBOLS = ["NormandyTestUtils"];
// Factory IDs
let _addonStudyFactoryId = 0;
let _preferenceStudyFactoryId = 0;
let testGlobals = {};
const NormandyTestUtils = {
init({ add_task } = {}) {
testGlobals.add_task = add_task;
},
factories: {
addonStudyFactory(attrs = {}) {
for (const key of ["name", "description"]) {
if (attrs && attrs[key]) {
throw new Error(
`${key} is no longer a valid key for addon studies, please update to v2 study schema`
);
}
}
return Object.assign(
{
recipeId: _addonStudyFactoryId++,
slug: "test-study",
userFacingName: "Test study",
userFacingDescription: "test description",
branch: AddonStudies.NO_BRANCHES_MARKER,
active: true,
addonId: FIXTURE_ADDON_ID,
addonUrl: "http://test/addon.xpi",
addonVersion: "1.0.0",
studyStartDate: new Date(),
studyEndDate: null,
extensionApiId: 1,
extensionHash:
"ade1c14196ec4fe0aa0a6ba40ac433d7c8d1ec985581a8a94d43dc58991b5171",
extensionHashAlgorithm: "sha256",
enrollmentId: NormandyUtils.generateUuid(),
temporaryErrorDeadline: null,
},
attrs
);
},
branchedAddonStudyFactory(attrs = {}) {
return NormandyTestUtils.factories.addonStudyFactory(
Object.assign(
{
branch: "a",
},
attrs
)
);
},
preferenceStudyFactory(attrs = {}) {
const defaultPref = {
"test.study": {},
};
const defaultPrefInfo = {
preferenceValue: false,
preferenceType: "boolean",
previousPreferenceValue: undefined,
preferenceBranchType: "default",
};
const preferences = {};
for (const [prefName, prefInfo] of Object.entries(
attrs.preferences || defaultPref
)) {
preferences[prefName] = { ...defaultPrefInfo, ...prefInfo };
}
// Generate a slug from userFacingName
let {
userFacingName = `Test study ${_preferenceStudyFactoryId++}`,
slug,
} = attrs;
delete attrs.slug;
if (userFacingName && !slug) {
slug = userFacingName.replace(" ", "-").toLowerCase();
}
return Object.assign(
{
userFacingName,
userFacingDescription: `${userFacingName} description`,
slug,
branch: "control",
expired: false,
lastSeen: new Date().toJSON(),
experimentType: "exp",
enrollmentId: NormandyUtils.generateUuid(),
actionName: "PreferenceExperimentAction",
},
attrs,
{
preferences,
}
);
},
},
/**
* Combine a list of functions right to left. The rightmost function is passed
* to the preceding function as the argument; the result of this is passed to
* the next function until all are exhausted. For example, this:
*
* decorate(func1, func2, func3);
*
* is equivalent to this:
*
* func1(func2(func3));
*/
decorate(...args) {
const funcs = Array.from(args);
let decorated = funcs.pop();
const origName = decorated.name;
funcs.reverse();
for (const func of funcs) {
decorated = func(decorated);
}
Object.defineProperty(decorated, "name", { value: origName });
return decorated;
},
/**
* Wrapper around add_task for declaring tests that use several with-style
* wrappers. The last argument should be your test function; all other arguments
* should be functions that accept a single test function argument.
*
* The arguments are combined using decorate and passed to add_task as a single
* test function.
*
* @param {[Function]} args
* @example
* decorate_task(
* withMockPreferences,
* withMockNormandyApi,
* async function myTest(mockPreferences, mockApi) {
* // Do a test
* }
* );
*/
decorate_task(...args) {
return testGlobals.add_task(NormandyTestUtils.decorate(...args));
},
isUuid(s) {
return UUID_REGEX.test(s);
},
withMockRecipeCollection(recipes = []) {
return function wrapper(testFunc) {
return async function inner(...args) {
let recipeIds = new Set();
for (const recipe of recipes) {
if (!recipe.id || recipeIds.has(recipe.id)) {
throw new Error(
"To use withMockRecipeCollection, each recipe must have a unique ID"
);
}
recipeIds.add(recipe.id);
}
let db = await RecipeRunner._remoteSettingsClientForTesting.db;
await db.clear();
const fakeSig = { signature: "abc" };
for (const recipe of recipes) {
await db.create({
id: `recipe-${recipe.id}`,
recipe,
signature: fakeSig,
});
}
// last modified needs to be some positive integer
let lastModified = await db.getLastModified();
await db.importChanges({}, lastModified + 1);
const collectionHelper = {
async addRecipes(newRecipes) {
for (const recipe of newRecipes) {
if (!recipe.id || recipeIds.has(recipe)) {
throw new Error(
"To use withMockRecipeCollection, each recipe must have a unique ID"
);
}
}
db = await RecipeRunner._remoteSettingsClientForTesting.db;
for (const recipe of newRecipes) {
recipeIds.add(recipe.id);
await db.create({
id: `recipe-${recipe.id}`,
recipe,
signature: fakeSig,
});
}
lastModified = (await db.getLastModified()) || 0;
await db.importChanges({}, lastModified + 1);
},
};
try {
await testFunc(...args, collectionHelper);
} finally {
db = await RecipeRunner._remoteSettingsClientForTesting.db;
await db.clear();
lastModified = await db.getLastModified();
await db.importChanges({}, lastModified + 1);
}
};
};
},
};
|
