mocr

A mock http server used in tests

Features

• Easy to use, mock http server
• Spy/track requests received by the server
• Designed to work with end-to-end & unit tests
• Strongly typed, types included
• Zero dependencies

Installation

yarn add -D mocr
# or
npm install --save-dev mocr

Configuration

All config options mentioned below are optional.

| Name | Default | Description | | ----- | ------- | ------------------------------------------ | | debug | false | When set to true, logging will be enabled. | | port | 9091 | The port that the server will be running. |

Usage

import mocr, { createRequestSpy } from 'mocr';

describe('my tests', () => {
  const mockServer = mocr({
    /* Configuration */
  });

  beforeAll(async () => {
    // Start the server
    await mockServer.start();
  });

  beforeEach(async () => {
    // Reset the request spy
    mockServer.requestSpy.reset();
  });

  afterAll(async () => {
    // Stop the server
    await mockServer.stop();
  });

  it('should make a call to the backend when pressing the button', () => {
    // Press the button

    const { request, body } = requestSpy.calls[0];

    expect(mockServer.requestSpy).toHaveBeenCalledTimes(1);
    expect(request.method).toBe(/* Expected Method, ie. POST, PUT */);
    expect(body).toHaveBeenCalledWith(/* Expected Request Body */);
  });
});

Methods

mocr

const mockServer = mocr(/* Optional Config */);

await mockServer.start();
// Run your test case
await mockServer.stop();

Used to create an instance of mocr - it accepts optional configuration. You can have as many mocr servers running in parallel as long as they run on a different port. See example for a complete example.

start()

const mockServer = mocr(/* Optional Config */);

await mockServer.start();

Starts the http server.

stop()

const mockServer = mocr(/* Optional Config */);

await mockServer.stop();

Stops the server of the mocr instance.

mockNextResponse({ data })

const { start, stop, mockNextResponse } = mocr(/* Optional Config */);

mockNextResponse({ foo: 'bar' });

Used to return a mock/stubbed response from the server. Will only use that response once and will then fall back to the default Hello World server response. For mocking multiple requests, see mockNextResponses below.

mockNextResponses([ { data } ])

const { start, stop, mockNextResponses } = mocr(/* Optional Config */);

mockNextResponses([{ id: '123' }, { id: '456' }]);

Similar to mockNextResponse but expects an array of data. The data will be return for each response in the order they appear in the array.

Properties

requestSpy

const { start, stop, requestSpy } = mocr(/* Optional Config */);

expect(requestSpy.calls).toHaveLength(1);

Holds a records/tracks all incoming requests to the mock server along with their body/data(if any). To be used for validating requests/content leaving your application. Below you can find all available methods for a RequestSpy. See example above.

| Name | Description | | ----- | ----------------------------------------------------------------------------- | | calls | An array of all the calls. [ {request: IncomingMessage. body: string {} } ] | | reset | Empties the calls array. |

License

This project is licensed under the MIT License - see the LICENSE file for details