-
Notifications
You must be signed in to change notification settings - Fork 0
/
ShadowPuppeteer.js
2205 lines (1958 loc) · 65.5 KB
/
ShadowPuppeteer.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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
const requireg = require('requireg');
const Helper = require('codeceptjs/lib/helper');
const Locator = require('codeceptjs/lib/locator');
const recorder = require('codeceptjs/lib/recorder');
const stringIncludes = require('codeceptjs/lib/assert/include').includes;
const { urlEquals } = require('codeceptjs/lib/assert/equal');
const { equals } = require('codeceptjs/lib/assert/equal');
const { empty } = require('codeceptjs/lib/assert/empty');
const { truth } = require('codeceptjs/lib/assert/truth');
const {
xpathLocator,
ucfirst,
fileExists,
clearString,
chunkArray,
convertCssPropertiesToCamelCase,
screenshotOutputFolder,
} = require('codeceptjs/lib/utils');
const {
isColorProperty,
convertColorToRGBA,
} = require('codeceptjs/lib/colorUtils');
const path = require('path');
const ElementNotFound = require('codeceptjs/lib/helper/errors/ElementNotFound');
const RemoteBrowserConnectionRefused = require('codeceptjs/lib/helper/errors/RemoteBrowserConnectionRefused');
const Popup = require('codeceptjs/lib/helper/extras/Popup');
const Console = require('codeceptjs/lib/helper/extras/Console');
const axios = require('axios');
const fs = require('fs');
const colors = require('chalk');
let puppeteer;
const popupStore = new Popup();
const consoleLogStore = new Console();
/**
* Uses [Google Chrome's Puppeteer](https://github.com/GoogleChrome/puppeteer) library to run tests inside headless Chrome.
* Browser control is executed via DevTools Protocol (instead of Selenium).
* This helper works with a browser out of the box with no additional tools required to install.
*
* Requires `puppeteer` package to be installed.
*
* ## Configuration
*
* This helper should be configured in codecept.json or codecept.conf.js
*
* * `url`: base url of website to be tested
* * `show`: (optional, default: false) - show Google Chrome window for debug.
* * `restart`: (optional, default: true) - restart browser between tests.
* * `disableScreenshots`: (optional, default: false) - don't save screenshot on failure.
* * `fullPageScreenshots` (optional, default: false) - make full page screenshots on failure.
* * `uniqueScreenshotNames`: (optional, default: false) - option to prevent screenshot override if you have scenarios with the same name in different suites.
* * `keepBrowserState`: (optional, default: false) - keep browser state between tests when `restart` is set to false.
* * `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` is set to false.
* * `waitForAction`: (optional) how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
* * `waitForNavigation`: (optional, default: 'load'). When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions). Array values are accepted as well.
* * `getPageTimeout` (optional, default: '0') config option to set maximum navigation time in milliseconds.
* * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000.
* * `windowSize`: (optional) default window size. Set a dimension like `640x480`.
* * `userAgent`: (optional) user-agent string.
* * `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["Puppeteer"]._startBrowser()`.
* * `chrome`: (optional) pass additional [Puppeteer run options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions).
*
*
* #### Example #1: Wait for 0 network connections.
*
* ```json
* {
* "helpers": {
* "Puppeteer" : {
* "url": "http://localhost",
* "restart": false,
* "waitForNavigation": "networkidle0",
* "waitForAction": 500
* }
* }
* }
* ```
*
* #### Example #2: Wait for DOMContentLoaded event and 0 network connections
*
* ```json
* {
* "helpers": {
* "Puppeteer" : {
* "url": "http://localhost",
* "restart": false,
* "waitForNavigation": [ "domcontentloaded", "networkidle0" ],
* "waitForAction": 500
* }
* }
* }
* ```
*
* #### Example #3: Debug in window mode
*
* ```json
* {
* "helpers": {
* "Puppeteer" : {
* "url": "http://localhost",
* "show": true
* }
* }
* }
* ```
*
* #### Example #4: Connect to remote browser by specifying [websocket endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target)
*
* ```json
* {
* "helpers": {
* "Puppeteer" : {
* "url": "http://localhost",
* "chrome": {
* "browserWSEndpoint": "ws://localhost:9222/devtools/browser/c5aa6160-b5bc-4d53-bb49-6ecb36cd2e0a"
* }
* }
* }
* }
* ```
*
* Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
*
* ## Access From Helpers
*
* Receive Puppeteer client from a custom helper by accessing `browser` for the Browser object or `page` for the current Page object:
*
* ```js
* const browser = this.helpers['Puppeteer'].browser;
* await browser.pages(); // List of pages in the browser
*
* const currentPage = this.helpers['Puppeteer'].page;
* await currentPage.url(); // Get the url of the current page
* ```
*
* ## Methods
*/
class ShadowPuppeteer extends Helper {
constructor(config) {
super(config);
puppeteer = requireg('puppeteer');
// set defaults
this.isRemoteBrowser = false;
this.isRunning = false;
// override defaults with config
this._setConfig(config);
}
_validateConfig(config) {
const defaults = {
waitForAction: 100,
waitForTimeout: 1000,
fullPageScreenshots: false,
disableScreenshots: false,
uniqueScreenshotNames: false,
manualStart: false,
getPageTimeout: 0,
waitForNavigation: 'load',
restart: true,
keepCookies: false,
keepBrowserState: false,
show: false,
defaultPopupAction: 'accept',
};
return Object.assign(defaults, config);
}
_setConfig(config) {
this.options = this._validateConfig(config);
this.puppeteerOptions = Object.assign({ headless: !this.options.show }, this.options.chrome);
this.isRemoteBrowser = !!this.puppeteerOptions.browserWSEndpoint;
popupStore.defaultAction = this.options.defaultPopupAction;
}
static _config() {
return [
{ name: 'url', message: 'Base url of site to be tested', default: 'http://localhost' },
];
}
static _checkRequirements() {
try {
requireg('puppeteer');
} catch (e) {
return ['puppeteer@^1.6.0'];
}
}
_init() {
}
_beforeSuite() {
if (!this.options.restart && !this.options.manualStart && !this.isRunning) {
this.debugSection('Session', 'Starting singleton browser session');
return this._startBrowser();
}
}
async _before() {
recorder.retry({
retries: 3,
when: err => err.message.indexOf('context') > -1, // ignore context errors
});
if (this.options.restart && !this.options.manualStart) return this._startBrowser();
if (!this.isRunning && !this.options.manualStart) return this._startBrowser();
return this.browser;
}
async _after() {
if (!this.isRunning) return;
// close other sessions
const contexts = this.browser.browserContexts();
contexts.shift();
await Promise.all(contexts.map(c => c.close()));
if (this.options.restart) {
this.isRunning = false;
return this._stopBrowser();
}
if (this.options.keepBrowserState) return;
if (!this.options.keepCookies) {
this.debugSection('Session', 'cleaning cookies and localStorage');
await this.clearCookie();
}
await this.executeScript('localStorage.clear();').catch((err) => {
if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err;
});
await this.closeOtherTabs();
return this.browser;
}
_afterSuite() {
}
_finishTest() {
if (!this.options.restart && this.isRunning) return this._stopBrowser();
}
_session() {
const page = this.page;
return {
start: async () => {
this.debugSection('Incognito Tab', 'opened');
const bc = await this.browser.createIncognitoBrowserContext();
await bc.newPage();
// Create a new page inside context.
return bc;
},
stop: async (context) => {
// is closed by _after
},
loadVars: async (context) => {
// if (this.withinLocator)
const existingPages = context.targets().filter(t => t.type() === 'page');
// this.page = await existingPages[0].page();
// this.context = await page.$('body');
return this._setPage(await existingPages[0].page());
},
restoreVars: async () => {
this.withinLocator = null;
this.page = page;
if (!page) return;
this.context = await page.$('body');
},
};
}
/**
* Set the automatic popup response to Accept.
* This must be set before a popup is triggered.
*
* ```js
* I.amAcceptingPopups();
* I.click('#triggerPopup');
* I.acceptPopup();
* ```
*/
amAcceptingPopups() {
popupStore.actionType = 'accept';
}
/**
* Accepts the active JavaScript native popup window, as created by window.alert|window.confirm|window.prompt.
* Don't confuse popups with modal windows, as created by [various
* libraries](http://jster.net/category/windows-modals-popups).
*/
acceptPopup() {
popupStore.assertPopupActionType('accept');
}
/**
* Set the automatic popup response to Cancel/Dismiss.
* This must be set before a popup is triggered.
*
* ```js
* I.amCancellingPopups();
* I.click('#triggerPopup');
* I.cancelPopup();
* ```
*/
amCancellingPopups() {
popupStore.actionType = 'cancel';
}
/**
* Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt.
*/
cancelPopup() {
popupStore.assertPopupActionType('cancel');
}
/**
* Checks that the active JavaScript popup, as created by `window.alert|window.confirm|window.prompt`, contains the
* given string.
*/
async seeInPopup(text) {
popupStore.assertPopupVisible();
const popupText = await popupStore.popup.message();
stringIncludes('text in popup').assert(text, popupText);
}
/**
* Set current page
* @param {object} page page to set
*/
async _setPage(page) {
page = await page;
this._addPopupListener(page);
this.page = page;
if (!page) return;
page.setDefaultNavigationTimeout(this.options.getPageTimeout);
this.context = await page.$('body');
await page.bringToFront();
}
/**
* Add the 'dialog' event listener to a page
* @page {Puppeteer.Page}
*
* The popup listener handles the dialog with the predefined action when it appears on the page.
* It also saves a reference to the object which is used in seeInPopup.
*/
_addPopupListener(page) {
if (!page) {
return;
}
page.on('dialog', async (dialog) => {
popupStore.popup = dialog;
const action = popupStore.actionType || this.options.defaultPopupAction;
await this._waitForAction();
switch (action) {
case 'accept':
return dialog.accept();
case 'cancel':
return dialog.dismiss();
default: {
throw new Error('Unknown popup action type. Only "accept" or "cancel" are accepted');
}
}
});
}
/**
* Gets page URL including hash.
*/
async _getPageUrl() {
return this.executeScript(() => window.location.href);
}
/**
* Grab the text within the popup. If no popup is visible then it will return null
*
* ```js
* await I.grabPopupText();
* ```
*/
async grabPopupText() {
if (popupStore.popup) {
return popupStore.popup.message();
}
return null;
}
async _startBrowser() {
if (this.isRemoteBrowser) {
try {
this.browser = await puppeteer.connect(this.puppeteerOptions);
} catch (err) {
if (err.toString().indexOf('ECONNREFUSED')) {
throw new RemoteBrowserConnectionRefused(err);
}
throw err;
}
// Clear any prior existing pages when connecting to remote websocket
await this.browser.newPage();
await this.closeOtherTabs();
} else {
this.browser = await puppeteer.launch(this.puppeteerOptions);
}
this.browser.on('targetcreated', target => target.page().then(page => targetCreatedHandler.call(this, page)));
this.browser.on('targetchanged', (target) => {
this.debugSection('Url', target.url());
});
const existingPages = await this.browser.pages();
const mainPage = existingPages[0] || await this.browser.newPage();
if (existingPages.length) {
// Run the handler as it will not be triggered if the page already exists
targetCreatedHandler.call(this, mainPage);
}
await this._setPage(mainPage);
if (this.options.windowSize && this.options.windowSize.indexOf('x') > 0) {
const dimensions = this.options.windowSize.split('x');
await this.resizeWindow(parseInt(dimensions[0], 10), parseInt(dimensions[1], 10));
}
this.isRunning = true;
if (this.options.userAgent) {
await this.page.setUserAgent(this.options.userAgent);
}
}
async _stopBrowser() {
this.withinLocator = null;
this._setPage(null);
this.context = null;
popupStore.clear();
if (this.isRemoteBrowser) {
await this.browser.disconnect();
} else {
await this.browser.close();
}
}
async _evaluateHandeInContext(...args) {
let context = await this._getContext();
if (context.constructor.name === 'Frame') {
// Currently there is no evalateHandle for the Frame object
// https://github.com/GoogleChrome/puppeteer/issues/1051
context = await context.executionContext();
}
return context.evaluateHandle(...args);
}
async _withinBegin(locator) {
if (this.withinLocator) {
throw new Error('Can\'t start within block inside another within block');
}
const frame = isFrameLocator(locator);
if (frame) {
if (Array.isArray(frame)) {
return this.switchTo(null)
.then(() => frame.reduce((p, frameLocator) => p.then(() => this.switchTo(frameLocator)), Promise.resolve()));
}
await this.switchTo(locator);
this.withinLocator = new Locator(locator);
return;
}
const els = await this._locate(locator);
assertElementExists(els, locator);
this.context = els[0];
this.withinLocator = new Locator(locator);
}
async _withinEnd() {
this.withinLocator = null;
this.context = await this.page.mainFrame().$('body');
}
/**
* {{> ../webapi/amOnPage }}
*/
async amOnPage(url) {
if (!(/^\w+\:\/\//.test(url))) {
url = this.options.url + url;
}
await this.page.goto(url, { waitUntil: this.options.waitForNavigation });
// inject query-selector-shadow-dom
await this.page.addScriptTag({
path: require.resolve('query-selector-shadow-dom/dist/querySelectorShadowDom')
});
return this._waitForAction();
}
/**
* {{> ../webapi/resizeWindow }}
*
* Unlike other drivers Puppeteer changes the size of a viewport, not the window!
* Puppeteer does not control the window of a browser so it can't adjust its real size.
* It also can't maximize a window.
*/
async resizeWindow(width, height) {
if (width === 'maximize') {
throw new Error('Puppeteer can\'t control windows, so it can\'t maximize it');
}
await this.page.setViewport({ width, height });
return this._waitForAction();
}
/**
* Set headers for all next requests
*
* ```js
* I.haveRequestHeaders({
* 'X-Sent-By': 'CodeceptJS',
* });
* ```
*/
async haveRequestHeaders(customHeaders) {
if (!customHeaders) {
throw new Error('Cannot send empty headers.');
}
return this.page.setExtraHTTPHeaders(customHeaders);
}
/**
* {{> ../webapi/moveCursorTo}}
*/
async moveCursorTo(locator, offsetX = 0, offsetY = 0) {
const els = await this._locate(locator);
assertElementExists(els);
// Use manual mouse.move instead of .hover() so the offset can be added to the coordinates
const { x, y } = await els[0]._clickablePoint();
await this.page.mouse.move(x + offsetX, y + offsetY);
return this._waitForAction();
}
/**
* {{> ../webapi/dragAndDrop }}
*/
async dragAndDrop(srcElement, destElement) {
return proceedDragAndDrop.call(this, srcElement, destElement);
}
/**
* {{> ../webapi/refreshPage }}
*/
async refreshPage() {
return this.page.reload({ timeout: this.options.getPageTimeout, waitUntil: this.options.waitForNavigation });
}
/**
* {{> ../webapi/scrollPageToTop }}
*/
scrollPageToTop() {
return this.page.evaluate(() => {
window.scrollTo(0, 0);
});
}
/**
* {{> ../webapi/scrollPageToBottom }}
*/
scrollPageToBottom() {
return this.page.evaluate(() => {
const body = document.body;
const html = document.documentElement;
window.scrollTo(0, Math.max(
body.scrollHeight, body.offsetHeight,
html.clientHeight, html.scrollHeight, html.offsetHeight,
));
});
}
/**
* {{> ../webapi/scrollTo }}
*/
async scrollTo(locator, offsetX = 0, offsetY = 0) {
if (typeof locator === 'number' && typeof offsetX === 'number') {
offsetY = offsetX;
offsetX = locator;
locator = null;
}
let x = 0;
let y = 0;
if (locator) {
const els = await this._locate(locator);
assertElementExists(els, locator, 'Element');
await els[0]._scrollIntoViewIfNeeded();
const elementCoordinates = await els[0]._clickablePoint();
x = elementCoordinates.x;
y = elementCoordinates.y;
}
await this.page.evaluate((x, y) => {
window.scrollTo(x, y);
}, x + offsetX, y + offsetY);
return this._waitForAction();
}
/**
* {{> ../webapi/seeInTitle }}
*/
async seeInTitle(text) {
const title = await this.page.title();
stringIncludes('web page title').assert(text, title);
}
/**
* {{> ../webapi/grabPageScrollPosition}}
*/
async grabPageScrollPosition() {
/* eslint-disable comma-dangle */
function getScrollPosition() {
return {
x: window.pageXOffset,
y: window.pageYOffset
};
}
/* eslint-enable comma-dangle */
return this.executeScript(getScrollPosition);
}
/**
* Checks that title is equal to provided one.
*
* ```js
* I.seeTitleEquals('Test title.');
* ```
*/
async seeTitleEquals(text) {
const title = await this.page.title();
return equals('web page title').assert(title, text);
}
/**
* {{> ../webapi/dontSeeInTitle }}
*/
async dontSeeInTitle(text) {
const title = await this.page.title();
stringIncludes('web page title').negate(text, title);
}
/**
* {{> ../webapi/grabTitle }}
*/
async grabTitle() {
return this.page.title();
}
async debugLocator(locator) {
const elements = await this._locate(locator);
console.log(colors.yellow.bold(` Locator '${locator}' matches ${elements.length} element${elements.length === 1 ? '' : 's'}.`));
}
/**
* Get elements by different locator types, including strict locator
* Should be used in custom helpers:
*
* ```js
* const elements = await this.helpers['Puppeteer']._locate({name: 'password'});
* ```
*/
async _locate(locator) {
return findElements(await this.context, locator);
}
/**
* Find a checkbox by providing human readable text:
*
* ```js
* this.helpers['Puppeteer']._locateCheckable('I agree with terms and conditions').then // ...
* ```
*/
async _locateCheckable(locator) {
return findCheckable.call(this, locator, this.context);
}
/**
* Find a clickable element by providing human readable text:
*
* ```js
* this.helpers['Puppeteer']._locateClickable('Next page').then // ...
* ```
*/
async _locateClickable(locator) {
const context = await this._getContext();
return findClickable.call(this, context, locator);
}
/**
* Find field elements by providing human readable text:
*
* ```js
* this.helpers['Puppeteer']._locateFields('Your email').then // ...
* ```
*/
async _locateFields(locator) {
return findFields.call(this, locator);
}
/**
* Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
*
* ```js
* I.switchToNextTab();
* I.switchToNextTab(2);
* ```
*/
async switchToNextTab(num = 1) {
const pages = await this.browser.pages();
const index = pages.indexOf(this.page);
this.withinLocator = null;
const page = pages[index + num];
if (!page) {
throw new Error(`There is no ability to switch to next tab with offset ${num}`);
}
await this._setPage(page);
return this._waitForAction();
}
/**
* Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
*
* ```js
* I.switchToPreviousTab();
* I.switchToPreviousTab(2);
* ```
*/
async switchToPreviousTab(num = 1) {
const pages = await this.browser.pages();
const index = pages.indexOf(this.page);
this.withinLocator = null;
const page = pages[index - num];
if (!page) {
throw new Error(`There is no ability to switch to previous tab with offset ${num}`);
}
await this._setPage(page);
return this._waitForAction();
}
/**
* Close current tab and switches to previous.
*
* ```js
* I.closeCurrentTab();
* ```
*/
async closeCurrentTab() {
const oldPage = this.page;
await this.switchToPreviousTab();
await oldPage.close();
return this._waitForAction();
}
/**
* Close all tabs except for the current one.
*
* ```js
* I.closeOtherTabs();
* ```
*/
async closeOtherTabs() {
const pages = await this.browser.pages();
const otherPages = pages.filter(page => page !== this.page);
let p = Promise.resolve();
otherPages.forEach((page) => {
p = p.then(() => page.close());
});
await p;
return this._waitForAction();
}
/**
* Open new tab and switch to it
*
* ```js
* I.openNewTab();
* ```
*/
async openNewTab() {
await this._setPage(await this.browser.newPage());
return this._waitForAction();
}
/**
* {{> ../webapi/grabNumberOfOpenTabs }}
*/
async grabNumberOfOpenTabs() {
const pages = await this.browser.pages();
return pages.length;
}
/**
* {{> ../webapi/seeElement }}
*/
async seeElement(locator) {
let els = await this._locate(locator);
els = await Promise.all(els.map(el => el.boundingBox()));
return empty('visible elements').negate(els.filter(v => v).fill('ELEMENT'));
}
/**
* {{> ../webapi/dontSeeElement }}
*/
async dontSeeElement(locator) {
let els = await this._locate(locator);
els = await Promise.all(els.map(el => el.boundingBox()));
return empty('visible elements').assert(els.filter(v => v).fill('ELEMENT'));
}
/**
* {{> ../webapi/seeElementInDOM }}
*/
async seeElementInDOM(locator) {
const els = await this._locate(locator);
return empty('elements on page').negate(els.filter(v => v).fill('ELEMENT'));
}
/**
* {{> ../webapi/dontSeeElementInDOM }}
*/
async dontSeeElementInDOM(locator) {
const els = await this._locate(locator);
return empty('elements on a page').assert(els.filter(v => v).fill('ELEMENT'));
}
/**
* {{> ../webapi/click }}
*/
async click(locator, context = null) {
return proceedClick.call(this, locator, context);
}
/**
* {{> ../webapi/clickLink }}
*/
async clickLink(locator, context = null) {
return proceedClick.call(this, locator, context, { waitForNavigation: true });
}
/**
* {{> ../webapi/downloadFile }}
*/
async downloadFile(locator, customName) {
let fileName;
await this.page.setRequestInterception(true);
this.click(locator);
const xRequest = await new Promise((resolve) => {
this.page.on('request', (request) => {
const grabbedFileName = request.url().split('/')[request.url().split('/').length - 1];
const fileExtension = request.url().split('/')[request.url().split('/').length - 1].split('.')[1];
customName ? fileName = `${customName}.${fileExtension}` : fileName = grabbedFileName;
request.abort();
resolve(request);
});
});
const options = {
encoding: null,
method: xRequest._method,
uri: xRequest._url,
body: xRequest._postData,
headers: xRequest._headers,
};
const cookies = await this.page.cookies();
options.headers.Cookie = cookies.map(ck => `${ck.name}=${ck.value}`).join(';');
const response = await axios({
method: options.method, url: options.uri, headers: options.headers, responseType: 'arraybuffer',
});
const outputFile = path.join(`${global.output_dir}/${fileName}`);
try {
return new Promise((resolve, reject) => {
const wstream = fs.createWriteStream(outputFile);
wstream.write(response.data);
wstream.end();
this.debug(`File is downloaded in ${outputFile}`);
wstream.on('finish', () => { resolve(fileName); });
wstream.on('error', reject);
});
} catch (error) {
throw new Error(`There is something wrong with downloaded file. ${error}`);
}
}
/**
* {{> ../webapi/doubleClick }}
*/
async doubleClick(locator, context = null) {
return proceedClick.call(this, locator, context, { clickCount: 2 });
}
/**
* {{> ../webapi/rightClick }}
*/
async rightClick(locator, context = null) {
return proceedClick.call(this, locator, context, { button: 'right' });
}
/**
* {{> ../webapi/checkOption }}
*/
async checkOption(field, context = null) {
const els = await findCheckable.call(this, field, context);
assertElementExists(els[0], field, 'Checkbox or radio');
if (await els[0].getProperty('checked') === true) return;
await els[0].click();
return this._waitForAction();
}
/**
* {{> ../webapi/seeCheckboxIsChecked }}
*/
async seeCheckboxIsChecked(field) {
return proceedIsChecked.call(this, 'assert', field);
}
/**
* {{> ../webapi/dontSeeCheckboxIsChecked }}
*/
async dontSeeCheckboxIsChecked(field) {
return proceedIsChecked.call(this, 'negate', field);
}
/**
* {{> ../webapi/pressKey }}
*/
async pressKey(key) {
let modifier;
const modifiers = ['Control', 'Command', 'Shift', 'Alt'];
if (Array.isArray(key) && modifiers.indexOf(key[0]) > -1) {
modifier = key[0];
key = key[1];
}
if (modifier) await this.page.keyboard.down(modifier);
await await this.page.keyboard.press(key);
if (modifier) await this.page.keyboard.up(modifier);
return this._waitForAction();
}
/**
* {{> ../webapi/fillField }}
*/
async fillField(field, value) {
const els = await findFields.call(this, field);
assertElementExists(els, field, 'Field');
const el = els[0];
// await el.focus();
const tag = await el.getProperty('tagName').then(el => el.jsonValue());
const editable = await el.getProperty('contenteditable').then(el => el.jsonValue());
if (tag === 'INPUT' || tag === 'TEXTAREA') {
await this._evaluateHandeInContext(el => el.value = '', el);
} else if (editable) {
await this._evaluateHandeInContext(el => el.innerHTML = '', el);
}
await el.type(value, { delay: 10 });
return this._waitForAction();
}
/**
* {{> ../webapi/clearField }}
*/
async clearField(field) {
return this.fillField(field, '');
}
/**
* {{> ../webapi/appendField }}
*/
async appendField(field, value) {