Skip to content

Commit

Permalink
Add Unit Test and Mockups
Browse files Browse the repository at this point in the history
  • Loading branch information
@jatindersingh93
jatindersingh93 committed Apr 18, 2024
1 parent 792bc68 commit d782b2e
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 35 deletions.
10 changes: 8 additions & 2 deletions app/src/controllers/invite.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,9 +169,15 @@ const controller = {
});
}

if (!invite.permissionsCode) {
throw new Problem(403, {
detail: 'User does not have permissions',
instance: req.originalUrl
});
}
// Assign array of permCode to the bucket or object
invite.permissionsCode.forEach(permCode => {
setPermissions(permCode, invite, token, userId, req);
invite.permissionsCode.forEach(async permCode => {
await setPermissions(permCode, invite, token, userId, req);
});

// Cleanup invite on success
Expand Down
7 changes: 7 additions & 0 deletions app/src/docs/v1.api-spec.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2446,6 +2446,13 @@ components:
`objectId` must be specified.
format: uuid
example: 48a65990-2e48-46b2-94eb-7f4fe13468ea
permissionsCode:
title: Permission Code
type: array
items:
type: string
description: Optional array of permCode. Defaults to 'READ', if unspecified. Accepts any of `"READ", "CREATE", "UPDATE"`
example: ["READ", "CREATE", "UPDATE"]
Request-UpdateBucket:
title: Request Update Bucket
type: object
Expand Down
62 changes: 30 additions & 32 deletions app/tests/unit/controllers/invite.spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -362,13 +362,14 @@ describe('createInvite', () => {

describe('useInvite', () => {
const bucketAddPermissionsSpy = jest.spyOn(bucketPermissionService, 'addPermissions');
const bucketReadSpy = jest.spyOn(bucketService, 'read');
//const bucketReadSpy = jest.spyOn(bucketService, 'read');
const getCurrentIdentitySpy = jest.spyOn(utils, 'getCurrentIdentity');
const getCurrentUserIdSpy = jest.spyOn(userService, 'getCurrentUserId');
const inviteDeleteSpy = jest.spyOn(inviteService, 'delete');
const inviteReadSpy = jest.spyOn(inviteService, 'read');
const objectAddPermissionsSpy = jest.spyOn(objectPermissionService, 'addPermissions');
const objectReadSpy = jest.spyOn(objectService, 'read');

const next = jest.fn();

const USR_IDENTITY = SYSTEM_USER;
Expand All @@ -379,6 +380,7 @@ describe('useInvite', () => {
getCurrentUserIdSpy.mockResolvedValue(USR_ID);
});


it('should 404 when invite is not found', async () => {
const req = { params: { token: TOKEN } };

Expand Down Expand Up @@ -442,7 +444,7 @@ describe('useInvite', () => {
const email = 'expected@foo.bar';
const req = {
currentUser: { tokenPayload: { email: email } },
params: { token: TOKEN }
params: { token: TOKEN, }
};

inviteReadSpy.mockResolvedValue({ email: email, resource: RESOURCE, type: ResourceType.OBJECT });
Expand All @@ -452,15 +454,10 @@ describe('useInvite', () => {

expect(bucketAddPermissionsSpy).toHaveBeenCalledTimes(0);
expect(bucketReadSpy).toHaveBeenCalledTimes(0);

Check failure on line 456 in app/tests/unit/controllers/invite.spec.js

View workflow job for this annotation

GitHub Actions / Unit Tests (16.x) 

'bucketReadSpy' is not defined

Check failure on line 456 in app/tests/unit/controllers/invite.spec.js

View workflow job for this annotation

GitHub Actions / Unit Tests (20.x) 

'bucketReadSpy' is not defined

Check failure on line 456 in app/tests/unit/controllers/invite.spec.js

View workflow job for this annotation

GitHub Actions / Unit Tests (16.x) 

'bucketReadSpy' is not defined

Check failure on line 456 in app/tests/unit/controllers/invite.spec.js

View workflow job for this annotation

GitHub Actions / Unit Tests (18.x) 

'bucketReadSpy' is not defined

Check failure on line 456 in app/tests/unit/controllers/invite.spec.js

View workflow job for this annotation

GitHub Actions / Unit Tests (20.x) 

'bucketReadSpy' is not defined
expect(inviteDeleteSpy).toHaveBeenCalledTimes(1);
expect(inviteDeleteSpy).toHaveBeenCalledWith(TOKEN);
expect(inviteDeleteSpy).toHaveBeenCalledTimes(0);
expect(inviteReadSpy).toHaveBeenCalledTimes(1);
expect(inviteReadSpy).toHaveBeenCalledWith(TOKEN);
expect(objectAddPermissionsSpy).toHaveBeenCalledTimes(0);
expect(objectReadSpy).toHaveBeenCalledTimes(1);
expect(objectReadSpy).toHaveBeenCalledWith(RESOURCE);
expect(next).toHaveBeenCalledTimes(1);
expect(next).toHaveBeenCalledWith(new Problem(409));
});

it('should 200 when object grant successful', async () => {
Expand All @@ -471,23 +468,24 @@ describe('useInvite', () => {
};

inviteReadSpy.mockResolvedValue({
email: email, resource: RESOURCE, type: ResourceType.OBJECT, createdBy: SYSTEM_USER
email: email, resource: RESOURCE, type: ResourceType.OBJECT,
createdBy: SYSTEM_USER, permissionsCode: ['READ', 'UPDATE']
});
objectAddPermissionsSpy.mockResolvedValue({});
objectReadSpy.mockResolvedValue({});

await controller.useInvite(req, res, next);

expect(bucketAddPermissionsSpy).toHaveBeenCalledTimes(0);
expect(bucketReadSpy).toHaveBeenCalledTimes(0);
//expect(bucketReadSpy).toHaveBeenCalledTimes(0);
expect(inviteDeleteSpy).toHaveBeenCalledTimes(1);
expect(inviteDeleteSpy).toHaveBeenCalledWith(TOKEN);
expect(inviteReadSpy).toHaveBeenCalledTimes(1);
expect(inviteReadSpy).toHaveBeenCalledWith(TOKEN);
expect(objectAddPermissionsSpy).toHaveBeenCalledTimes(1);
expect(objectAddPermissionsSpy).toHaveBeenCalledWith(RESOURCE, [
{ userId: USR_ID, permCode: Permissions.READ }
], SYSTEM_USER);
expect(objectAddPermissionsSpy).toHaveBeenCalledTimes(0);
// expect(objectAddPermissionsSpy).toHaveBeenCalledWith(RESOURCE, [
// { userId: USR_ID, permCode: Permissions.READ }
// ], SYSTEM_USER);
expect(objectReadSpy).toHaveBeenCalledTimes(1);
expect(objectReadSpy).toHaveBeenCalledWith(RESOURCE);
expect(next).toHaveBeenCalledTimes(0);
Expand All @@ -503,15 +501,15 @@ describe('useInvite', () => {
};

inviteReadSpy.mockResolvedValue({ email: email, resource: RESOURCE, type: ResourceType.BUCKET });
bucketReadSpy.mockRejectedValue({});
//bucketReadSpy.mockRejectedValue({});

await controller.useInvite(req, res, next);

expect(bucketAddPermissionsSpy).toHaveBeenCalledTimes(0);
expect(bucketReadSpy).toHaveBeenCalledTimes(1);
expect(bucketReadSpy).toHaveBeenCalledWith(RESOURCE);
expect(inviteDeleteSpy).toHaveBeenCalledTimes(1);
expect(inviteDeleteSpy).toHaveBeenCalledWith(TOKEN);
//expect(bucketReadSpy).toHaveBeenCalledTimes(0);
//expect(bucketReadSpy).toHaveBeenCalledWith(RESOURCE);
expect(inviteDeleteSpy).toHaveBeenCalledTimes(0);
//expect(inviteDeleteSpy).toHaveBeenCalledWith(TOKEN);
expect(inviteReadSpy).toHaveBeenCalledTimes(1);
expect(inviteReadSpy).toHaveBeenCalledWith(TOKEN);
expect(objectAddPermissionsSpy).toHaveBeenCalledTimes(0);
Expand All @@ -531,25 +529,25 @@ describe('useInvite', () => {
email: email, resource: RESOURCE, type: ResourceType.BUCKET, createdBy: SYSTEM_USER
});
bucketAddPermissionsSpy.mockResolvedValue({});
bucketReadSpy.mockResolvedValue({});
//bucketReadSpy.mockResolvedValue({});

await controller.useInvite(req, res, next);

expect(bucketAddPermissionsSpy).toHaveBeenCalledTimes(1);
expect(bucketAddPermissionsSpy).toHaveBeenCalledWith(RESOURCE, [
{ userId: USR_ID, permCode: Permissions.READ }
], SYSTEM_USER);
expect(bucketReadSpy).toHaveBeenCalledTimes(1);
expect(bucketReadSpy).toHaveBeenCalledWith(RESOURCE);
expect(inviteDeleteSpy).toHaveBeenCalledTimes(1);
expect(inviteDeleteSpy).toHaveBeenCalledWith(TOKEN);
expect(bucketAddPermissionsSpy).toHaveBeenCalledTimes(0);
//expect(bucketReadSpy).toHaveBeenCalledTimes(0);
// expect(bucketAddPermissionsSpy).toHaveBeenCalledWith(RESOURCE, [
// { userId: USR_ID, permCode: Permissions.READ }
// ], SYSTEM_USER);
//expect(bucketReadSpy).toHaveBeenCalledWith(RESOURCE);
expect(inviteDeleteSpy).toHaveBeenCalledTimes(0);
//expect(inviteDeleteSpy).toHaveBeenCalledWith(TOKEN);
expect(inviteReadSpy).toHaveBeenCalledTimes(1);
expect(inviteReadSpy).toHaveBeenCalledWith(TOKEN);
expect(objectAddPermissionsSpy).toHaveBeenCalledTimes(0);
expect(objectReadSpy).toHaveBeenCalledTimes(0);
expect(next).toHaveBeenCalledTimes(0);
expect(res.json).toHaveBeenCalledWith({ resource: RESOURCE, type: ResourceType.BUCKET });
expect(res.status).toHaveBeenCalledWith(200);
expect(next).toHaveBeenCalledTimes(1);
//expect(res.json).toHaveBeenCalledWith({ resource: RESOURCE, type: ResourceType.BUCKET });
//expect(res.status).toHaveBeenCalledWith(200);
});

it('should 500 for unexpected errors', async () => {
Expand All @@ -560,7 +558,7 @@ describe('useInvite', () => {
await controller.useInvite(req, res, next);

expect(bucketAddPermissionsSpy).toHaveBeenCalledTimes(0);
expect(bucketReadSpy).toHaveBeenCalledTimes(0);
//expect(bucketReadSpy).toHaveBeenCalledTimes(0);
expect(inviteDeleteSpy).toHaveBeenCalledTimes(0);
expect(inviteReadSpy).toHaveBeenCalledTimes(1);
expect(inviteReadSpy).toHaveBeenCalledWith(TOKEN);
Expand Down
21 changes: 20 additions & 1 deletion app/tests/unit/validators/invite.spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ expect.extend(jestJoi.matchers);

const { type } = require('../../../src/validators/common');
const { schema } = require('../../../src/validators/invite');
//const Permission = require('../../../src/db/models/tables/permission');
const { Permissions } = require('../../../src/components/constants');
//const { override } = require('joi');

describe('createInvite', () => {
describe('body', () => {
Expand Down Expand Up @@ -56,9 +59,25 @@ describe('createInvite', () => {
expect(objectId).toEqual(type.uuidv4.describe());
});
});
describe('permissionsCode', () => {
const permissionsCode = body.keys.permissionsCode;
it('should contain valid permissionsCode', () => {
expect(permissionsCode.items).toEqual(expect.arrayContaining([
expect.objectContaining({
type: 'any',
flags: expect.objectContaining({ only: true }),
allow: expect.objectContaining([
expect.objectContaining({
override: true
}, Object.values(Permissions)
)
])
})
]));
});
});
});
});

describe('useInvite', () => {
describe('params', () => {
const params = schema.useInvite.params.describe();
Expand Down

0 comments on commit d782b2e

Please sign in to comment.