mprokopowicz / mockyeah

A powerful service mocking, recording, and playback utility.

mockyeah

"A powerful service mocking, recording, and playback utility."

Testing is difficult when you don't have control of your data. mockyeah puts you in complete control, enabling you to implement real mock web services with ease. Real mock services means you have control of response payloads, HTTP Status Codes, response latency, and more.

Have a requirement to implement specific behavior when a service is slow to respond or a server returns an unexpected status code? No problem! mockyeah makes developing for such requirements easy.

Install

$ npm install mockyeah --save-dev

Usage

• Introductory tutorial
• Testing with mockyeah
• Examples
• Configuration

API

• Mock Services
• Server Management
• Mock Expectations
• Service Snapshots

CLI

• mockyeah-cli
• mockyeah-cli Documentation

Introductory tutorial

1. Create an example project and initialized with NPM

   $ mkdir example-app && cd example-app
   $ npm init # all defaults will be fine

2. Install mockyeah

   $ npm install mockyeah --save-dev

3. Create script file and add the source below

   $ touch index.js

   const mockyeah = require('mockyeah');
   
   mockyeah.get('/hello-world', { text: 'Hello World' });

4. Run the script file with Node

   $ node index.js

5. Open http://localhost:4001/hello-world

6. Profit. You should see "Hello World" returned from your mock server.

Testing with mockyeah

const request = require('supertest')('http://localhost:4001');
const mockyeah = require('mockyeah');

describe('Wondrous service', () => {
  // remove service mocks after each test
  afterEach(() => mockyeah.reset());

  // stop mockyeah server
  after(() => mockyeah.close());

  it('should create a mock service that returns an internal error', (done) => {
    // create failing service mock
    mockyeah.get('/wondrous', { status: 500 });

    // assert service mock is working
    request
      .get('/wondrous')
      .expect(500, done);
  });

  it('should create a mock service that returns JSON', (done) => {
    // create service mock that returns json data
    mockyeah.get('/wondrous', { json: { foo: 'bar' } });

    // assert service mock is working
    request
      .get('/wondrous')
      .expect(200, { foo: 'bar' }, done);
  });

  it('should verify a mock service expectation', (done) => {
    // create service mock with expectation
    const expectation = mockyeah
      .get('/wondrous', { text: 'it worked' })
      .expect()
      .params({
        foo: 'bar'
      })
      .once();

    // invoke request and verify expectation
    request
      .get('/wondrous?foo=bar')
      .expect(200, 'it worked')
      .then(() => {
        expectation.verify();
        done();
      });
  });
});