test: coverage for checkUserPushPermission

Author: kriswest

src/proxy/processors/push-action/checkUserPushPermission.ts

@@ -11,17 +11,17 @@ const exec = async (req: any, action: Action): Promise<Action> => {
   // n.b. action.user will be set to whatever the user had set in their user.name config in their git client.
   // it is not necessarily the GitHub username. GitHub looks users by email address as should we
   const userEmail = action.userEmail;
-  let username = "unknown";
+  let username = 'unknown';
 
   // Find the user associated with this email address
   const list = await getUsers({ email: action.userEmail });
 
   if (list.length > 1) {
     console.warn(`Multiple users found with email address ${userEmail}, using the first only`);
-  } else if (list.length == 0){ 
+  } else if (list.length == 0) {
     console.error(`No user with email address ${userEmail} found`);
   } else {
-    username = list[0].username
+    username = list[0].username;
     isUserAllowed = await isUserPushAllowed(repoName, username);
   }
 
@@ -30,14 +30,16 @@ const exec = async (req: any, action: Action): Promise<Action> => {
   if (!isUserAllowed) {
     console.log('User not allowed to Push');
     step.error = true;
-    step.log(`User ${username} <${userEmail}> is not allowed to push on repo ${action.repo}, ending`);
+    step.log(
+      `User ${username} <${userEmail}> is not allowed to push on repo ${action.repo}, ending`,
+    );
 
     console.log('setting error');
 
     step.setError(
-      `Rejecting push as user ${action.user} ` +
-      `is not allowed to push on repo ` +
-      `${action.repo}`,
+      `Your push has been blocked (${action.userEmail} ` +
+        `is not allowed to push on repo ` +
+        `${action.repo})`,
     );
     action.addStep(step);
     return action;

test/testCheckUserPushPermission.test.js

@@ -0,0 +1,61 @@
+const chai = require('chai');
+const processor = require('../src/proxy/processors/push-action/checkUserPushPermission');
+const { Action } = require('../src/proxy/actions/Action');
+const { expect } = chai;
+const db = require('../src/db');
+chai.should();
+
+const TEST_ORG = 'finos';
+const TEST_REPO = 'test';
+const TEST_URL = 'https://github.com/finos/user-push-perms-test.git';
+const TEST_USERNAME_1 = 'push-perms-test';
+const TEST_EMAIL_1 = '[email protected]';
+const TEST_USERNAME_2 = 'push-perms-test-2';
+const TEST_EMAIL_2 = '[email protected]';
+const TEST_EMAIL_3 = '[email protected]';
+
+describe('CheckUserPushPermissions...', async () => {
+  before(async function () {
+    await db.deleteRepo(TEST_REPO);
+    await db.deleteUser(TEST_USERNAME_1);
+
+    await db.createRepo({
+      project: TEST_ORG,
+      name: TEST_REPO,
+      url: TEST_URL,
+    });
+    await db.createUser(TEST_USERNAME_1, 'abc', TEST_EMAIL_1, TEST_USERNAME_1, false);
+    await db.addUserCanPush(TEST_REPO, TEST_USERNAME_1);
+
+    await db.createUser(TEST_USERNAME_2, 'abc', TEST_EMAIL_2, TEST_USERNAME_2, false);
+  });
+
+  after(async function () {
+    await db.deleteRepo(TEST_REPO);
+    await db.deleteUser(TEST_USERNAME_1);
+    await db.deleteUser(TEST_USERNAME_2);
+  });
+
+  it('A committer that is approved should be allowed to push...', async () => {
+    const action = new Action('1', 'type', 'method', 1, TEST_ORG + '/' + TEST_REPO);
+    action.userEmail = TEST_EMAIL_1;
+    const { error } = await processor.exec(null, action);
+    expect(error).to.be.false;
+  });
+
+  it('A committer that is NOT approved should NOT be allowed to push...', async () => {
+    const action = new Action('1', 'type', 'method', 1, TEST_ORG + '/' + TEST_REPO);
+    action.userEmail = TEST_EMAIL_2;
+    const { error, errorMessage } = await processor.exec(null, action);
+    expect(error).to.be.true;
+    expect(errorMessage).to.contains('Your push has been blocked');
+  });
+
+  it('An unknown committer should NOT be allowed to push...', async () => {
+    const action = new Action('1', 'type', 'method', 1, TEST_ORG + '/' + TEST_REPO);
+    action.userEmail = TEST_EMAIL_3;
+    const { error, errorMessage } = await processor.exec(null, action);
+    expect(error).to.be.true;
+    expect(errorMessage).to.contains('Your push has been blocked');
+  });
+});