feat: Add validator approval option to exclude users (#594)

* Add validator `approval` option to exclude users

* Add unit test

* Add feature to changelog

* Add exclude option to docs

Author: diegomarangoni

__tests__/unit/validators/approvals.test.js

@@ -115,6 +115,30 @@ test('mergeable is false if required member(s) has not approved', async () => {
   expect(validation.validations[0].description).toBe('approval: userC required')
 })
 
+test('mergeable is false if excluded member(s) has approved', async () => {
+  const approval = new Approval()
+  const reviewList = [
+    {
+      user: {
+        login: 'userA'
+      },
+      state: 'APPROVED'
+    }
+  ]
+  const settings = {
+    do: 'approval',
+    min: {
+      count: 1
+    },
+    exclude: {
+      users: ['userA']
+    }
+  }
+
+  const validation = await approval.processValidate(createMockContext(5, reviewList), settings)
+  expect(validation.validations[0].description).toBe('approval count is less than "1"')
+})
+
 test('mergeable passes if required user has approved', async () => {
   const approval = new Approval()
   const reviewList = [

docs/changelog.rst

@@ -1,5 +1,6 @@
 CHANGELOG
 =====================================
+| October 19, 2021 : feat: Add validator approval option to exclude users `#594 <https://github.com/mergeability/mergeable/pull/594>`_
 | October 12, 2021 : feat: Add boolean option for payload filter `#583 <https://github.com/mergeability/mergeable/pull/583>`_
 | September 27, 2021 : fix: use node version 14.17.6 for the release action `#591 <https://github.com/mergeability/mergeable/pull/591>`_
 | September 25, 2021 : feat: Support for objects in arrays in the payload filter `#589 <https://github.com/mergeability/mergeable/pull/589>`_

docs/validators/approval.rst

@@ -20,6 +20,8 @@ Approvals
         teams: ['org/team_slug'] # when the option is present, only the approvals from the team members will count
         users: ['user1', 'user2'] # when the option is present, approvals from users in this list will count
         owners: true # Optional boolean. When true, the file .github/CODEOWNER is read and only owners approval will count
+      exclude:
+        users: ['bot1', 'bot2'] # when the option is present, approvals from users in this list will NOT count
 
 
 .. note::

lib/validators/approvals.js

@@ -42,6 +42,9 @@ class Approvals extends Validator {
         teams: 'array',
         users: 'array',
         owners: 'boolean'
+      },
+      exclude: {
+        users: 'array'
       }
     }
   }
@@ -66,6 +69,12 @@ class Approvals extends Validator {
       delete validationSettings.limit
     }
 
+    let excludeOption = null
+    if (validationSettings.exclude) {
+      excludeOption = validationSettings.exclude
+      delete validationSettings.exclude
+    }
+
     const reviews = await this.githubAPI.listReviews(context, this.getPayload(context).number)
 
     const {
@@ -112,6 +121,10 @@ class Approvals extends Validator {
       }))
     }
 
+    if (excludeOption) {
+      if (excludeOption.users) approvedReviewers = _.without(approvedReviewers, ...excludeOption.users)
+    }
+
     const optionProcessed = await this.processOptions(validationSettings, approvedReviewers)
     output = [...output, ...optionProcessed]