codeceptjs 3.2.2 → 3.3.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/CHANGELOG.md +57 -0
  2. package/docs/advanced.md +2 -2
  3. package/docs/api.md +227 -188
  4. package/docs/build/ApiDataFactory.js +13 -6
  5. package/docs/build/Appium.js +98 -36
  6. package/docs/build/FileSystem.js +11 -1
  7. package/docs/build/GraphQL.js +11 -0
  8. package/docs/build/JSONResponse.js +297 -0
  9. package/docs/build/Nightmare.js +48 -48
  10. package/docs/build/Playwright.js +271 -151
  11. package/docs/build/Puppeteer.js +76 -67
  12. package/docs/build/REST.js +36 -0
  13. package/docs/build/TestCafe.js +44 -44
  14. package/docs/build/WebDriver.js +69 -69
  15. package/docs/changelog.md +7 -0
  16. package/docs/configuration.md +8 -8
  17. package/docs/custom-helpers.md +1 -1
  18. package/docs/data.md +9 -9
  19. package/docs/helpers/ApiDataFactory.md +7 -0
  20. package/docs/helpers/Appium.md +240 -198
  21. package/docs/helpers/FileSystem.md +11 -1
  22. package/docs/helpers/JSONResponse.md +230 -0
  23. package/docs/helpers/Playwright.md +283 -216
  24. package/docs/helpers/Puppeteer.md +9 -1
  25. package/docs/helpers/REST.md +30 -9
  26. package/docs/installation.md +3 -1
  27. package/docs/internal-api.md +265 -0
  28. package/docs/mobile.md +11 -11
  29. package/docs/nightmare.md +3 -3
  30. package/docs/playwright.md +73 -18
  31. package/docs/plugins.md +136 -36
  32. package/docs/puppeteer.md +28 -12
  33. package/docs/quickstart.md +2 -3
  34. package/docs/reports.md +44 -3
  35. package/docs/testcafe.md +1 -1
  36. package/docs/translation.md +2 -2
  37. package/docs/videos.md +2 -2
  38. package/docs/visual.md +2 -2
  39. package/docs/vue.md +1 -1
  40. package/docs/webdriver.md +92 -4
  41. package/lib/cli.js +25 -20
  42. package/lib/command/init.js +5 -15
  43. package/lib/command/workers/runTests.js +25 -7
  44. package/lib/config.js +17 -13
  45. package/lib/helper/ApiDataFactory.js +13 -6
  46. package/lib/helper/Appium.js +65 -3
  47. package/lib/helper/FileSystem.js +11 -1
  48. package/lib/helper/GraphQL.js +11 -0
  49. package/lib/helper/JSONResponse.js +297 -0
  50. package/lib/helper/Playwright.js +209 -89
  51. package/lib/helper/Puppeteer.js +12 -3
  52. package/lib/helper/REST.js +36 -0
  53. package/lib/helper/extras/Console.js +8 -0
  54. package/lib/helper/extras/PlaywrightRestartOpts.js +35 -0
  55. package/lib/interfaces/bdd.js +3 -1
  56. package/lib/plugin/allure.js +12 -0
  57. package/lib/plugin/autoLogin.js +1 -1
  58. package/lib/plugin/eachElement.js +127 -0
  59. package/lib/plugin/tryTo.js +6 -0
  60. package/lib/utils.js +20 -0
  61. package/package.json +25 -23
  62. package/translations/pt-BR.js +8 -0
  63. package/typings/index.d.ts +4 -0
  64. package/typings/types.d.ts +318 -109
@@ -14,12 +14,12 @@ const {
14
14
  ucfirst,
15
15
  fileExists,
16
16
  chunkArray,
17
- toCamelCase,
18
17
  convertCssPropertiesToCamelCase,
19
18
  screenshotOutputFolder,
20
19
  getNormalizedKeyAttributeValue,
21
20
  isModifierKey,
22
21
  clearString,
22
+ requireWithFallback,
23
23
  } = require('../utils');
