cjihrig / artificial

Inject fake HTTP request/response into an Express server

artificial

Inject fake HTTP request/response into an Express server. This is a port of hapi's shot module, adapted to work with Express. artificial allows fake responses to be injected into a server without first binding to a port. This simplifies testing.

Basic Usage

'use strict';
const Artificial = require('artificial');
const Express = require('express');
const app = Express();

Artificial(app);  // Create the app.inject() method.

app.get('/', (req, res, next) => {
  res.send({ success: 'success!' });
});

app.inject({ method: 'GET', url: '/' }, (res) => {
  // res contains the fake HTTP response.
});

API

artificial exports a single function that is used to add a single injection method to an Express app.

Artificial(app [, method])

• Arguments
  • app (object) - An Express application.
  • method (string) - The name of the method to attach to app. Optional. Defaults to 'inject', meaning that app.inject() is created.
• Returns
  • app (object) - The same Express application as app.

Defines an injection method on an Express server. By default, the method's name is inject(). This method injects a request into the server, simulating an incoming HTTP request without using sockets. Injection is useful for testing purposes, as well as for invoking routing logic internally without the overhead and limitations of the network stack.