README
Serenity/JS
Serenity/JS is a framework designed to make acceptance and regression testing of modern full-stack applications faster, more collaborative and easier to scale.
Visit serenity-js.org for the latest tutorials and API docs, and follow @SerenityJS and @JanMolak on Twitter for project updates.
Learning Serenity/JS
To learn more about Serenity/JS, check out the video below, read the tutorial, review the examples, and create your own test suite with Serenity/JS template projects.
If you have any questions, join us on Serenity/JS Community Chat.
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()),
);
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;