groot/automatisch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: Implement saml auth providers API endpoint

Browse Source
This commit is contained in:
Faruk AYDIN
2024-03-14 10:26:26 +01:00
parent b1e2e370c8
commit 68c5a3dca7
12 changed files with 139 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/backend/src/controllers/api/v1/admin/saml-auth-providers/get-saml-auth-provider.ee.js
View File

@@ -6,5 +6,7 @@ export default async (request, response) => {
.findById(request.params.samlAuthProviderId)
.throwIfNotFound();
renderObject(response, samlAuthProvider);
renderObject(response, samlAuthProvider, {
serializer: 'AdminSamlAuthProvider',
});
};

4
packages/backend/src/controllers/api/v1/admin/saml-auth-providers/get-saml-auth-providers.ee.js
View File

@@ -7,5 +7,7 @@ export default async (request, response) => {
'desc'
);
renderObject(response, samlAuthProviders);
renderObject(response, samlAuthProviders, {
serializer: 'AdminSamlAuthProvider',
});
};

12
packages/backend/src/controllers/api/v1/saml-auth-providers/get-saml-auth-providers.ee.js Normal file
View File

@@ -0,0 +1,12 @@
import { renderObject } from '../../../../helpers/renderer.js';
import SamlAuthProvider from '../../../../models/saml-auth-provider.ee.js';
export default async (request, response) => {
const samlAuthProviders = await SamlAuthProvider.query()
.where({
active: true,
})
.orderBy('created_at', 'desc');
renderObject(response, samlAuthProviders);
};

30
packages/backend/src/controllers/api/v1/saml-auth-providers/get-saml-auth-providers.ee.test.js Normal file
View File

@@ -0,0 +1,30 @@
import { vi, describe, it, expect, beforeEach } from 'vitest';
import request from 'supertest';
import app from '../../../../app.js';
import { createSamlAuthProvider } from '../../../../../test/factories/saml-auth-provider.ee.js';
import getSamlAuthProvidersMock from '../../../../../test/mocks/rest/api/v1/saml-auth-providers/get-saml-auth-providers.js';
import * as license from '../../../../helpers/license.ee.js';
describe('GET /api/v1/saml-auth-providers', () => {
let samlAuthProviderOne, samlAuthProviderTwo;
beforeEach(async () => {
samlAuthProviderOne = await createSamlAuthProvider();
samlAuthProviderTwo = await createSamlAuthProvider();
});
it('should return saml auth providers', async () => {
vi.spyOn(license, 'hasValidLicense').mockResolvedValue(true);
const response = await request(app)
.get('/api/v1/saml-auth-providers')
.expect(200);
const expectedPayload = await getSamlAuthProvidersMock([
samlAuthProviderTwo,
samlAuthProviderOne,
]);
expect(response.body).toEqual(expectedPayload);
});
});

10
packages/backend/src/routes/api/v1/saml-auth-providers.ee.js Normal file
View File

@@ -0,0 +1,10 @@
import { Router } from 'express';
import asyncHandler from 'express-async-handler';
import { checkIsEnterprise } from '../../../helpers/check-is-enterprise.js';
import getSamlAuthProvidersAction from '../../../controllers/api/v1/saml-auth-providers/get-saml-auth-providers.ee.js';
const router = Router();
router.get('/', checkIsEnterprise, asyncHandler(getSamlAuthProvidersAction));
export default router;

6
packages/backend/src/routes/index.js
View File

@@ -13,7 +13,8 @@ import stepsRouter from './api/v1/steps.js';
import appsRouter from './api/v1/apps.js';
import connectionsRouter from './api/v1/connections.js';
import executionsRouter from './api/v1/executions.js';
import samlAuthProvidersRouter from './api/v1/admin/saml-auth-providers.ee.js';
import samlAuthProvidersRouter from './api/v1/saml-auth-providers.ee.js';
import adminSamlAuthProvidersRouter 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';
import adminUsersRouter from './api/v1/admin/users.ee.js';
@@ -35,7 +36,8 @@ router.use('/api/v1/steps', stepsRouter);
router.use('/api/v1/apps', appsRouter);
router.use('/api/v1/connections', connectionsRouter);
router.use('/api/v1/executions', executionsRouter);
router.use('/api/v1/admin/saml-auth-providers', samlAuthProvidersRouter);
router.use('/api/v1/saml-auth-providers', samlAuthProvidersRouter);
router.use('/api/v1/admin/saml-auth-providers', adminSamlAuthProvidersRouter);
router.use('/api/v1/admin/roles', rolesRouter);
router.use('/api/v1/admin/permissions', permissionsRouter);
router.use('/api/v1/admin/users', adminUsersRouter);

18
packages/backend/src/serializers/admin-saml-auth-provider.ee.js Normal file
View File

@@ -0,0 +1,18 @@
const adminSamlAuthProviderSerializer = (samlAuthProvider) => {
return {
id: samlAuthProvider.id,
name: samlAuthProvider.name,
certificate: samlAuthProvider.certificate,
signatureAlgorithm: samlAuthProvider.signatureAlgorithm,
issuer: samlAuthProvider.issuer,
entryPoint: samlAuthProvider.entryPoint,
firstnameAttributeName: samlAuthProvider.firstnameAttributeName,
surnameAttributeName: samlAuthProvider.surnameAttributeName,
emailAttributeName: samlAuthProvider.emailAttributeName,
roleAttributeName: samlAuthProvider.roleAttributeName,
active: samlAuthProvider.active,
defaultRoleId: samlAuthProvider.defaultRoleId,
};
};
export default adminSamlAuthProviderSerializer;

