Skip to main content

external@serenity-js/local-server

Follow Serenity/JS on LinkedIn Watch Serenity/JS on YouTube Join Serenity/JS Community Chat Support Serenity/JS on GitHub

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!

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 @serenity-js/local-server

Example test​

import { actorCalled } from '@serenity-js/core'
import {
    ManageALocalServer, StartLocalServer, StopLocalServer
} 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.runningAHttpListener(requestListener),   // (2)
    CallAnApi.using(axios.create()),
)

await actor.attemptsTo(
    StartLocalServer.onRandomPort(),                            // (3)
    Send.a(GetRequest.to(LocalServer.url())),                   // (4)
    Ensure.that(LastResponse.status(), equals(200)),
    Ensure.that(LastResponse.body(), equals('Hello!')),
    StopLocalServer.ifRunning(),                                // (5)
)

In the above example:

  1. Import a requestListener you want to use in your test.
  2. Give the actor an ability to ManageALocalServer. This enables the interactions to StartLocalServer and StopLocalServer, as well as the LocalServer question.
  3. Start the local server on a random port, specific port, or a random port within your preferred port range.
  4. Use the LocalServer.url() question to retrieve the url of the local server and interact with its HTTP API.
  5. Stop the local server is when the test is complete. Please note that you probably want to StopLocalServer in an afterEach 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 accepted by Node's http.createServer or https.createServer 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!')
}

Learn more about Node.js.

Express​

// listener.js
const express = require('express')

module.exports.requestListener = express().
    get('/', (req: express.Request, res: express.Response) => {
        res.status(200).send('Hello World!')
    })

Learn more about Express.

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

Learn more about HAPI.

Koa​

// listener.js
const Koa = require('koa')

module.exports.requestListener = new Koa()
    .use(ctx => Promise.resolve(ctx.body = 'Hello World!'))
    .callback()

Learn more about Koa.

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

Learn more about Restify.

📣 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!

Follow Serenity/JS on LinkedIn Watch Serenity/JS on YouTube Join Serenity/JS Community Chat GitHub stars

💛 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!

GitHub Sponsors

Index

Abilities

Activities

Models

Questions

Type Aliases

Type Aliases

externalRequestListener

RequestListener: (request: http.IncomingMessage, response: http.ServerResponse) => void

A requestListener function accepted by Node's http.createServer or https.createServer.

Type declaration

    • (request: http.IncomingMessage, response: http.ServerResponse): void

    • Parameters

      • externalrequest: http.IncomingMessage
      • externalresponse: http.ServerResponse

      Returns void

externalServerWithShutdown

ServerWithShutdown: net.Server & { shutdown: (callback: (error?: Error) => void) => void; forceShutdown: (callback: (error?: Error) => void) => void }

A net.Server with an additional shutdown method.

Page Options