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
207
208
209
210
211
212
213
214
215
216
217
218
219
|
/* 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 = [
"check_notification_displayed",
"assert_notification_displayed",
"close_notification",
"wait_for_notification_to_stop",
"wait_for_notification_to_show",
"get_notification_button",
"get_notification",
];
var utils = ChromeUtils.import("resource://testing-common/mozmill/utils.jsm");
/**
* A helper function for determining whether or not a notification with
* a particular value is being displayed.
*
* @param aWindow the window to check
* @param aBoxId the id of the notification box
* @param aValue the value of the notification to look for
* @param aNotification an optional out parameter: object that will pass the
* notification element out of this function in its
* 'notification' property
*
* @returns True/false depending on the state of the notification.
*/
function check_notification_displayed(aWindow, aBoxId, aValue, aNotification) {
let nb = aWindow.document.getElementById(aBoxId);
if (!nb) {
throw new Error("Couldn't find a notification box for id=" + aBoxId);
}
if (nb.querySelector(".notificationbox-stack")) {
let box = nb.querySelector(".notificationbox-stack")._notificationBox;
let notification = box.getNotificationWithValue(aValue);
if (aNotification) {
aNotification.notification = notification;
}
return notification != null;
}
return false;
}
/**
* A helper function ensuring whether or not a notification with
* a particular value is being displayed. Throws if the state is
* not the expected one.
*
* @param aWindow the window to check
* @param aBoxId the id of the notification box
* @param aValue the value of the notification to look for
* @param aDisplayed true if the notification should be displayed, false
* otherwise
* @returns the notification if we're asserting that the notification is
* displayed, and it actually shows up. Throws otherwise.
*/
function assert_notification_displayed(aWindow, aBoxId, aValue, aDisplayed) {
let notification = {};
let hasNotification = check_notification_displayed(
aWindow,
aBoxId,
aValue,
notification
);
if (hasNotification != aDisplayed) {
throw new Error(
"Expected the notification with value " +
aValue +
" to " +
(aDisplayed ? "be shown" : "not be shown")
);
}
return notification.notification;
}
/**
* A helper function for closing a notification if one is currently displayed
* in the window.
*
* @param aWindow the window with the notification
* @param aBoxId the id of the notification box
* @param aValue the value of the notification to close
*/
function close_notification(aWindow, aBoxId, aValue) {
let nb = aWindow.document.getElementById(aBoxId);
if (!nb) {
throw new Error("Couldn't find a notification box for id=" + aBoxId);
}
let box = nb.querySelector(".notificationbox-stack")._notificationBox;
let notification = box.getNotificationWithValue(aValue);
if (notification) {
notification.close();
}
}
/**
* A helper function that waits for a notification with value aValue
* to stop displaying in the window.
*
* @param aWindow the window with the notification
* @param aBoxId the id of the notification box
* @param aValue the value of the notification to wait to stop
*/
function wait_for_notification_to_stop(aWindow, aBoxId, aValue) {
let nb = aWindow.document.getElementById(aBoxId);
if (!nb) {
throw new Error("Couldn't find a notification box for id=" + aBoxId);
}
let box = nb.querySelector(".notificationbox-stack")._notificationBox;
utils.waitFor(
() => !box.getNotificationWithValue(aValue),
"Timed out waiting for notification with value " + aValue + " to stop."
);
}
/**
* A helper function that waits for a notification with value aValue
* to show in the window.
*
* @param aWindow the window that we want the notification to appear in
* @param aBoxId the id of the notification box
* @param aValue the value of the notification to wait for
*/
function wait_for_notification_to_show(aWindow, aBoxId, aValue) {
let nb = aWindow.document.getElementById(aBoxId);
if (!nb) {
throw new Error("Couldn't find a notification box for id=" + aBoxId);
}
function nbReady() {
if (nb.querySelector(".notificationbox-stack")) {
let box = nb.querySelector(".notificationbox-stack")._notificationBox;
return box.getNotificationWithValue(aValue) != null && !box._animating;
}
return false;
}
utils.waitFor(
nbReady,
"Timed out waiting for notification with value " + aValue + " to show."
);
}
/**
* Return the notification element based on the container ID and the Value type.
*
* @param {Window} win - The window that we want the notification to appear in.
* @param {string} id - The id of the notification box.
* @param {string} val - The value of the notification to fetch.
* @returns {?Element} - The notification element if found.
*/
function get_notification(win, id, val) {
let nb = win.document.getElementById(id);
if (!nb) {
throw new Error("Couldn't find a notification box for id=" + id);
}
if (nb.querySelector(".notificationbox-stack")) {
let box = nb.querySelector(".notificationbox-stack")._notificationBox;
return box.getNotificationWithValue(val);
}
return null;
}
/**
* Gets a button in a notification, as those do not have IDs.
*
* @param aWindow The window that has the notification.
* @param aBoxId The id of the notification box.
* @param aValue The value of the notification to find.
* @param aMatch Attributes of the button to find. An object with key:value
* pairs, similar to click_menus_in_sequence().
*/
function get_notification_button(aWindow, aBoxId, aValue, aMatch) {
let notification = get_notification(aWindow, aBoxId, aValue);
let buttons = notification.buttonContainer.querySelectorAll(
"button, toolbarbutton"
);
for (let button of buttons) {
let matchedAll = true;
for (let name in aMatch) {
let value = aMatch[name];
let matched = false;
if (name == "popup") {
if (button.getAttribute("type") == "menu") {
// The button contains a menupopup as the first child.
matched = button.querySelector("menupopup#" + value);
} else {
// The "popup" attribute is not on the button itself but in its
// buttonInfo member.
matched = "buttonInfo" in button && button.buttonInfo.popup == value;
}
} else if (
button.hasAttribute(name) &&
button.getAttribute(name) == value
) {
matched = true;
}
if (!matched) {
matchedAll = false;
break;
}
}
if (matchedAll) {
return button;
}
}
throw new Error("Couldn't find the requested button on a notification");
}
|
