@cuppet/core 1.0.16 → 1.1.0

package/features/app/stepDefinitions/apiSteps.js

@@ -7,7 +7,7 @@ Given('that I send a {string} request to {string}', async function (method, path
     await apiSteps.sendRequest(method, path);
 });
 When(
-    'I send a {string} request to {string} with http header {string} and value {string}',
+    'that I send a {string} request to {string} with http header {string} and value {string}',
     async function (method, path, headerName, headerValue) {
         const name = await dataStorage.checkForSavedVariable(headerName);
         const value = await dataStorage.checkForSavedVariable(headerValue);
@@ -35,6 +35,10 @@ Given('that I have request body', async function (docString) {
     const body = JSON.stringify(docString);
     await apiSteps.prepareRequestBody(body);
 });
+Given('that I have a multipart request body', async function (docString) {
+    const body = JSON.parse(docString);
+    await apiSteps.buildMultipartFormData(body);
+});
 Given(
     'I put {string} to {string} property of {string} element in the body',
     async function (value, property, parentObj) {
@@ -50,3 +54,6 @@ Given('I validate that the page is a valid XML', async function () {
     const currentPath = main.extractPath(this.page, true);
     await apiSteps.validateXMLEndpoint(currentPath);
 });
+Then('the response header {string} should be {string}', async function (header, value) {
+    await apiSteps.validateResponseHeader(header, value);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cuppet/core",
-    "version": "1.0.16",
+    "version": "1.1.0",
     "description": "Core testing framework components for Cuppet - BDD framework based on Cucumber and Puppeteer",
     "main": "index.js",
     "files": [
@@ -36,6 +36,7 @@
         "chai": "^4.3.7",
         "lighthouse": "^12.1.0",
         "mime": "^3.0.0",
+        "mime-types": "^3.0.1",
         "moment": "^2.30.1",
         "pa11y": "^8.0.0",
         "pa11y-reporter-html": "^2.0.0",
@@ -61,8 +62,10 @@
     "scripts": {
         "test": "cucumber-js features/tests",
         "postinstall": "node postinstall.js",
-        "lint": "eslint .",
-        "format": "prettier --write ."
+        "lint:check": "eslint .",
+        "format:check": "prettier --check .",
+        "format": "eslint . --fix && prettier --write .",
+        "verify": "yarn lint:check && yarn format:check"
     },
     "repository": {
         "type": "git",

package/src/apiFunctions.js

@@ -3,12 +3,17 @@ const config = require('config');
 const storage = require('./dataStorage');
 const xml2js = require('xml2js');
 const assert = require('chai').assert;
+const fs = require('fs');
+const mime = require('mime-types');
+const FormData = require('form-data');
 
 module.exports = {
     /** @type {object} */
     response: null,
     /** @type {object} */
     request: null,
+    /** @type {object} */
+    formData: null,
 
     /**
      * Prepare path for API test usage
@@ -40,11 +45,15 @@ module.exports = {
             'Content-Type': 'application/json',
             Accept: 'application/json',
         };
+        if (this.formData) {
+            defaultHeaders = {};
+            Object.assign(defaultHeaders, this.formData.getHeaders());
+        }
         if (config.has('api.x-api-key')) {
             defaultHeaders['X-Api-Key'] = config.get('api.x-api-key');
         }
         if (config.has('api.Authorization')) {
-            defaultHeaders['X-Api-Key'] = config.get('api.Authorization');
+            defaultHeaders['Authorization'] = config.get('api.Authorization');
         }
         if (headers && defaultHeaders) {
             defaultHeaders = {
@@ -97,6 +106,9 @@ module.exports = {
         if (this.request) {
             data = this.request;
         }
+        if (this.formData) {
+            data = this.formData;
+        }
         try {
             this.response = await axios.request({
                 url: apiUrl,
@@ -104,12 +116,14 @@ module.exports = {
                 ...(Object.keys(auth).length && { auth }),
                 // The data is conditionally added to the request, because it's not used with GET requests and creates conflict.
                 // The following checks if data object is not empty, returns data object if not empty or skip if empty.
-                ...(Object.keys(data).length && { data }),
+                ...((data instanceof FormData || Object.keys(data).length) && { data }),
                 headers: requestHeaders,
             });
+
             return this.response;
         } catch (error) {
-            throw new Error(`Request failed with: ${error}. Response: ${JSON.stringify(this.response)}`);
+            console.log('Request has failed, use response code step definition to validate the response!');
+            return (this.response = error.response);
         }
     },
 
@@ -154,7 +168,9 @@ module.exports = {
      */
     validateResponseCode: async function (code) {
         if (this.response.status !== Number(code)) {
-            throw new Error(`Response code is different than expected, code: ${this.response.status}`);
+            throw new Error(
+                `Unexpected response code, code: ${this.response.status}. Response: ${JSON.stringify(this.response.data)}`
+            );
         }
     },
 
@@ -259,32 +275,48 @@ module.exports = {
     },
 
     /**
-     *
-     * @param {string} method - method - GET,POST, PUT etc.
-     * @param {string} currentUrl - url of the page/endpoint
-     * @param {object} reqHeaders - request headers
-     * @param {string} resHeaders - response headers
-     * @param {boolean} flag - direction of presence (true/false)
+     * Validate response header
+     * @param {string} header - header name
+     * @param {string} value - header value
      * @returns {Promise<void>}
      */
-    validateResponseHeader: async function (method, currentUrl, reqHeaders, resHeaders, flag) {
-        const prepareUrl = await this.prepareUrl(currentUrl);
-        const requestHeaders = await this.setHeaders(reqHeaders);
-        const auth = await this.setBasicAuth();
-        let response;
-        try {
-            response = await axios.request({
-                url: prepareUrl,
-                method: method,
-                ...(Object.keys(auth).length && { auth }),
-                headers: requestHeaders,
-            });
-        } catch (error) {
-            throw new Error(`Request failed with: ${error}`);
-        }
-        const hasProperty = Object.prototype.hasOwnProperty.call(response.headers, resHeaders.toLowerCase());
-        if (hasProperty !== flag) {
-            throw new Error('The response headers are different than expected!');
+    validateResponseHeader: async function (header, value) {
+        // Resolve header and value from variables or user input.
+        // The header is checked directly for faster execution as it is less likely to contain variables.
+        const resolveHeader = await storage.checkForVariable(header);
+        const resolveValue = await storage.checkForSavedVariable(value);
+        const actualValue = this.response.headers[resolveHeader.toLowerCase()];
+        assert.isDefined(actualValue, `The response header "${resolveHeader}" is not found!`);
+        assert.strictEqual(
+            actualValue,
+            resolveValue,
+            `The response header "${resolveHeader}" does not have the expected value`
+        );
+    },
+
+    /**
+     * Build multipart/form-data request body
+     * If you want to send a file, you need to pass the file name (not the path) as a string.
+     * Please use the files from the files folder.
+     * @param {object} data - the data to be sent in the request body
+     * @returns {Promise<Object>} - returns the request body object
+     */
+    buildMultipartFormData: async function (data) {
+        const filePath = config.get('filePath');
+        const formData = new FormData();
+        for (const [key, value] of Object.entries(data)) {
+            if (key === 'file') {
+                const mimeType = mime.contentType(value) || 'application/octet-stream';
+                formData.append('file', fs.createReadStream(filePath + value), {
+                    filename: value,
+                    contentType: mimeType,
+                });
+                formData.append('type', mimeType);
+            } else {
+                formData.append(key, await storage.checkForSavedVariable(value));
+            }
         }
+        this.formData = formData;
+        return this.formData;
     },
 };