inject - Kequapp Documentation

import { inject } from 'kequapp';

You may unit test your application without starting a server by using the inject tool. The first parameter is your app, then options used to populate the request.

The returned req value is a simulation of Node's built-in ClientRequest object and is a Transform stream. The returned res value is a simulation of Node's built-in ServerResponse object and is also a Transform stream. The returned getResponse tool waits for your application to finish processing, and parses the response. It is very similar to getBody as described earlier. You could inspect what your application is doing using the req and res objects in real-time instead if that's what you need.

it('reads the authorization header', async () => {
    const { getResponse, res } = inject(app, {
        url: '/admin/dashboard',
        headers: {
            Authorization: 'mike',
        },
    });

    const body = await getResponse();

    assert.strictEqual(res.getHeader('Content-Type'), 'text/plain');
    assert.strictEqual(body, 'Hello admin mike!');
});

All requests are automatically finalized when using inject unless the body parameter is set to null. Doing this will allow you to write to the stream in cases where more precise testing is necessary.

The following two examples are the same.

const { getResponse } = inject(app, {
    method: 'POST',
    url: '/users',
    headers: {
        'Content-Type': 'application/json',
    },
    body: '{ "name": "April" }',
});

const body = await getResponse();

const { getResponse, req } = inject(app, {
    method: 'POST',
    url: '/users',
    headers: {
        'Content-Type': 'application/json',
    },
    body: null,
});

// finalize request
req.end('{ "name": "April" }');

const body = await getResponse();

Note that getResponse will not resolve until the request is finalized.

# inject