@serenity-js/local-server
Serenity/JS is an innovative open-source framework designed to make acceptance and regression testing of complex software systems faster, more collaborative and easier to scale.
βοΈ Get started with Serenity/JS!
π Join the Serenity/JS Community!
- Meet other Serenity/JS developers and maintainers on the Serenity/JS Community chat channel,
- Find answers to your Serenity/JS questions on the Serenity/JS Forum,
- Learn how to contribute to Serenity/JS,
- Support the project and gain access to Serenity/JS Playbooks by becoming a Serenity/JS GitHub Sponsor!
Serenity/JS Local Serverβ
@serenity-js/local-server
enables Serenity/JS Actors to manage local HTTP or HTTPS test servers powered by Express,
Hapi,
Koa,
Restify
or raw Node.js.
Installationβ
To install this module, run the following command in your computer terminal:
npm install --save-dev @serenity-js/{core,local-server}
Example testβ
import { actorCalled } from '@serenity-js/core';
import {
ManageALocalServer, StartLocalTestServer, StopLocalTestServer
} from '@serenity-js/local-server'
import { CallAnApi, GetRequest, Send } from '@serenity-js/rest';
import { Ensure, equals } from '@serenity-js/assertions';
import axios from 'axios';
import { requestListener } from './listener'; (1)
const actor = actorCalled('Apisit').whoCan(
ManageALocalServer.using(requestListener), (2)
CallAnApi.using(axios.create()),
);
await actor.attemptsTo(
StartLocalTestServer.onRandomPort(), (3)
Send.a(GetRequest.to(LocalServer.url())), (4)
Ensure.that(LastResponse.status(), equals(200)),
Ensure.that(LastResponse.body(), equals('Hello!')),
StopLocalTestServer.ifRunning(), (5)
);
In the above example:
- A
requestListener
to be tested is imported. - The
Actor
is given anAbility
toManageALocalServer
. This enables theInteraction
toStartLocalTestServer
andStopLocalTestServer
, as well as theLocalServer
Question
. - The local server is started on a random port, although you can specify a port range if you prefer.
- The url of the local server is retrieved and used to test an interaction with its HTTP API.
- The local server is stopped when the test is complete. Please note that you probably want to
StopLocalTestServer
in anafterEach
block of your test (or something equivalent) to make sure that the server is correctly shut down even when the test fails.
Creating a serverβ
Any requestListener
that Node's
http.createServer
or https.createServer
would accept can be used with ManageALocalServer
.
Below are example implementations of a simple HTTP server that would satisfy the above test.
Raw Node.jsβ
// listener.js
module.exports.requestListener = (request, response) => {
response.setHeader('Connection', 'close');
response.end('Hello World!');
}
Expressβ
// listener.js
const express = require('express');
module.exports.requestListener = express().
get('/', (req: express.Request, res: express.Response) => {
res.status(200).send('Hello World!');
});
HAPIβ
// listener.js
const hapi = require('@hapi/hapi');
const server = new hapi.Server();
server.route({ method: 'GET', path: '/', handler: (req, h) => 'Hello World!' })
module.exports.requestListener = server.listener;
Koaβ
// listener.js
const Koa = require('koa');
module.exports.requestListener = new Koa()
.use(ctx => Promise.resolve(ctx.body = 'Hello World!'))
.callback();
Restifyβ
// listener.js
const restify = require('restify');
const server = restify.createServer(options);
server.get('/', (req, res, next) => {
res.send('Hello World!');
});
module.exports.requestListener = server;
π£ Stay up to dateβ
New features, tutorials, and demos are coming soon! Follow Serenity/JS on LinkedIn, subscribe to Serenity/JS channel on YouTube and join the Serenity/JS Community Chat to stay up to date! Please also make sure to star βοΈ Serenity/JS on GitHub to help others discover the framework!
π Support Serenity/JSβ
If you appreciate all the effort that goes into making sophisticated tools easy to work with, please support our work and become a Serenity/JS GitHub Sponsor today!
Index
Abilities
Activities
Models
Questions
Type Aliases
Type Aliases
RequestListener
Type declaration
Parameters
request: http.IncomingMessage
response: http.ServerResponse
Returns void
ServerWithShutdown
A net.Server with an added shutdown method.
A
requestListener
function accepted by Nodeβshttp.createServer
orhttps.createServer
.