fix: scenario for modified|added mergeable config and pull_request_review (mergeability#140)

* fix: scenario for modified|added mergeable config and pull_request_review events to also pull from PR modified files.

* chore: upgrade circle to 2

* chore: do not update npm to latest because there is a bug. see npm/npm#16807 (comment)

Author: jusx

.circleci/config.yml

@@ -0,0 +1,33 @@
+version: 2 # use CircleCI 2.0
+jobs: # a collection of steps
+  build: # runs not using Workflows must have a `build` job as entry point
+    docker: # run the steps with Docker
+      - image: circleci/node:8.8.1 # ...with this image as the primary container; this is where all `steps` will run
+    steps: # a collection of executable commands
+      - checkout # special step to check out source code to working directory
+      # - run:
+      #     name: update-npm
+      #     command: 'sudo npm install -g npm@latest'
+      - restore_cache: # special step to restore the dependency cache
+          # Read about caching dependencies: https://circleci.com/docs/2.0/caching/
+          key: dependency-cache-{{ checksum "package.json" }}
+      - run:
+          name: install-npm
+          command: npm install
+      - save_cache: # special step to save the dependency cache
+          key: dependency-cache-{{ checksum "package.json" }}
+          paths:
+            - ./node_modules
+      - run: # run tests
+          name: test
+          command: npm test
+      - store_artifacts: # special step to save test results as as artifact
+          # Upload test summary for display in Artifacts: https://circleci.com/docs/2.0/artifacts/
+          path: test-results.xml
+          prefix: tests
+      - store_artifacts: # for display in Artifacts: https://circleci.com/docs/2.0/artifacts/
+          path: coverage
+          prefix: coverage
+      - store_test_results: # for display in Test Summary: https://circleci.com/docs/2.0/collect-test-data/
+          path: test-results.xml
+      # See https://circleci.com/docs/2.0/deployment-integrations/ for deploy examples

__tests__/configuration/configuration.test.js

@@ -24,7 +24,7 @@ describe('config file fetching', () => {
     expect(content).toBe(configString)
   })
 
-  test('fetch from main branch if the event is pull_request and file is not modified', async () => {
+  test('fetch from main branch if the event is PR relevant and file is not modified or added', async () => {
     let configString = `
           mergeable:
             issues:
@@ -43,14 +43,24 @@ describe('config file fetching', () => {
                 days: 20
                 message: Issue test
         `
-    let context = createMockGhConfig(configString, prConfig, { files: ['someFile'] })
+    let context = createMockGhConfig(
+      configString,
+      prConfig,
+      { files: [ { filename: 'someFile', status: 'modified' } ] }
+    )
+
     context.event = 'pull_request'
     let file = await Configuration.fetchConfigFile(context)
-    const content = Buffer.from(file.data.content, 'base64').toString()
+    let content = Buffer.from(file.data.content, 'base64').toString()
+    expect(content).toBe(configString)
+
+    context.event = 'pull_request_review'
+    file = await Configuration.fetchConfigFile(context)
+    content = Buffer.from(file.data.content, 'base64').toString()
     expect(content).toBe(configString)
   })
 
-  test('fetch from head branch if the event is pull_request and file is modified', async () => {
+  test('fetch from head branch if the event is relevant to PR and file is modified or added', async () => {
     let configString = `
           mergeable:
             issues:
@@ -60,19 +70,35 @@ describe('config file fetching', () => {
             pull_requests:
               stale:
                 days: 20
-                message: PR test
+                message: from HEAD
         `
     let prConfig = `
           mergeable:
             issues:
               stale:
                 days: 20
-                message: Issue test
+                message: From PR Config
         `
-    let context = createMockGhConfig(configString, prConfig, { files: ['.github/mergeable.yml'] })
+    let files = {files: [
+      { filename: '.github/mergeable.yml', status: 'modified' }
+    ]}
+    let context = createMockGhConfig(configString, prConfig, files)
     context.event = 'pull_request'
     let file = await Configuration.fetchConfigFile(context)
-    const content = Buffer.from(file.data.content, 'base64').toString()
+    let content = Buffer.from(file.data.content, 'base64').toString()
+    expect(content).toBe(prConfig)
+
+    context.event = 'pull_request_review'
+    file = await Configuration.fetchConfigFile(context)
+    content = Buffer.from(file.data.content, 'base64').toString()
+    expect(content).toBe(prConfig)
+
+    files = {files: [
+      { file: '.github/mergeable.yml', status: 'added' }
+    ]}
+    context = createMockGhConfig(configString, prConfig, files)
+    context.event = 'pull_request'
+    content = Buffer.from(file.data.content, 'base64').toString()
     expect(content).toBe(prConfig)
   })
 })
@@ -340,7 +366,7 @@ const createMockGhConfig = (json, prConfig, options) => {
       },
       pullRequests: {
         getFiles: () => {
-          return { data: options.files && options.files.map(file => ({filename: file, status: 'modified'})) }
+          return { data: options.files }
         }
       }
     }

circle.yml

@@ -111,10 +111,12 @@ class Configuration {
     let github = context.github
     let repo = context.repo()
 
-    if (context.event === 'pull_request') {
+    if (['pull_request', 'pull_request_review'].includes(context.event)) {
       // get modified file list
-      let result = await context.github.pullRequests.getFiles(context.repo({number: context.payload[context.event].number}))
-      let modifiedFiles = result.data.filter(file => file.status === 'modified').map(file => file.filename)
+      let result = await context.github.pullRequests.getFiles(context.repo({number: context.payload.pull_request.number}))
+      let modifiedFiles = result.data
+        .filter(file => ['modified', 'added'].includes(file.status))
+        .map(file => file.filename)
 
       // check if config file is in that list
       if (modifiedFiles.includes(Configuration.FILE_NAME)) {