Stale Notifications For Issues and Pulls (#57)

* update configuration to load defaults for pulls and issues stale settings.

* Unit tests updated for handler and added stale.

* update README with stale feature information.

Author: jusx

__fixtures__/helper.js

@@ -100,6 +100,14 @@ module.exports = {
       },
       status: 'completed'
     }
+  },
+
+  mockConfigWithContext: (context, configString) => {
+    context.github.repos.getContent = () => {
+      return Promise.resolve({ data: {
+        content: Buffer.from(configString).toString('base64') }
+      })
+    }
   }
 
 }

__tests__/configuration.test.js

@@ -10,7 +10,6 @@ test('that Configuration validates root node in yml', () => {
 })
 
 // write test to test for bad yml
-
 test('that constructor loads settings correctly', () => {
   let config = new Configuration(`
     mergeable:
@@ -33,6 +32,7 @@ test('that defaults load correctly when mergeable is null', () => {
   expect(mergeable.title).toBe(Configuration.DEFAULTS.title)
   expect(mergeable.label).toBe(Configuration.DEFAULTS.label)
   expect(mergeable.exclude).toBe(undefined)
+  expect(mergeable.stale).toBe(Configuration.DEFAULTS.stale)
 })
 
 test('that defaults load correctly when mergeable has partial properties defined', () => {
@@ -48,29 +48,12 @@ test('that defaults load correctly when mergeable has partial properties defined
 })
 
 test('that instanceWithContext returns the right Configuration', async () => {
-  let context = {
-    repo: jest.fn().mockReturnValue({
-      repo: '',
-      owner: ''
-    }),
-    payload: {
-      pull_request: {
-        number: 1
-      }
-    },
-    github: {
-      repos: {
-        getContent: jest.fn().mockReturnValue(
-          Promise.resolve({ data: { content: Buffer.from(`
-            mergeable:
-              approvals: 5
-              label: 'label regex'
-              title: 'title regex'
-          `).toString('base64') }})
-        )
-      }
-    }
-  }
+  let context = createMockGhConfig(`
+    mergeable:
+      approvals: 5
+      label: 'label regex'
+      title: 'title regex'
+  `)
 
   Configuration.instanceWithContext(context).then(config => {
     let mergeable = config.settings.mergeable
@@ -82,29 +65,12 @@ test('that instanceWithContext returns the right Configuration', async () => {
 })
 
 test('that instanceWithContext returns the right Configuration (pull_requrests)', async () => {
-  let context = {
-    repo: jest.fn().mockReturnValue({
-      repo: '',
-      owner: ''
-    }),
-    payload: {
-      pull_request: {
-        number: 1
-      }
-    },
-    github: {
-      repos: {
-        getContent: jest.fn().mockReturnValue(
-          Promise.resolve({ data: { content: Buffer.from(`
-            mergeable:
-              pull_requests:
-                label: 'label issue regex'
-                title: 'title issue regex'
-          `).toString('base64') }})
-        )
-      }
-    }
-  }
+  let context = createMockGhConfig(`
+    mergeable:
+      pull_requests:
+        label: 'label issue regex'
+        title: 'title issue regex'
+  `)
 
   await Configuration.instanceWithContext(context).then(config => {
     let mergeable = config.settings.mergeable
@@ -117,29 +83,12 @@ test('that instanceWithContext returns the right Configuration (pull_requrests)'
 })
 
 test('that instanceWithContext returns the right Configuration (issues)', async () => {
-  let context = {
-    repo: jest.fn().mockReturnValue({
-      repo: '',
-      owner: ''
-    }),
-    payload: {
-      pull_request: {
-        number: 1
-      }
-    },
-    github: {
-      repos: {
-        getContent: jest.fn().mockReturnValue(
-          Promise.resolve({ data: { content: Buffer.from(`
-            mergeable:
-              issues:
-                label: 'label issue regex'
-                title: 'title issue regex'
-          `).toString('base64') }})
-        )
-      }
-    }
-  }
+  let context = createMockGhConfig(`
+    mergeable:
+      issues:
+        label: 'label issue regex'
+        title: 'title issue regex'
+  `)
 
   await Configuration.instanceWithContext(context).then(config => {
     let mergeable = config.settings.mergeable
@@ -151,6 +100,58 @@ test('that instanceWithContext returns the right Configuration (issues)', async
   expect(context.github.repos.getContent.mock.calls.length).toBe(1)
 })
 
+test('that instanceWithContext loads the configuration for stale correctly when specified for pull_requests and issues separately', async () => {
+  let context = createMockGhConfig(`
+    mergeable:
+      pull_requests:
+        label: 'label issue regex'
+        title: 'title issue regex'
+        stale:
+          days: 20
+  `)
+
+  await Configuration.instanceWithContext(context).then(config => {
+    let mergeable = config.settings.mergeable
+    expect(mergeable.pull_requests.stale !== undefined).toBe(true)
+    expect(mergeable.pull_requests.stale.days).toBe(20)
+    expect(mergeable.pull_requests.stale.message).toBe(Configuration.DEFAULTS.stale.message)
+  })
+
+  context = createMockGhConfig(`
+    mergeable:
+      issues:
+        stale:
+          days: 20
+  `)
+
+  await Configuration.instanceWithContext(context).then(config => {
+    let mergeable = config.settings.mergeable
+    expect(mergeable.issues.stale !== undefined).toBe(true)
+    expect(mergeable.issues.stale.days).toBe(20)
+    expect(mergeable.issues.stale.message).toBe(Configuration.DEFAULTS.stale.message)
+  })
+
+  context = createMockGhConfig(`
+    mergeable:
+      issues:
+        stale:
+          days: 20
+          message: Issue test
+      pull_requests:
+        stale:
+          days: 20
+          message: PR test
+  `)
+
+  await Configuration.instanceWithContext(context).then(config => {
+    let mergeable = config.settings.mergeable
+    expect(mergeable.issues.stale !== undefined).toBe(true)
+    expect(mergeable.issues.stale.days).toBe(20)
+    expect(mergeable.issues.stale.message).toBe('Issue test')
+    expect(mergeable.pull_requests.stale.message).toBe('PR test')
+  })
+})
+
 test('that instanceWithContext still returns the Configuration when repo does not content mergeable.yml', async () => {
   let context = {
     repo: () => {
@@ -187,6 +188,30 @@ test('that instanceWithContext still returns the Configuration when repo does no
   expect(context.github.repos.getContent.mock.calls.length).toBe(1)
 })
 
+// helper method to return mocked configiration.
+const createMockGhConfig = (json) => {
+  return {
+    repo: jest.fn().mockReturnValue({
+      repo: '',
+      owner: ''
+    }),
+    payload: {
+      pull_request: {
+        number: 1
+      }
+    },
+    github: {
+      repos: {
+        getContent: jest.fn().mockReturnValue(
+          Promise.resolve({
+            data: { content: Buffer.from(json).toString('base64') }
+          })
+        )
+      }
+    }
+  }
+}
+
 // to mimic HttpError (https://github.com/octokit/rest.js/blob/fc8960ccf3415b5d77e50372d3bb873cfec80c55/lib/request/http-error.js)
 class HttpError extends Error {
   constructor (message, code, status) {

__tests__/handler.test.js

@@ -3,6 +3,54 @@ const Handler = require('../lib/handler')
 const Configuration = require('../lib/configuration')
 Configuration.DEFAULTS.approvals = 0
 
+test('handleStale calls search.issues only when settings exists for days', async () => {
+  // setup context with no added configuration.
+  let context = mockContext('title')
+  const expectMockCalls = async (config, expected) => {
+    mockConfigWithContext(context, config)
+    await Handler.handleStale(context)
+    expect(context.github.search.issues.mock.calls.length).toBe(expected)
+    context.github.search.issues.mockClear()
+  }
+
+  context.github.search = {
+    issues: jest.fn().mockReturnValue({
+      data: { items: [] }
+    })
+  }
+
+  await Handler.handleStale(context)
+  expect(context.github.search.issues.mock.calls.length).toBe(0)
+  context.github.search.issues.mockClear()
+
+  // setup context with PR configuration.
+  await expectMockCalls(`
+    mergeable:
+      pull_requests:
+        stale:
+          days: 10
+  `, 1)
+
+  // setup context with issues configuration.
+  await expectMockCalls(`
+    mergeable:
+      issues:
+        stale:
+          days: 10
+  `, 1)
+
+  // setup context with both issues and pr configuration.
+  await expectMockCalls(`
+    mergeable:
+      issues:
+        stale:
+          days: 10
+      pull_requests:
+        stale:
+          days: 10
+  `, 2)
+})
+
 test('handlePullRequest when it is mergeable', async () => {
   let context = mockContext('title')
   await expectSuccessStatus(context)
@@ -32,26 +80,24 @@ test('one exclude configuration will exclude the validation', async () => {
   let context = Helper.mockContext({ title: 'wip', body: 'body' })
   context.repo = mockRepo()
 
-  context.github.repos.getContent = () => {
-    return Promise.resolve({ data: { content: Buffer.from(`
-      mergeable:
-        approvals: 0
-        exclude: 'title'
-    `).toString('base64') }})
-  }
+  mockConfigWithContext(context, `
+    mergeable:
+      approvals: 0
+      exclude: 'title'
+  `)
+
   await expectSuccessStatus(context)
 })
 
 test('more than one exclude configuration will exclude the validation', async () => {
   let context = Helper.mockContext({ title: 'wip', label: ['proof of concept'], body: 'body' })
   context.repo = mockRepo()
 
-  context.github.repos.getContent = () => {
-    return Promise.resolve({ data: { content: Buffer.from(`
-      mergeable:
-        exclude: 'approvals, title, label'
-    `).toString('base64') }})
-  }
+  mockConfigWithContext(context, `
+    mergeable:
+      exclude: 'approvals, title, label'
+  `)
+
   await expectSuccessStatus(context)
 })
 
@@ -66,6 +112,14 @@ const expectSuccessStatus = async (context) => {
     })
 }
 
+const mockConfigWithContext = (context, configString) => {
+  context.github.repos.getContent = () => {
+    return Promise.resolve({ data: {
+      content: Buffer.from(configString).toString('base64') }
+    })
+  }
+}
+
 const mockContext = (title) => {
   let context = Helper.mockContext({ title: title, body: 'body' })
   context.repo = mockRepo()

__tests__/projects.test.js

@@ -33,15 +33,15 @@ const createMockPR = ({description, number}) => {
 
 const createMockContext = (data) => {
   const repoProjects = [
-      {name: 'Project One', id: 1},
-      {name: 'Porject Two', id: 2}
+    {name: 'Project One', id: 1},
+    {name: 'Porject Two', id: 2}
   ]
   const projectColumns = [
-      {id: 1}
+    {id: 1}
   ]
   const projectCards = [
-      {content_url: 'testRepo/issues/1'},
-      {content_url: 'testRepo/issues/2'}
+    {content_url: 'testRepo/issues/1'},
+    {content_url: 'testRepo/issues/2'}
   ]
 
   return Helper.mockContext({repoProjects: repoProjects, projectColumns: projectColumns, projectCards: projectCards})