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
|
/* 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";
const EXPORTED_SYMBOLS = [
"assert_messages_in_search_view",
"assert_search_window_folder_displayed",
"close_search_window",
"open_search_window",
"open_search_window_from_context_menu",
"select_click_search_row",
"select_shift_click_search_row",
];
var { get_about_3pane, mc, right_click_on_folder } = ChromeUtils.import(
"resource://testing-common/mozmill/FolderDisplayHelpers.jsm"
);
var windowHelper = ChromeUtils.import(
"resource://testing-common/mozmill/WindowHelpers.jsm"
);
var { Assert } = ChromeUtils.importESModule(
"resource://testing-common/Assert.sys.mjs"
);
var EventUtils = ChromeUtils.import(
"resource://testing-common/mozmill/EventUtils.jsm"
);
var utils = ChromeUtils.import("resource://testing-common/mozmill/utils.jsm");
/**
* Open a search window using the accel-shift-f shortcut.
*
* @returns the controller for the search window
*/
function open_search_window() {
windowHelper.plan_for_new_window("mailnews:search");
EventUtils.synthesizeKey("f", { shiftKey: true, accelKey: true }, mc.window);
return windowHelper.wait_for_new_window("mailnews:search");
}
/**
* Open a search window as if from the context menu. This needs the context menu
* to be already open.
*
* @param aFolder the folder to open the search window for
* @returns the controller for the search window
*/
async function open_search_window_from_context_menu(aFolder) {
let win = get_about_3pane();
let context = win.document.getElementById("folderPaneContext");
let item = win.document.getElementById("folderPaneContext-searchMessages");
await right_click_on_folder(aFolder);
windowHelper.plan_for_new_window("mailnews:search");
context.activateItem(item);
return windowHelper.wait_for_new_window("mailnews:search");
}
/**
* Close a search window by calling window.close() on the controller.
*/
function close_search_window(aController) {
windowHelper.close_window(aController);
}
/**
* Assert that the given folder is selected in the search window corresponding
* to the given controller.
*/
function assert_search_window_folder_displayed(aController, aFolder) {
let currentFolder = aController.window.gCurrentFolder;
Assert.equal(
currentFolder,
aFolder,
"The search window's selected folder should have been: " +
aFolder.prettyName +
", but is actually: " +
currentFolder?.prettyName
);
}
/**
* Pretend we are clicking on a row with our mouse.
*
* @param {number} aViewIndex - The view index to click.
* @param {MozMillController} aController - The controller in whose context to
* do this.
* @returns {nsIMsgDBHdr} The message header selected.
*/
function select_click_search_row(aViewIndex, aController) {
if (aController == null) {
aController = mc;
}
let tree = aController.window.document.getElementById("threadTree");
tree.scrollToRow(aViewIndex);
let coords = tree.getCoordsForCellItem(
aViewIndex,
tree.columns.subjectCol,
"cell"
);
let treeChildren = tree.lastElementChild;
EventUtils.synthesizeMouse(
treeChildren,
coords.x + coords.width / 2,
coords.y + coords.height / 2,
{},
aController.window
);
return aController.window.gFolderDisplay.view.dbView.getMsgHdrAt(aViewIndex);
}
/**
* Pretend we are clicking on a row with our mouse with the shift key pressed,
* adding all the messages between the shift pivot and the shift selected row.
*
* @param {number} aViewIndex - The view index to click.
* @param {MozMillController} aController The controller in whose context to
* do this.
* @returns {nsIMsgDBHdr[]} The message headers for all messages that are now
* selected.
*/
function select_shift_click_search_row(aViewIndex, aController) {
if (aController == null) {
aController = mc;
}
let tree = aController.window.document.getElementById("threadTree");
tree.scrollToRow(aViewIndex);
let coords = tree.getCoordsForCellItem(
aViewIndex,
tree.columns.subjectCol,
"cell"
);
let treeChildren = tree.lastElementChild;
EventUtils.synthesizeMouse(
treeChildren,
coords.x + coords.width / 2,
coords.y + coords.height / 2,
{ shiftKey: true },
aController.window
);
utils.sleep(0);
return aController.window.gFolderDisplay.selectedMessages;
}
/**
* Assert that the given synthetic message sets are present in the folder
* display.
*
* Verify that the messages in the provided SyntheticMessageSets are the only
* visible messages in the provided DBViewWrapper.
*
* @param {SyntheticMessageSet} aSynSets - Either a single SyntheticMessageSet
* or a list of them.
* @param {MozMillController} aController - The controller which we get the
* folderDisplay property from.
*/
function assert_messages_in_search_view(aSynSets, aController) {
if (aController == null) {
aController = mc;
}
if (!Array.isArray(aSynSets)) {
aSynSets = [aSynSets];
}
// Iterate over all the message sets, retrieving the message header. Use
// this to construct a URI to populate a dictionary mapping.
let synMessageURIs = {}; // map URI to message header
for (let messageSet of aSynSets) {
for (let msgHdr of messageSet.msgHdrs()) {
synMessageURIs[msgHdr.folder.getUriForMsg(msgHdr)] = msgHdr;
}
}
// Iterate over the contents of the view, nulling out values in
// synMessageURIs for found messages, and exploding for missing ones.
let dbView = aController.window.gFolderDisplay.view.dbView;
let treeView = aController.window.gFolderDisplay.view.dbView.QueryInterface(
Ci.nsITreeView
);
let rowCount = treeView.rowCount;
for (let iViewIndex = 0; iViewIndex < rowCount; iViewIndex++) {
let msgHdr = dbView.getMsgHdrAt(iViewIndex);
let uri = msgHdr.folder.getUriForMsg(msgHdr);
Assert.ok(
uri in synMessageURIs,
"The view should show the message header" + msgHdr.messageKey
);
delete synMessageURIs[uri];
}
// Iterate over our URI set and make sure every message was shown.
for (let uri in synMessageURIs) {
let msgHdr = synMessageURIs[uri];
Assert.ok(
false,
"The view is should include the message header" + msgHdr.messageKey
);
}
}
|
