codeceptjs 4.0.0-beta.2 → 4.0.0-beta.20

package/lib/helper/REST.js

@@ -1,8 +1,8 @@
-import { default as axios } from 'axios';
-import Helper from '@codeceptjs/helper';
-import Secret from '../secret.js';
-import { beautify } from '../utils.js';
-import { output } from '../output.js';
+import axios from 'axios'
+import Helper from '@codeceptjs/helper'
+import { Agent } from 'https'
+import Secret from '../secret.js'
+import { beautify } from '../utils.js'
 
 /**
  * ## Configuration
@@ -10,14 +10,16 @@ import { output } from '../output.js';
  * @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 {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 {object} [httpAgent] - create an agent with SSL certificate
+ * @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 = {};
+const config = {}
 
 /**
  * REST helper allows to send additional requests to the REST API during acceptance tests.
@@ -41,6 +43,41 @@ 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
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ```js
+ * {
+ *   helpers: {
+ *     REST: {
+ *       endpoint: 'http://site.com/api',
+ *       prettyPrintJson: true,
+ *       httpAgent: {
+ *          ca: fs.readFileSync(__dirname + '/path/to/ca.pem'),
+ *          rejectUnauthorized: false,
+ *          keepAlive: true
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
  * ## Access From Helpers
  *
  * Send REST requests by accessing `_executeRequest` method:
@@ -56,7 +93,7 @@ const config = {};
  */
 class REST extends Helper {
   constructor(config) {
-    super(config);
+    super(config)
     this.options = {
       timeout: 10000,
       defaultHeaders: {},
@@ -64,39 +101,57 @@ class REST extends Helper {
       prettyPrintJson: false,
       onRequest: null,
       onResponse: null,
-    };
+    }
 
     if (this.options.maxContentLength) {
-      const maxContentLength = this.options.maxUploadFileSize * 1024 * 1024;
-      this.options.maxContentLength = maxContentLength;
-      this.options.maxBodyLength = maxContentLength;
+      const maxContentLength = this.options.maxUploadFileSize * 1024 * 1024
+      this.options.maxContentLength = maxContentLength
+      this.options.maxBodyLength = maxContentLength
     }
 
     // override defaults with config
-    this._setConfig(config);
+    this._setConfig(config)
+
+    this.headers = { ...this.options.defaultHeaders }
+
+    // Create an agent with SSL certificate
+    if (this.options.httpAgent) {
+      // if one of those keys is there, all good to go
+      if (this.options.httpAgent.ca || this.options.httpAgent.key || this.options.httpAgent.cert) {
+        this.httpsAgent = new Agent(this.options.httpAgent)
+      } else {
+        // otherwise, throws an error of httpAgent config
+        throw Error('Please recheck your httpAgent config!')
+      }
+    }
 
-    this.headers = { ...this.options.defaultHeaders };
-    this.axios = axios.create();
+    this.axios = this.httpsAgent ? axios.create({ httpsAgent: this.httpsAgent }) : axios.create()
     // @ts-ignore
-    this.axios.defaults.headers = this.options.defaultHeaders;
+    this.axios.defaults.headers = this.options.defaultHeaders
   }
 
   static _config() {
     return [
-      { name: 'endpoint', message: 'Endpoint of API you are going to test', default: 'http://localhost:3000/api' },
-    ];
+      {
+        name: 'endpoint',
+        message: 'Endpoint of API you are going to test',
+        default: 'http://localhost:3000/api',
+      },
+    ]
   }
 
   static _checkRequirements() {
     try {
-      require('axios');
+      // In ESM, axios is already imported at the top, so no need to check
+      // The import will fail at module load time if axios is missing
+      return null
     } catch (e) {
-      return ['axios'];
+      return ['axios']
     }
   }
 
   _before() {
-    this.headers = { ...this.options.defaultHeaders };
+    this.headers = { ...this.options.defaultHeaders }
   }
 
   /**
@@ -105,7 +160,7 @@ class REST extends Helper {
    * @param {object} headers headers list
    */
   haveRequestHeaders(headers) {
-    this.headers = { ...this.headers, ...headers };
+    this.headers = { ...this.headers, ...headers }
   }
 
   /**
@@ -119,7 +174,7 @@ class REST extends Helper {
    * @param {string | CodeceptJS.Secret} accessToken  Bearer access token
    */
   amBearerAuthenticated(accessToken) {
-    this.haveRequestHeaders({ Authorization: `Bearer ${accessToken}` });
+    this.haveRequestHeaders({ Authorization: `Bearer ${accessToken}` })
   }
 
   /**
@@ -131,54 +186,74 @@ class REST extends Helper {
    */
   async _executeRequest(request) {
     // Add custom headers. They can be set by amBearerAuthenticated() or haveRequestHeaders()
-    request.headers = { ...this.headers, ...request.headers };
+    request.headers = { ...this.headers, ...request.headers }
 
-    const _debugRequest = { ...request };
-    this.axios.defaults.timeout = request.timeout || this.options.timeout;
+    const _debugRequest = { ...request }
+    this.axios.defaults.timeout = request.timeout || this.options.timeout
 
     if (this.headers && this.headers.auth) {
-      request.auth = this.headers.auth;
+      request.auth = this.headers.auth
     }
 
     if (typeof request.data === 'object') {
-      const returnedValue = {};
+      const returnedValue = {}
       for (const [key, value] of Object.entries(request.data)) {
-        returnedValue[key] = value;
-        if (value instanceof Secret) returnedValue[key] = value.getMasked();
+        returnedValue[key] = value
+        if (value instanceof Secret) returnedValue[key] = value.getMasked()
       }
-      _debugRequest.data = returnedValue;
+      _debugRequest.data = returnedValue
     }
 
     if (request.data instanceof Secret) {
-      _debugRequest.data = '*****';
-      request.data = (typeof request.data === 'object' && !(request.data instanceof Secret)) ? { ...request.data.toString() } : request.data.toString();
+      _debugRequest.data = '*****'
+      request.data = typeof request.data === 'object' && !(request.data instanceof Secret) ? { ...request.data.toString() } : request.data.toString()
     }
 
-    if ((typeof request.data) === 'string') {
+    if (typeof request.data === 'string') {
       if (!request.headers || !request.headers['Content-Type']) {
-        request.headers = { ...request.headers, ...{ 'Content-Type': 'application/x-www-form-urlencoded' } };
+        request.headers = { ...request.headers, ...{ 'Content-Type': 'application/x-www-form-urlencoded' } }
       }
     }
 
     if (this.config.onRequest) {
-      await this.config.onRequest(request);
+      await this.config.onRequest(request)
     }
 
-    this.options.prettyPrintJson ? output.debugSection('Request', beautify(JSON.stringify(_debugRequest))) : output.debugSection('Request', JSON.stringify(_debugRequest));
+    try {
+      this.options.prettyPrintJson ? this.debugSection('Request', beautify(JSON.stringify(_debugRequest))) : this.debugSection('Request', JSON.stringify(_debugRequest))
+    } catch (e) {
+      console.log('[REST] Request:', JSON.stringify(_debugRequest))
+    }
 
-    let response;
+    if (this.options.printCurl) {
+      try {
+        this.debugSection('CURL Request', curlize(request))
+      } catch (e) {
+        console.log('[REST] CURL Request:', curlize(request))
+      }
+    }
+
+    let response
     try {
-      response = await this.axios(request);
+      response = await this.axios(request)
     } catch (err) {
-      if (!err.response) throw err;
-      output.debugSection('Response', `Response error. Status code: ${err.response.status}`);
-      response = err.response;
+      if (!err.response) throw err
+      try {
+        this.debugSection('Response', `Response error. Status code: ${err.response.status}`)
+      } catch (e) {
+        console.log('[REST] Response error. Status code:', err.response.status)
+      }
+      response = err.response
     }
     if (this.config.onResponse) {
-      await this.config.onResponse(response);
+      await this.config.onResponse(response)
     }
-    this.options.prettyPrintJson ? output.debugSection('Response', beautify(JSON.stringify(response.data))) : output.debugSection('Response', JSON.stringify(response.data));
-    return response;
+    try {
+      this.options.prettyPrintJson ? this.debugSection('Response', beautify(JSON.stringify(response.data))) : this.debugSection('Response', JSON.stringify(response.data))
+    } catch (e) {
+      console.log('[REST] Response:', JSON.stringify(response.data))
+    }
+    return response
   }
 
   /**
@@ -187,7 +262,7 @@ class REST extends Helper {
    * @param {*} url
    */
   _url(url) {
-    return /^\w+\:\/\//.test(url) ? url : this.options.endpoint + url;
+    return /^\w+\:\/\//.test(url) ? url : this.options.endpoint + url
   }
 
   /**
@@ -200,7 +275,7 @@ class REST extends Helper {
    * @param {number} newTimeout - timeout in milliseconds
    */
   setRequestTimeout(newTimeout) {
-    this.options.timeout = newTimeout;
+    this.options.timeout = newTimeout
   }
 
   /**
@@ -219,8 +294,29 @@ class REST extends Helper {
     const request = {
       baseURL: this._url(url),
       headers,
-    };
-    return this._executeRequest(request);
+    }
+    return this._executeRequest(request)
+  }
+
+  /**
+   * Send HEAD request to REST API
+   *
+   * ```js
+   * I.sendHeadRequest('/api/users.json');
+   * ```
+   *
+   * @param {*} url
+   * @param {object} [headers={}] - the headers object to be sent. By default, it is sent as an empty object
+   *
+   * @returns {Promise<*>} response
+   */
+  async sendHeadRequest(url, headers = {}) {
+    const request = {
+      baseURL: this._url(url),
+      method: 'HEAD',
+      headers,
+    }
+    return this._executeRequest(request)
   }
 
   /**
@@ -246,14 +342,14 @@ class REST extends Helper {
       method: 'POST',
       data: payload,
       headers,
-    };
+    }
 
     if (this.options.maxContentLength) {
-      request.maxContentLength = this.options.maxContentLength;
-      request.maxBodyLength = this.options.maxContentLength;
+      request.maxContentLength = this.options.maxContentLength
+      request.maxBodyLength = this.options.maxContentLength
     }
 
-    return this._executeRequest(request);
+    return this._executeRequest(request)
   }
 
   /**
@@ -279,14 +375,14 @@ class REST extends Helper {
       method: 'PATCH',
       data: payload,
       headers,
-    };
+    }
 
     if (this.options.maxContentLength) {
-      request.maxContentLength = this.options.maxContentLength;
-      request.maxBodyLength = this.options.maxBodyLength;
+      request.maxContentLength = this.options.maxContentLength
+      request.maxBodyLength = this.options.maxBodyLength
     }
 
-    return this._executeRequest(request);
+    return this._executeRequest(request)
   }
 
   /**
@@ -312,14 +408,14 @@ class REST extends Helper {
       method: 'PUT',
       data: payload,
       headers,
-    };
+    }
 
     if (this.options.maxContentLength) {
-      request.maxContentLength = this.options.maxContentLength;
-      request.maxBodyLength = this.options.maxBodyLength;
+      request.maxContentLength = this.options.maxContentLength
+      request.maxBodyLength = this.options.maxBodyLength
     }
 
-    return this._executeRequest(request);
+    return this._executeRequest(request)
   }
 
   /**
@@ -339,9 +435,54 @@ class REST extends Helper {
       baseURL: this._url(url),
       method: 'DELETE',
       headers,
-    };
+    }
+
+    return this._executeRequest(request)
+  }
+
+  /**
+   * Sends DELETE request to API with payload.
+   *
+   * ```js
+   * I.sendDeleteRequestWithPayload('/api/users/1', { author: 'john' });
+   * ```
+   *
+   * @param {*} url
+   * @param {*} [payload={}] - the payload to be sent. By default it is sent as an empty object
+   * @param {object} [headers={}] - the headers object to be sent. By default, it is sent as an empty object
+   *
+   * @returns {Promise<*>} response
+   */
+  async sendDeleteRequestWithPayload(url, payload = {}, headers = {}) {
+    const request = {
+      baseURL: this._url(url),
+      method: 'DELETE',
+      data: payload,
+      headers,
+    }
+
+    return this._executeRequest(request)
+  }
+}
+
+export { REST as default }
+
+function curlize(request) {
+  if (request.data?.constructor.name.toLowerCase() === 'formdata') return 'cURL is not printed as the request body is not a JSON'
+  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" '
+  }
 
-    return this._executeRequest(request);
+  if (request.data) {
+    curl += `-d '${JSON.stringify(request.data)}'`
   }
+  return curl
 }
-export default REST;