cypress-automocker

This is the fork of the cypress plugin "cypressautomocker". I wanted to add the ability to pass my own options for an out directory. Maybe I might make a pull request into original repo sometime.

This tool is built on top of the open-source testing platform Cypress.io to allow recording API results and replaying the APIs as a mock server.

Folder layout

There are three subfolders within the head directory:

1. example: Contains a simple application to test against that implements APIs with changing responses, along with an example Cypress test.
2. include-in-tests: Contains a library to include in your in your test suite,
3. include-in-webapp: Contains a library to include in your application that is being tested.

Running the example

To install and run the example, run the following:

cd example
npm install
npm run start

You should see Example app listening at http://localhost:1337 which means that the local server is running on port 1337. It will also open Cypress, allowing you to run the test.

The first time you run the test, our tool will record the API results to the file example/cypress/automocks/testCounter.json. The next time the test is run, it will automatically use the contents of the file to mock the APIs.

You can control the recording and playback behavior using the (optional) automocker field in cypress.json:

  "automocker": {
    "record": true,
    "playback": true
  }

The default (that is, if "automocker" doesn't exist) is to treat both record and playback as true, which means that it will automatically record API calls (if the proper commands are called in the tests) if the mock file does not exits, and will play them back as mocks if they do exist.

Integrating Into Your Own Web Application and tests

Integrating this tool into your web application involves a few steps:

1. Add the cypressautomocker to your project:

npm install --save cypressautomocker

2. Add the cypress web hooks to your application.

import installCypressHooks from 'cypressautomocker/include-in-webapp';
installCypressHooks();

Another option to do the same thing would be to include the following code in your HTML instead:

<script src="node_modules/cypressautomocker/include-in-webapp/installCypressHooks-norequire.js">

3. Add the following to cypress/support/commands.js

import registerAutoMockCommands from 'cypressautomocker/include-in-tests';
registerAutoMockCommands();

4. In each of your tests, add the following:

  // The name of the JSON file that contains the recorded mock data.
  const MOCK_FILENAME = 'testCounter';

  before(() => {
    // default options
    let options = {
      isCustomMock: false,
      outDir: '/tests/e2e/mocks'
    };
    cy.automock(MOCK_FILENAME, {...options});
  });

  after(() => {
    cy.automockEnd();
  });