@dino-dna/probot-stale/test/stale.test.js

A GitHub App built with Probot that closes abandoned Issues and Pull Requests after a period of inactivity.

/* eslint-disable camelcase */
process.env.LOG_LEVEL = 'fatal'

const { Application } = require('probot')
const Stale = require('../lib/stale')
const notFoundError = {
  code: 404,
  status: 'Not Found',
  headers: {}
}

describe('stale', () => {
  let app
  let github

  beforeEach(() => {
    app = new Application()

    const issueAction = jest.fn().mockImplementation(() => Promise.resolve(notFoundError))

    // Mock out the GitHub API
    github = {
      integrations: {
        getInstallations: jest.fn()
      },
      paginate: jest.fn(),
      issues: {
        removeLabel: issueAction,
        getLabel: jest.fn().mockImplementation(() => Promise.reject(notFoundError)),
        createLabel: issueAction,
        addLabels: issueAction,
        createComment: issueAction,
        edit: issueAction
      },
      search: {
        issues: issueAction
      }
    }

    // Mock out GitHub client
    app.auth = () => Promise.resolve(github)
  })

  test(
    'removes the stale label and ignores if it has already been removed',
    async () => {
      let stale = new Stale(github, { perform: true, owner: 'probot', repo: 'stale', logger: app.log })

      for (const type of ['pulls', 'issues']) {
        try {
          await stale.unmarkIssue(type, { number: 123 })
        } catch (_) {
          throw new Error('Should not have thrown an error')
        }
      }
    }
  )

  test('should limit the number of actions it takes each run', async () => {
    const staleLabel = 'stale'
    const limitPerRun = 30

    const issueCount = 40
    const staleCount = 3

    const issues = []
    for (let i = 1; i <= issueCount; i++) {
      const labels = (i <= staleCount) ? [{ name: staleLabel }] : []
      issues.push({ number: i, labels: labels })
    }

    const prs = []
    for (let i = 101; i <= 100 + issueCount; i++) {
      const labels = (i <= 100 + staleCount) ? [{ name: staleLabel }] : []
      prs.push({ number: i, labels: labels })
    }

    github.search.issuesAndPullRequests = ({ q, sort, order, per_page }) => {
      let items = []
      if (q.includes('is:pr')) {
        items = items.concat(prs.slice(0, per_page))
      } else if (q.includes('is:issue')) {
        items = items.concat(issues.slice(0, per_page))
      } else {
        throw new Error('query should specify PullRequests or Issues')
      }

      if (q.includes(`-label:"${staleLabel}"`)) {
        items = items.filter(item => !item.labels.map(label => label.name).includes(staleLabel))
      } else if (q.includes(`label:"${staleLabel}"`)) {
        items = items.filter(item => item.labels.map(label => label.name).includes(staleLabel))
      }

      expect(items.length).toBeLessThanOrEqual(per_page)

      return Promise.resolve({
        data: {
          items: items
        }
      })
    }

    for (const type of ['pulls', 'issues']) {
      let comments = 0
      let closed = 0
      let labeledStale = 0
      github.issues.createComment = jest.fn().mockImplementation(() => {
        comments++
        return Promise.resolve(notFoundError)
      })
      github.issues.edit = ({ owner, repo, number, state }) => {
        if (state === 'closed') {
          closed++
        }
      }
      github.issues.addLabels = ({ owner, repo, number, labels }) => {
        if (labels.includes(staleLabel)) {
          labeledStale++
        }
      }

      // Mock out GitHub client
      app.auth = () => Promise.resolve(github)

      const stale = new Stale(github, { perform: true, owner: 'probot', repo: 'stale', logger: app.log })
      stale.config.limitPerRun = limitPerRun
      stale.config.staleLabel = staleLabel
      stale.config.closeComment = 'closed'

      await stale.markAndSweep(type)

      expect(comments).toEqual(limitPerRun)
      expect(closed).toEqual(staleCount)
      expect(labeledStale).toEqual(limitPerRun - staleCount)
    }
  })

  test(
    'should not close issues if daysUntilClose is configured as false',
    async () => {
      let stale = new Stale(github, { perform: true, owner: 'probot', repo: 'stale', logger: app.log })
      stale.config.daysUntilClose = false
      stale.getStale = jest.fn().mockImplementation(() => Promise.resolve({ data: { items: [] } }))
      stale.getClosable = jest.fn()

      await stale.markAndSweep('issues')
      expect(stale.getClosable).not.toHaveBeenCalled()

      await stale.markAndSweep('pulls')
      expect(stale.getClosable).not.toHaveBeenCalled()
    }
  )

  test(
    'should not close issues if the keyword pulls or keyword issues is used, and daysUntilClose is configured as false',
    async () => {
      let stale = new Stale(github, { perform: true, owner: 'probot', repo: 'stale', logger: app.log })
      stale.config.pulls = { daysUntilClose: false }
      stale.config.issues = { daysUntilClose: false }
      stale.getStale = jest.fn().mockImplementation(() => Promise.resolve({ data: { items: [] } }))
      stale.getClosable = jest.fn()

      await stale.markAndSweep('issues')
      expect(stale.getClosable).not.toHaveBeenCalled()

      await stale.markAndSweep('pulls')
      expect(stale.getClosable).not.toHaveBeenCalled()
    }
  )

  test(
    'should not close issues if only keyword is configured with the pulls value',
    async () => {
      let stale = new Stale(github, { perform: true, owner: 'probot', repo: 'stale', logger: app.log })
      stale.config.only = 'pulls'
      stale.config.daysUntilClose = 1
      stale.getStale = jest.fn().mockImplementation(() => Promise.resolve({ data: { items: [] } }))
      stale.getClosable = jest.fn()

      await stale.markAndSweep('issues')
      expect(stale.getClosable).not.toHaveBeenCalled()
    }
  )

  test(
    'should not close pull requests if only keyword is configured with the issues value',
    async () => {
      let stale = new Stale(github, { perform: true, owner: 'probot', repo: 'stale', logger: app.log })
      stale.config.only = 'issues'
      stale.config.daysUntilClose = 1
      stale.getStale = jest.fn().mockImplementation(() => Promise.resolve({ data: { items: [] } }))
      stale.getClosable = jest.fn()

      await stale.markAndSweep('pulls')
      expect(stale.getClosable).not.toHaveBeenCalled()
    }
  )

  describe('mark', () => {
    test(
      'should not mark issue if it is already closed',
      async () => {
        let stale = new Stale(github, { perform: true, owner: 'probot', repo: 'stale', logger: app.log })
        stale.getStale = jest.fn().mockImplementation(() => {
          return Promise.resolve({
            data: {
              items: [
                { number: 1, state: 'closed' }
              ]
            }
          })
        })
        stale.markIssue = jest.fn()

        await stale.mark('issues')
        expect(stale.markIssue).not.toHaveBeenCalled()
      }
    )

    test(
      'should not mark issue if it is locked',
      async () => {
        let stale = new Stale(github, { perform: true, owner: 'probot', repo: 'stale', logger: app.log })
        stale.getStale = jest.fn().mockImplementation(() => {
          return Promise.resolve({
            data: {
              items: [
                { number: 1, state: 'open', locked: true }
              ]
            }
          })
        })
        stale.markIssue = jest.fn()

        await stale.mark('issues')
        expect(stale.markIssue).not.toHaveBeenCalled()
      }
    )

    test(
      'should mark issue if it is open',
      async () => {
        let stale = new Stale(github, { perform: true, owner: 'probot', repo: 'stale', logger: app.log })
        stale.getStale = jest.fn().mockImplementation(() => {
          return Promise.resolve({
            data: {
              items: [
                { number: 1, state: 'open' }
              ]
            }
          })
        })
        stale.markIssue = jest.fn()

        await stale.mark('issues')
        expect(stale.markIssue).toHaveBeenCalled()
      }
    )
  })

  describe('sweep', () => {
    test(
      'should not close issue if it is already closed',
      async () => {
        const staleLabel = 'stale'
        let stale = new Stale(github, { perform: true, owner: 'probot', repo: 'stale', logger: app.log })
        stale.config.daysUntilClose = 1
        stale.getClosable = jest.fn().mockImplementation(() => {
          return Promise.resolve({
            data: {
              items: [
                { number: 1, labels: [{ name: staleLabel }], state: 'closed' }
              ]
            }
          })
        })
        stale.close = jest.fn()

        await stale.sweep('issues')
        expect(stale.close).not.toHaveBeenCalled()
      }
    )

    test(
      'should not close issue if it is locked',
      async () => {
        const staleLabel = 'stale'
        let stale = new Stale(github, { perform: true, owner: 'probot', repo: 'stale', logger: app.log })
        stale.config.daysUntilClose = 1
        stale.getClosable = jest.fn().mockImplementation(() => {
          return Promise.resolve({
            data: {
              items: [
                { number: 1, labels: [{ name: staleLabel }], state: 'open', locked: true }
              ]
            }
          })
        })
        stale.close = jest.fn()

        await stale.sweep('issues')
        expect(stale.close).not.toHaveBeenCalled()
      }
    )

    test(
      'should close issue if it is open',
      async () => {
        const staleLabel = 'stale'
        let stale = new Stale(github, { perform: true, owner: 'probot', repo: 'stale', logger: app.log })
        stale.config.daysUntilClose = 1
        stale.getClosable = jest.fn().mockImplementation(() => {
          return Promise.resolve({
            data: {
              items: [
                { number: 1, labels: [{ name: staleLabel }], state: 'open' }
              ]
            }
          })
        })
        stale.close = jest.fn()

        await stale.sweep('issues')
        expect(stale.close).toHaveBeenCalled()
      }
    )
  })
})