@jsoverson/test-server

Local test server

This is a quick server library that exposes one async, start to control a local static file server. You can only control the path that is served. The port is assigned for you and this always binds to 127.0.0.1.

Who is this for?

People who want to test interaction with an HTTP server and want to control that dependency locally so tests don't have to reach out to the internet.

Usage

const {start} = require('@jsoverson/test-server');
const fetch = require('node-fetch');

(async function () {
  const server = await start();

  console.log(`Server started on port ${server.port}, serving directory ${server.path}.`);

  const response = await fetch(server.url('index.html'));

  await server.stop();
})();

Magic URLs

/drop : any URL ending in /drop will drop the connection

/wait/#### : any URL ending in /wait/#### (e.g. /wait/5000) will wait #### milliseconds before responding. The response is the time actually waited.

/status/#### : any URL ending in /status/#### (e.g. /status/404) will return an HTTP status of ####. The response text is also the status code.

Debugging

This library uses debug so you can start your script with DEBUG=test-server* yourScript.js to get debug output.

API

start(...pathParts = [process.cwd(), 'server_root']) returns TestServer

pathParts are the parts of the path that can be passed to path.join(). Defaults to a 'server_root' directory in the current working directory.

TestServer();

.port

The assigned port

.path

The path that is being served

.address

The http path + port.

.url(path)

Convenience method that appends path to .address