Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Expand credential sharing tests for User Management #3931

Merged
merged 5 commits into from
Aug 29, 2022
Merged

Expand credential sharing tests for User Management #3931

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
265113c
:test_tube: Expand cred sharing tests
ivov Aug 24, 2022
31df388
:twisted_rightwards_arrows: Merge parent branch
ivov Aug 24, 2022
b47b07c
:zap: Add recently added flags
ivov Aug 24, 2022
f163602
🔀 Merge branch 'user-management-p2' into user-management-p2-testing
BHesseldieck Aug 26, 2022
04b3cee
✅ fix and adjust tests for /credentials
BHesseldieck Aug 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 55 additions & 45 deletions packages/cli/test/integration/credentials.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import express from 'express';
import { UserSettings } from 'n8n-core';

import config from '../../config';
import { Db } from '../../src';
import { RESPONSE_ERROR_MESSAGES } from '../../src/constants';
import { randomCredentialPayload, randomName, randomString } from './shared/random';
Expand All @@ -9,6 +10,7 @@ import * as utils from './shared/utils';

import type { AuthAgent, SaveCredentialFunction } from './shared/types';
import type { Role } from '../../src/databases/entities/Role';
import type { CredentialsEntity } from '../../src/databases/entities/CredentialsEntity';

jest.mock('../../src/telemetry');

Expand Down Expand Up @@ -380,7 +382,9 @@ test('PATCH /credentials/:id should fail with missing encryption key', async ()
mock.mockRestore();
});

test.skip('GET /credentials should retrieve all creds for owner', async () => {
test('GET /credentials should return all creds for owner', async () => {
config.set('experimental.credentialsSharing', true);

const owner = await testDb.createUser({ globalRole: globalOwnerRole });
const firstMember = await testDb.createUser({ globalRole: globalMemberRole });
const secondMember = await testDb.createUser({ globalRole: globalMemberRole });
Expand All @@ -398,15 +402,18 @@ test.skip('GET /credentials should retrieve all creds for owner', async () => {

const [ownerCredential, memberCredential] = response.body.data;

expect(typeof ownerCredential.name).toBe('string');
expect(typeof ownerCredential.type).toBe('string');
expect(typeof ownerCredential.nodesAccess[0].nodeType).toBe('string');
expect(ownerCredential.encryptedData).toBeUndefined();
validateMainCredentialData(ownerCredential);
validateMainCredentialData(memberCredential);

expect(ownerCredential.ownedBy.id).toBe(owner.id);
expect(ownerCredential.ownedBy.email).toBe(owner.email);
expect(ownerCredential.ownedBy.firstName).toBe(owner.firstName);
expect(ownerCredential.ownedBy.lastName).toBe(owner.lastName);
expect(ownerCredential.ownedBy).toMatchObject({
id: owner.id,
email: owner.email,
firstName: owner.firstName,
lastName: owner.lastName,
});

expect(Array.isArray(ownerCredential.sharedWith)).toBe(true);
expect(ownerCredential.sharedWith.length).toBe(2);

const [firstSharee, secondSharee] = ownerCredential.sharedWith;

Expand All @@ -424,63 +431,59 @@ test.skip('GET /credentials should retrieve all creds for owner', async () => {
lastName: secondMember.lastName,
});

expect(typeof memberCredential.name).toBe('string');
expect(typeof memberCredential.type).toBe('string');
expect(typeof memberCredential.nodesAccess[0].nodeType).toBe('string');
expect(memberCredential.encryptedData).toBeUndefined();
expect(memberCredential.ownedBy).toMatchObject({
id: firstMember.id,
email: firstMember.email,
firstName: firstMember.firstName,
lastName: firstMember.lastName,
});

expect(memberCredential.ownedBy.id).toBe(firstMember.id);
expect(memberCredential.ownedBy.email).toBe(firstMember.email);
expect(memberCredential.ownedBy.firstName).toBe(firstMember.firstName);
expect(memberCredential.ownedBy.lastName).toBe(firstMember.lastName);
expect(Array.isArray(memberCredential.sharedWith)).toBe(true);
expect(memberCredential.sharedWith.length).toBe(0);

expect(memberCredential.sharedWith).toBeUndefined();
config.set('experimental.credentialsSharing', false);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tech debt: https://linear.app/n8n/issue/N8N-4396

});

// @TODO: Test for member request
test('GET /credentials should return only relevant creds for member', async () => {
config.set('experimental.credentialsSharing', true);

test.skip('GET /credentials should retrieve member creds for member', async () => {
const owner = await testDb.createUser({ globalRole: globalOwnerRole });
const member = await testDb.createUser({ globalRole: globalMemberRole });

await saveCredential(randomCredentialPayload(), { user: owner });
const { id } = await saveCredential(randomCredentialPayload(), { user: member });

for (let i = 0; i < 3; i++) {
await saveCredential(randomCredentialPayload(), { user: member });
}
await authAgent(member).post(`/credentials/${id}/share`).send({ shareeId: owner.id });

const response = await authAgent(member).get('/credentials');

expect(response.statusCode).toBe(200);
expect(response.body.data.length).toBe(3); // member retrieved only member creds
expect(response.body.data.length).toBe(1); // member retrieved only member cred

for (const memberCredential of response.body.data) {
expect(typeof memberCredential.name).toBe('string');
expect(typeof memberCredential.type).toBe('string');
expect(typeof memberCredential.nodesAccess[0].nodeType).toBe('string');
expect(memberCredential.encryptedData).toBeUndefined();
const [memberCredential] = response.body.data;

expect(memberCredential.ownedBy.id).toBe(member.id);
expect(memberCredential.ownedBy.email).toBe(member.email);
expect(memberCredential.ownedBy.firstName).toBe(member.firstName);
expect(memberCredential.ownedBy.lastName).toBe(member.lastName);
validateMainCredentialData(memberCredential);

expect(memberCredential.sharedWith).toBeUndefined();
}
});
expect(memberCredential.ownedBy).toMatchObject({
id: member.id,
email: member.email,
firstName: member.firstName,
lastName: member.lastName,
});

test('GET /credentials should not retrieve owner creds for member', async () => {
const owner = await testDb.createUser({ globalRole: globalOwnerRole });
const member = await testDb.createUser({ globalRole: globalMemberRole });
expect(Array.isArray(memberCredential.sharedWith)).toBe(true);
expect(memberCredential.sharedWith.length).toBe(1);

for (let i = 0; i < 3; i++) {
await saveCredential(randomCredentialPayload(), { user: owner });
}
const [sharee] = memberCredential.sharedWith;

const response = await authAgent(member).get('/credentials');
expect(sharee).toMatchObject({
id: owner.id,
email: owner.email,
firstName: owner.firstName,
lastName: owner.lastName,
});

expect(response.statusCode).toBe(200);
expect(response.body.data.length).toBe(0); // member did not retrieve owner's creds
config.set('experimental.credentialsSharing', false);
});

test('GET /credentials/:id should retrieve owned cred for owner', async () => {
Expand Down Expand Up @@ -593,3 +596,10 @@ const INVALID_PAYLOADS = [
{},
undefined,
];

function validateMainCredentialData(ownerCredential: CredentialsEntity) {
expect(typeof ownerCredential.name).toBe('string');
expect(typeof ownerCredential.type).toBe('string');
expect(typeof ownerCredential.nodesAccess[0].nodeType).toBe('string');
expect(ownerCredential.data).toBeUndefined();
}