feat: Add boolean option for payload filter (#593)

* Add boolean filter for payload (no tests)

* Add tests

* Update changelog

* Remove boolean filter option from validator and allow it only on filters.

Co-authored-by: Brian Bugh <[email protected]>

Author: hemeroc

__tests__/unit/filters/options_processor/options/boolean.test.js

@@ -0,0 +1,44 @@
+const BooleanMatch = require('../../../../../lib/filters/options_processor/options/boolean')
+
+const filterContext = undefined
+
+const filter = {
+  name: 'payload',
+  supportedOptions: [
+    'boolean',
+    'must_exclude',
+    'must_include']
+}
+
+const verify = (match, input, result) => {
+  const rule = { boolean: { match } }
+  const res = BooleanMatch.process(filterContext, filter, input, rule)
+  expect(res.status).toBe(result)
+  return res
+}
+
+test('return pass if input is a string that meets the criteria', () => {
+  verify(true, 'true', 'pass')
+  verify(false, 'false', 'pass')
+})
+
+test('return pass if input is a boolean that meets the criteria', () => {
+  verify(true, true, 'pass')
+  verify(false, false, 'pass')
+})
+
+test('return fail if input does not meet the criteria', () => {
+  verify(true, false, 'fail')
+  verify(false, 'true', 'fail')
+})
+
+test('return error if inputs are not in expected format', async () => {
+  const rule = { boolean: { match: true } }
+  const input = ['true']
+  try {
+    const config = BooleanMatch.process(filterContext, filter, input, rule)
+    expect(config).toBeUndefined()
+  } catch (e) {
+    expect(e.message).toBe('Input type invalid, expected strings "true" or "false", or boolean literal `true` or `false` as input')
+  }
+})

__tests__/unit/filters/payload.test.js

@@ -247,3 +247,37 @@ test('that proper errors are returned if a key is required but not provided in m
   const filter = await payload.processFilter(context, settings)
   expect(filter.status).toBe('error')
 })
+
+test('that boolean checks succeed', async () => {
+  const payload = new Payload()
+
+  const settings = {
+    do: 'payload',
+    pull_request: {
+      draft: {
+        boolean: {
+          match: true
+        }
+      }
+    }
+  }
+
+  const context = {
+    payload: {
+      repository: {
+        full_name: 'test-repo'
+      },
+      pull_request: {
+        draft: true
+      }
+    }
+  }
+
+  let filter = await payload.processFilter(context, settings)
+  expect(filter.status).toBe('pass')
+
+  context.payload.pull_request.draft = false
+
+  filter = await payload.processFilter(context, settings)
+  expect(filter.status).toBe('fail')
+})

docs/changelog.rst

@@ -1,5 +1,6 @@
 CHANGELOG
 =====================================
+| 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>`_
 | September 20, 2021 : fix: Check that getRouter is defined before attempting to access it `#587 <https://github.com/mergeability/mergeable/pull/587>`_

docs/configuration.rst

@@ -138,6 +138,7 @@ These Options are used with validators.
 Options List
 
 .. toctree::
+    options/boolean.rst
     options/begins_with.rst
     options/ends_with.rst
     options/jira.rst

docs/filters/payload.rst

@@ -1,7 +1,7 @@
 Payload
 ^^^^^^^^^^^^^^
 
-Check against any available fields within the payload, each event can have different field, please refer to `github API documentation for <https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads>`_ for available fields.
+Check against any available fields within the payload, each event can have different field, please refer to `github API documentation<https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads>`_ for available fields.
 
 An example to check if a pull_request_review event has `state` of `changes_requested`
 
