mehpi

Simple External API Mocking via Sinon

Motivation

So why another testing utility library for mocking HTTP servers? Because:

1. We love sinon
2. We wanted to love functional tests, but nock was unideal
3. We thought, "Hey wouldn't it be cool if we could mock APIs with sinon?"

Example

const MockAPI = require('mehpi')
const request = require('request')
const sinon = require('sinon')

describe('functional tests', () => {
  // Create a new mock api for github (localhost:5678)
  const github = new MockAPI('5678')

  // Start the API before all tests, stop it when we're done
  before((done) => github.start(done))
  after((done) => github.stop(done))

  // Setup some route stubs for the API
  beforeEach(() => {
    github.stub('GET', '/users/rsandor').returns(200)
    github.stub('GET', '/repos/rsandor/solace/comments').returns({
      status: 500,
      body: 'Internal Server Error'
    })
    github.stub('POST', '/gists')
      .onFirstCall().returns(500)
      .onSecondCall().returns(200)
  })

  // Restore all route stubs after each test
  afterEach(() => {
    github.restore()
  })

  // Write a test!
  it('should call github', (done) => {
    const getUsers = github.stub('GET /users/:username')
    request.get('http://localhost:5678/users/rsandor', function () {
      sinon.assert.calledOnce(getUsers)
      done()
    })
  })
})

API Reference

new MockAPI(port)

Creates a new MockAPI instance that runs locally on the given port.

.start(done)

Starts the server, then calls the done callback.

.stop([done])

Stops the server. If defined, calls the done callback.

.stub(method, path)

Creates and returns a sinon stub for the given HTTP method and path.

.restore([route])

Restores all route stubs on the mocked server.

License

MIT