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
|
/* 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 https://mozilla.org/MPL/2.0/. */
"use strict";
const { BackupService } = ChromeUtils.importESModule(
"resource:///modules/backup/BackupService.sys.mjs"
);
const { BackupResource } = ChromeUtils.importESModule(
"resource:///modules/backup/BackupResource.sys.mjs"
);
const { TelemetryTestUtils } = ChromeUtils.importESModule(
"resource://testing-common/TelemetryTestUtils.sys.mjs"
);
const { Sqlite } = ChromeUtils.importESModule(
"resource://gre/modules/Sqlite.sys.mjs"
);
const { sinon } = ChromeUtils.importESModule(
"resource://testing-common/Sinon.sys.mjs"
);
const BYTES_IN_KB = 1000;
do_get_profile();
/**
* Some fake backup resource classes to test with.
*/
class FakeBackupResource1 extends BackupResource {
static get key() {
return "fake1";
}
static get requiresEncryption() {
return false;
}
}
/**
* Another fake backup resource class to test with.
*/
class FakeBackupResource2 extends BackupResource {
static get key() {
return "fake2";
}
static get requiresEncryption() {
return true;
}
}
/**
* Yet another fake backup resource class to test with.
*/
class FakeBackupResource3 extends BackupResource {
static get key() {
return "fake3";
}
static get requiresEncryption() {
return false;
}
}
/**
* Create a file of a given size in kilobytes.
*
* @param {string} path the path where the file will be created.
* @param {number} sizeInKB size file in Kilobytes.
* @returns {Promise<undefined>}
*/
async function createKilobyteSizedFile(path, sizeInKB) {
let bytes = new Uint8Array(sizeInKB * BYTES_IN_KB);
await IOUtils.write(path, bytes);
}
/**
* @typedef {object} TestFileObject
* @property {(string|Array.<string>)} path
* The relative path of the file. It can be a string or an array of strings
* in the event that directories need to be created. For example, this is
* an array of valid TestFileObjects.
*
* [
* { path: "file1.txt" },
* { path: ["dir1", "file2.txt"] },
* { path: ["dir2", "dir3", "file3.txt"], sizeInKB: 25 },
* { path: "file4.txt" },
* ]
*
* @property {number} [sizeInKB=10]
* The size of the created file in kilobytes. Defaults to 10.
*/
/**
* Easily creates a series of test files and directories under parentPath.
*
* @param {string} parentPath
* The path to the parent directory where the files will be created.
* @param {TestFileObject[]} testFilesArray
* An array of TestFileObjects describing what test files to create within
* the parentPath.
* @see TestFileObject
* @returns {Promise<undefined>}
*/
async function createTestFiles(parentPath, testFilesArray) {
for (let { path, sizeInKB } of testFilesArray) {
if (Array.isArray(path)) {
// Make a copy of the array of path elements, chopping off the last one.
// We'll assume the unchopped items are directories, and make sure they
// exist first.
let folders = path.slice(0, -1);
await IOUtils.getDirectory(PathUtils.join(parentPath, ...folders));
}
if (sizeInKB === undefined) {
sizeInKB = 10;
}
// This little piece of cleverness coerces a string into an array of one
// if path is a string, or just leaves it alone if it's already an array.
let filePath = PathUtils.join(parentPath, ...[].concat(path));
await createKilobyteSizedFile(filePath, sizeInKB);
}
}
/**
* Checks that files exist within a particular folder. The filesize is not
* checked.
*
* @param {string} parentPath
* The path to the parent directory where the files should exist.
* @param {TestFileObject[]} testFilesArray
* An array of TestFileObjects describing what test files to search for within
* parentPath.
* @see TestFileObject
* @returns {Promise<undefined>}
*/
async function assertFilesExist(parentPath, testFilesArray) {
for (let { path } of testFilesArray) {
let copiedFileName = PathUtils.join(parentPath, ...[].concat(path));
Assert.ok(
await IOUtils.exists(copiedFileName),
`${copiedFileName} should exist in the staging folder`
);
}
}
/**
* Remove a file or directory at a path if it exists and files are unlocked.
*
* @param {string} path path to remove.
*/
async function maybeRemovePath(path) {
try {
await IOUtils.remove(path, { ignoreAbsent: true, recursive: true });
} catch (error) {
// Sometimes remove() throws when the file is not unlocked soon
// enough.
if (error.name != "NS_ERROR_FILE_IS_LOCKED") {
// Ignoring any errors, as the temp folder will be cleaned up.
console.error(error);
}
}
}
|
