PutRequest.spec.ts

import 'mocha';

import { q, Question } from '@serenity-js/core';

import { PutRequest } from '../../src/model';
import { actorUsingAMockedAxiosInstance } from '../actors';
import { expect } from '../expect';

/** @test {PutRequest} */
describe('PutRequest', () => {

    const { actor } = actorUsingAMockedAxiosInstance();

    /** @test {PutRequest.to} */
    it('represents an Axios request', () =>
        expect(actor.answer(PutRequest.to('/products/2')))
            .to.eventually.deep.equal({
                method: 'PUT',
                url: '/products/2',
            }));

    /**
     * @test {PutRequest.to}
     * @test {PutRequest#with}
     */
    it('can have a request body', () =>
        expect(actor.answer(PutRequest.to('/products/2').with({ name: 'apple' })))
            .to.eventually.deep.equal({
                method: 'PUT',
                url: '/products/2',
                data: { name: 'apple' },
            })
    );

    /**
     * @test {PutRequest.to}
     * @test {PutRequest#with}
     * @test {PutRequest#using}
     */
    it('allows for additional request properties to be specified', () =>
        expect(actor.answer(PutRequest.to('/products/2').with({ name: 'apple' }).using({
            headers: {
                Accept: 'application/json',
            },
        }))).
        to.eventually.deep.equal({
            method: 'PUT',
            url: '/products/2',
            headers: {
                Accept: 'application/json',
            },
            data: { name: 'apple' },
        })
    );

    it('accepts dynamic records', () =>
        expect(
            actor.answer(PutRequest.to('/products/2').with({ name: 'apple' })
                .using({
                    headers: {
                        Authorization: q`Bearer ${ Question.about('token', actor => 'some-token') }`,
                    },
                })
            )
        ).
        to.eventually.deep.equal({
            method: 'PUT',
            url: '/products/2',
            headers: {
                Authorization: 'Bearer some-token',
            },
            data: { name: 'apple' },
        })
    );

    /** @test {PutRequest#toString} */
    it('provides a sensible description of the interaction being performed', () => {
        expect(PutRequest.to('/products/2').toString())
            .to.equal(`a PUT request to '/products/2'`);
    });
});