codeceptjs 3.6.2-beta.1 → 3.6.2

package/README.md

@@ -46,7 +46,7 @@ CodeceptJS uses **Helper** modules to provide actions to `I` object. Currently,
 
 * [**Playwright**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Playwright.md) - is a Node library to automate the Chromium, WebKit and Firefox browsers with a single API.
 * [**Puppeteer**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Puppeteer.md) - uses Google Chrome's Puppeteer for fast headless testing.
-* [**WebDriver**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/WebDriver.md) - uses [webdriverio](http://webdriver.io/) to run tests via WebDriver protocol.
+* [**WebDriver**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/WebDriver.md) - uses [webdriverio](http://webdriver.io/) to run tests via WebDriver or Devtools protocol.
 * [**TestCafe**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/TestCafe.md) - cheap and fast cross-browser test automation.
 * [**Appium**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Appium.md) - for **mobile testing** with Appium
 * [**Detox**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Detox.md) - This is a wrapper on top of Detox library, aimed to unify testing experience for CodeceptJS framework. Detox provides a grey box testing for mobile applications, playing especially well for React Native apps.

package/lib/helper/Playwright.js

@@ -3115,8 +3115,6 @@ class Playwright extends Helper {
   /**
    * Returns full URL of request matching parameter "urlMatch".
    *
-   * @param {string|RegExp} urlMatch Expected URL of request in network traffic. Can be a string or a regular expression.
-   *
    * Examples:
    *
    * ```js
@@ -3124,6 +3122,7 @@ class Playwright extends Helper {
    * I.grabTrafficUrl(/session.*start/);
    * ```
    *
+   * @param {string|RegExp} urlMatch Expected URL of request in network traffic. Can be a string or a regular expression.
    * @return {Promise<*>}
    */
   grabTrafficUrl(urlMatch) {

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/helper/WebDriver.js

@@ -1795,14 +1795,21 @@ class WebDriver extends Helper {
    * {{> saveScreenshot }}
    */
   async saveScreenshot(fileName, fullPage = false) {
-    const outputFile = screenshotOutputFolder(fileName);
+    let outputFile = screenshotOutputFolder(fileName);
 
     if (this.activeSessionName) {
       const browser = this.sessionWindows[this.activeSessionName];
 
-      if (browser) {
-        this.debug(`Screenshot of ${this.activeSessionName} session has been saved to ${outputFile}`);
-        return browser.saveScreenshot(outputFile);
+      for (const sessionName in this.sessionWindows) {
+        const activeSessionPage = this.sessionWindows[sessionName];
+        outputFile = screenshotOutputFolder(`${sessionName}_${fileName}`);
+
+        this.debug(`${sessionName} - Screenshot is saving to ${outputFile}`);
+
+        if (browser) {
+          this.debug(`Screenshot of ${sessionName} session has been saved to ${outputFile}`);
+          return browser.saveScreenshot(outputFile);
+        }
       }
     }
 

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}

package/lib/plugin/screenshotOnFail.js

@@ -110,7 +110,8 @@ module.exports = function (config) {
           allureReporter.addAttachment('Main session - Last Seen Screenshot', fs.readFileSync(path.join(global.output_dir, fileName)), dataType);
 
           if (helper.activeSessionName) {
-            for (const sessionName in helper.sessionPages) {
+            const sessions = helper.sessionPages || helper.sessionWindows;
+            for (const sessionName in sessions) {
               const screenshotFileName = `${sessionName}_${fileName}`;
               test.artifacts[`${sessionName.replace(/ /g, '_')}_screenshot`] = path.join(global.output_dir, screenshotFileName);
               allureReporter.addAttachment(`${sessionName} - Last Seen Screenshot`, fs.readFileSync(path.join(global.output_dir, screenshotFileName)), dataType);

package/lib/plugin/stepByStepReport.js

@@ -112,11 +112,13 @@ module.exports = function (config) {
   });
 
   event.dispatcher.on(event.test.failed, (test, err) => {
+    // BeforeSuite/AfterSuite don't have any access to the browser, hence it could not take screenshot.
+    if (test.ctx._runnable.title.includes('hook: BeforeSuite')) return;
     persist(test, err);
   });
 
   event.dispatcher.on(event.all.result, () => {
-    if (!Object.keys(slides).length) return;
+    if (Object.keys(recordedTests).length === 0 || !Object.keys(slides).length) return;
 
     let links = '';
 
@@ -148,7 +150,7 @@ module.exports = function (config) {
     stepNum++;
     slides[fileName] = step;
     try {
-      await helper.saveScreenshot(path.relative(reportDir, path.join(dir, fileName)), config.fullPageScreenshots);
+      await helper.saveScreenshot(path.join(dir, fileName), config.fullPageScreenshots);
     } catch (err) {
       output.plugin(`Can't save step screenshot: ${err}`);
       error = err;

package/lib/utils.js

@@ -291,7 +291,7 @@ module.exports.screenshotOutputFolder = function (fileName) {
   const fileSep = path.sep;
 
   if (!fileName.includes(fileSep) || fileName.includes('record_')) {
-    return path.join(global.output_dir, fileName);
+    return path.resolve(global.output_dir, fileName);
   }
   return path.resolve(global.codecept_dir, fileName);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.6.2-beta.1",
+  "version": "3.6.2",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -98,7 +98,7 @@
     "glob": "6.0.1",
     "html-minifier-terser": "7.2.0",
     "inquirer": "6.5.2",
-    "joi": "17.12.3",
+    "joi": "17.13.0",
     "js-beautify": "1.15.1",
     "lodash.clonedeep": "4.5.0",
     "lodash.merge": "4.6.2",
@@ -128,14 +128,14 @@
     "@types/node": "20.11.30",
     "@wdio/sauce-service": "8.35.1",
     "@wdio/selenium-standalone-service": "8.3.2",
-    "@wdio/utils": "8.33.1",
+    "@wdio/utils": "8.36.1",
     "@xmldom/xmldom": "0.8.10",
     "apollo-server-express": "2.25.3",
     "chai-as-promised": "7.1.1",
     "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",
@@ -164,7 +164,7 @@
     "typedoc-plugin-markdown": "3.17.1",
     "typescript": "5.3.3",
     "wdio-docker-service": "1.5.0",
-    "webdriverio": "8.35.1",
+    "webdriverio": "8.36.1",
     "xml2js": "0.6.2",
     "xpath": "0.0.34"
   },
@@ -179,4 +179,4 @@
       "strict": false
     }
   }
-}
+}

package/typings/promiseBasedTypes.d.ts

@@ -1154,7 +1154,6 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -1781,7 +1780,6 @@ declare namespace CodeceptJS {
      * @property [host = "0.0.0.0"] - Mock server host
      * @property [httpsOpts] - key & cert values are the paths to .key and .crt files
      */
-    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -1906,7 +1904,6 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
-    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -4828,7 +4825,6 @@ declare namespace CodeceptJS {
         stopRecordingTraffic(): Promise<any>;
         /**
          * Returns full URL of request matching parameter "urlMatch".
-         * @param urlMatch - Expected URL of request in network traffic. Can be a string or a regular expression.
          *
          * Examples:
          *
@@ -4836,6 +4832,7 @@ declare namespace CodeceptJS {
          * I.grabTrafficUrl('https://api.example.com/session');
          * I.grabTrafficUrl(/session.*start/);
          * ```
+         * @param urlMatch - Expected URL of request in network traffic. Can be a string or a regular expression.
          */
         grabTrafficUrl(urlMatch: string | RegExp): Promise<any>;
         /**
@@ -8031,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

@@ -1178,7 +1178,6 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -1808,7 +1807,6 @@ declare namespace CodeceptJS {
      * @property [host = "0.0.0.0"] - Mock server host
      * @property [httpsOpts] - key & cert values are the paths to .key and .crt files
      */
-    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -1933,7 +1931,6 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
-    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -5079,7 +5076,6 @@ declare namespace CodeceptJS {
         stopRecordingTraffic(): void;
         /**
          * Returns full URL of request matching parameter "urlMatch".
-         * @param urlMatch - Expected URL of request in network traffic. Can be a string or a regular expression.
          *
          * Examples:
          *
@@ -5087,6 +5083,7 @@ declare namespace CodeceptJS {
          * I.grabTrafficUrl('https://api.example.com/session');
          * I.grabTrafficUrl(/session.*start/);
          * ```
+         * @param urlMatch - Expected URL of request in network traffic. Can be a string or a regular expression.
          */
         grabTrafficUrl(urlMatch: string | RegExp): Promise<any>;
         /**
@@ -8528,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.
@@ -8537,6 +8535,7 @@ declare namespace CodeceptJS {
         prettyPrintJson?: boolean;
         timeout?: number;
         defaultHeaders?: any;
+        httpAgent?: any;
         onRequest?: (...params: any[]) => any;
         onResponse?: (...params: any[]) => any;
         maxUploadFileSize?: number;
@@ -8562,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
      *
@@ -12158,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;