Ghost/ghost/core/test/e2e-api/admin/labels.test.js

const logging = require('@tryghost/logging');
const {agentProvider, fixtureManager, matchers} = require('../../utils/e2e-framework');
const {anyContentVersion, anyObjectId, anyISODateTime, anyErrorId, anyEtag, anyLocationFor} = matchers;
const sinon = require('sinon');

const matchLabel = {
    id: anyObjectId,
    created_at: anyISODateTime,
    updated_at: anyISODateTime
};

describe('Labels API', function () {
    let agent;

    before(async function () {
        agent = await agentProvider.getAdminAPIAgent();
        await fixtureManager.init();
        await agent.loginAsOwner();
    });

    afterEach(function () {
        sinon.restore();
    });

    it('Can browse with no labels', async function () {
        await agent
            .get('labels')
            .expectStatus(200)
            .matchBodySnapshot()
            .matchHeaderSnapshot({
                'content-version': anyContentVersion,
                etag: anyEtag
            });
    });

    it('Can add', async function () {
        await agent
            .post('labels')
            .body({labels: [{
                name: 'test'
            }]})
            .expectStatus(201)
            .matchBodySnapshot({
                labels: [matchLabel]
            })
            .matchHeaderSnapshot({
                'content-version': anyContentVersion,
                etag: anyEtag,
                location: anyLocationFor('labels')
            });
    });

    it('Errors when adding label with the same name', async function () {
        const loggingStub = sinon.stub(logging, 'error');
        await agent
            .post('labels')
            .body({labels: [{
                name: 'test'
            }]})
            .expectStatus(422)
            .matchBodySnapshot({
                errors: [{
                    id: anyErrorId

                }]
            })
            .matchHeaderSnapshot({
                'content-version': anyContentVersion,
                etag: anyEtag
            });
        sinon.assert.calledOnce(loggingStub);
    });

    it('Can browse with member count', async function () {
        await agent
            .get('labels/?include=count.members')
            .expectStatus(200)
            .matchBodySnapshot({
                labels: [matchLabel]
            })
            .matchHeaderSnapshot({
                'content-version': anyContentVersion,
                etag: anyEtag
            });
    });

    it('Can read by slug and edit', async function () {
        const {body} = await agent
            .get('labels/slug/test/')
            .expectStatus(200)
            .matchBodySnapshot({
                labels: [matchLabel]
            })
            .matchHeaderSnapshot({
                'content-version': anyContentVersion,
                etag: anyEtag
            });

        const id = body.labels[0].id;

        await agent
            .put(`labels/${id}`)
            .body({labels: [{name: 'testing'}]})
            .expectStatus(200)
            .matchBodySnapshot({
                labels: [matchLabel]
            })
            .matchHeaderSnapshot({
                'content-version': anyContentVersion,
                etag: anyEtag
            });
    });

    it('Can destroy', async function () {
        const {body} = await agent
            .get('labels/slug/test/')
            .expectStatus(200)
            .matchBodySnapshot({
                labels: [matchLabel]
            })
            .matchHeaderSnapshot({
                'content-version': anyContentVersion,
                etag: anyEtag
            });

        const id = body.labels[0].id;

        await agent
            .delete(`labels/${id}`)
            .expectStatus(204)
            .expectEmptyBody()
            .matchHeaderSnapshot({
                'content-version': anyContentVersion,
                etag: anyEtag
            });
    });

    it('Cannot destroy non-existent label', async function () {
        await agent
            .delete('labels/abcd1234abcd1234abcd1234')
            .expectStatus(404)
            .matchBodySnapshot({
                errors: [{
                    id: anyErrorId
                }]
            })
            .matchHeaderSnapshot({
                'content-version': anyContentVersion,
                etag: anyEtag
            });
    });
});