codeceptjs 3.6.4-beta.1 → 3.6.4-beta.2

package/lib/helper/REST.js

@@ -1,6 +1,5 @@
 const axios = require('axios').default;
 const Helper = require('@codeceptjs/helper');
-const { Agent } = require('https');
 const Secret = require('../secret');
 
 const { beautify } = require('../utils');
@@ -11,12 +10,12 @@ const { beautify } = require('../utils');
  * @typedef RESTConfig
  * @type {object}
  * @prop {string} [endpoint] - API base URL
- * @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 {boolean} [prettyPrintJson=false] - pretty print json for response/request on console logs.
+ * @prop {boolean} [printCurl=false] - print cURL request on console logs. False by default.
+ * @prop {number} [timeout=1000] - timeout for requests in milliseconds. 10000ms by default.
+ * @prop {object} [defaultHeaders] - a list of default headers.
+ * @prop {function} [onRequest] - an async function which can update request object.
+ * @prop {function} [onResponse] - an async function which can update response object.
  * @prop {number} [maxUploadFileSize] - set the max content file size in MB when performing api calls.
  */
 const config = {};
@@ -42,24 +41,6 @@ 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
  *
@@ -96,14 +77,7 @@ class REST extends Helper {
     this._setConfig(config);
 
     this.headers = { ...this.options.defaultHeaders };
-
-    // 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();
+    this.axios = axios.create();
     // @ts-ignore
     this.axios.defaults.headers = this.options.defaultHeaders;
   }
@@ -192,6 +166,7 @@ class REST extends Helper {
     }
 
     this.options.prettyPrintJson ? this.debugSection('Request', beautify(JSON.stringify(_debugRequest))) : this.debugSection('Request', JSON.stringify(_debugRequest));
+    if (this.options.printCurl) this.debugSection('CURL Request', curlize(request));
 
     let response;
     try {
@@ -372,3 +347,22 @@ class REST extends Helper {
   }
 }
 module.exports = REST;
+
+function curlize(request) {
+  let curl = `curl --location --request ${request.method ? request.method.toUpperCase() : 'GET'} ${request.baseURL} `.replace("'", '');
+
+  if (request.headers) {
+    Object.entries(request.headers).forEach(([key, value]) => {
+      curl += `-H "${key}: ${value}" `;
+    });
+  }
+
+  if (!curl.toLowerCase().includes('content-type: application/json')) {
+    curl += '-H "Content-Type: application/json" ';
+  }
+
+  if (request.data) {
+    curl += `-d '${JSON.stringify(request.data)}'`;
+  }
+  return curl;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.6.4-beta.01",
+  "version": "3.6.4-beta.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.13.0",
+    "joi": "17.13.1",
     "js-beautify": "1.15.1",
     "lodash.clonedeep": "4.5.0",
     "lodash.merge": "4.6.2",
@@ -128,7 +128,7 @@
     "@types/node": "20.11.30",
     "@wdio/sauce-service": "8.35.1",
     "@wdio/selenium-standalone-service": "8.3.2",
-    "@wdio/utils": "8.36.1",
+    "@wdio/utils": "8.38.2",
     "@xmldom/xmldom": "0.8.10",
     "apollo-server-express": "2.25.3",
     "chai-as-promised": "7.1.2",

package/typings/promiseBasedTypes.d.ts

@@ -1155,7 +1155,6 @@ declare namespace CodeceptJS {
      * ## Methods
      */
     // @ts-ignore
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -1268,7 +1267,6 @@ declare namespace CodeceptJS {
      * ## Methods
      */
     // @ts-ignore
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): Promise<any>;
@@ -1941,7 +1939,6 @@ declare namespace CodeceptJS {
      * @property [httpsOpts] - key & cert values are the paths to .key and .crt files
      */
     // @ts-ignore
-    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -2067,7 +2064,6 @@ declare namespace CodeceptJS {
      * ## Methods
      */
     // @ts-ignore
-    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -8192,24 +8188,6 @@ 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

@@ -1179,7 +1179,6 @@ declare namespace CodeceptJS {
      * ## Methods
      */
     // @ts-ignore
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -1292,7 +1291,6 @@ declare namespace CodeceptJS {
      * ## Methods
      */
     // @ts-ignore
-    // @ts-ignore
     class ExpectHelper {
         expectEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
         expectNotEqual(actualValue: any, expectedValue: any, customErrorMsg?: any): void;
@@ -1968,7 +1966,6 @@ declare namespace CodeceptJS {
      * @property [httpsOpts] - key & cert values are the paths to .key and .crt files
      */
     // @ts-ignore
-    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -2094,7 +2091,6 @@ declare namespace CodeceptJS {
      * ## Methods
      */
     // @ts-ignore
-    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -8686,20 +8682,20 @@ declare namespace CodeceptJS {
     /**
      * ## Configuration
      * @property [endpoint] - API base URL
-     * @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 [prettyPrintJson = false] - pretty print json for response/request on console logs.
+     * @property [printCurl = false] - print cURL request on console logs. False by default.
+     * @property [timeout = 1000] - timeout for requests in milliseconds. 10000ms by default.
+     * @property [defaultHeaders] - a list of default headers.
+     * @property [onRequest] - an async function which can update request object.
+     * @property [onResponse] - an async function which can update response object.
      * @property [maxUploadFileSize] - set the max content file size in MB when performing api calls.
      */
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
+        printCurl?: boolean;
         timeout?: number;
         defaultHeaders?: any;
-        httpAgent?: any;
         onRequest?: (...params: any[]) => any;
         onResponse?: (...params: any[]) => any;
         maxUploadFileSize?: number;
@@ -8725,24 +8721,6 @@ 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
      *