test: checkAuthorEmails action and fix bugs

Author: jescalada

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

@@ -5,24 +5,27 @@ import { Commit } from '../../actions/Action';
 const commitConfig = getCommitConfig();
 
 const isEmailAllowed = (email: string): boolean => {
+  if (!email) {
+    return false;
+  }
+
   const [emailLocal, emailDomain] = email.split('@');
-  console.log({ emailLocal, emailDomain });
 
-  // E-mail address is not a permissible domain name
+  if (!emailLocal || !emailDomain) {
+    return false;
+  }
+
   if (
     commitConfig.author.email.domain.allow &&
     !emailDomain.match(new RegExp(commitConfig.author.email.domain.allow, 'g'))
   ) {
-    console.log('Bad e-mail address domain...');
     return false;
   }
 
-  // E-mail username is not a permissible form
   if (
     commitConfig.author.email.local.block &&
     emailLocal.match(new RegExp(commitConfig.author.email.local.block, 'g'))
   ) {
-    console.log('Bad e-mail address username...');
     return false;
   }
 

test/processors/checkAuthorEmails.test.js

@@ -0,0 +1,167 @@
+const sinon = require('sinon');
+const proxyquire = require('proxyquire').noCallThru();
+const { expect } = require('chai');
+
+describe('checkAuthorEmails', () => {
+  let exec;
+  let Step;
+  let getCommitConfig;
+  let stepSpy;
+  let action;
+  let config;
+
+  beforeEach(() => {
+    Step = class {
+      constructor() {
+        this.error = undefined;
+      }
+      log() {}
+      setError() {}
+    };
+    stepSpy = sinon.spy(Step.prototype, 'log');
+    sinon.spy(Step.prototype, 'setError');
+
+    config = {
+      author: {
+        email: {
+          domain: { allow: null },
+          local: { block: null }
+        }
+      }
+    };
+    getCommitConfig = sinon.stub().returns(config);
+
+    action = {
+      commitData: [],
+      addStep: sinon.stub().callsFake(function(step) {
+        this.step = new Step();
+        Object.assign(this.step, step);
+        return this.step;
+      })
+    };
+
+    exec = proxyquire('../../src/proxy/processors/push-action/checkAuthorEmails', {
+      '../../../config': { getCommitConfig },
+      '../../actions': { Step }
+    }).exec;
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  it('should allow valid emails when no restrictions', async () => {
+    action.commitData = [
+      { authorEmail: '[email protected]' },
+      { authorEmail: '[email protected]' }
+    ];
+
+    await exec({}, action);
+
+    expect(action.step.error).to.be.undefined;
+  });
+
+  it('should block emails from forbidden domains', async () => {
+    config.author.email.domain.allow = 'example\\.com$';
+    action.commitData = [
+      { authorEmail: '[email protected]' },
+      { authorEmail: '[email protected]' }
+    ];
+
+    await exec({}, action);
+
+    expect(action.step.error).to.be.true;
+    expect(stepSpy.calledWith(
+      'The following commit author e-mails are illegal: [email protected]'
+    )).to.be.true;
+    expect(Step.prototype.setError.calledWith(
+      'Your push has been blocked. Please verify your Git configured e-mail address is valid (e.g. [email protected])'
+    )).to.be.true;
+  });
+
+  it('should block emails with forbidden usernames', async () => {
+    config.author.email.local.block = 'blocked';
+    action.commitData = [
+      { authorEmail: '[email protected]' },
+      { authorEmail: '[email protected]' }
+    ];
+
+    await exec({}, action);
+
+    expect(action.step.error).to.be.true;
+    expect(stepSpy.calledWith(
+      'The following commit author e-mails are illegal: [email protected]'
+    )).to.be.true;
+  });
+
+  it('should handle empty email strings', async () => {
+    action.commitData = [
+      { authorEmail: '' },
+      { authorEmail: '[email protected]' }
+    ];
+
+    await exec({}, action);
+
+    expect(action.step.error).to.be.true;
+    expect(stepSpy.calledWith(
+      'The following commit author e-mails are illegal: '
+    )).to.be.true;
+  });
+
+  it('should allow emails when both checks pass', async () => {
+    config.author.email.domain.allow = 'example\\.com$';
+    config.author.email.local.block = 'forbidden';
+    action.commitData = [
+      { authorEmail: '[email protected]' },
+      { authorEmail: '[email protected]' }
+    ];
+
+    await exec({}, action);
+
+    expect(action.step.error).to.be.undefined;
+  });
+
+  it('should block emails that fail both checks', async () => {
+    config.author.email.domain.allow = 'example\\.com$';
+    config.author.email.local.block = 'forbidden';
+    action.commitData = [
+      { authorEmail: '[email protected]' }
+    ];
+
+    await exec({}, action);
+
+    expect(action.step.error).to.be.true;
+    expect(stepSpy.calledWith(
+      'The following commit author e-mails are illegal: [email protected]'
+    )).to.be.true;
+  });
+
+  it('should handle emails without domain', async () => {
+    action.commitData = [
+      { authorEmail: 'nodomain@' }
+    ];
+
+    await exec({}, action);
+
+    expect(action.step.error).to.be.true;
+    expect(stepSpy.calledWith(
+      'The following commit author e-mails are illegal: nodomain@'
+    )).to.be.true;
+  });
+
+  it('should handle multiple illegal emails', async () => {
+    config.author.email.domain.allow = 'example\\.com$';
+    action.commitData = [
+      { authorEmail: '[email protected]' },
+      { authorEmail: '[email protected]' },
+      { authorEmail: '[email protected]' }
+    ];
+
+    await exec({}, action);
+
+    expect(action.step.error).to.be.true;
+    expect(stepSpy.calledWith(
+      'The following commit author e-mails are illegal: [email protected],[email protected]'
+    )).to.be.true;
+  });
+});