codeceptjs 3.2.2 → 3.2.3

package/lib/helper/Appium.js

@@ -331,6 +331,7 @@ class Appium extends Webdriver {
    *
    * @param {*} caps
    * @param {*} fn
+   * @return {Promise<any>}
    */
   async runOnIOS(caps, fn) {
     if (this.platform !== 'ios') return;
@@ -373,6 +374,7 @@ class Appium extends Webdriver {
    *
    * @param {*} caps
    * @param {*} fn
+   * @return {Promise<any>}
    */
   async runOnAndroid(caps, fn) {
     if (this.platform !== 'android') return;
@@ -393,6 +395,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {*} fn
+   * @return {Promise<any>}
    */
   /* eslint-disable */
   async runInWeb(fn) {
@@ -434,6 +437,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {string} bundleId String  ID of bundled app
+   * @return {Promise<void>}
    *
    * Appium: support only Android
    */
@@ -451,6 +455,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {string} bundleId String  ID of bundled app
+   * @return {Promise<void>}
    *
    * Appium: support only Android
    */
@@ -467,6 +472,7 @@ class Appium extends Webdriver {
    * I.installApp('/path/to/file.apk');
    * ```
    * @param {string} path path to apk file
+   * @return {Promise<void>}
    *
    * Appium: support only Android
    */
@@ -508,6 +514,7 @@ class Appium extends Webdriver {
    * I.seeCurrentActivityIs(".HomeScreenActivity")
    * ```
    * @param {string} currentActivity
+   * @return {Promise<void>}
    *
    * Appium: support only Android
    */
@@ -524,6 +531,8 @@ class Appium extends Webdriver {
    * I.seeDeviceIsLocked();
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only Android
    */
   async seeDeviceIsLocked() {
@@ -539,6 +548,8 @@ class Appium extends Webdriver {
    * I.seeDeviceIsUnlocked();
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only Android
    */
   async seeDeviceIsUnlocked() {
@@ -555,6 +566,8 @@ class Appium extends Webdriver {
    * I.seeOrientationIs('LANDSCAPE')
    * ```
    *
+   * @return {Promise<void>}
+   *
    * @param {'LANDSCAPE'|'PORTRAIT'} orientation LANDSCAPE or PORTRAIT
    *
    * Appium: support Android and iOS
@@ -586,6 +599,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {'LANDSCAPE'|'PORTRAIT'} orientation LANDSCAPE or PORTRAIT
+   * @return {Promise<any>}
    *
    * Appium: support Android and iOS
    */
@@ -609,6 +623,8 @@ class Appium extends Webdriver {
    * let contexts = await I.grabAllContexts();
    * ```
    *
+   * @return {Promise<string[]>}
+   *
    * Appium: support Android and iOS
    */
   async grabAllContexts() {
@@ -623,6 +639,8 @@ class Appium extends Webdriver {
    * let context = await I.grabContext();
    * ```
    *
+   * @return {Promise<string|null>}
+   *
    * Appium: support Android and iOS
    */
   async grabContext() {
@@ -637,6 +655,8 @@ class Appium extends Webdriver {
    * let activity = await I.grabCurrentActivity();
    * ```
    *
+   * @return {Promise<string>}
+   *
    * Appium: support only Android
    */
   async grabCurrentActivity() {
@@ -653,6 +673,8 @@ class Appium extends Webdriver {
    * let con = await I.grabNetworkConnection();
    * ```
    *
+   * @return {Promise<{}>}
+   *
    * Appium: support only Android
    */
   async grabNetworkConnection() {
@@ -673,6 +695,8 @@ class Appium extends Webdriver {
    * let orientation = await I.grabOrientation();
    * ```
    *
+   * @return {Promise<string>}
+   *
    * Appium: support Android and iOS
    */
   async grabOrientation() {
@@ -689,6 +713,8 @@ class Appium extends Webdriver {
    * let settings = await I.grabSettings();
    * ```
    *
+   * @return {Promise<string>}
+   *
    * Appium: support Android and iOS
    */
   async grabSettings() {
@@ -720,6 +746,8 @@ class Appium extends Webdriver {
    * I.switchToWeb('WEBVIEW_io.selendroid.testapp');
    * ```
    *
+   * @return {Promise<void>}
+   *
    * @param {string} [context]
    */
   async switchToWeb(context) {
@@ -747,6 +775,7 @@ class Appium extends Webdriver {
    * I.switchToNative('SOME_OTHER_CONTEXT');
    * ```
    * @param {*} context
+   * @return {Promise<void>}
    */
   async switchToNative(context = null) {
     this.isWeb = false;
@@ -763,6 +792,8 @@ class Appium extends Webdriver {
    * I.startActivity('io.selendroid.testapp', '.RegisterUserActivity');
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only Android
    */
   async startActivity(appPackage, appActivity) {
@@ -786,6 +817,8 @@ class Appium extends Webdriver {
    * ```
    * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/setNetworkConnection.html).
    *
+   * @return {Promise<{}>}
+   *
    * Appium: support only Android
    */
   async setNetworkConnection(value) {
@@ -801,6 +834,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {object} settings object
+   * @return {Promise<any>}
    *
    * Appium: support Android and iOS
    */
@@ -841,6 +875,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {number} keyValue  Device specific key value
+   * @return {Promise<void>}
    *
    * Appium: support only Android
    */
@@ -859,6 +894,8 @@ class Appium extends Webdriver {
    * I.openNotifications();
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only Android
    */
   async openNotifications() {
@@ -877,6 +914,8 @@ class Appium extends Webdriver {
    * I.makeTouchAction("~buttonStartWebviewCD", 'tap');
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support Android and iOS
    */
   async makeTouchAction(locator, action) {
@@ -898,6 +937,8 @@ class Appium extends Webdriver {
    *
    * Shortcut for `makeTouchAction`
    *
+   * @return {Promise<void>}
+   *
    * @param {*} locator
    */
   async tap(locator) {
@@ -918,6 +959,7 @@ class Appium extends Webdriver {
    * @param {number} xoffset
    * @param {number} yoffset
    * @param {number} [speed=1000] (optional), 1000 by default
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -971,6 +1013,7 @@ class Appium extends Webdriver {
    * @param {CodeceptJS.LocatorOrString} locator
    * @param {number} [yoffset] (optional)
    * @param {number} [speed=1000] (optional), 1000 by default
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -999,6 +1042,7 @@ class Appium extends Webdriver {
    * @param {CodeceptJS.LocatorOrString} locator
    * @param {number} [xoffset] (optional)
    * @param {number} [speed=1000] (optional), 1000 by default
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -1025,6 +1069,7 @@ class Appium extends Webdriver {
    * @param {CodeceptJS.LocatorOrString} locator
    * @param {number} [xoffset] (optional)
    * @param {number} [speed=1000] (optional), 1000 by default
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -1051,6 +1096,7 @@ class Appium extends Webdriver {
    * @param {CodeceptJS.LocatorOrString} locator
    * @param {number} [yoffset] (optional)
    * @param {number} [speed=1000] (optional), 1000 by default
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -1084,6 +1130,7 @@ class Appium extends Webdriver {
    * @param {number} timeout
    * @param {number} offset
    * @param {number} speed
+   * @return {Promise<void>}
    *
    * Appium: support Android and iOS
    */
@@ -1181,6 +1228,10 @@ class Appium extends Webdriver {
    * I.pullFile('/storage/emulated/0/DCIM/logo.png', output_dir);
    * ```
    *
+   * @param {string} path
+   * @param {string} dest
+   * @return {Promise<string>}
+   *
    * Appium: support Android and iOS
    */
   async pullFile(path, dest) {
@@ -1200,6 +1251,8 @@ class Appium extends Webdriver {
    * I.shakeDevice();
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only iOS
    */
   async shakeDevice() {
@@ -1216,6 +1269,8 @@ class Appium extends Webdriver {
    *
    * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/rotate.html).
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only iOS
    */
   async rotate(x, y, duration, radius, rotation, touchCount) {
@@ -1228,6 +1283,8 @@ class Appium extends Webdriver {
    *
    * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/setImmediateValue.html).
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only iOS
    */
   async setImmediateValue(id, value) {
@@ -1244,6 +1301,8 @@ class Appium extends Webdriver {
    * I.touchId(false); // simulates invalid fingerprint
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only iOS
    * TODO: not tested
    */
@@ -1260,6 +1319,8 @@ class Appium extends Webdriver {
    * I.closeApp();
    * ```
    *
+   * @return {Promise<void>}
+   *
    * Appium: support only iOS
    */
   async closeApp() {
@@ -1410,6 +1471,7 @@ class Appium extends Webdriver {
    * ```
    *
    * @param {string} fileName file name to save.
+   * @return {Promise<void>}
    */
   async saveScreenshot(fileName) {
     return super.saveScreenshot(fileName, false);

package/lib/helper/FileSystem.js

@@ -15,7 +15,17 @@ const { fileEquals } = require('../assert/equal');
  * I.amInPath('test');
  * I.seeFile('codecept.json');
  * I.seeInThisFile('FileSystem');
- * I.dontSeeInThisFile("WebDriverIO");
+ * I.dontSeeInThisFile("WebDriver");
+ * ```
+ *
+ * ## Configuration
+ *
+ * Enable helper in config file:
+ *
+ * ```js
+ * helpers: {
+ *     FileSystem: {},
+ * }
  * ```
  *
  * ## Methods

package/lib/helper/Playwright.js

@@ -14,7 +14,6 @@ const {
   ucfirst,
   fileExists,
   chunkArray,
-  toCamelCase,
   convertCssPropertiesToCamelCase,
   screenshotOutputFolder,
   getNormalizedKeyAttributeValue,
@@ -73,7 +72,7 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  * * `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`, `networkidle`. Choose one of those options is possible. See [Playwright API](https://github.com/microsoft/playwright/blob/master/docs/api.md#pagewaitfornavigationoptions).
+ * * `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).
  * * `pressKeyDelay`: (optional, default: '10'). Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
  * * `getPageTimeout` (optional, default: '0') config option to set maximum navigation time in milliseconds.
  * * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000.
@@ -84,6 +83,7 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  * * `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
  * * `chromium`: (optional) pass additional chromium options
  * * `electron`: (optional) pass additional electron options
+ * * `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).
  *
  * #### Video Recording Customization
  *
@@ -301,6 +301,11 @@ class Playwright extends Helper {
       headless: !this.options.show,
       ...this._getOptionsForBrowser(config),
     };
+
+    if (this.options.channel && this.options.browser === 'chromium') {
+      this.playwrightOptions.channel = this.options.channel;
+    }
+
     if (this.options.video) {
       this.options.recordVideo = { size: parseWindowSize(this.options.windowSize) };
     }
@@ -501,10 +506,10 @@ class Playwright extends Helper {
   * First argument is a description of an action.
   * Second argument is async function that gets this helper as parameter.
   *
-  * { [`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.
+  * { [`page`](https://github.com/microsoft/playwright/blob/main/docs/src/api/class-page.md), [`context`](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.
   *
   * ```js
-  * I.usePlaywrightTo('emulate offline mode', async ({ context }) {
+  * I.usePlaywrightTo('emulate offline mode', async ({ context }) => {
   *   await context.setOffline(true);
   * });
   * ```
@@ -1071,7 +1076,7 @@ class Playwright extends Helper {
    * I.openNewTab();
    * ```
    *
-   * You can pass in [page options](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsernewpageoptions) to emulate device on this page
+   * You can pass in [page options](https://github.com/microsoft/playwright/blob/main/docs/api.md#browsernewpageoptions) to emulate device on this page
    *
    * ```js
    * // enable mobile
@@ -1580,7 +1585,7 @@ class Playwright extends Helper {
    */
   async clearCookie() {
     // Playwright currently doesn't support to delete a certain cookie
-    // https://github.com/microsoft/playwright/blob/master/docs/api.md#class-browsercontext
+    // https://github.com/microsoft/playwright/blob/main/docs/api.md#class-browsercontext
     if (!this.browserContext) return;
     return this.browserContext.clearCookies();
   }
@@ -1888,7 +1893,7 @@ class Playwright extends Helper {
     }
 
     if (this.options.trace) {
-      const path = `${global.output_dir}/trace/${clearString(test.title).slice(0, 255)}.zip`;
+      const path = `${`${global.output_dir}/trace/${clearString(test.title)}`.slice(0, 251)}.zip`;
       await this.browserContext.tracing.stop({ path });
       test.artifacts.trace = path;
     }

package/lib/plugin/autoLogin.js

@@ -37,7 +37,7 @@ const defaultConfig = {
  * ```js
  * // inside a test file
  * // use login to inject auto-login function
- * Before(login => {
+ * Before(({ login }) => {
  *    login('user'); // login using user session
  * });
  *

package/lib/plugin/tryTo.js

@@ -42,6 +42,12 @@ const defaultConfig = {
  * #### Multiple Conditional Assertions
  *
  * ```js
+ *
+ * Add assert requires first:
+ * ```js
+ * const assert = require('assert');
+ * ```
+ * Then use the assert:
  * const result1 = await tryTo(() => I.see('Hello, user'));
  * const result2 = await tryTo(() => I.seeElement('.welcome'));
  * assert.ok(result1 && result2, 'Assertions were not succesful');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.2.2",
+  "version": "3.2.3",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",

package/typings/index.d.ts

@@ -10,6 +10,8 @@ declare namespace CodeceptJS {
   type Cookie = {
     name: string;
     value: string;
+    domain?: string,
+    path?: string,
   };
 
   interface PageScrollPosition {