From 84a0b37fccb75e7ec34f4384e88d723829ebe9a4 Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Wed, 21 Feb 2024 17:52:51 +0100 Subject: [PATCH] feat: Implement permission catalog API endpoint --- .../permissions/get-permissions-catalog.ee.js | 6 ++ .../get-permissions-catalog.ee.test.js | 32 ++++++++++ .../src/routes/api/v1/admin/permissions.ee.js | 17 +++++ packages/backend/src/routes/index.js | 2 + packages/backend/src/serializers/role.js | 2 +- .../permissions/get-permissions-catalog.ee.js | 64 +++++++++++++++++++ 6 files changed, 122 insertions(+), 1 deletion(-) create mode 100644 packages/backend/src/controllers/api/v1/admin/permissions/get-permissions-catalog.ee.js create mode 100644 packages/backend/src/controllers/api/v1/admin/permissions/get-permissions-catalog.ee.test.js create mode 100644 packages/backend/src/routes/api/v1/admin/permissions.ee.js create mode 100644 packages/backend/test/mocks/rest/api/v1/admin/permissions/get-permissions-catalog.ee.js diff --git a/packages/backend/src/controllers/api/v1/admin/permissions/get-permissions-catalog.ee.js b/packages/backend/src/controllers/api/v1/admin/permissions/get-permissions-catalog.ee.js new file mode 100644 index 00000000..232e33ea --- /dev/null +++ b/packages/backend/src/controllers/api/v1/admin/permissions/get-permissions-catalog.ee.js @@ -0,0 +1,6 @@ +import { renderObject } from '../../../../../helpers/renderer.js'; +import permissionCatalog from '../../../../../helpers/permission-catalog.ee.js'; + +export default async (request, response) => { + renderObject(response, permissionCatalog); +}; diff --git a/packages/backend/src/controllers/api/v1/admin/permissions/get-permissions-catalog.ee.test.js b/packages/backend/src/controllers/api/v1/admin/permissions/get-permissions-catalog.ee.test.js new file mode 100644 index 00000000..44a791dc --- /dev/null +++ b/packages/backend/src/controllers/api/v1/admin/permissions/get-permissions-catalog.ee.test.js @@ -0,0 +1,32 @@ +import { vi, describe, it, expect, beforeEach } from 'vitest'; +import request from 'supertest'; +import app from '../../../../../app.js'; +import createAuthTokenByUserId from '../../../../../helpers/create-auth-token-by-user-id.js'; +import { createRole } from '../../../../../../test/factories/role.js'; +import { createUser } from '../../../../../../test/factories/user.js'; +import getPermissionsCatalogMock from '../../../../../../test/mocks/rest/api/v1/admin/permissions/get-permissions-catalog.ee.js'; +import * as license from '../../../../../helpers/license.ee.js'; + +describe('GET /api/v1/admin/permissions/catalog', () => { + let role, currentUser, token; + + beforeEach(async () => { + role = await createRole({ key: 'admin' }); + currentUser = await createUser({ roleId: role.id }); + + token = createAuthTokenByUserId(currentUser.id); + }); + + it('should return roles', async () => { + vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true); + + const response = await request(app) + .get('/api/v1/admin/permissions/catalog') + .set('Authorization', token) + .expect(200); + + const expectedPayload = await getPermissionsCatalogMock(); + + expect(response.body).toEqual(expectedPayload); + }); +}); diff --git a/packages/backend/src/routes/api/v1/admin/permissions.ee.js b/packages/backend/src/routes/api/v1/admin/permissions.ee.js new file mode 100644 index 00000000..91a8486c --- /dev/null +++ b/packages/backend/src/routes/api/v1/admin/permissions.ee.js @@ -0,0 +1,17 @@ +import { Router } from 'express'; +import { authenticateUser } from '../../../../helpers/authentication.js'; +import { authorizeAdmin } from '../../../../helpers/authorization.js'; +import { checkIsEnterprise } from '../../../../helpers/check-is-enterprise.js'; +import getPermissionsCatalogAction from '../../../../controllers/api/v1/admin/permissions/get-permissions-catalog.ee.js'; + +const router = Router(); + +router.get( + '/catalog', + authenticateUser, + authorizeAdmin, + checkIsEnterprise, + getPermissionsCatalogAction +); + +export default router; diff --git a/packages/backend/src/routes/index.js b/packages/backend/src/routes/index.js index 6f78042d..1582d935 100644 --- a/packages/backend/src/routes/index.js +++ b/packages/backend/src/routes/index.js @@ -7,6 +7,7 @@ import automatischRouter from './api/v1/automatisch.js'; import usersRouter from './api/v1/users.js'; import samlAuthProvidersRouter from './api/v1/admin/saml-auth-providers.ee.js'; import rolesRouter from './api/v1/admin/roles.ee.js'; +import permissionsRouter from './api/v1/admin/permissions.ee.js'; const router = Router(); @@ -18,5 +19,6 @@ router.use('/api/v1/automatisch', automatischRouter); router.use('/api/v1/users', usersRouter); router.use('/api/v1/admin/saml-auth-providers', samlAuthProvidersRouter); router.use('/api/v1/admin/roles', rolesRouter); +router.use('/api/v1/admin/permissions', permissionsRouter); export default router; diff --git a/packages/backend/src/serializers/role.js b/packages/backend/src/serializers/role.js index 0209097d..cc3be89c 100644 --- a/packages/backend/src/serializers/role.js +++ b/packages/backend/src/serializers/role.js @@ -1,4 +1,4 @@ -import permissionSerializer from './permission'; +import permissionSerializer from './permission.js'; const roleSerializer = (role) => { let roleData = { diff --git a/packages/backend/test/mocks/rest/api/v1/admin/permissions/get-permissions-catalog.ee.js b/packages/backend/test/mocks/rest/api/v1/admin/permissions/get-permissions-catalog.ee.js new file mode 100644 index 00000000..627bfa33 --- /dev/null +++ b/packages/backend/test/mocks/rest/api/v1/admin/permissions/get-permissions-catalog.ee.js @@ -0,0 +1,64 @@ +const getPermissionsCatalogMock = async () => { + const data = { + actions: [ + { + key: 'create', + label: 'Create', + subjects: ['Connection', 'Flow'], + }, + { + key: 'read', + label: 'Read', + subjects: ['Connection', 'Execution', 'Flow'], + }, + { + key: 'update', + label: 'Update', + subjects: ['Connection', 'Flow'], + }, + { + key: 'delete', + label: 'Delete', + subjects: ['Connection', 'Flow'], + }, + { + key: 'publish', + label: 'Publish', + subjects: ['Flow'], + }, + ], + conditions: [ + { + key: 'isCreator', + label: 'Is creator', + }, + ], + subjects: [ + { + key: 'Connection', + label: 'Connection', + }, + { + key: 'Flow', + label: 'Flow', + }, + { + key: 'Execution', + label: 'Execution', + }, + ], + }; + + return { + data: data, + meta: { + count: 1, + currentPage: null, + isArray: false, + totalPages: null, + type: 'Object', + }, + }; +}; + +export default getPermissionsCatalogMock;