32
packages/backend/src/serializers/admin-saml-auth-provider.ee.test.js Normal file
View File

@@ -0,0 +1,32 @@
import { describe, it, expect, beforeEach } from 'vitest';
import { createSamlAuthProvider } from '../../test/factories/saml-auth-provider.ee.js';
import adminSamlAuthProviderSerializer from './admin-saml-auth-provider.ee.js';
describe('adminSamlAuthProviderSerializer', () => {
let samlAuthProvider;
beforeEach(async () => {
samlAuthProvider = await createSamlAuthProvider();
});
it('should return saml auth provider data', async () => {
const expectedPayload = {
id: samlAuthProvider.id,
name: samlAuthProvider.name,
certificate: samlAuthProvider.certificate,
signatureAlgorithm: samlAuthProvider.signatureAlgorithm,
issuer: samlAuthProvider.issuer,
entryPoint: samlAuthProvider.entryPoint,
firstnameAttributeName: samlAuthProvider.firstnameAttributeName,
surnameAttributeName: samlAuthProvider.surnameAttributeName,
emailAttributeName: samlAuthProvider.emailAttributeName,
roleAttributeName: samlAuthProvider.roleAttributeName,
active: samlAuthProvider.active,
defaultRoleId: samlAuthProvider.defaultRoleId,
};
expect(adminSamlAuthProviderSerializer(samlAuthProvider)).toEqual(
expectedPayload
);
});
});

2
packages/backend/src/serializers/index.js
View File

@@ -1,6 +1,7 @@
import userSerializer from './user.js';
import roleSerializer from './role.js';
import permissionSerializer from './permission.js';
import adminSamlAuthProviderSerializer from './admin-saml-auth-provider.ee.js';
import samlAuthProviderSerializer from './saml-auth-provider.ee.js';
import appAuthClientSerializer from './app-auth-client.js';
import appConfigSerializer from './app-config.js';
@@ -19,6 +20,7 @@ const serializers = {
User: userSerializer,
Role: roleSerializer,
Permission: permissionSerializer,
AdminSamlAuthProvider: adminSamlAuthProviderSerializer,
SamlAuthProvider: samlAuthProviderSerializer,
AppAuthClient: appAuthClientSerializer,
AppConfig: appConfigSerializer,

10
packages/backend/src/serializers/saml-auth-provider.ee.js
View File

@@ -2,16 +2,8 @@ const samlAuthProviderSerializer = (samlAuthProvider) => {
return {
id: samlAuthProvider.id,
name: samlAuthProvider.name,
certificate: samlAuthProvider.certificate,
signatureAlgorithm: samlAuthProvider.signatureAlgorithm,
loginUrl: samlAuthProvider.loginUrl,
issuer: samlAuthProvider.issuer,
entryPoint: samlAuthProvider.entryPoint,
firstnameAttributeName: samlAuthProvider.firstnameAttributeName,
surnameAttributeName: samlAuthProvider.surnameAttributeName,
emailAttributeName: samlAuthProvider.emailAttributeName,
roleAttributeName: samlAuthProvider.roleAttributeName,
active: samlAuthProvider.active,
defaultRoleId: samlAuthProvider.defaultRoleId,
};
};

10
packages/backend/src/serializers/saml-auth-provider.ee.test.js
View File

@@ -13,16 +13,8 @@ describe('samlAuthProviderSerializer', () => {
const expectedPayload = {
id: samlAuthProvider.id,
name: samlAuthProvider.name,
certificate: samlAuthProvider.certificate,
signatureAlgorithm: samlAuthProvider.signatureAlgorithm,
loginUrl: samlAuthProvider.loginUrl,
issuer: samlAuthProvider.issuer,
entryPoint: samlAuthProvider.entryPoint,
firstnameAttributeName: samlAuthProvider.firstnameAttributeName,
surnameAttributeName: samlAuthProvider.surnameAttributeName,
emailAttributeName: samlAuthProvider.emailAttributeName,
roleAttributeName: samlAuthProvider.roleAttributeName,
active: samlAuthProvider.active,
defaultRoleId: samlAuthProvider.defaultRoleId,
};
expect(samlAuthProviderSerializer(samlAuthProvider)).toEqual(

23
packages/backend/test/mocks/rest/api/v1/saml-auth-providers/get-saml-auth-providers.js Normal file
View File

@@ -0,0 +1,23 @@
const getSamlAuthProvidersMock = async (samlAuthProviders) => {
const data = samlAuthProviders.map((samlAuthProvider) => {
return {
id: samlAuthProvider.id,
name: samlAuthProvider.name,
loginUrl: samlAuthProvider.loginUrl,
issuer: samlAuthProvider.issuer,
};
});
return {
data: data,
meta: {
count: data.length,
currentPage: null,
isArray: true,
totalPages: null,
type: 'SamlAuthProvider',
},
};
};
export default getSamlAuthProvidersMock;