@serenity-js/rest

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 REST

@serenity-js/rest module lets your actors interact with and test HTTP REST APIs.

Installation

To install this module, as well as axios HTTP client, run the following command in your computer terminal:

npm install --save-dev @serenity-js/{core,rest,assertions} axios

Example test

import { actorCalled } from '@serenity-js/core';
import { CallAnApi, DeleteRequest, GetRequest, LastResponse, PostRequest, Send } from '@serenity-js/rest'
import { Ensure, equals, startsWith } from '@serenity-js/assertions';

const actor = actorCalled('Apisit').whoCan(CallAnApi.at('https://myapp.com/api'));

actor.attemptsTo(
    // no users present in the system
    Send.a(GetRequest.to('/users')),
    Ensure.that(LastResponse.status(), equals(200)),
    Ensure.that(LastResponse.body(), equals([])),

    // create a new test user account
    Send.a(PostRequest.to('/users').with({
        login: 'tester',
        password: 'P@ssword1',
    }),
    Ensure.that(LastResponse.status(), equals(201)),
    Ensure.that(LastResponse.header('Location'), startsWith('/users')),

    // delete the test user account
    Send.a(DeleteRequest.to(LastResponse.header('Location'))),
    Ensure.that(LastResponse.status(), equals(200)),
);

Changelog

3.0.0-rc.41 (2023-02-07)

Bug Fixes

• assertions: custom errors thrown via Ensure now include activity location (1fdf7a2), closes #1102
• assertions: interaction to Ensure no longer emits an AssertionReport artifact (db3e5ae), closes #1486
• core: corrected issue in asyncMap that led lists of lists to be flat-mapped not mapped (d7a6f1d)
• core: easier configuration and automatic colour support detection for AnsiDiffFormatter (637ed44), closes #1486
• core: further improvements to how the expected vs received values are rendered in VS Code (e2101d0), closes #1486
• core: improved support for Node 14 (f828b45)
• core: introduced ExpectationDetails to provide more accurate info re failed expectations (02b8f33), closes #1102
• core: removed AssertionReport and AssertionReportDiffer as they're no longer needed (a968ac5), closes #1480
• core: removed the legacy Error (de-)serialisation mechanism (7ea2b10)
• core: typeOf now correctly recognises Proxy objects (3ca68a3)
• core: updated npm-failsafe to 1.0.0 (df80731), closes #1486
• playwright: upgraded Playwright to 1.30.0 (305a2c2)
• web: renamed internal function inspector to inspected (4d2b147)

Features

• assertions: diffs included in RuntimeErrors are now colour-coded (f88efb4), closes #1486
• core: assertion and synchronisation errors include location of the activity that threw them (f06f378), closes #1102
• core: assertion errors include precise information about unmet expectations and improved diffs (1eb09b1), closes #1102
• core: better assertion errors reporting in Visual Studio Code (3b94b7d), closes #1486
• core: error factory is now configurable, which allows for the diffs to include colours (dac293d), closes #1486
• core: new ability to RaiseErrors (4617d39), closes #1102
• core: overridable abilities (03966cc)
• protractor: improved assertion error reporting for Protractor (8f8f91c), closes #1102
• webdriverio: improved assertion error reporting for WebdriverIO (7513752), closes #1102