codeceptjs 3.6.1 → 3.6.2-beta.2

package/lib/helper/Playwright.js

@@ -417,7 +417,14 @@ class Playwright extends Helper {
     }
 
     if (this.options.video) {
-      this.options.recordVideo = { size: parseWindowSize(this.options.windowSize) };
+      // set the video resolution with window size
+      let size = parseWindowSize(this.options.windowSize);
+
+      // if the video resolution is passed, set the record resoultion with that resolution
+      if (this.options.recordVideo && this.options.recordVideo.size) {
+        size = parseWindowSize(this.options.recordVideo.size);
+      }
+      this.options.recordVideo = { size };
     }
     if (this.options.recordVideo && !this.options.recordVideo.dir) {
       this.options.recordVideo.dir = `${global.output_dir}/videos/`;
@@ -2984,7 +2991,7 @@ class Playwright extends Helper {
   }
 
   /**
-   * {{> flushNetworkTraffics }}
+   * {{> startRecordingTraffic }}
    *
    */
   startRecordingTraffic() {
@@ -3656,6 +3663,11 @@ async function targetCreatedHandler(page) {
 
 function parseWindowSize(windowSize) {
   if (!windowSize) return { width: 800, height: 600 };
+
+  if (windowSize.width && windowSize.height) {
+    return { width: parseInt(windowSize.width, 10), height: parseInt(windowSize.height, 10) };
+  }
+
   const dimensions = windowSize.split('x');
   if (dimensions.length < 2 || windowSize === 'maximize') {
     console.log('Invalid window size, setting window to default values');

package/lib/helper/REST.js

@@ -1,5 +1,6 @@
 const axios = require('axios').default;
 const Helper = require('@codeceptjs/helper');
+const { Agent } = require('https');
 const Secret = require('../secret');
 
 const { beautify } = require('../utils');
@@ -13,6 +14,7 @@ const { beautify } = require('../utils');
  * @prop {boolean} [prettyPrintJson=false] - pretty print json for response/request on console logs
  * @prop {number} [timeout=1000] - timeout for requests in milliseconds. 10000ms by default
  * @prop {object} [defaultHeaders] - a list of default headers
+ * @prop {object} [httpAgent] - create an agent with SSL certificate
  * @prop {function} [onRequest] - a async function which can update request object.
  * @prop {function} [onResponse] - a async function which can update response object.
  * @prop {number} [maxUploadFileSize] - set the max content file size in MB when performing api calls.
@@ -40,6 +42,24 @@ const config = {};
  *   }
  *}
  * ```
+ *  With httpAgent
+ *
+ * ```js
+ * {
+ *   helpers: {
+ *     REST: {
+ *       endpoint: 'http://site.com/api',
+ *       prettyPrintJson: true,
+ *       httpAgent: {
+ *          key: fs.readFileSync(__dirname + '/path/to/keyfile.key'),
+ *          cert: fs.readFileSync(__dirname + '/path/to/certfile.cert'),
+ *          rejectUnauthorized: false,
+ *          keepAlive: true
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
  *
  * ## Access From Helpers
  *
@@ -76,7 +96,14 @@ class REST extends Helper {
     this._setConfig(config);
 
     this.headers = { ...this.options.defaultHeaders };
-    this.axios = axios.create();
+
+    // Create an agent with SSL certificate
+    if (this.options.httpAgent) {
+      if (!this.options.httpAgent.key || !this.options.httpAgent.cert) throw Error('Please recheck your httpAgent config!');
+      this.httpsAgent = new Agent(this.options.httpAgent);
+    }
+
+    this.axios = this.httpsAgent ? axios.create({ httpsAgent: this.httpsAgent }) : axios.create();
     // @ts-ignore
     this.axios.defaults.headers = this.options.defaultHeaders;
   }

package/lib/locator.js

@@ -299,6 +299,15 @@ class Locator {
     return new Locator({ xpath });
   }
 
+  /**
+   * @param {String} text
+   * @returns {Locator}
+   */
+  withClassAttr(text) {
+    const xpath = sprintf('%s[%s]', this.toXPath(), `contains(@class, '${text}')`);
+    return new Locator({ xpath });
+  }
+
   /**
    * @param {string} output
    * @returns {Locator}
@@ -541,7 +550,7 @@ function removePrefix(xpath) {
  * @returns {boolean}
  */
 function isPlaywrightLocator(locator) {
-  return locator.includes('_react') || locator.includes('_vue') || locator.includes('data-testid');
+  return locator.includes('_react') || locator.includes('_vue');
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.6.1",
+  "version": "3.6.2-beta.2",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -98,16 +98,16 @@
     "glob": "6.0.1",
     "html-minifier-terser": "7.2.0",
     "inquirer": "6.5.2",
-    "joi": "17.12.2",
+    "joi": "17.12.3",
     "js-beautify": "1.15.1",
     "lodash.clonedeep": "4.5.0",
     "lodash.merge": "4.6.2",
     "mkdirp": "1.0.4",
-    "mocha": "10.3.0",
+    "mocha": "10.4.0",
     "monocart-coverage-reports": "2.7.4",
     "ms": "2.1.3",
     "ora-classic": "5.4.2",
-    "pactum": "3.6.6",
+    "pactum": "3.6.7",
     "parse-function": "5.6.10",
     "parse5": "7.1.2",
     "promise-retry": "1.1.1",
@@ -135,7 +135,7 @@
     "chai-subset": "1.6.0",
     "contributor-faces": "1.1.0",
     "documentation": "12.3.0",
-    "electron": "28.2.1",
+    "electron": "30.0.1",
     "eslint": "8.56.0",
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-plugin-import": "2.29.1",
@@ -148,7 +148,7 @@
     "jsdoc": "3.6.11",
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.10.1",
-    "playwright": "1.43.0",
+    "playwright": "1.43.1",
     "puppeteer": "22.6.3",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.1",
@@ -179,4 +179,4 @@
       "strict": false
     }
   }
-}
+}

package/typings/promiseBasedTypes.d.ts

@@ -4765,10 +4765,11 @@ declare namespace CodeceptJS {
          */
         stopMockingRoute(url?: string | RegExp, handler?: (...params: any[]) => any): Promise<any>;
         /**
-         * Resets all recorded network requests.
+         * Starts recording the network traffics.
+         * This also resets recorded network requests.
          *
          * ```js
-         * I.flushNetworkTraffics();
+         * I.startRecordingTraffic();
          * ```
          */
         startRecordingTraffic(): Promise<any>;
@@ -8027,6 +8028,24 @@ declare namespace CodeceptJS {
      *   }
      * }
      * ```
+     *  With httpAgent
+     *
+     * ```js
+     * {
+     *   helpers: {
+     *     REST: {
+     *       endpoint: 'http://site.com/api',
+     *       prettyPrintJson: true,
+     *       httpAgent: {
+     *          key: fs.readFileSync(__dirname + '/path/to/keyfile.key'),
+     *          cert: fs.readFileSync(__dirname + '/path/to/certfile.cert'),
+     *          rejectUnauthorized: false,
+     *          keepAlive: true
+     *       }
+     *     }
+     *   }
+     * }
+     * ```
      *
      * ## Access From Helpers
      *

package/typings/types.d.ts

@@ -5015,11 +5015,13 @@ declare namespace CodeceptJS {
          */
         stopMockingRoute(url?: string | RegExp, handler?: (...params: any[]) => any): void;
         /**
-         * Resets all recorded network requests.
+         * Starts recording the network traffics.
+         * This also resets recorded network requests.
          *
          * ```js
-         * I.flushNetworkTraffics();
+         * I.startRecordingTraffic();
          * ```
+         * @returns automatically synchronized promise through #recorder
          */
         startRecordingTraffic(): void;
         /**
@@ -8523,6 +8525,7 @@ declare namespace CodeceptJS {
      * @property [prettyPrintJson = false] - pretty print json for response/request on console logs
      * @property [timeout = 1000] - timeout for requests in milliseconds. 10000ms by default
      * @property [defaultHeaders] - a list of default headers
+     * @property [httpAgent] - create an agent with SSL certificate
      * @property [onRequest] - a async function which can update request object.
      * @property [onResponse] - a async function which can update response object.
      * @property [maxUploadFileSize] - set the max content file size in MB when performing api calls.
@@ -8532,6 +8535,7 @@ declare namespace CodeceptJS {
         prettyPrintJson?: boolean;
         timeout?: number;
         defaultHeaders?: any;
+        httpAgent?: any;
         onRequest?: (...params: any[]) => any;
         onResponse?: (...params: any[]) => any;
         maxUploadFileSize?: number;
@@ -8557,6 +8561,24 @@ declare namespace CodeceptJS {
      *   }
      * }
      * ```
+     *  With httpAgent
+     *
+     * ```js
+     * {
+     *   helpers: {
+     *     REST: {
+     *       endpoint: 'http://site.com/api',
+     *       prettyPrintJson: true,
+     *       httpAgent: {
+     *          key: fs.readFileSync(__dirname + '/path/to/keyfile.key'),
+     *          cert: fs.readFileSync(__dirname + '/path/to/certfile.cert'),
+     *          rejectUnauthorized: false,
+     *          keepAlive: true
+     *       }
+     *     }
+     *   }
+     * }
+     * ```
      *
      * ## Access From Helpers
      *
@@ -12153,6 +12175,7 @@ declare namespace CodeceptJS {
         withAttr(attributes: {
             [key: string]: string;
         }): Locator;
+        withClassAttr(text: string): Locator;
         as(output: string): Locator;
         inside(locator: CodeceptJS.LocatorOrString): Locator;
         after(locator: CodeceptJS.LocatorOrString): Locator;
@@ -12377,14 +12400,14 @@ declare namespace CodeceptJS {
      * Detox provides a grey box testing for mobile applications, playing especially good for React Native apps.
      *
      * Detox plays quite differently from Appium. To establish detox testing you need to build a mobile application in a special way to inject Detox code.
-     * This why **Detox is grey box testing** solution, so you need an access to application source code, and a way to build and execute it on emulator.
+     * This why **Detox is grey box testing** solution, so you need access to application source code, and a way to build and execute it on emulator.
      *
      * Comparing to Appium, Detox runs faster and more stable but requires an additional setup for build.
      *
      * ### Setup
      *
-     * 1. [Install and configure Detox for iOS](https://github.com/wix/Detox/blob/master/docs/Introduction.GettingStarted.md) and [Android](https://github.com/wix/Detox/blob/master/docs/Introduction.Android.md)
-     * 2. [Build an application](https://github.com/wix/Detox/blob/master/docs/Introduction.GettingStarted.md#step-4-build-your-app-and-run-detox-tests) using `detox build` command.
+     * 1. [Install and configure Detox](https://wix.github.io/Detox/docs/introduction/project-setup)
+     * 2. [Build an application](https://wix.github.io/Detox/docs/introduction/project-setup#step-5-build-the-app) using `detox build` command.
      * 3. Install [CodeceptJS](https://codecept.io) and detox-helper:
      *
      * ```
@@ -12397,15 +12420,28 @@ declare namespace CodeceptJS {
      *
      * ```js
      *  "detox": {
-     *    "configurations": {
-     *      "ios.sim.debug": {
-     *        "binaryPath": "ios/build/Build/Products/Debug-iphonesimulator/example.app",
-     *        "build": "xcodebuild -project ios/example.xcodeproj -scheme example -configuration Debug -sdk iphonesimulator -derivedDataPath ios/build",
-     *        "type": "ios.simulator",
-     *        "name": "iPhone 7"
-     *      }
-     *    }
-     *  }
+     *     "configurations": {
+     *       "ios.sim.debug": {
+     *         "device": "simulator",
+     *         "app": "ios.debug"
+     *       }
+     *     },
+     *     "apps": {
+     *       "ios.debug": {
+     *         "type": "ios.app",
+     *         "binaryPath": "../test/ios/build/Build/Products/Debug-iphonesimulator/MyTestApp.app",
+     *         "build": "xcodebuild -workspace ../test/ios/MyTestApp.xcworkspace -scheme MyTestApp -configuration Debug -sdk iphonesimulator -derivedDataPath ../test/ios/build"
+     *       }
+     *     },
+     *     "devices": {
+     *       "simulator": {
+     *         "type": "ios.simulator",
+     *         "device": {
+     *           "type": "iPhone 15"
+     *         }
+     *       }
+     *     }
+     *   }
      * ```
      *
      *
@@ -12500,6 +12536,14 @@ declare namespace CodeceptJS {
          * ```
          */
         setPortraitOrientation(): void;
+        /**
+         * Grab the device platform
+         *
+         * ```js
+         * const platform = await I.grabPlatform();
+         * ```
+         */
+        grabPlatform(): void;
         /**
          * Execute code only on iOS
          *
@@ -12589,6 +12633,19 @@ declare namespace CodeceptJS {
          * ```
          */
         click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): void;
+        /**
+         * Clicks on an element.
+         * Element can be located by its label
+         *
+         * The second parameter is a context (id | type | accessibility id) to narrow the search.
+         *
+         *
+         * ```js
+         * I.tapByLabel('Login'); // locate by text
+         * I.tapByLabel('Login', '#nav'); // locate by text inside #nav
+         * ```
+         */
+        tapByLabel(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): void;
         /**
          * Performs click on element with horizontal and vertical offset.
          * An element is located by text, id, accessibility id.
@@ -12639,6 +12696,17 @@ declare namespace CodeceptJS {
          * @param [context = null] - context element
          */
         seeElement(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): void;
+        /**
+         * Checks if an element exists.
+         *
+         * ```js
+         * I.checkIfElementExists('~edit'); // located by accessibility id
+         * I.checkIfElementExists('~edit', '#menu'); // element inside #menu
+         * ```
+         * @param locator - element to locate
+         * @param [context = null] - context element
+         */
+        checkIfElementExists(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): void;
         /**
          * Checks that element is not visible.
          * Use second parameter to narrow down the search.
@@ -12688,6 +12756,18 @@ declare namespace CodeceptJS {
          * @param value - value to fill
          */
         fillField(field: CodeceptJS.LocatorOrString, value: string): void;
+        /**
+         * Taps return key.
+         * A field can be located by text, accessibility id, id.
+         *
+         * ```js
+         * I.tapReturnKey('Username');
+         * I.tapReturnKey('~name');
+         * I.tapReturnKey({ android: 'NAME', ios: 'name' });
+         * ```
+         * @param field - an input element to fill in
+         */
+        tapReturnKey(field: CodeceptJS.LocatorOrString): void;
         /**
          * Clears a text field.
          * A field can be located by text, accessibility id, id.
@@ -12813,7 +12893,7 @@ declare namespace CodeceptJS {
          */
         waitForElementVisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
         /**
-         * Waits an elment to become not visible.
+         * Waits an elmenet to become not visible.
          *
          * ```js
          * I.waitToHide('#message', 2); // wait for 2 seconds
@@ -12822,6 +12902,14 @@ declare namespace CodeceptJS {
          * @param [sec = 5] - number of seconds to wait
          */
         waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): void;
+        /**
+         * Scrolls within a scrollable container to an element.
+         * @param targetLocator - Locator of the element to scroll to
+         * @param containerLocator - Locator of the scrollable container
+         * @param direction - 'up' or 'down'
+         * @param [offset = 100] - Offset for scroll, can be adjusted based on need
+         */
+        scrollToElement(targetLocator: CodeceptJS.LocatorOrString, containerLocator: CodeceptJS.LocatorOrString, direction?: string, offset?: number): void;
     }
     /**
      * Abstract class.