You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP
Socket
Book a DemoInstallSign in
Socket

express-request-mock

Package Overview
Dependencies
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

express-request-mock

A convenient wrapper for node-mocks-http which makes testing Express controllers and middleware easy.

4.0.0
latest
Source
npmnpm
Version published
Weekly downloads
2.1K
0.61%
Maintainers
1
Weekly downloads
 
Created
Source

express-request-mock

GitHub license build status npm version

A convenient wrapper for node-mocks-http which makes testing Express controllers and middleware easy.

import requestMock from 'express-request-mock'
import handler from '../routes/animals'

it('returns a 200 response', async () => {
  const { response } = await requestMock(handler, options)
  expect(response.statusCode).toEqual(200)
})

Installation

This is a Node.js module available through the npm registry. Node.js 18 or higher is required.

$ npm install --save-dev express-request-mock

Usage

This package provides one function which accepts three arguments:

  • The route handler to test (a function which accepts a request, response, and optional fallthrough function.)
  • An options object for createRequest (the options are documented here.)
  • An object containing extra properties to decorate to the request and response objects.

The function returns a promise which will resolve when the response is ended or the fallthrough function (next()) is called. The promise will reject if the underlying code throws an error or the fallthrough function is called with an error.

When resolved the promise will to an object with the following keys:

  • request: The request object created by createRequest
  • response: The response object created by createResponse

Below is a complete example demonstrating the use of express-request-mock to test an Express route handler:

import { describe, it } from 'node:test'
import assert from 'node:assert'
import requestMock from 'express-request-mock'
import handler from '../routes/animals'

describe('Controllers - Animals', () => {
  describe('when a valid species is requested', () => {
    const options = { query: { species: 'dog' } }

    it('returns a 200 response', async () => {
      const { response } = await requestMock(handler, options)
      assert.equal(response.statusCode, 200)
    })
  })

  describe('when a non-existent species is requested', () => {
    const options = { query: { species: 'unicorn' } }

    it('returns a 404 response', async () => {
      const { response } = await requestMock(handler, options)
      assert.equal(response.statusCode, 404)
    })
  })

  describe('when an invalid request is received', () => {
    const options = { query: {} }

    it('calls the fallthrough function with an error', async () => {
      const call = () => requestMock(handler, options)

      await assert.rejects(call, {
        name: 'NoSpeciesProvided',
        message: 'You must provide a species',
      })
    })
  })
})

License

express-request-mock is MIT licensed.

Keywords

mock

FAQs

Package last updated on 18 Oct 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts