'use strict'; const { omit, map, orderBy } = require('lodash'); const { createStrapiInstance } = require('../../../../../test/helpers/strapi'); const { createAuthRequest } = require('../../../../../test/helpers/request'); describe('Admin API Token v2 CRUD (e2e)', () => { let rq; let strapi; const deleteAllTokens = async () => { const tokens = await strapi.admin.services['api-token'].list(); const promises = []; tokens.forEach(({ id }) => { promises.push(strapi.admin.services['api-token'].revoke(id)); }); await Promise.all(promises); }; // Initialization Actions beforeAll(async () => { strapi = await createStrapiInstance(); rq = await createAuthRequest({ strapi }); // delete tokens await deleteAllTokens(); }); // Cleanup actions afterAll(async () => { await strapi.destroy(); }); // create a random valid token that we can test with (delete, list, etc) let currentTokens = 0; const createValidToken = async (token = {}) => { const req = await rq({ url: '/admin/api-tokens', method: 'POST', body: Object.assign( { type: 'read-only', name: 'token_' + String(currentTokens++), description: 'generic description', }, token ), }); expect(req.status).toEqual(201); return req.body.data; }; test('Fails to create an api token (missing parameters from the body)', async () => { const body = { name: 'api-token_tests-failBody', description: 'api-token_tests-description', }; const res = await rq({ url: '/admin/api-tokens', method: 'POST', body, }); expect(res.statusCode).toBe(400); expect(res.body).toMatchObject({ data: null, error: { status: 400, name: 'ValidationError', message: 'type is a required field', details: { errors: [ { path: ['type'], name: 'ValidationError', message: 'type is a required field', }, ], }, }, }); }); test('Fails to create an api token (invalid `type` in the body)', async () => { const body = { name: 'api-token_tests-failType', description: 'api-token_tests-description', type: 'invalid-type', }; const res = await rq({ url: '/admin/api-tokens', method: 'POST', body, }); expect(res.statusCode).toBe(400); expect(res.body).toMatchObject({ data: null, error: { status: 400, name: 'ValidationError', message: 'type must be one of the following values: read-only, full-access, custom', details: { errors: [ { path: ['type'], name: 'ValidationError', message: 'type must be one of the following values: read-only, full-access, custom', }, ], }, }, }); }); test('Creates a read-only api token (successfully)', async () => { const body = { name: 'api-token_tests-readonly', description: 'api-token_tests-description', type: 'read-only', }; const res = await rq({ url: '/admin/api-tokens', method: 'POST', body, }); expect(res.statusCode).toBe(201); expect(res.body.data).toStrictEqual({ accessKey: expect.any(String), name: body.name, permissions: [], description: body.description, type: body.type, id: expect.any(Number), createdAt: expect.any(String), }); }); test.skip('Fails to create a read-only api token with permissions', async () => { const body = { name: 'api-token_tests-readonly', description: 'api-token_tests-description', type: 'read-only', permissions: ['admin::thing.action'], }; const res = await rq({ url: '/admin/api-tokens', method: 'POST', body, }); expect(res.statusCode).toBe(400); // TODO: should be a 400 expect(res.body.data).toStrictEqual({ accessKey: expect.any(String), name: body.name, permissions: [], description: body.description, type: body.type, id: expect.any(Number), createdAt: expect.any(String), }); }); test('Creates a custom api token (successfully)', async () => { const body = { name: 'api-token_tests-custom', description: 'api-token_tests-description', type: 'custom', permissions: ['admin::subject.action', 'plugin::foo.bar.action'], }; const res = await rq({ url: '/admin/api-tokens', method: 'POST', body, }); expect(res.statusCode).toBe(201); expect(res.body.data).toStrictEqual({ accessKey: expect.any(String), name: body.name, permissions: body.permissions, description: body.description, type: body.type, id: expect.any(Number), createdAt: expect.any(String), }); }); test.skip('Fails to create a custom api token without permissions', async () => { const body = { name: 'api-token_tests-custom', description: 'api-token_tests-description', type: 'custom', permissions: [], }; const res = await rq({ url: '/admin/api-tokens', method: 'POST', body, }); expect(res.statusCode).toBe(400); // expect(res.body).toMatchObject({ // data: null, // error: { // status: 400, // name: 'ValidationError', // message: 'type must be one of the following values: read-only, full-access, custom', // details: { // errors: [ // { // path: ['type'], // name: 'ValidationError', // message: 'type must be one of the following values: read-only, full-access, custom', // }, // ], // }, // }, // }); }); test('Creates an api token without a description (successfully)', async () => { const body = { name: 'api-token_tests-without-description', type: 'full-access', }; const res = await rq({ url: '/admin/api-tokens', method: 'POST', body, }); expect(res.statusCode).toBe(201); expect(res.body.data).toStrictEqual({ accessKey: expect.any(String), name: body.name, permissions: [], description: '', type: body.type, id: expect.any(Number), createdAt: expect.any(String), }); }); test('Creates an api token with trimmed description and name (successfully)', async () => { const body = { name: ' api-token_tests-spaces-at-the-end ', description: ' api-token_tests-description-with-spaces-at-the-end ', type: 'read-only', }; const res = await rq({ url: '/admin/api-tokens', method: 'POST', body, }); expect(res.statusCode).toBe(201); expect(res.body.data).toStrictEqual({ accessKey: expect.any(String), name: 'api-token_tests-spaces-at-the-end', permissions: [], description: 'api-token_tests-description-with-spaces-at-the-end', type: body.type, id: expect.any(Number), createdAt: expect.any(String), }); }); test('List all tokens (successfully)', async () => { await deleteAllTokens(); // create 4 tokens let tokens = []; tokens.push(await createValidToken()); tokens.push(await createValidToken()); tokens.push(await createValidToken()); tokens.push(await createValidToken()); const res = await rq({ url: '/admin/api-tokens', method: 'GET', }); expect(res.statusCode).toBe(200); expect(res.body.data.length).toBe(4); expect(orderBy(res.body.data, ['id'])).toStrictEqual( map(orderBy(tokens, ['id']), t => omit(t, ['accessKey'])) ); }); test('Deletes a token (successfully)', async () => { const token = await createValidToken(); const res = await rq({ url: `/admin/api-tokens/${token.id}`, method: 'DELETE', }); expect(res.statusCode).toBe(200); expect(res.body.data).toStrictEqual({ name: token.name, permissions: token.permissions, description: token.description, type: token.type, id: token.id, createdAt: token.createdAt, }); }); test('Does not return an error if the ressource to delete does not exist', async () => { const res = await rq({ url: '/admin/api-tokens/42', method: 'DELETE', }); expect(res.statusCode).toBe(200); expect(res.body.data).toBeNull(); }); test('Retrieves a token (successfully)', async () => { const token = await createValidToken(); const res = await rq({ url: `/admin/api-tokens/${token.id}`, method: 'GET', }); expect(res.statusCode).toBe(200); expect(res.body.data).toStrictEqual({ name: token.name, permissions: token.permissions, description: token.description, type: token.type, id: token.id, createdAt: token.createdAt, }); }); test('Returns a 404 if the ressource to retrieve does not exist', async () => { const res = await rq({ url: '/admin/api-tokens/42', method: 'GET', }); expect(res.statusCode).toBe(404); expect(res.body).toMatchObject({ data: null, error: { status: 404, name: 'NotFoundError', message: 'API Token not found', details: {}, }, }); }); test('Updates a token (successfully)', async () => { // create a token const body = { name: 'api-token_tests-name', description: 'api-token_tests-description', type: 'read-only', }; const res = await rq({ url: '/admin/api-tokens', method: 'POST', body, }); const token = res.body.data; const updatedBody = { name: 'api-token_tests-updated-name', description: 'api-token_tests-description', type: 'read-only', }; const updatedRes = await rq({ url: `/admin/api-tokens/${token.id}`, method: 'PUT', body: updatedBody, }); expect(updatedRes.statusCode).toBe(200); expect(updatedRes.body.data).toStrictEqual({ name: updatedBody.name, permissions: [], description: updatedBody.description, type: updatedBody.type, id: token.id, createdAt: token.createdAt, }); }); test('Returns a 404 if the ressource to update does not exist', async () => { const body = { name: 'api-token_tests-updated-name', description: 'api-token_tests-updated-description', type: 'read-only', }; const res = await rq({ url: '/admin/api-tokens/42', method: 'PUT', body, }); expect(res.statusCode).toBe(404); expect(res.body).toMatchObject({ data: null, error: { status: 404, name: 'NotFoundError', message: 'API Token not found', details: {}, }, }); }); test('Updates a token with partial payload (successfully)', async () => { const token = await createValidToken(); const body = { description: 'api-token_tests-re-updated-description', }; const res = await rq({ url: `/admin/api-tokens/${token.id}`, method: 'PUT', body, }); expect(res.statusCode).toBe(200); expect(res.body.data).toMatchObject({ name: token.name, permissions: token.permissions, description: body.description, // updated field type: token.type, id: token.id, createdAt: token.createdAt, }); }); test('Fails to update an api token (invalid `type` in the body)', async () => { const body = { name: 'api-token_tests-name', description: 'api-token_tests-description', type: 'invalid-type', }; const res = await rq({ url: '/admin/api-tokens/1', method: 'PUT', body, }); expect(res.statusCode).toBe(400); expect(res.body).toMatchObject({ data: null, error: { details: { errors: [ { message: 'type must be one of the following values: read-only, full-access, custom', name: 'ValidationError', path: ['type'], }, ], }, message: 'type must be one of the following values: read-only, full-access, custom', name: 'ValidationError', status: 400, }, }); }); test('Updates a token when passing a `null` description (successfully)', async () => { const token = await createValidToken(); const body = { description: null, }; const res = await rq({ url: `/admin/api-tokens/${token.id}`, method: 'PUT', body, }); expect(res.statusCode).toBe(200); expect(res.body.data).toMatchObject({ name: token.name, permissions: token.permissions, description: '', type: token.type, id: token.id, createdAt: token.createdAt, }); }); test('Updates a token but not the description if no description is passed (successfully)', async () => { const token = await createValidToken(); const body = { name: 'api-token_tests-newNameWithoutDescUpdate', }; const res = await rq({ url: `/admin/api-tokens/${token.id}`, method: 'PUT', body, }); expect(res.statusCode).toBe(200); expect(res.body.data).toMatchObject({ name: body.name, description: token.description, permissions: token.permissions, type: token.type, id: token.id, createdAt: token.createdAt, }); }); });