jest-matcher-http 1.3.0 → 1.4.1

package/.eslintrc.js

@@ -5,13 +5,16 @@ module.exports = {
     node: true,
     'jest/globals': true,
   },
+  plugins: [
+    'jest',
+    'jsdoc',
+  ],
   extends: [
     'airbnb-base',
     'plugin:jsdoc/recommended',
     'plugin:jest/recommended',
     'plugin:jest/style',
   ],
-  plugins: ['jest'],
   overrides: [],
   parserOptions: {
     ecmaVersion: 2020,

package/.github/workflows/test_and_publish.yml

@@ -1,6 +1,3 @@
-# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
-
 name: Test & Publish
 
 on:
@@ -15,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [16.x, 18.x]
+        node-version: [16.x, 18.x, 19.x]
     steps:
     - uses: actions/checkout@v3
     - name: Use Node.js ${{ matrix.node-version }}
@@ -25,6 +22,12 @@ jobs:
         cache: 'npm'
     - run: npm ci
     - run: npm test
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v3
+      with:
+        flags: run-${{ matrix.node-version }}
+        fail_ci_if_error: true
+        verbose: true
   
   analyze:
     name: Analyze
@@ -60,10 +63,10 @@ jobs:
     needs: [test, analyze]
     steps: 
     - uses: actions/checkout@v3
-    - name: Use Node.js ${{ matrix.node-version }}
+    - name: Use Node.js 18.x
       uses: actions/setup-node@v3
       with:
-        node-version: ${{ matrix.node-version }}
+        node-version: 18.x
         cache: 'npm'
     - run: npm ci
     - run: npm run semantic-release

package/README.md

@@ -7,6 +7,9 @@
   <a href="https://github.com/rimesime/jest-matcher-http/actions?query=workflow%3ATest+branch%3Amain">
     <img alt="Build states" src="https://github.com/rimesime/jest-matcher-http/workflows/Test/badge.svg">
   </a>
+  <a href="https://codecov.io/gh/rimesime/jest-matcher-http" >
+    <img src="https://codecov.io/gh/rimesime/jest-matcher-http/branch/main/graph/badge.svg?token=OY3A3BFOUG"/>
+  </a>
   <a href="#badge">
     <img alt="semantic-release: angular" src="https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release">
   </a>
@@ -97,30 +100,19 @@ describe('Example', () => {
 
 # Contributing
 
-1. Clone the repository:
-    ```shell
-    $ git clone git@github.com:rimesime/jest-matcher-http.git
-    ```
-
-1. This repository uses conventional commits that are validated using `git-conventional-commits`. To validate this automatically, git-hooks need to be enabled manually after cloning this repository:
-    ```shell
-    $ git config core.hooksPath .git-hooks
-    ```
-
-1. Install dependencies:
-    ```shell
-    $ npm ci
-    ```
+Thank you for investing time to contribute to this project.
 
-1. Test:
-    ```shell
-    $ npm test
-    ```
+Clone the repository:
+  ```shell
+  $ git clone git@github.com:rimesime/jest-matcher-http.git
+  $ npm ci
+  $ npm test
+  ```
 
-1. Commit (using commitizen for semantic releases):
-    ```shell
-    $ npm run commit
-    ```
+If you spot a problem, search if an issue already exists. If a 
+related issue doesn't exist, you can open a new issue providing 
+all relevant information to e.g. reproduce the problem or motivate 
+your change. You are welcome to open a PR for any ticket.
 
 # License
 

package/integration_tests/axios.int.test.js

@@ -68,7 +68,7 @@ describe('axios', () => {
       }
 
       expect(caughtError.message).toContain(
-        `expected http header "${headerName.toLowerCase()}" with value ""\n`
+        `expected http header "${headerName.toLowerCase()}" to have value ""\n`
               + '\n'
               + 'server responded with body:\n'
               + `${JSON.stringify(resultJson, null, 2)}\n`

package/integration_tests/needle.int.test.js

@@ -67,7 +67,7 @@ describe('needle', () => {
       }
 
       expect(caughtError.message).toContain(
-        `expected http header "${headerName.toLowerCase()}" with value ""\n`
+        `expected http header "${headerName.toLowerCase()}" to have value ""\n`
               + '\n'
               + 'server responded with body:\n'
               + `${JSON.stringify(resultJson, null, 2)}\n`

package/integration_tests/superagent.int.test.js

@@ -67,7 +67,7 @@ describe('superagent', () => {
       }
 
       expect(caughtError.message).toContain(
-        `expected http header "${headerName.toLowerCase()}" with value ""\n`
+        `expected http header "${headerName.toLowerCase()}" to have value ""\n`
               + '\n'
               + 'server responded with body:\n'
               + `${JSON.stringify(resultJson, null, 2)}\n`

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "jest-matcher-http",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "Additional Jest matchers for HTTP responses.",
   "main": "src/index.js",
   "scripts": {
+    "lint": "eslint .",
     "test": "jest --coverage --config jest.unit.config.js",
     "acp": "git add . && npm run commit && git push",
     "commit": "git-cz",
@@ -19,6 +20,10 @@
     "url": "https://github.com/rimesime/jest-matcher-http/issues"
   },
   "homepage": "https://github.com/rimesime/jest-matcher-http#readme",
+  "pre-commit": [
+    "lint",
+    "test"
+  ],
   "release": {
     "branches": [
       "main"
@@ -35,15 +40,15 @@
     "axios": "^1.2.1",
     "commitizen": "^4.2.5",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^8.28.0",
+    "eslint": "^8.31.0",
     "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jest": "^27.1.6",
+    "eslint-plugin-jest": "^27.2.0",
     "eslint-plugin-jsdoc": "^39.6.4",
     "express": "^4.18.2",
     "http-terminator": "^3.2.0",
     "jest": "^29.3.1",
     "needle": "^3.2.0",
+    "pre-commit": "^1.2.2",
     "semantic-release": "^19.0.5",
     "signal-promise": "^1.0.3",
     "superagent": "^8.0.5"
@@ -51,6 +56,11 @@
   "dependencies": {
     "@jest/globals": "^29.3.1"
   },
+  "overrides": {
+    "eslint-config-airbnb-base": {
+      "json5": "^2.2.2"
+    }
+  },
   "config": {
     "commitizen": {
       "path": "./node_modules/cz-conventional-changelog"

package/src/matchers.js

@@ -39,13 +39,10 @@ function toReturnHttpCode(response, expectedHttpStatusCode) {
 
   const pass = status === expectedHttpStatusCode;
 
-  if (pass) {
-    return { pass };
-  }
-
   return {
     pass,
-    message: () => `expected http status code ${status} to equal ${expectedHttpStatusCode}\n\n`
+    message: () => `expected http status code ${status}${pass ? ' not' : ''} `
+      + `to equal ${expectedHttpStatusCode}\n\n`
       + `server responded with body:\n${JSON.stringify(result, null, 2)}\n\n`
       + `server responded with headers:\n${JSON.stringify(headers, null, 2)}`,
   };
@@ -68,13 +65,10 @@ function toReturnHttpHeader(response, headerField, headerValue) {
 
   const pass = headers[headerFieldLowerCase] === headerValue;
 
-  if (pass) {
-    return { pass };
-  }
-
   return {
     pass,
-    message: () => `expected http header "${headerFieldLowerCase}" with value "${headerValue}"\n\n`
+    message: () => `expected http header "${headerFieldLowerCase}"`
+      + `${pass ? ' not' : ''} to have value "${headerValue}"\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

@@ -67,6 +67,41 @@ describe('matchers', () => {
       );
     });
 
+    it('should succeed if http code is not as expected - negated', async () => {
+      const response = {
+        status: 200,
+        body: {},
+        headers: {},
+      };
+
+      expect(response).not.toReturnHttpCode(1);
+    });
+
+    it('should fail if http code is not as expected - negated', async () => {
+      const response = {
+        status: 200,
+        body: {},
+        headers: {},
+      };
+
+      let caughtError;
+      try {
+        expect(response).not.toReturnHttpCode(response.status);
+      } catch (error) {
+        caughtError = error;
+      }
+
+      expect(caughtError.message).toBe(
+        'expected http status code 200 not to equal 200\n'
+          + '\n'
+          + 'server responded with body:\n'
+          + '{}\n'
+          + '\n'
+          + 'server responded with headers:\n'
+          + '{}',
+      );
+    });
+
     it('should throw if result is not supported', async () => {
       const response = {
         status: 200,
@@ -124,7 +159,7 @@ describe('matchers', () => {
       }
 
       expect(caughtError.message).toBe(
-        'expected http header "request-id" with value "some-uuid"\n'
+        'expected http header "request-id" to have value "some-uuid"\n'
           + '\n'
           + 'server responded with body:\n'
           + '{}\n'
@@ -133,5 +168,44 @@ describe('matchers', () => {
           + '{}',
       );
     });
+
+    it('should succeed if http header is not as expected - negated', async () => {
+      const response = {
+        status: 200,
+        body: {},
+        headers: {},
+      };
+
+      expect(response).not.toReturnHttpHeader('request-id', 'some-uuid');
+    });
+
+    it('should fail if http header is not as expected - negated', async () => {
+      const response = {
+        status: 200,
+        body: {},
+        headers: {
+          'request-id': 'some-uuid',
+        },
+      };
+
+      let caughtError;
+      try {
+        expect(response).not.toReturnHttpHeader('request-id', 'some-uuid');
+      } catch (error) {
+        caughtError = error;
+      }
+
+      expect(caughtError.message).toBe(
+        'expected http header "request-id" not to have value "some-uuid"\n'
+          + '\n'
+          + 'server responded with body:\n'
+          + '{}\n'
+          + '\n'
+          + 'server responded with headers:\n'
+          + '{\n'
+          + '  "request-id": "some-uuid"\n'
+          + '}',
+      );
+    });
   });
 });

package/.git-hooks/pre-commit

@@ -1,4 +0,0 @@
-#!/bin/sh
-
-.git-hooks/pre-commit-eslint
-.git-hooks/pre-commit-test-unit

package/.git-hooks/pre-commit-eslint

@@ -1,36 +0,0 @@
-#!/bin/sh
-
-STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep ".jsx\{0,1\}$")
-
-if [[ "$STAGED_FILES" = "" ]]; then
-  exit 0
-fi
-
-PASS=true
-
-echo "\nValidating Javascript:\n"
-
-ESLINT="$(git rev-parse --show-toplevel)/node_modules/.bin/eslint"
-
-for FILE in $STAGED_FILES
-do
-  "$ESLINT" "$FILE"
-
-  if [[ "$?" == 0 ]]; then
-    echo "\t\033[32mESLint Passed: $FILE\033[0m"
-  else
-    echo "\t\033[41mESLint Failed: $FILE\033[0m"
-    PASS=false
-  fi
-done
-
-echo "\nJavascript validation completed!\n"
-
-if ! $PASS; then
-  echo "\033[41mESLINT FAILED:\033[0m Your commit contains files that should pass ESLint but do not. Please fix the ESLint errors and try again.\n"
-  exit 1
-else
-  echo "\033[42mESLINT SUCCEEDED\033[0m\n"
-fi
-
-exit $?

package/.git-hooks/pre-commit-test-unit

@@ -1,3 +0,0 @@
-#!/bin/sh
-
-npm test