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
|
/* Any copyright is dedicated to the Public Domain.
https://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
const { PreferencesBackupResource } = ChromeUtils.importESModule(
"resource:///modules/backup/PreferencesBackupResource.sys.mjs"
);
/**
* Test that the measure method correctly collects the disk-sizes of things that
* the PreferencesBackupResource is meant to back up.
*/
add_task(async function test_measure() {
Services.fog.testResetFOG();
const EXPECTED_PREFERENCES_KILOBYTES_SIZE = 415;
const tempDir = await IOUtils.createUniqueDirectory(
PathUtils.tempDir,
"PreferencesBackupResource-measure-test"
);
const mockFiles = [
{ path: "prefs.js", sizeInKB: 20 },
{ path: "xulstore.json", sizeInKB: 1 },
{ path: "permissions.sqlite", sizeInKB: 100 },
{ path: "content-prefs.sqlite", sizeInKB: 260 },
{ path: "containers.json", sizeInKB: 1 },
{ path: "handlers.json", sizeInKB: 1 },
{ path: "search.json.mozlz4", sizeInKB: 1 },
{ path: "user.js", sizeInKB: 2 },
{ path: ["chrome", "userChrome.css"], sizeInKB: 5 },
{ path: ["chrome", "userContent.css"], sizeInKB: 5 },
{ path: ["chrome", "css", "mockStyles.css"], sizeInKB: 5 },
];
await createTestFiles(tempDir, mockFiles);
let preferencesBackupResource = new PreferencesBackupResource();
await preferencesBackupResource.measure(tempDir);
let measurement = Glean.browserBackup.preferencesSize.testGetValue();
let scalars = TelemetryTestUtils.getProcessScalars("parent", false, false);
TelemetryTestUtils.assertScalar(
scalars,
"browser.backup.preferences_size",
measurement,
"Glean and telemetry measurements for preferences data should be equal"
);
Assert.equal(
measurement,
EXPECTED_PREFERENCES_KILOBYTES_SIZE,
"Should have collected the correct glean measurement for preferences files"
);
await maybeRemovePath(tempDir);
});
/**
* Test that the backup method correctly copies items from the profile directory
* into the staging directory.
*/
add_task(async function test_backup() {
let sandbox = sinon.createSandbox();
let preferencesBackupResource = new PreferencesBackupResource();
let sourcePath = await IOUtils.createUniqueDirectory(
PathUtils.tempDir,
"PreferencesBackupResource-source-test"
);
let stagingPath = await IOUtils.createUniqueDirectory(
PathUtils.tempDir,
"PreferencesBackupResource-staging-test"
);
const simpleCopyFiles = [
{ path: "xulstore.json" },
{ path: "containers.json" },
{ path: "handlers.json" },
{ path: "search.json.mozlz4" },
{ path: "user.js" },
{ path: ["chrome", "userChrome.css"] },
{ path: ["chrome", "userContent.css"] },
{ path: ["chrome", "childFolder", "someOtherStylesheet.css"] },
];
await createTestFiles(sourcePath, simpleCopyFiles);
// Create our fake database files. We don't expect these to be copied to the
// staging directory in this test due to our stubbing of the backup method, so
// we don't include it in `simpleCopyFiles`.
await createTestFiles(sourcePath, [
{ path: "permissions.sqlite" },
{ path: "content-prefs.sqlite" },
]);
// We have no need to test that Sqlite.sys.mjs's backup method is working -
// this is something that is tested in Sqlite's own tests. We can just make
// sure that it's being called using sinon. Unfortunately, we cannot do the
// same thing with IOUtils.copy, as its methods are not stubbable.
let fakeConnection = {
backup: sandbox.stub().resolves(true),
close: sandbox.stub().resolves(true),
};
sandbox.stub(Sqlite, "openConnection").returns(fakeConnection);
let manifestEntry = await preferencesBackupResource.backup(
stagingPath,
sourcePath
);
Assert.equal(
manifestEntry,
null,
"PreferencesBackupResource.backup should return null as its ManifestEntry"
);
await assertFilesExist(stagingPath, simpleCopyFiles);
// Next, we'll make sure that the Sqlite connection had `backup` called on it
// with the right arguments.
Assert.ok(
fakeConnection.backup.calledTwice,
"Called backup the expected number of times for all connections"
);
Assert.ok(
fakeConnection.backup.firstCall.calledWith(
PathUtils.join(stagingPath, "permissions.sqlite")
),
"Called backup on the permissions.sqlite Sqlite connection"
);
Assert.ok(
fakeConnection.backup.secondCall.calledWith(
PathUtils.join(stagingPath, "content-prefs.sqlite")
),
"Called backup on the content-prefs.sqlite Sqlite connection"
);
// And we'll make sure that preferences were properly written out.
Assert.ok(
await IOUtils.exists(PathUtils.join(stagingPath, "prefs.js")),
"prefs.js should exist in the staging folder"
);
await maybeRemovePath(stagingPath);
await maybeRemovePath(sourcePath);
sandbox.restore();
});
/**
* Test that the recover method correctly copies items from the recovery
* directory into the destination profile directory.
*/
add_task(async function test_recover() {
let preferencesBackupResource = new PreferencesBackupResource();
let recoveryPath = await IOUtils.createUniqueDirectory(
PathUtils.tempDir,
"PreferencesBackupResource-recovery-test"
);
let destProfilePath = await IOUtils.createUniqueDirectory(
PathUtils.tempDir,
"PreferencesBackupResource-test-profile"
);
const simpleCopyFiles = [
{ path: "prefs.js" },
{ path: "xulstore.json" },
{ path: "permissions.sqlite" },
{ path: "content-prefs.sqlite" },
{ path: "containers.json" },
{ path: "handlers.json" },
{ path: "search.json.mozlz4" },
{ path: "user.js" },
{ path: ["chrome", "userChrome.css"] },
{ path: ["chrome", "userContent.css"] },
{ path: ["chrome", "childFolder", "someOtherStylesheet.css"] },
];
await createTestFiles(recoveryPath, simpleCopyFiles);
// The backup method is expected to have returned a null ManifestEntry
let postRecoveryEntry = await preferencesBackupResource.recover(
null /* manifestEntry */,
recoveryPath,
destProfilePath
);
Assert.equal(
postRecoveryEntry,
null,
"PreferencesBackupResource.recover should return null as its post recovery entry"
);
await assertFilesExist(destProfilePath, simpleCopyFiles);
await maybeRemovePath(recoveryPath);
await maybeRemovePath(destProfilePath);
});
|
