-
Notifications
You must be signed in to change notification settings - Fork 7
/
test-utils.js
326 lines (294 loc) · 8.19 KB
/
test-utils.js
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
// @ts-check
const validator = require('html-validator');
/**
* @typedef SerializedRemoteEvent
* @property {string} type
* @property {any} detail
*/
/**
* @ignore @typedef {import('puppeteer').ElementHandle} ElementHandle
*/
/**
* @ignore @typedef {import('puppeteer').JSHandle} JStHandle
*/
/**
* @ignore @typedef {import('puppeteer').Page} Page
*/
/**
* @private
* @param {Page} page
* @param {string} path
* @param {ElementHandle} container
*/
const find = async (page, path, container) => {
const result = await page.evaluateHandle((path, container) => {
// @ts-ignore
return window.queryDeepSelector(path, container);
}, path, container);
return result;
};
/**
* @class TestUtils
* @property {ElementHandle} targetComponent
* @property {Page} page
*/
class TestUtils {
/**
* @param {string} path deeq query selector formatted path
* @param {ElementHandle} container
*/
async find (path, container = this.targetComponent) {
return await find(this.page, path.trim(), container);
}
/**
* Initializes the showroom test-utils with a puppeteer page instance
* @param {Page} page
*/
async initialize (page) {
this.page = page;
await page.evaluate(() => {
// @ts-ignore
if (!window.queryDeepSelector) {
/**
* @param {string} selectorStr
* @param {any} container
*/
const queryDeepSelector = (selectorStr, container = document) => {
const selectorArr = selectorStr.replace(new RegExp('//', 'g'), '%split%//%split%').split('%split%');
for (const index in selectorArr) {
const selector = selectorArr[index].trim();
if (!selector) continue;
if (selector === '//') {
container = container.shadowRoot;
} else if (selector === 'document') {
container = document;
}
else {
container = container.querySelector(selector);
}
if (!container) break;
}
return container;
};
window['queryDeepSelector'] = queryDeepSelector;
}
});
return page;
}
/**
* clears the collected events in the browser
*/
async clearEventList () {
await this.page.evaluate(() => {
// @ts-ignore
dashboard.clearEvents();
});
}
/**
* Selects a component to be tested
* @param {string} componentName
* @returns ElementHandle
*/
async setTestSubject (componentName) {
this.testSubjectName = componentName;
let lastTargetComponent = this.targetComponent;
while (lastTargetComponent === this.targetComponent) {
// @ts-ignore
lastTargetComponent = await this.page.evaluate((async (componentName) => {
await showroom.ready;
await showroom.setTestSubject(componentName)
}), componentName);
this.targetComponent = await this.testSubject();
}
return this.targetComponent;
}
/**
* @return ElementHandle
*/
async testSubject () {
/**
* @type ElementHandle
*/
// @ts-ignore
const handle = await this.page.evaluateHandle(() => {
// @ts-ignore
return dashboard.targetComponent;
});
return handle;
}
/**
* @returns Promise<Array<SerializedRemoteEvent>>
*/
async getEventList () {
return await (await this.page.evaluate(async () => {
// @ts-ignore
await showroom.ready;
return window.dashboard.events.map(({type, detail, bubbles}) => {
return {
type,
detail,
bubbles
};
});
}));
}
/**
* @returns SerializedRemoteEvent
*/
async getLastEvent () {
return this.page.evaluate(() => {
// @ts-ignore
const { type, detail, bubbles } = window.dashboard.lastEvent;
return { type, detail, bubbles };
});
}
/**
* Tests HTML validity of a remote element
* @param {ElementHandle} target HTML as string
* @throws {Error} When validation fails
*/
async validateHTML (target) {
/**
* @type ElementHandle
*/
const resolvedTarget = target || this.targetComponent;
const html = await this.getProperty('innerHTML', resolvedTarget);
await validator({
format: 'text',
data: html
});
}
/**
* Returns the value of a property on the remote target
* @param {string} property
* @param {ElementHandle} [target] defaults to current tested component
* @returns any|JSHandle
*/
async getProperty (property, target) {
const resolvedTarget = target || this.targetComponent;
return await (await this.page.evaluate((target, prop) => {
return target[prop];
}, resolvedTarget, property));
}
/**
* Sets a property on a remote target
* @param {string} property
* @param {any} value
* @param {ElementHandle} [target] defaults to current tested component
*/
async setProperty (property, value, target) {
const resolvedTarget = target || this.targetComponent;
await this.page.evaluate((target, prop, value) => {
// @ts-ignore
showroom.setProperty(prop, value);
}, resolvedTarget, property, value);
}
async setAttribute (name, value, target) {
const resolvedTarget = target || this.targetComponent;
await this.page.evaluate((target, name, value) => {
// @ts-ignore
showroom.setAttribute(name, value);
}, resolvedTarget, name, value);
return resolvedTarget;
}
/**
* Returns value of a remote element's attribute
* @param {string} name
* @param {ElementHandle} target
* @returns Promise<string>
*/
async getAttribute (name, target) {
const resolvedTarget = target || this.targetComponent;
/**
* @type string
*/
const result = await(await this.page.evaluate((target, name) => {
return target.getAttribute(name);
}, resolvedTarget, name));
return result;
}
/**
* @param {string} name
* @param {ElementHandle} target
* @returns Promise<boolean>
*/
async hasAttribute (name, target) {
const resolvedTarget = target || this.targetComponent;
/**
* @type boolean
*/
const result = await(await this.page.evaluate((target, name) => {
return target.hasAttribute(name);
}, resolvedTarget, name));
return result;
}
/**
* @param {string} name
* @param {ElementHandle} target
*/
async removeAttribute (name, target) {
const resolvedTarget = target || this.targetComponent;
await this.page.evaluate((target, name) => {
target.removeAttribute(name);
}, resolvedTarget, name);
return resolvedTarget;
}
/**
*
* @param {ElementHandle} target
* @returns boolean;
*/
async isVisible (target) {
const resolvedTarget = target || this.targetComponent;
/**
* @type boolean
*/
const isIntersectingViewport = await resolvedTarget.isIntersectingViewport();
/**
* @type boolean
*/
const isNotHidden = await this.page.evaluate(async (target) => {
const style = getComputedStyle(target);
return style && style.display !== 'none' && style.visibility !== 'hidden' && style.opacity !== '0';
}, resolvedTarget);
return isIntersectingViewport && isNotHidden;
}
/**
*
* @param {ElementHandle} target
* @returns Promise<string>
*/
async getTextContent(target) {
const resolvedTarget = target || this.targetComponent;
await this.page.evaluate(async (target) => target, resolvedTarget);
const textContent = await resolvedTarget.getProperty('textContent');
/**
* @type Promise<string>
*/
const asText = textContent.jsonValue();
return asText;
}
/**
* Executes predefined function on a showroom descriptor file for the current tested component
* @param {string} fnName
*/
async trigger (fnName) {
await this.page.evaluate((fnName) => {
// @ts-ignore
dashboard.trigger(fnName);
}, fnName);
}
}
/**
* @param {Page} page
* @returns TestUtils
*/
module.exports = async function createUtils(page) {
if (!page) {
throw new Error('Page object is mandatory');
}
const testUtils = new TestUtils();
await testUtils.initialize(page);
return testUtils;
}
module.exports.TestUtils = TestUtils;