Merge pull request #177 from pactumjs/176-mock-files

176 mock files

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pactum",
-  "version": "3.1.10",
+  "version": "3.1.11",
   "description": "REST API Testing Tool for all levels in a Test Pyramid",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",

src/exports/mock.d.ts

@@ -20,6 +20,7 @@ export interface InteractionResponse {
   status: number;
   headers?: object;
   body?: object;
+  file?: string;
   fixedDelay?: number;
   randomDelay?: RandomDelay;
 }

src/helpers/requestProcessor.js

@@ -90,7 +90,9 @@ function setMultiPartFormData(request) {
       request.headers = multiPartHeaders;
     } else {
       for (const prop in multiPartHeaders) {
-        request.headers[prop] = multiPartHeaders[prop];
+        if (request.headers[prop] === undefined) {
+          request.headers[prop] = multiPartHeaders[prop];
+        }
       }
     }
     delete request._multiPartFormData;

src/models/Interaction.model.js

@@ -166,6 +166,9 @@ class InteractionResponse {
     } else if (response.randomDelay) {
       this.delay = new InteractionResponseDelay('RANDOM', response.randomDelay);
     }
+    if (response.file) {
+      this.file = getValue(response.file);
+    }
   }
 }
 

src/models/server.js

@@ -1,4 +1,7 @@
 const polka = require('polka');
+const fs = require('fs');
+const mime = require('mime-lite')
+const fs_path = require('path');
 
 const Interaction = require('./Interaction.model');
 const helper = require('../helpers/helper');
@@ -138,9 +141,9 @@ function sendInteractionFoundResponse(req, res, interaction) {
     res.status(_response.status);
     const delay = getDelay(_response);
     if (delay > 0) {
-      setTimeout(() => sendResponseBody(res, _response.body), delay);
+      setTimeout(() => sendResponse(res, _response), delay);
     } else {
-      sendResponseBody(res, _response.body);
+      sendResponse(res, _response);
     }
   }
   interaction.callCount += 1;
@@ -164,11 +167,13 @@ function updateCalls(req, interaction) {
 /**
  * sends response body
  * @param {ExpressResponse} res - HTTP response
- * @param {object} body - response body to be sent
+ * @param {object} interaction_response - response body to be sent
  */
-function sendResponseBody(res, body) {
-  if (body) {
-    res.send(body);
+function sendResponse(res, interaction_response) {
+  if (interaction_response.file) {
+    res.download(interaction_response);
+  } else if (interaction_response.body) {
+    res.send(interaction_response.body);
   } else {
     res.send();
   }
@@ -392,7 +397,10 @@ class ExpressResponse {
   send(data) {
     if (data) {
       if (typeof data === 'object') {
-        this.res.setHeader('Content-Type', 'application/json');
+        const header_keys = this.res.getHeaderNames();
+        if (!header_keys.includes('content-type')) {
+          this.res.setHeader('Content-Type', 'application/json');
+        }
         this.res.end(JSON.stringify(data));
       } else {
         this.res.end(data);
@@ -401,6 +409,20 @@ class ExpressResponse {
       this.res.end();
     }
   }
+
+  download(interaction_response) {
+    if (interaction_response.headers) {
+      const header_keys = Object.keys(interaction_response.headers).map(_ => _.toLowerCase());
+      if (!header_keys.includes('content-type')) {
+        const file_name = fs_path.basename(interaction_response.file)
+        this.res.setHeader('content-type', mime.getType(file_name));
+      }
+    } else {
+      const file_name = fs_path.basename(interaction_response.file)
+      this.res.setHeader('content-type', mime.getType(file_name));
+    }
+    fs.createReadStream(interaction_response.file).pipe(this.res);
+  }
 }
 
 module.exports = Server;

test/component/files.spec.js

@@ -57,4 +57,13 @@ describe('Files', () => {
       .expectStatus(200);
   });
 
+  it('with file - custom content-type header', async () => {
+    await pactum.spec()
+      .useInteraction('post file')
+      .post('http://localhost:9393/api/file')
+      .withFile('./package.json')
+      .withHeaders('content-type', 'any')
+      .expectStatus(200);
+  });
+
 });

test/component/interactions.file.spec.js

@@ -0,0 +1,44 @@
+const pactum = require('../../src/index');
+
+describe('Interactions - File', () => {
+
+  it('download file with default headers', async () => {
+    await pactum.spec()
+      .useInteraction({
+        request: {
+          method: 'GET',
+          path: '/download'
+        },
+        response: {
+          status: 200,
+          file: 'assets/logo.png'
+        }
+      })
+      .get('http://localhost:9393/download')
+      .expectStatus(200)
+      .expectBodyContains('PNG')
+      .expectHeader('content-type', 'image/png');
+  });
+
+  it('download file with custom headers', async () => {
+    await pactum.spec()
+      .useInteraction({
+        request: {
+          method: 'GET',
+          path: '/download'
+        },
+        response: {
+          status: 200,
+          headers: {
+            'content-type': 'application/json'
+          },
+          file: 'assets/logo.png'
+        }
+      })
+      .get('http://localhost:9393/download')
+      .expectStatus(200)
+      .expectBodyContains('PNG')
+      .expectHeader('content-type', 'application/json');
+  });
+
+});

test/component/interactions.mock.spec.js

@@ -623,4 +623,31 @@ describe('Interactions - Not Strict - Follow Redirects', () => {
     pactum.request.setDefaultFollowRedirects(false);
   });
 
+});
+
+describe('Interactions - Response - Headers', () => {
+
+  it('with custom content-type headers', async () => {
+    await pactum.spec()
+      .useInteraction({
+        request: {
+          method: 'GET',
+          path: '/custom/header'
+        },
+        response: {
+          status: 200,
+          headers: {
+            'content-type': 'any'
+          },
+          body: {
+            message: 'hello'
+          }
+        }
+      })
+      .get('http://localhost:9393/custom/header')
+      .expectStatus(200)
+      .expectHeader('content-type', 'any')
+      .expectJson('message', 'hello');
+  });
+
 });

test/component/interactions.spec.js

@@ -825,7 +825,6 @@ describe('Pact - VALID', () => {
 
 });
 
-
 describe('Interactions - expects skip check', () => {
 
   it('skip expects - defaults', async () => {