24
24
  const {
25
25
  isColorProperty,
@@ -39,6 +39,9 @@ const popupStore = new Popup();
39
39
  const consoleLogStore = new Console();
40
40
  const availableBrowsers = ['chromium', 'webkit', 'firefox', 'electron'];
41
41
 
42
+ const {
43
+ setRestartStrategy, restartsSession, restartsContext, restartsBrowser,
44
+ } = require('./extras/PlaywrightRestartOpts');
42
45
  const { createValueEngine, createDisabledEngine } = require('./extras/PlaywrightPropEngine');
43
46
 
44
47
  /**
@@ -50,12 +53,18 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
50
53
  *
51
54
  * This helper works with a browser out of the box with no additional tools required to install.
52
55
  *
53
- * Requires `playwright` package version ^1 to be installed:
56
+ * Requires `playwright` or `playwright-core` package version ^1 to be installed:
54
57
  *
55
58
  * ```
56
- * npm i playwright@^1 --save
59
+ * npm i playwright@^1.18 --save
60
+ * ```
61
+ * or
62
+ * ```
63
+ * npm i playwright-core@^1.18 --save
57
64
  * ```
58
65
  *
66
+ * Using playwright-core package, will prevent the download of browser binaries and allow connecting to an existing browser installation or for connecting to a remote one.
67
+ *
59
68
  * ## Configuration
60
69
  *
61
70
  * This helper should be configured in codecept.json or codecept.conf.js
@@ -63,17 +72,21 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
63
72
  * * `url`: base url of website to be tested
64
73
  * * `browser`: a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
65
74
  * * `show`: (optional, default: false) - show browser window.
66
- * * `restart`: (optional, default: true) - restart browser between tests.
75
+ * * `restart`: (optional, default: false) - restart strategy between tests. Possible values:
76
+ * * 'context' or **false** - restarts [browser context](https://playwright.dev/docs/api/class-browsercontext) but keeps running browser. Recommended by Playwright team to keep tests isolated.
77
+ * * 'browser' or **true** - closes browser and opens it again between tests.
78
+ * * 'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with `keepCookies` and `keepBrowserState` options. This behavior was default before CodeceptJS 3.1
79
+ * * `timeout`: (optional, default: 1000) - [timeout](https://playwright.dev/docs/api/class-page#page-set-default-timeout) in ms of all Playwright actions .
67
80
  * * `disableScreenshots`: (optional, default: false) - don't save screenshot on failure.
68
81
  * * `emulate`: (optional, default: {}) launch browser in device emulation mode.
69
82
  * * `video`: (optional, default: false) enables video recording for failed tests; videos are saved into `output/videos` folder
70
83
  * * `trace`: (optional, default: false) record [tracing information](https://playwright.dev/docs/trace-viewer) with screenshots and snapshots.
71
84
  * * `fullPageScreenshots` (optional, default: false) - make full page screenshots on failure.
72
85
  * * `uniqueScreenshotNames`: (optional, default: false) - option to prevent screenshot override if you have scenarios with the same name in different suites.
73
- * * `keepBrowserState`: (optional, default: false) - keep browser state between tests when `restart` is set to false.
74
- * * `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` is set to false.
86
+ * * `keepBrowserState`: (optional, default: false) - keep browser state between tests when `restart` is set to 'session'.
87
+ * * `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` is set to 'session'.
75
88
  * * `waitForAction`: (optional) how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
76
- * * `waitForNavigation`: (optional, default: 'load'). When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagewaitfornavigationoptions).
89
+ * * `waitForNavigation`: (optional, default: 'load'). When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API](https://github.com/microsoft/playwright/blob/main/docs/api.md#pagewaitfornavigationoptions).
77
90
  * * `pressKeyDelay`: (optional, default: '10'). Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
78
91
  * * `getPageTimeout` (optional, default: '0') config option to set maximum navigation time in milliseconds.
79
92
  * * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000.
@@ -84,6 +97,7 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
84
97
  * * `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
85
98
  * * `chromium`: (optional) pass additional chromium options
86
99
  * * `electron`: (optional) pass additional electron options
100
+ * * `channel`: (optional) While Playwright can operate against the stock Google Chrome and Microsoft Edge browsers available on the machine. In particular, current Playwright version will support Stable and Beta channels of these browsers. See [Google Chrome & Microsoft Edge](https://playwright.dev/docs/browsers/#google-chrome--microsoft-edge).
87
101
  *
88
102
  * #### Video Recording Customization
89
103
  *
@@ -235,7 +249,7 @@ class Playwright extends Helper {
235
249
  constructor(config) {
236
250
  super(config);
237
251
 
238
- playwright = require('playwright');
252
+ playwright = requireWithFallback('playwright', 'playwright-core');
239
253
 
240
254
  // set defaults
241
255
  this.isRemoteBrowser = false;
@@ -259,8 +273,10 @@ class Playwright extends Helper {
259
273
  waitForAction: 100,
260
274
  waitForTimeout: 1000,
261
275
  pressKeyDelay: 10,
276
+ timeout: 1000,
262
277
  fullPageScreenshots: false,
263
278
  disableScreenshots: false,
279
+ ignoreLog: ['warning', 'log'],
264
280
  uniqueScreenshotNames: false,
265
281
  manualStart: false,
266
282
  getPageTimeout: 0,
@@ -270,6 +286,7 @@ class Playwright extends Helper {
270
286
  keepBrowserState: false,
271
287
  show: false,
272
288
  defaultPopupAction: 'accept',
289
+ use: { actionTimeout: 0 },
273
290
  ignoreHTTPSErrors: false, // Adding it here o that context can be set up to ignore the SSL errors
274
291
  };
275
292
 
@@ -297,10 +314,16 @@ class Playwright extends Helper {
297
314
 
298
315
  _setConfig(config) {
299
316
  this.options = this._validateConfig(config);
317
+ setRestartStrategy(this.options);
300
318
  this.playwrightOptions = {
301
319
  headless: !this.options.show,
302
320
  ...this._getOptionsForBrowser(config),
303
321
  };
322
+
323
+ if (this.options.channel && this.options.browser === 'chromium') {
324
+ this.playwrightOptions.channel = this.options.channel;
325
+ }
326
+
304
327
  if (this.options.video) {
305
328
  this.options.recordVideo = { size: parseWindowSize(this.options.windowSize) };
306
329
  }
@@ -329,9 +352,9 @@ class Playwright extends Helper {
329
352
 
330
353
  static _checkRequirements() {
331
354
  try {
332
- require('playwright');
355
+ requireWithFallback('playwright', 'playwright-core');
333
356
  } catch (e) {
334
- return ['playwright@^1'];
357
+ return ['playwright@^1.18'];
335
358
  }
336
359
  }
337
360
 
@@ -348,7 +371,7 @@ class Playwright extends Helper {
348
371
  }
349
372
 
350
373
  _beforeSuite() {
351
- if (!this.options.restart && !this.options.manualStart && !this.isRunning) {
374
+ if ((restartsSession() || restartsContext()) && !this.options.manualStart && !this.isRunning) {
352
375
  this.debugSection('Session', 'Starting singleton browser session');
353
376
  return this._startBrowser();
354
377
  }
@@ -366,7 +389,7 @@ class Playwright extends Helper {
366
389
  },
367
390
  });
368
391
 
369
- if (this.options.restart && !this.options.manualStart) await this._startBrowser();
392
+ if (restartsBrowser() && !this.options.manualStart) await this._startBrowser();
370
393
  if (!this.isRunning && !this.options.manualStart) await this._startBrowser();
371
394
 
372
395
  this.isAuthenticated = false;
@@ -388,7 +411,9 @@ class Playwright extends Helper {
388
411
  if (this.storageState) contextOptions.storageState = this.storageState;
389
412
  if (this.options.userAgent) contextOptions.userAgent = this.options.userAgent;
390
413
  if (this.options.locale) contextOptions.locale = this.options.locale;
391
- this.browserContext = await this.browser.newContext(contextOptions); // Adding the HTTPSError ignore in the context so that we can ignore those errors
414
+ if (!this.browserContext || !restartsSession()) {
415
+ this.browserContext = await this.browser.newContext(contextOptions); // Adding the HTTPSError ignore in the context so that we can ignore those errors
416
+ }
392
417
  }
393
418
 
394
419
  let mainPage;
@@ -416,7 +441,11 @@ class Playwright extends Helper {
416
441
  return;
417
442
  }
418
443
 
419
- if (this.options.restart) {
444
+ if (restartsSession()) {
445
+ return refreshContextSession.bind(this)();
446
+ }
447
+
448
+ if (restartsBrowser()) {
420
449
  this.isRunning = false;
421
450
  return this._stopBrowser();
422
451
  }
@@ -438,11 +467,10 @@ class Playwright extends Helper {
438
467
  return this.browser;
439
468
  }
440
469
 
441
- _afterSuite() {
442
- }
470
+ _afterSuite() {}
443
471
 
444
- _finishTest() {
445
- if (!this.options.restart && this.isRunning) return this._stopBrowser();
472
+ async _finishTest() {
473
+ if ((restartsSession() || restartsContext()) && this.isRunning) return this._stopBrowser();
446
474
  }
447
475
 
448
476
  _session() {
@@ -501,16 +529,16 @@ class Playwright extends Helper {
501
529
  * First argument is a description of an action.
502
530
  * Second argument is async function that gets this helper as parameter.
503
531
  *
504
- * { [`page`](https://github.com/microsoft/playwright/blob/master/docs/api.md#class-page), [`context`](https://github.com/microsoft/playwright/blob/master/docs/api.md#class-context) [`browser`](https://github.com/microsoft/playwright/blob/master/docs/api.md#class-browser) } objects from Playwright API are available.
532
+ * { [`page`](https://github.com/microsoft/playwright/blob/main/docs/src/api/class-page.md), [`browserContext`](https://github.com/microsoft/playwright/blob/main/docs/src/api/class-browsercontext.md) [`browser`](https://github.com/microsoft/playwright/blob/main/docs/src/api/class-browser.md) } objects from Playwright API are available.
505
533
  *
506
534
  * ```js
507
- * I.usePlaywrightTo('emulate offline mode', async ({ context }) {
508
- * await context.setOffline(true);
535
+ * I.usePlaywrightTo('emulate offline mode', async ({ browserContext }) => {
536
+ * await browserContext.setOffline(true);
509
537
  * });
510
538
  * ```
511
539
  *
512
540
  * @param {string} description used to show in logs.
513
- * @param {function} fn async functuion that executed with Playwright helper as argument
541
+ * @param {function} fn async function that executed with Playwright helper as argument
514
542
  */
515
543
  usePlaywrightTo(description, fn) {
516
544
  return this._useTo(...arguments);
@@ -578,7 +606,9 @@ class Playwright extends Helper {
578
606
  this._addPopupListener(page);
579
607
  this.page = page;
580
608
  if (!page) return;
609
+ this.browserContext.setDefaultTimeout(0);
581
610
  page.setDefaultNavigationTimeout(this.options.getPageTimeout);
611
+ page.setDefaultTimeout(this.options.timeout);
582
612
 
583
613
  page.on('crash', async () => {
584
614
  console.log('ERROR: Page has crashed, closing page!');
@@ -679,7 +709,6 @@ class Playwright extends Helper {
679
709
  this._setPage(null);
680
710
  this.context = null;
681
711
  popupStore.clear();
682
-
683
712
  await this.browser.close();
684
713
  }
685
714
 
@@ -821,9 +850,21 @@ class Playwright extends Helper {
821
850
 
822
851
  /**
823
852
  * {{> dragAndDrop }}
853
+ *
854
+ * [Additional options](https://playwright.dev/docs/api/class-page#page-drag-and-drop) can be passed as 3rd argument.
855
+ *
856
+ * ```js
857
+ * // specify coordinates for source position
858
+ * I.dragAndDrop('img.src', 'img.dst', { sourcePosition: {x: 10, y: 10} })
859
+ * ```
860
+ *
861
+ * > By default option `force: true` is set
824
862
  */
825
- async dragAndDrop(srcElement, destElement) {
826
- return proceedDragAndDrop.call(this, srcElement, destElement);
863
+ async dragAndDrop(srcElement, destElement, options = { force: true }) {
864
+ const src = new Locator(srcElement, 'css');
865
+ const dst = new Locator(destElement, 'css');
866
+
867
+ return this.page.dragAndDrop(buildLocatorString(src), buildLocatorString(dst), options);
827
868
  }
828
869
 
829
870
  /**
@@ -1071,7 +1112,7 @@ class Playwright extends Helper {
1071
1112
  * I.openNewTab();
1072
1113
  * ```
1073
1114
  *
1074
- * You can pass in [page options](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsernewpageoptions) to emulate device on this page
1115
+ * You can pass in [page options](https://github.com/microsoft/playwright/blob/main/docs/api.md#browsernewpageoptions) to emulate device on this page
1075
1116
  *
1076
1117
  * ```js
1077
1118
  * // enable mobile
@@ -1163,10 +1204,21 @@ class Playwright extends Helper {
1163
1204
  /**
1164
1205
  * {{> click }}
1165
1206
  *
1207
+ * [Additional options](https://playwright.dev/docs/api/class-page#page-click) for click available as 3rd argument.
1208
+ *
1209
+ * Examples:
1210
+ *
1211
+ * ```js
1212
+ * // click on element at position
1213
+ * I.click('canvas', '.model', { position: { x: 20, y: 40 } })
1214
+ *
1215
+ * // make ctrl-click
1216
+ * I.click('.edit', null, { modifiers: ['Ctrl'] } )
1217
+ * ```
1166
1218
  *
1167
1219
  */
1168
- async click(locator, context = null) {
1169
- return proceedClick.call(this, locator, context);
1220
+ async click(locator, context = null, opts = {}) {
1221
+ return proceedClick.call(this, locator, context, opts);
1170
1222
  }
1171
1223
 
1172
1224
  /**
@@ -1205,30 +1257,40 @@ class Playwright extends Helper {
1205
1257
 
1206
1258
  /**
1207
1259
  * {{> checkOption }}
1260
+ *
1261
+ * [Additional options](https://playwright.dev/docs/api/class-elementhandle#element-handle-check) for check available as 3rd argument.
1262
+ *
1263
+ * Examples:
1264
+ *
1265
+ * ```js
1266
+ * // click on element at position
1267
+ * I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } })
1268
+ * ```
1269
+ * > ⚠️ To avoid flakiness, option `force: true` is set by default
1208
1270
  */
1209
- async checkOption(field, context = null) {
1271
+ async checkOption(field, context = null, options = { force: true }) {
1210
1272
  const elm = await this._locateCheckable(field, context);
1211
- const curentlyChecked = await elm.getProperty('checked')
1212
- .then(checkedProperty => checkedProperty.jsonValue());
1213
- // Only check if NOT currently checked
1214
- if (!curentlyChecked) {
1215
- await elm.click();
1216
- return this._waitForAction();
1217
- }
1273
+ await elm.check(options);
1274
+ return this._waitForAction();
1218
1275
  }
1219
1276
 
1220
1277
  /**
1221
1278
  * {{> uncheckOption }}
1279
+ *
1280
+ * [Additional options](https://playwright.dev/docs/api/class-elementhandle#element-handle-uncheck) for uncheck available as 3rd argument.
1281
+ *
1282
+ * Examples:
1283
+ *
1284
+ * ```js
1285
+ * // click on element at position
1286
+ * I.uncheckOption('Agree', '.signup', { position: { x: 5, y: 5 } })
1287
+ * ```
1288
+ * > ⚠️ To avoid flakiness, option `force: true` is set by default
1222
1289
  */
1223
- async uncheckOption(field, context = null) {
1290
+ async uncheckOption(field, context = null, options = { force: true }) {
1224
1291
  const elm = await this._locateCheckable(field, context);
1225
- const curentlyChecked = await elm.getProperty('checked')
1226
- .then(checkedProperty => checkedProperty.jsonValue());
1227
- // Only uncheck if currently checked
1228
- if (curentlyChecked) {
1229
- await elm.click();
1230
- return this._waitForAction();
1231
- }
1292
+ await elm.uncheck(options);
1293
+ return this._waitForAction();
1232
1294
  }
1233
1295
 
1234
1296
  /**
@@ -1580,7 +1642,7 @@ class Playwright extends Helper {
1580
1642
  */
1581
1643
  async clearCookie() {
1582
1644
  // Playwright currently doesn't support to delete a certain cookie
1583
- // https://github.com/microsoft/playwright/blob/master/docs/api.md#class-browsercontext
1645
+ // https://github.com/microsoft/playwright/blob/main/docs/api.md#class-browsercontext
1584
1646
  if (!this.browserContext) return;
1585
1647
  return this.browserContext.clearCookies();
1586
1648
  }
@@ -1876,6 +1938,53 @@ class Playwright extends Helper {
1876
1938
  return this.page.screenshot({ path: outputFile, fullPage: fullPageOption, type: 'png' });
1877
1939
  }
1878
1940
 
1941
+ /**
1942
+ * Performs [api request](https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-get) using
1943
+ * the cookies from the current browser session.
1944
+ *
1945
+ * ```js
1946
+ * const users = await I.makeApiRequest('GET', '/api/users', { params: { page: 1 }});
1947
+ * users[0]
1948
+ * I.makeApiRequest('PATCH', )
1949
+ * ```
1950
+ *
1951
+ * > This is Playwright's built-in alternative to using REST helper's sendGet, sendPost, etc methods.
1952
+ *
1953
+ * @param {string} method HTTP method
1954
+ * @param {string} url endpoint
1955
+ * @param {object} options request options depending on method used
1956
+ * @returns {Promise<object>} response
1957
+ */
1958
+ async makeApiRequest(method, url, options) {
1959
+ method = method.toLowerCase();
1960
+ const allowedMethods = ['get', 'post', 'patch', 'head', 'fetch', 'delete'];
1961
+ if (!allowedMethods.includes(method)) {
1962
+ throw new Error(`Method ${method} is not allowed, use the one from a list ${allowedMethods} or switch to using REST helper`);
1963
+ }
1964
+
1965
+ if (url.startsWith('/')) { // local url
1966
+ url = this.options.url + url;
1967
+ this.debugSection('URL', url);
1968
+ }
1969
+
1970
+ const response = await this.page.request[method](url, options);
1971
+ this.debugSection('Status', response.status());
1972
+ this.debugSection('Response', await response.text());
1973
+
1974
+ // hook to allow JSON response handle this
1975
+ if (this.config.onResponse) {
1976
+ const axiosResponse = {
1977
+ data: await response.json(),
1978
+ status: response.status(),
1979
+ statusText: response.statusText(),
1980
+ headers: response.headers(),
1981
+ };
1982
+ this.config.onResponse(axiosResponse);
1983
+ }
1984
+
1985
+ return response;
1986
+ }
1987
+
1879
1988
  async _failed(test) {
1880
1989
  await this._withinEnd();
1881
1990
 
@@ -1888,7 +1997,7 @@ class Playwright extends Helper {
1888
1997
  }
1889
1998
 
1890
1999
  if (this.options.trace) {
1891
- const path = `${global.output_dir}/trace/${clearString(test.title).slice(0, 255)}.zip`;
2000
+ const path = `${`${global.output_dir}/trace/${clearString(test.title)}`.slice(0, 251)}.zip`;
1892
2001
  await this.browserContext.tracing.stop({ path });
1893
2002
  test.artifacts.trace = path;
1894
2003
  }
@@ -2484,8 +2593,7 @@ async function findCheckable(locator, context) {
2484
2593
  async function proceedIsChecked(assertType, option) {
2485
2594
  let els = await findCheckable.call(this, option);
2486
2595
  assertElementExists(els, option, 'Checkable');
2487
- els = await Promise.all(els.map(el => el.getProperty('checked')));
2488
- els = await Promise.all(els.map(el => el.jsonValue()));
2596
+ els = await Promise.all(els.map(el => el.isChecked()));
2489
2597
  const selected = els.reduce((prev, cur) => prev || cur);
2490
2598
  return truth(`checkable ${option}`, 'to be checked')[assertType](selected);
2491
2599
  }
@@ -2513,36 +2621,6 @@ async function findFields(locator) {
2513
2621
  return this._locate({ css: locator });
2514
2622
  }
2515
2623
 
2516
- async function proceedDragAndDrop(sourceLocator, destinationLocator) {
2517
- // modern drag and drop in Playwright
2518
- if (this.page.dragAndDrop) {
2519
- const source = new Locator(sourceLocator);
2520
- const dest = new Locator(destinationLocator);
2521
- if (source.isBasic() && dest.isBasic()) {
2522
- return this.page.dragAndDrop(source.simplify(), dest.simplify());
2523
- }
2524
- }
2525
-
2526
- const src = await this._locate(sourceLocator);
2527
- assertElementExists(src, sourceLocator, 'Source Element');
2528
-
2529
- const dst = await this._locate(destinationLocator);
2530
- assertElementExists(dst, destinationLocator, 'Destination Element');
2531
-
2532
- // Note: Using clickablePoint private api becaues the .BoundingBox does not take into account iframe offsets!
2533
- const dragSource = await clickablePoint(src[0]);
2534
- const dragDestination = await clickablePoint(dst[0]);
2535
-
2536
- // Drag start point
2537
- await this.page.mouse.move(dragSource.x, dragSource.y, { steps: 5 });
2538
- await this.page.mouse.down();
2539
-
2540
- // Drag destination
2541
- await this.page.mouse.move(dragDestination.x, dragDestination.y, { steps: 5 });
2542
- await this.page.mouse.up();
2543
- await this._waitForAction();
2544
- }
2545
-
2546
2624
  async function proceedSeeInField(assertType, field, value) {
2547
2625
  const els = await findFields.call(this, field);
2548
2626
  assertElementExists(els, field, 'Field');
@@ -2569,14 +2647,15 @@ async function proceedSeeInField(assertType, field, value) {
2569
2647
  };
2570
2648
 
2571
2649
  if (tag === 'SELECT') {
2572
- const selectedOptions = await el.$$('option:checked');
2573
- // locate option by values and check them
2574
- if (value === '') {
2575
- return proceedMultiple(selectedOptions);
2650
+ if (await el.getProperty('multiple')) {
2651
+ const selectedOptions = await el.$$('option:checked');
2652
+ if (!selectedOptions.length) return null;
2653
+
2654
+ const options = await filterFieldsByValue(selectedOptions, value, true);
2655
+ return proceedMultiple(options);
2576
2656
  }
2577
2657
 
2578
- const options = await filterFieldsByValue(selectedOptions, value, true);
2579
- return proceedMultiple(options);
2658
+ return el.inputValue();
2580
2659
  }
2581
2660
 
2582
2661
  if (tag === 'INPUT') {
@@ -2592,7 +2671,8 @@ async function proceedSeeInField(assertType, field, value) {
2592
2671
  }
2593
2672
  return proceedMultiple(els[0]);
2594
2673
  }
2595
- const fieldVal = await el.getProperty('value').then(el => el.jsonValue());
2674
+
2675
+ const fieldVal = await el.inputValue();
2596
2676
  return stringIncludes(`fields by ${field}`)[assertType](value, fieldVal);
2597
2677
  }
2598
2678
 
@@ -2623,10 +2703,10 @@ async function filterFieldsBySelectionState(elements, state) {
2623
2703
  }
2624
2704
 
2625
2705
  async function elementSelected(element) {
2626
- const type = await element.getProperty('type').then(el => el.jsonValue());
2706
+ const type = await element.getProperty('type').then(el => !!el && el.jsonValue());
2627
2707
 
2628
2708
  if (type === 'checkbox' || type === 'radio') {
2629
- return element.getProperty('checked').then(el => el.jsonValue());
2709
+ return element.isChecked();
2630
2710
  }
2631
2711
  return element.getProperty('selected').then(el => el.jsonValue());
2632
2712
  }
@@ -2674,12 +2754,18 @@ async function targetCreatedHandler(page) {
2674
2754
  });
2675
2755
  });
2676
2756
  page.on('console', (msg) => {
2677
- this.debugSection(`Browser:${ucfirst(msg.type())}`, (msg.text && msg.text() || msg._text || '') + msg.args().join(' '));
2757
+ if (!consoleLogStore.includes(msg) && this.options.ignoreLog && !this.options.ignoreLog.includes(msg.type())) {
2758
+ this.debugSection(`Browser:${ucfirst(msg.type())}`, (msg.text && msg.text() || msg._text || '') + msg.args().join(' '));
2759
+ }
2678
2760
  consoleLogStore.add(msg);
2679
2761
  });
2680
2762
 
2681
2763
  if (this.options.windowSize && this.options.windowSize.indexOf('x') > 0 && this._getType() === 'Browser') {
2682
- await page.setViewportSize(parseWindowSize(this.options.windowSize));
2764
+ try {
2765
+ await page.setViewportSize(parseWindowSize(this.options.windowSize));
2766
+ } catch (err) {
2767
+ // target can be already closed, ignoring...
2768
+ }
2683
2769
  }
2684
2770
  }
2685
2771
 
@@ -2769,3 +2855,37 @@ async function clickablePoint(el) {
2769
2855
  } = rect;
2770
2856
  return { x: x + width / 2, y: y + height / 2 };
2771
2857
  }
2858
+
2859
+ async function refreshContextSession() {
2860
+ // close other sessions
2861
+ try {
2862
+ const contexts = await this.browser.contexts();
2863
+ contexts.shift();
2864
+
2865
+ await Promise.all(contexts.map(c => c.close()));
2866
+ } catch (e) {
2867
+ console.log(e);
2868
+ }
2869
+
2870
+ if (this.page) {
2871
+ const existingPages = await this.browserContext.pages();
2872
+ await this._setPage(existingPages[0]);
2873
+ }
2874
+
2875
+ if (this.options.keepBrowserState) return;
2876
+
2877
+ if (!this.options.keepCookies) {
2878
+ this.debugSection('Session', 'cleaning cookies and localStorage');
2879
+ await this.clearCookie();
2880
+ }
2881
+ const currentUrl = await this.grabCurrentUrl();
2882
+
2883
+ if (currentUrl.startsWith('http')) {
2884
+ await this.executeScript('localStorage.clear();').catch((err) => {
2885
+ if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err;
2886
+ });
2887
+ await this.executeScript('sessionStorage.clear();').catch((err) => {
2888
+ if (!(err.message.indexOf("Storage is disabled inside 'data:' URLs.") > -1)) throw err;
2889
+ });
2890
+ }
2891
+ }
@@ -22,6 +22,7 @@ const {
22
22
  screenshotOutputFolder,
23
23
  getNormalizedKeyAttributeValue,
24
24
  isModifierKey,
25
+ requireWithFallback,
25
26
  } = require('../utils');
26
27
  const {
27
28
  isColorProperty,
@@ -43,7 +44,15 @@ const consoleLogStore = new Console();
43
44
  * Browser control is executed via DevTools Protocol (instead of Selenium).
44
45
  * This helper works with a browser out of the box with no additional tools required to install.
45
46
  *
46
- * Requires `puppeteer` package to be installed.
47
+ * Requires `puppeteer` or `puppeteer-core` package to be installed.
48
+ * ```
49
+ * npm i puppeteer --save
50
+ * ```
51
+ * or
52
+ * ```
53
+ * npm i puppeteer-core --save
54
+ * ```
55
+ * Using `puppeteer-core` package, will prevent the download of browser binaries and allow connecting to an existing browser installation or for connecting to a remote one.
47
56
  *
48
57
  * > Experimental Firefox support [can be activated](https://codecept.io/helpers/Puppeteer-firefox).
49
58
  *
@@ -182,7 +191,7 @@ class Puppeteer extends Helper {
182
191
  constructor(config) {
183
192
  super(config);
184
193
 
185
- puppeteer = require('puppeteer');
194
+ puppeteer = requireWithFallback('puppeteer', 'puppeteer-core');
186
195
 
187
196
  // set defaults
188
197
  this.isRemoteBrowser = false;
@@ -245,7 +254,7 @@ class Puppeteer extends Helper {
245
254
 
246
255
  static _checkRequirements() {
247
256
  try {
248
- require('puppeteer');
257
+ requireWithFallback('puppeteer', 'puppeteer-core');
249
258
  } catch (e) {
250
259
  return ['puppeteer'];
251
260
  }
@@ -63,6 +63,12 @@ class REST extends Helper {
63
63
  this.axios.defaults.headers = this.options.defaultHeaders;
64
64
  }
65
65
 
66
+ static _config() {
67
+ return [
68
+ { name: 'endpoint', message: 'Endpoint of API you are going to test', default: 'http://localhost:3000/api' },
69
+ ];
70
+ }
71
+
66
72
  static _checkRequirements() {
67
73
  try {
68
74
  require('axios');
@@ -71,6 +77,33 @@ class REST extends Helper {
71
77
  }
72
78
  }
73
79
 
80
+ _before() {
81
+ this.headers = { ...this.options.defaultHeaders };
82
+ }
83
+
84
+ /**
85
+ * Sets request headers for all requests of this test
86
+ *
87
+ * @param {object} headers headers list
88
+ */
89
+ haveRequestHeaders(headers) {
90
+ this.headers = { ...headers, ...this.headers };
91
+ }
92
+
93
+ /**
94
+ * Adds a header for Bearer authentication
95
+ *
96
+ * ```js
97
+ * // we use secret function to hide token from logs
98
+ * I.amBearerAuthenticated(secret('heregoestoken'))
99
+ * ```
100
+ *
101
+ * @param {string} accessToken Bearer access token
102
+ */
103
+ amBearerAuthenticated(accessToken) {
104
+ this.haveRequestHeaders({ Authorization: `Bearer ${accessToken}` });
105
+ }
106
+
74
107
  /**
75
108
  * Executes axios request
76
109
  *
@@ -111,6 +144,9 @@ class REST extends Helper {
111
144
  this.debugSection('Response', `Response error. Status code: ${err.response.status}`);
112
145
  response = err.response;
113
146
  }
147
+ if (this.config.onResponse) {
148
+ await this.config.onResponse(response);
149
+ }
114
150
  this.debugSection('Response', JSON.stringify(response.data));
115
151
  return response;
116
152
  }
@@ -14,6 +14,14 @@ class Console {
14
14
  this._logEntries = [];
15
15
  }
16
16
 
17
+ includes(msg) {
18
+ const prev = this._logEntries[this._logEntries.length - 1];
19
+ if (!prev) return false;
20
+ const text = msg.text && msg.text() || msg._text || '';
21
+ const prevText = prev.text && prev.text() || prev._text || '';
22
+ return text === prevText;
23
+ }
24
+
17
25
  add(entry) {
18
26
  if (Array.isArray(entry)) {
19
27
  this._logEntries = this._logEntries.concat(entry);