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
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
const { FileMigratorBase } = ChromeUtils.importESModule(
"resource:///modules/FileMigrators.sys.mjs"
);
const DUMMY_FILEMIGRATOR_KEY = "dummy-file-migrator";
const DUMMY_FILEPICKER_TITLE = "Some dummy file picker title";
const DUMMY_FILTER_TITLE = "Some file type";
const DUMMY_EXTENSION_PATTERN = "*.test";
const TEST_FILE_PATH = getTestFilePath("dummy_file.csv");
/**
* A subclass of FileMigratorBase that doesn't do anything, but
* is useful for testing.
*
* Notably, the `migrate` method is not overridden here. Tests that
* use this class should use Sinon to stub out the migrate method.
*/
class DummyFileMigrator extends FileMigratorBase {
static get key() {
return DUMMY_FILEMIGRATOR_KEY;
}
static get displayNameL10nID() {
return "migration-wizard-migrator-display-name-file-password-csv";
}
static get brandImage() {
return "chrome://branding/content/document.ico";
}
get enabled() {
return true;
}
get progressHeaderL10nID() {
return "migration-passwords-from-file-progress-header";
}
get successHeaderL10nID() {
return "migration-passwords-from-file-success-header";
}
async getFilePickerConfig() {
return Promise.resolve({
title: DUMMY_FILEPICKER_TITLE,
filters: [
{
title: DUMMY_FILTER_TITLE,
extensionPattern: DUMMY_EXTENSION_PATTERN,
},
],
});
}
get displayedResourceTypes() {
return [MigrationWizardConstants.DISPLAYED_RESOURCE_TYPES.PASSWORDS];
}
}
/**
* Tests the flow of selecting a file migrator (in this case,
* the DummyFileMigrator), getting the file picker opened for it,
* and then passing the path of the selected file to the migrator.
*/
add_task(async function test_file_migration() {
let migrator = new DummyFileMigrator();
let sandbox = sinon.createSandbox();
registerCleanupFunction(() => {
sandbox.restore();
});
// First, use Sinon to insert our DummyFileMigrator as the only available
// file migrator.
sandbox.stub(MigrationUtils, "getFileMigrator").callsFake(() => {
return migrator;
});
sandbox.stub(MigrationUtils, "availableFileMigrators").get(() => {
return [migrator];
});
// This is the expected success state that our DummyFileMigrator will
// return as the final progress update to the migration wizard.
const SUCCESS_STATE = {
[MigrationWizardConstants.DISPLAYED_FILE_RESOURCE_TYPES.PASSWORDS_NEW]:
"2 added",
[MigrationWizardConstants.DISPLAYED_FILE_RESOURCE_TYPES.PASSWORDS_UPDATED]:
"1 updated",
};
let migrateStub = sandbox.stub(migrator, "migrate").callsFake(filePath => {
Assert.equal(filePath, TEST_FILE_PATH);
return SUCCESS_STATE;
});
// We use MockFilePicker to simulate a native file picker, and prepare it
// to return a dummy file pointed at TEST_FILE_PATH. The file at
// TEST_FILE_PATH is not required (nor expected) to exist.
const { MockFilePicker } = SpecialPowers;
MockFilePicker.init(window);
registerCleanupFunction(() => {
MockFilePicker.cleanup();
});
let dummyFile = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsIFile);
dummyFile.initWithPath(TEST_FILE_PATH);
let filePickerShownPromise = new Promise(resolve => {
MockFilePicker.showCallback = () => {
Assert.ok(true, "Filepicker shown.");
MockFilePicker.setFiles([dummyFile]);
resolve();
};
});
MockFilePicker.returnValue = MockFilePicker.returnOK;
await withMigrationWizardDialog(async prefsWin => {
let dialogBody = prefsWin.document.body;
let wizard = dialogBody.querySelector("migration-wizard");
let shadow = wizard.openOrClosedShadowRoot;
let wizardDone = BrowserTestUtils.waitForEvent(
wizard,
"MigrationWizard:DoneMigration"
);
// Now select our DummyFileMigrator from the list.
let selector = shadow.querySelector("#browser-profile-selector");
selector.click();
info("Waiting for panel-list shown");
await new Promise(resolve => {
wizard
.querySelector("panel-list")
.addEventListener("shown", resolve, { once: true });
});
info("Panel list shown. Clicking on panel-item");
let panelItem = wizard.querySelector(
`panel-item[key="${DUMMY_FILEMIGRATOR_KEY}"]`
);
panelItem.click();
// Selecting a file migrator from the selector should automatically
// open the file picker, so we await it here. Once the file is
// selected, migration should begin immediately.
info("Waiting for file picker");
await filePickerShownPromise;
await wizardDone;
Assert.ok(migrateStub.called, "Migrate on DummyFileMigrator was called.");
// At this point, with migration having completed, we should be showing
// the PROGRESS page with the SUCCESS_STATE represented.
let deck = shadow.querySelector("#wizard-deck");
Assert.equal(
deck.selectedViewName,
`page-${MigrationWizardConstants.PAGES.FILE_IMPORT_PROGRESS}`
);
// We expect only the displayed resource types in SUCCESS_STATE are
// displayed now.
let progressGroups = shadow.querySelectorAll(
"div[name='page-page-file-import-progress'] .resource-progress-group"
);
for (let progressGroup of progressGroups) {
let expectedSuccessText =
SUCCESS_STATE[progressGroup.dataset.resourceType];
if (expectedSuccessText) {
let successText =
progressGroup.querySelector(".success-text").textContent;
Assert.equal(successText, expectedSuccessText);
} else {
Assert.ok(
BrowserTestUtils.is_hidden(progressGroup),
`Resource progress group for ${progressGroup.dataset.resourceType}` +
` should be hidden.`
);
}
}
});
});
|
