jest-matcher-http 1.2.0 → 1.3.0

package/.github/dependabot.yml

@@ -5,11 +5,11 @@ updates:
     schedule:
       interval: "weekly"
     commit-message:
-      prefix: "fix"
+      prefix: "chore"
 
   - package-ecosystem: "npm"
     directory: "/"
     schedule:
       interval: "daily"
     commit-message:
-      prefix: "fix"
+      prefix: "chore"

package/README.md

@@ -5,7 +5,7 @@
     <img alt="npm latest version" src="https://img.shields.io/npm/v/jest-matcher-http/latest.svg">
   </a>
   <a href="https://github.com/rimesime/jest-matcher-http/actions?query=workflow%3ATest+branch%3Amain">
-    <img alt="Build states" src="https://github.com/semantic-release/semantic-release/workflows/Test/badge.svg">
+    <img alt="Build states" src="https://github.com/rimesime/jest-matcher-http/workflows/Test/badge.svg">
   </a>
   <a href="#badge">
     <img alt="semantic-release: angular" src="https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release">
@@ -22,6 +22,10 @@ Supported http libraries:
 - [axios](https://www.npmjs.com/package/axios)
 - [needle](https://www.npmjs.com/package/needle)
 
+Supported content types:
+- application/json
+- text/plain
+
 # Installation & Configuration
 
 With npm:

package/integration_tests/axios.int.test.js

@@ -5,43 +5,64 @@ const axios = require('axios');
 const { runAgainstServer, staticVariables } = require('./localServer.int.helper');
 
 describe('axios', () => {
-  let response;
-  const { body, headerName, headerValue } = staticVariables;
+  let responseJson;
+  let responseText;
+  const {
+    resultJson,
+    resultText,
+    headerName,
+    headerValue,
+  } = staticVariables;
 
   beforeAll(async () => {
     await runAgainstServer(async (url) => {
       const request = axios.create({ baseURL: url });
-      response = await request.get('/');
+      responseJson = await request.get('/json');
+      responseText = await request.get('/text');
     });
   });
 
   describe('toReturnHttpCode', () => {
     it('should succeed if http code is as expected', async () => {
-      expect(response).toReturnHttpCode(200);
+      expect(responseJson).toReturnHttpCode(200);
     });
 
-    it('should fail if http code is not as expected', async () => {
+    it('should fail if http code is not as expected for application/json responses', async () => {
       let caughtError;
       try {
-        expect(response).toReturnHttpCode(500);
+        expect(responseJson).toReturnHttpCode(500);
       } catch (error) {
         caughtError = error;
       }
 
       expect(caughtError.message).toContain('expected http status code 200 to equal 500\n');
+      expect(caughtError.message).toContain(`${JSON.stringify(resultJson, null, 2)}\n`);
+      expect(caughtError.message).toContain(`"${headerName.toLowerCase()}": "${headerValue}"`);
+    });
+
+    it('should fail if http code is not as expected for plain/text responses', async () => {
+      let caughtError;
+      try {
+        expect(responseText).toReturnHttpCode(500);
+      } catch (error) {
+        caughtError = error;
+      }
+
+      expect(caughtError.message).toContain('expected http status code 200 to equal 500\n');
+      expect(caughtError.message).toContain(`${JSON.stringify(resultText, null, 2)}\n`);
       expect(caughtError.message).toContain(`"${headerName.toLowerCase()}": "${headerValue}"`);
     });
   });
 
   describe('toReturnHttpHeader', () => {
     it('should succeed if http header is as expected', async () => {
-      expect(response).toReturnHttpHeader(headerName, headerValue);
+      expect(responseJson).toReturnHttpHeader(headerName, headerValue);
     });
 
     it('should fail if http header is not as expected', async () => {
       let caughtError;
       try {
-        expect(response).toReturnHttpHeader(headerName, '');
+        expect(responseJson).toReturnHttpHeader(headerName, '');
       } catch (error) {
         caughtError = error;
       }
@@ -50,7 +71,7 @@ describe('axios', () => {
         `expected http header "${headerName.toLowerCase()}" with value ""\n`
               + '\n'
               + 'server responded with body:\n'
-              + `${JSON.stringify(body, null, 2)}\n`
+              + `${JSON.stringify(resultJson, null, 2)}\n`
               + '\n'
               + 'server responded with headers:\n',
       );

package/integration_tests/localServer.int.helper.js

@@ -5,7 +5,8 @@ const http = require('http');
 const { createHttpTerminator } = require('http-terminator');
 const Signal = require('signal-promise');
 
-const body = { name: 'john' };
+const resultJson = { name: 'john' };
+const resultText = 'Text';
 const headerName = 'Some';
 const headerValue = 'Header';
 
@@ -19,11 +20,19 @@ const headerValue = 'Header';
 async function runAgainstServer(func) {
   // eslint-disable-next-line new-cap
   const app = new express();
-  app.get('/', (req, res) => {
+  app.get('/json', (req, res) => {
     res
       .status(200)
+      .set('Content-Type', 'application/json')
       .set(headerName, headerValue)
-      .json(body);
+      .json(resultJson);
+  });
+  app.get('/text', (req, res) => {
+    res
+      .status(200)
+      .set('Content-Type', 'text/plain')
+      .set(headerName, headerValue)
+      .send(resultText);
   });
   const server = http.createServer(app);
   const httpTerminator = createHttpTerminator({ server });
@@ -40,7 +49,8 @@ async function runAgainstServer(func) {
 module.exports = {
   runAgainstServer,
   staticVariables: {
-    body,
+    resultJson,
+    resultText,
     headerName,
     headerValue,
   },

package/integration_tests/needle.int.test.js

@@ -5,42 +5,63 @@ const needle = require('needle');
 const { runAgainstServer, staticVariables } = require('./localServer.int.helper');
 
 describe('needle', () => {
-  let response;
-  const { body, headerName, headerValue } = staticVariables;
+  let responseJson;
+  let responseText;
+  const {
+    resultJson,
+    resultText,
+    headerName,
+    headerValue,
+  } = staticVariables;
 
   beforeAll(async () => {
     await runAgainstServer(async (url) => {
-      response = await needle('get', url);
+      responseJson = await needle('get', `${url}/json`);
+      responseText = await needle('get', `${url}/text`);
     });
   });
 
   describe('toReturnHttpCode', () => {
     it('should succeed if http code is as expected', async () => {
-      expect(response).toReturnHttpCode(200);
+      expect(responseJson).toReturnHttpCode(200);
     });
 
-    it('should fail if http code is not as expected', async () => {
+    it('should fail if http code is not as expected for application/json responses', async () => {
       let caughtError;
       try {
-        expect(response).toReturnHttpCode(500);
+        expect(responseJson).toReturnHttpCode(500);
       } catch (error) {
         caughtError = error;
       }
 
       expect(caughtError.message).toContain('expected http status code 200 to equal 500\n');
+      expect(caughtError.message).toContain(`${JSON.stringify(resultJson, null, 2)}\n`);
+      expect(caughtError.message).toContain(`"${headerName.toLowerCase()}": "${headerValue}"`);
+    });
+
+    it('should fail if http code is not as expected for plain/text responses', async () => {
+      let caughtError;
+      try {
+        expect(responseText).toReturnHttpCode(500);
+      } catch (error) {
+        caughtError = error;
+      }
+
+      expect(caughtError.message).toContain('expected http status code 200 to equal 500\n');
+      expect(caughtError.message).toContain(`${JSON.stringify(resultText, null, 2)}\n`);
       expect(caughtError.message).toContain(`"${headerName.toLowerCase()}": "${headerValue}"`);
     });
   });
 
   describe('toReturnHttpHeader', () => {
     it('should succeed if http header is as expected', async () => {
-      expect(response).toReturnHttpHeader(headerName, headerValue);
+      expect(responseJson).toReturnHttpHeader(headerName, headerValue);
     });
 
     it('should fail if http header is not as expected', async () => {
       let caughtError;
       try {
-        expect(response).toReturnHttpHeader(headerName, '');
+        expect(responseJson).toReturnHttpHeader(headerName, '');
       } catch (error) {
         caughtError = error;
       }
@@ -49,7 +70,7 @@ describe('needle', () => {
         `expected http header "${headerName.toLowerCase()}" with value ""\n`
               + '\n'
               + 'server responded with body:\n'
-              + `${JSON.stringify(body, null, 2)}\n`
+              + `${JSON.stringify(resultJson, null, 2)}\n`
               + '\n'
               + 'server responded with headers:\n',
       );

package/integration_tests/superagent.int.test.js

@@ -5,42 +5,63 @@ const superagent = require('superagent');
 const { runAgainstServer, staticVariables } = require('./localServer.int.helper');
 
 describe('superagent', () => {
-  let response;
-  const { body, headerName, headerValue } = staticVariables;
+  let responseJson;
+  let responseText;
+  const {
+    resultJson,
+    resultText,
+    headerName,
+    headerValue,
+  } = staticVariables;
 
   beforeAll(async () => {
     await runAgainstServer(async (url) => {
-      response = await superagent.get(`${url}/`);
+      responseJson = await superagent.get(`${url}/json`);
+      responseText = await superagent.get(`${url}/text`);
     });
   });
 
   describe('toReturnHttpCode', () => {
     it('should succeed if http code is as expected', async () => {
-      expect(response).toReturnHttpCode(200);
+      expect(responseJson).toReturnHttpCode(200);
     });
 
-    it('should fail if http code is not as expected', async () => {
+    it('should fail if http code is not as expected for application/json responses', async () => {
       let caughtError;
       try {
-        expect(response).toReturnHttpCode(500);
+        expect(responseJson).toReturnHttpCode(500);
       } catch (error) {
         caughtError = error;
       }
 
       expect(caughtError.message).toContain('expected http status code 200 to equal 500\n');
+      expect(caughtError.message).toContain(`${JSON.stringify(resultJson, null, 2)}\n`);
+      expect(caughtError.message).toContain(`"${headerName.toLowerCase()}": "${headerValue}"`);
+    });
+
+    it('should fail if http code is not as expected for plain/text responses', async () => {
+      let caughtError;
+      try {
+        expect(responseText).toReturnHttpCode(500);
+      } catch (error) {
+        caughtError = error;
+      }
+
+      expect(caughtError.message).toContain('expected http status code 200 to equal 500\n');
+      expect(caughtError.message).toContain(`${JSON.stringify(resultText, null, 2)}\n`);
       expect(caughtError.message).toContain(`"${headerName.toLowerCase()}": "${headerValue}"`);
     });
   });
 
   describe('toReturnHttpHeader', () => {
     it('should succeed if http header is as expected', async () => {
-      expect(response).toReturnHttpHeader(headerName, headerValue);
+      expect(responseJson).toReturnHttpHeader(headerName, headerValue);
     });
 
     it('should fail if http header is not as expected', async () => {
       let caughtError;
       try {
-        expect(response).toReturnHttpHeader(headerName, '');
+        expect(responseJson).toReturnHttpHeader(headerName, '');
       } catch (error) {
         caughtError = error;
       }
@@ -49,7 +70,7 @@ describe('superagent', () => {
         `expected http header "${headerName.toLowerCase()}" with value ""\n`
               + '\n'
               + 'server responded with body:\n'
-              + `${JSON.stringify(body, null, 2)}\n`
+              + `${JSON.stringify(resultJson, null, 2)}\n`
               + '\n'
               + 'server responded with headers:\n',
       );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-matcher-http",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Additional Jest matchers for HTTP responses.",
   "main": "src/index.js",
   "scripts": {

package/src/matchers.js

@@ -1,16 +1,39 @@
 'use strict';
 
+/**
+ * Extract the result from the response.
+ *
+ * @param {object} response - The response of the request.
+ * @returns {object} The result.
+ * @throws {Error} If no result could be extracted.
+ */
+function extractResult(response) {
+  if (response.data) {
+    return response.data;
+  }
+
+  if (response.text && response.text !== JSON.stringify(response.body)) {
+    return response.text;
+  }
+
+  if (response.body) {
+    return response.body;
+  }
+
+  throw new Error('jest-matcher-http does not support this library');
+}
+
 /**
  * Expect a http request to return given http status code.
  * Log response body and headers otherwise.
  *
- * @param {{status: number, body: any, headers: any}} response - The response of the request.
+ * @param {object} response - The response of the request.
  * @param {number} expectedHttpStatusCode - The expected http status code.
  * @returns {{message: Function, pass: boolean}} The expect result according to jest.
  * @see {@link https://jestjs.io/docs/expect#expectextendmatchers}
  */
 function toReturnHttpCode(response, expectedHttpStatusCode) {
-  const body = response.body ?? response.data;
+  const result = extractResult(response);
   const status = response.status ?? response.statusCode;
   const { headers } = response;
 
@@ -23,7 +46,7 @@ function toReturnHttpCode(response, expectedHttpStatusCode) {
   return {
     pass,
     message: () => `expected http status code ${status} to equal ${expectedHttpStatusCode}\n\n`
-      + `server responded with body:\n${JSON.stringify(body, null, 2)}\n\n`
+      + `server responded with body:\n${JSON.stringify(result, null, 2)}\n\n`
       + `server responded with headers:\n${JSON.stringify(headers, null, 2)}`,
   };
 }
@@ -32,14 +55,14 @@ function toReturnHttpCode(response, expectedHttpStatusCode) {
  * Expect a http request to return the given http header.
  * Log response body and headers otherwise.
  *
- * @param {{body: any, headers: any}} response - The response of the request.
+ * @param {object} response - The response of the request.
  * @param {string} headerField - The expected http header field.
  * @param {string} headerValue - The expected http header value.
  * @returns {{message: Function, pass: boolean}} The expect result according to jest.
  * @see {@link https://jestjs.io/docs/expect#expectextendmatchers}
  */
 function toReturnHttpHeader(response, headerField, headerValue) {
-  const body = response.body ?? response.data;
+  const result = extractResult(response);
   const { headers } = response;
   const headerFieldLowerCase = headerField.toLowerCase();
 
@@ -52,7 +75,7 @@ function toReturnHttpHeader(response, headerField, headerValue) {
   return {
     pass,
     message: () => `expected http header "${headerFieldLowerCase}" with value "${headerValue}"\n\n`
-      + `server responded with body:\n${JSON.stringify(body, null, 2)}\n\n`
+      + `server responded with body:\n${JSON.stringify(result, null, 2)}\n\n`
       + `server responded with headers:\n${JSON.stringify(headers, null, 2)}`,
   };
 }

package/src/matchers.unit.test.js

@@ -32,6 +32,16 @@ describe('matchers', () => {
       expect(response).toReturnHttpCode(response.status);
     });
 
+    it('should succeed if result is in text', async () => {
+      const response = {
+        status: 200,
+        text: 'result',
+        headers: {},
+      };
+
+      expect(response).toReturnHttpCode(response.status);
+    });
+
     it('should fail if http code is not as expected', async () => {
       const response = {
         status: 200,
@@ -56,6 +66,22 @@ describe('matchers', () => {
           + '{}',
       );
     });
+
+    it('should throw if result is not supported', async () => {
+      const response = {
+        status: 200,
+        headers: {},
+      };
+
+      let caughtError;
+      try {
+        expect(response).toReturnHttpCode(1);
+      } catch (error) {
+        caughtError = error;
+      }
+
+      expect(caughtError.message).toBe('jest-matcher-http does not support this library');
+    });
   });
 
   describe('toReturnHttpHeader', () => {