@@ -13,6 +13,15 @@ An example to check if a pull_request_review event has `state` of `changes_reque
             must_include:
               regex: 'changes_requested'
 
+To check if a `pull_request` event is not a `draft`
+
+::
+
+      - do: payload
+        pull_request:
+          draft:
+            boolean:
+              match: false
 
 An example to check if a pull_request event has a `label` named `foo`
 
@@ -30,6 +39,8 @@ Each field must be checked using one of the following options
 
 ::
 
+      boolean:
+        match: true/false
       must_include:
         regex: 'This text must be included'
         regex_flag: 'none' # Optional. Specify the flag for Regex. default is 'i', to disable default use 'none'

docs/options/boolean.rst

@@ -0,0 +1,48 @@
+Boolean
+^^^^^^^
+
+``boolean`` can be used to validate if the input is exactly `true` or `false`. This does not pass truthy values.
+
+For example, if the `pull_request.draft` value is `false`:
+
+::
+
+    {
+      "action": "opened",
+      "number": 2,
+      "pull_request": {
+        "draft": false
+
+This will pass validation, because the value of `draft` exactly matches `false`:
+
+::
+
+    - do: payload
+      pull_request:
+        draft:
+          boolean:
+            match: false
+            message: 'Custom message...' # this is optional, a default message is used when not specified.
+
+
+.. list-table:: Supported Params
+   :widths: 25 50 25 25
+   :header-rows: 1
+
+   * - Param
+     - Description
+     - Required
+     - Default Message
+   * - match
+     - Bool value to check for
+     - Yes
+     -
+   * - message
+     - Message to show if the validation fails
+     - No
+     - The [INPUT NAME] must be [match]
+
+Supported Filters:
+::
+
+    'payload'

docs/recipes.rst

@@ -200,3 +200,29 @@ Add 2 checks to the PR
                   - do: title
                     begins_with:
                       match: [ 'some prefix' ]
+
+
+Only run rules if PR is not a draft
+"""""""""""""""""""""""
+Checks that the PR's draft state is false before running actions.
+
+::
+
+    version: 2
+    mergeable:
+      - when: pull_request.*, pull_request_review.*
+        name: 'Draft check'
+        validate:
+          - do: payload
+            pull_request:
+              draft:
+                boolean:
+                  match: false
+        pass:
+          - do: comment
+            payload:
+              body: This PR is NOT a draft!
+        fail:
+          - do: comment
+            payload:
+              body: This PR is STILL a draft!

lib/filters/options_processor/options/boolean.js

@@ -0,0 +1,30 @@
+const MATCH_NOT_FOUND_ERROR = 'Failed to run the test because \'match\' is not provided for \'boolean\' option. Please check README for more information about configuration'
+const UNKNOWN_INPUT_TYPE_ERROR = 'Input type invalid, expected strings "true" or "false", or boolean literal `true` or `false` as input'
+
+class BooleanMatch {
+  static process (context, filter, input, rule) {
+    const match = rule.boolean.match
+
+    if (match == null) {
+      throw new Error(MATCH_NOT_FOUND_ERROR)
+    }
+
+    if (input !== 'true' && input !== 'false' && typeof input !== 'boolean') {
+      throw new Error(UNKNOWN_INPUT_TYPE_ERROR)
+    }
+
+    let description = rule.boolean.message
+    if (!description) description = `The ${filter.name} must be ${match}`
+
+    const DEFAULT_SUCCESS_MESSAGE = `The ${filter.name} is ${match}`
+
+    const isMergeable = input.toString() === match.toString()
+
+    return {
+      status: isMergeable ? 'pass' : 'fail',
+      description: isMergeable ? DEFAULT_SUCCESS_MESSAGE : description
+    }
+  }
+}
+
+module.exports = BooleanMatch

lib/filters/payload.js

@@ -4,7 +4,7 @@ const constructError = require('./options_processor/options/lib/constructError')
 const _ = require('lodash')
 const { forEach } = require('p-iteration')
 
-const options = ['must_include', 'must_exclude']
+const options = ['boolean', 'must_include', 'must_exclude']
 
 async function recursveThruFields (filterObj, currentPath, output, payload, field) {
   await forEach(Object.keys(field), async key => {