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
|
/* Any copyright is dedicated to the Public Domain.
https://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
const { CookiesBackupResource } = ChromeUtils.importESModule(
"resource:///modules/backup/CookiesBackupResource.sys.mjs"
);
/**
* Tests that we can measure the Cookies db in a profile directory.
*/
add_task(async function test_measure() {
const EXPECTED_COOKIES_DB_SIZE = 1230;
Services.fog.testResetFOG();
// Create resource files in temporary directory
let tempDir = PathUtils.tempDir;
let tempCookiesDBPath = PathUtils.join(tempDir, "cookies.sqlite");
await createKilobyteSizedFile(tempCookiesDBPath, EXPECTED_COOKIES_DB_SIZE);
let cookiesBackupResource = new CookiesBackupResource();
await cookiesBackupResource.measure(tempDir);
let cookiesMeasurement = Glean.browserBackup.cookiesSize.testGetValue();
let scalars = TelemetryTestUtils.getProcessScalars("parent", false, false);
// Compare glean vs telemetry measurements
TelemetryTestUtils.assertScalar(
scalars,
"browser.backup.cookies_size",
cookiesMeasurement,
"Glean and telemetry measurements for cookies.sqlite should be equal"
);
// Compare glean measurements vs actual file sizes
Assert.equal(
cookiesMeasurement,
EXPECTED_COOKIES_DB_SIZE,
"Should have collected the correct glean measurement for cookies.sqlite"
);
await maybeRemovePath(tempCookiesDBPath);
});
/**
* 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 cookiesBackupResource = new CookiesBackupResource();
let sourcePath = await IOUtils.createUniqueDirectory(
PathUtils.tempDir,
"CookiesBackupResource-source-test"
);
let stagingPath = await IOUtils.createUniqueDirectory(
PathUtils.tempDir,
"CookiesBackupResource-staging-test"
);
// Make sure this file exists in the source directory, otherwise
// BackupResource will skip attempting to back it up.
await createTestFiles(sourcePath, [{ path: "cookies.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 cookiesBackupResource.backup(
stagingPath,
sourcePath
);
Assert.equal(
manifestEntry,
null,
"CookiesBackupResource.backup should return null as its ManifestEntry"
);
// Next, we'll make sure that the Sqlite connection had `backup` called on it
// with the right arguments.
Assert.ok(
fakeConnection.backup.calledOnce,
"Called backup the expected number of times for all connections"
);
Assert.ok(
fakeConnection.backup.calledWith(
PathUtils.join(stagingPath, "cookies.sqlite")
),
"Called backup on the cookies.sqlite Sqlite connection"
);
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 cookiesBackupResource = new CookiesBackupResource();
let recoveryPath = await IOUtils.createUniqueDirectory(
PathUtils.tempDir,
"CookiesBackupResource-recovery-test"
);
let destProfilePath = await IOUtils.createUniqueDirectory(
PathUtils.tempDir,
"CookiesBackupResource-test-profile"
);
const simpleCopyFiles = [{ path: "cookies.sqlite" }];
await createTestFiles(recoveryPath, simpleCopyFiles);
// The backup method is expected to have returned a null ManifestEntry
let postRecoveryEntry = await cookiesBackupResource.recover(
null /* manifestEntry */,
recoveryPath,
destProfilePath
);
Assert.equal(
postRecoveryEntry,
null,
"CookiesBackupResource.recover should return null as its post " +
"recovery entry"
);
await assertFilesExist(destProfilePath, simpleCopyFiles);
await maybeRemovePath(recoveryPath);
await maybeRemovePath(destProfilePath);
});
|