Merge pull request #248 from pactumjs/226-cannot-find-brotli-compress…

…ed-page

feat: compression request option

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pactum",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "description": "REST API Testing Tool for all levels in a Test Pyramid",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
@@ -61,7 +61,7 @@
     "openapi-fuzzer-core": "^1.0.6",
     "pactum-matchers": "^1.1.3",
     "parse-graphql": "^1.0.0",
-    "phin": "^3.6.1",
+    "phin": "^3.7.0",
     "polka": "^0.5.2"
   },
   "devDependencies": {

src/exports/handler.d.ts

@@ -2,14 +2,14 @@ import * as Spec from '../models/Spec';
 import { Interaction } from './mock';
 import { IncomingMessage } from 'http';
 
-interface Request {
+interface PactumRequest {
   url: string;
   method: string;
   timeout: number;
   data?: any;
 }
 
-interface Response extends IncomingMessage {
+interface PactumResponse extends IncomingMessage {
   json?: object;
   body?: any;
   text?: string;
@@ -27,8 +27,8 @@ interface SpecHandlerContext {
 }
 
 interface RequestResponseContext {
-  req: Request;
-  res: Response;
+  req: PactumRequest;
+  res: PactumResponse;
 }
 
 interface CaptureContext extends RequestResponseContext {

src/models/Spec.d.ts

@@ -207,6 +207,12 @@ declare class Spec {
    */
   withFollowRedirects(follow: boolean): Spec;
 
+  /**
+   * enables compression
+   * @see https://pactumjs.github.io/api/requests/withCompression.html
+   */
+  withCompression(): Spec;
+
   /**
    * retry request on specific conditions
    * @see https://pactumjs.github.io/api/requests/retry.html

src/models/Spec.js

@@ -293,6 +293,11 @@ class Spec {
     return this;
   }
 
+  withCompression() {
+    this._request.compression = true;
+    return this;
+  }
+
   retry(options, delay) {
     if (typeof options === 'undefined' || typeof options === 'number') {
       options = { count: options, delay: delay };

test/component/withCompression.spec.js

@@ -0,0 +1,61 @@
+const pactum = require('../../src/index');
+const expect = require('chai').expect;
+
+describe('withCompression', () => {
+
+  describe('should process', () => {
+
+    it('with encoding as br', async () => {
+      await pactum.spec()
+        .useInteraction({
+          request: {
+            method: 'GET',
+            path: '/api/compression',
+          },
+          response: {
+            status: 200,
+            headers: {
+              'content-encoding': 'br'
+            },
+            file: 'test/data/files/data.txt.br'
+          }
+        })
+        .get('http://localhost:9393/api/compression')
+        .withCompression()
+        .expectStatus(200);
+    });
+
+  });
+
+  describe('should not process', () => {
+
+    it('without a response body', async () => {
+      let err;
+      try {
+        await pactum.spec()
+          .useLogLevel('SILENT')
+          .useInteraction({
+            request: {
+              method: 'GET',
+              path: '/api/compression',
+            },
+            response: {
+              status: 200,
+              headers: {
+                'content-encoding': 'br'
+              }
+            }
+          })
+          .get('http://localhost:9393/api/compression')
+          .withCompression()
+
+          .expectStatus(200);
+      } catch (error) {
+        err = error;
+      }
+      expect(err.message).contains('unexpected end of file');
+    });
+
+  });
+
+});

test/data/files/convert.js

@@ -0,0 +1,13 @@
+const fs = require('fs');
+const zlib = require('zlib');
+
+const READ_FILE_NAME = 'data.txt';
+const WRITE_FILE_NAME = 'data.txt.br';
+
+const read_stream = fs.createReadStream(READ_FILE_NAME);
+const write_stream = fs.createWriteStream(WRITE_FILE_NAME);
+
+const compress = zlib.createBrotliCompress();
+
+
+read_stream.pipe(compress).pipe(write_stream);

test/data/files/data.txt.br

@@ -0,0 +1 @@
+��Hello World!