codeceptjs 3.6.2-beta.1 → 3.6.2-beta.2

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}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.6.2-beta.1",
+  "version": "3.6.2-beta.2",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -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",

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
@@ -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
@@ -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;