feat: Filter specific status of files in changeset (#564)

* Add filtering by status of files in changeset

* Fix test

* Complete docs and fix style issue

Author: gorosgobe

__tests__/unit/validators/changeset.test.js

@@ -71,6 +71,45 @@ test('that it validates ends_with correctly', async () => {
   expect(validation.status).toBe('pass')
 })
 
+test('correct files are considered based on file status setting', async () => {
+  const changeset = new Changeset()
+  const settings = {
+    do: 'changeset',
+    files: {
+      added: true,
+      modified: false
+    },
+    must_include: {
+      regex: 'added-file.js'
+    },
+    must_exclude: {
+      regex: '(modified-file.py)|(deleted-file.ts)'
+    }
+  }
+
+  const validation = await changeset.processValidate(createMockContext([{
+    filename: 'added-file.js',
+    status: 'added',
+    additions: 1,
+    changes: 0,
+    deletions: 0
+  }, {
+    filename: 'modified-file.py',
+    status: 'modified',
+    additions: 0,
+    changes: 1,
+    deletions: 0
+  }, {
+    filename: 'deleted-file.ts',
+    status: 'deleted',
+    additions: 0,
+    changes: 0,
+    deletions: 1
+  }]), settings)
+
+  expect(validation.status).toBe('pass')
+})
+
 const createMockContext = (files) => {
   return Helper.mockContext({ files: files })
 }

docs/changelog.rst

@@ -1,6 +1,6 @@
 CHANGELOG
 =====================================
-
+| July 12, 2921 : feat: Filter specific status of files in changeset `#550 <https://github.com/mergeability/mergeable/issues/550>`_
 | June 26, 2021 : feat: Add `payload` filter `#398 <https://github.com/mergeability/mergeable/issues/398>`_
 | March 31, 2021 : feat: add chart support to prometheus servicemonitor `#535 <https://github.com/mergeability/mergeable/pull/535>`_
 | March 30, 2021 : fix: codeowners team

docs/validators/changeset.rst

@@ -25,6 +25,11 @@ Change set
       max:
          count: 2 # max number of files in a PR
          message: 'Custom message...'
+      files: # status of files to be included in changeset. If no 'files' option is provided, all files are included. 
+         added: true # default: false. If true, added files are included.
+         modified: false # default: false. If true, modified files are included.
+         deleted: true # default: false. If true, deleted files are included. 
+      # note that setting file status sub-options (added, modified, deleted) to false is optional.
       # all of the message sub-option is optional
 
 you can use ``and`` and ``or`` options to create more complex validations

lib/validators/changeset.js

@@ -37,13 +37,24 @@ class Changeset extends Validator {
       max: {
         count: 'number',
         message: 'string'
+      },
+      files: {
+        added: 'boolean',
+        modified: 'boolean',
+        deleted: 'boolean'
       }
     }
   }
 
   async validate (context, validationSettings) {
     // fetch the file list
-    const result = await this.githubAPI.listFiles(context, context.repo({ pull_number: this.getPayload(context).number }))
+    let result = await this.githubAPI.listFiles(context, context.repo({ pull_number: this.getPayload(context).number }))
+
+    if (validationSettings.files) {
+      const fileStatusOptions = Object.keys(validationSettings.files).filter(fileStatus => validationSettings.files[fileStatus])
+      result = result.filter(file => fileStatusOptions.includes(file.status))
+      delete validationSettings.files
+    }
 
     const changedFiles = result.map(file => file.filename)