Modular Flex Architecture.

Flex

Author: jusx

.github/mergeable.yml

@@ -1,3 +1,2 @@
 mergeable:
-  approvals: 0
-  milestone: 'Version 1.1'
+  approvals: 1  

LICENSE

@@ -1,9 +1,18 @@
+const _ = require('lodash')
+
+const throwNotFound = () => {
+  let error = new Error('404 error')
+  error.code = 404
+  throw error
+}
+
 module.exports = {
   mockContext: (options) => {
     if (!options) options = {}
 
     return {
       repo: (properties) => { return Object.assign({ owner: 'owner', repo: 'repo' }, properties) },
+      event: (options.event) ? options.event : 'pull_request',
       payload: {
         pull_request: {
           user: {
@@ -12,6 +21,7 @@ module.exports = {
           title: (options.title) ? options.title : 'title',
           body: options.body,
           number: (options.number) ? options.number : 1,
+          milestone: (options.milestone) ? options.milestone : null,
           base: {
             ref: 'baseRef',
             sha: 'sha2'
@@ -25,21 +35,24 @@ module.exports = {
           assignees: (options.assignees) ? options.assignees : []
         }
       },
+      log: {
+        debug: (s) => console.log(`TEST[debug] > ${JSON.stringify(s)}`),
+        info: (s) => console.log(`TEST[info] > ${JSON.stringify(s)}`),
+        warn: (s) => console.log(`TEST[warn] > ${JSON.stringify(s)}`)
+      },
       github: {
         repos: {
           createStatus: () => {},
           getContent: ({ path }) => {
             return new Promise((resolve, reject) => {
               if (path === '.github/mergeable.yml') {
-                let error = new Error('404 error')
-                error.code = 404
-                throw error
+                throwNotFound()
               }
 
               if (path === '.github/CODEOWNERS') {
                 return options.codeowners ? resolve({ data: {
                   content: options.codeowners
-                }}) : resolve()
+                }}) : throwNotFound()
               }
             })
           },
@@ -63,7 +76,11 @@ module.exports = {
         },
         pullRequests: {
           getFiles: () => {
-            return { data: options.files && options.files.map(file => ({filename: file, status: 'modified'})) }
+            if (_.isString(options.files && options.files[0])) {
+              return { data: options.files.map(file => ({filename: file, status: 'modified'})) }
+            } else {
+              return { data: options.files && options.files }
+            }
           },
           getReviews: () => {
             return { data: (options.reviews) ? options.reviews : [] }
@@ -85,7 +102,7 @@ module.exports = {
             return { data: (options.labels) ? options.labels : [] }
           },
           get: () => {
-            return {data: (options.milestone) ? {milestone: options.milestone} : {}}
+            return {data: (options.deepValidation) ? options.deepValidation : {}}
           }
         }
       }
@@ -105,12 +122,16 @@ module.exports = {
     }
   },
 
-  mockConfigWithContext: (context, configString) => {
+  mockConfigWithContext: (context, configString, options) => {
     context.github.repos.getContent = () => {
       return Promise.resolve({ data: {
         content: Buffer.from(configString).toString('base64') }
       })
     }
+    context.github.pullRequests.getFiles = () => {
+      return Promise.resolve({
+        data: options && options.files ? options.files.map(file => ({ filename: file, status: 'modified' })) : []
+      })
+    }
   }
-
 }

__fixtures__/helper.js

@@ -0,0 +1,24 @@
+const { Action } = require('../../lib/actions/action')
+
+describe('Action#isEventSupported', () => {
+  let action = new Action()
+
+  test('Returns correctly with one supported event', () => {
+    action.supportedEvents = ['issues.opened']
+    expect(action.isEventSupported('pull_request.opened')).toBe(false)
+    expect(action.isEventSupported('issues.opened')).toBe(true)
+  })
+
+  test('Returns correctly with more than one supported event', () => {
+    action.supportedEvents = ['issues.opened', 'pull_request.opened']
+    expect(action.isEventSupported('pull_request.labeled')).toBe(false)
+    expect(action.isEventSupported('issues.opened')).toBe(true)
+    expect(action.isEventSupported('pull_request.opened')).toBe(true)
+  })
+
+  test('Returns correctly with a wildcard in the event name', () => {
+    action.supportedEvents = ['issues.opened', 'pull_request.*']
+    expect(action.isEventSupported('pull_request.labeled')).toBe(true)
+    expect(action.isEventSupported('issues.milestoned')).toBe(false)
+  })
+})

__tests__/actions/action.test.js

@@ -0,0 +1,47 @@
+const Checks = require('../../lib/actions/checks')
+const Helper = require('../../__fixtures__/helper')
+
+test('check that checks created when doPostAction is called with proper parameter', async () => {
+  const checks = new Checks()
+  const context = createMockContext()
+
+  await checks.beforeValidate({context})
+  expect(context.github.checks.create.mock.calls.length).toBe(1)
+})
+
+test('check that checks created when doPostAction is called with proper parameter', async () => {
+  const checks = new Checks()
+  const context = createMockContext()
+  const result = {
+    status: 'pass',
+    validations: [{
+      status: 'pass',
+      name: 'Label'
+    }]
+  }
+  const settings = {
+    payload: {
+      title: `Your run has returned the following status: {{status}}`,
+      summary: 'This is the summary'
+    }
+  }
+
+  checks.checkRunResult = {
+    data: {
+      id: '3'
+    }
+  }
+
+  await checks.afterValidate(context, settings, result)
+  expect(context.github.checks.update.mock.calls.length).toBe(1)
+  expect(context.github.checks.update.mock.calls[0][0].output.summary).toBe('This is the summary')
+  expect(context.github.checks.update.mock.calls[0][0].output.title).toBe('Your run has returned the following status: pass')
+})
+
+const createMockContext = () => {
+  let context = Helper.mockContext()
+
+  context.github.checks.create = jest.fn()
+  context.github.checks.update = jest.fn()
+  return context
+}

__tests__/actions/checks.test.js

@@ -0,0 +1,46 @@
+const Comment = require('../../lib/actions/comment')
+const Helper = require('../../__fixtures__/helper')
+
+const settings = {
+  payload: {
+    body: `Your run has returned the following status: {{status}}`
+  }
+}
+
+let result = {
+  status: 'pass',
+  validations: [{
+    status: 'pass',
+    name: 'Label'
+  }]
+}
+
+test('check that comment created when afterValidate is called with proper parameter', async () => {
+  const comment = new Comment()
+  const context = createMockContext()
+
+  await comment.afterValidate(context, settings, result)
+  expect(context.github.issues.createComment.mock.calls.length).toBe(1)
+  expect(context.github.issues.createComment.mock.calls[0][0].body).toBe(`Your run has returned the following status: pass`)
+})
+
+test('that comment is created three times when result contain three issues found to be acted on', async () => {
+  const comment = new Comment()
+  const context = createMockContext()
+
+  result.validationSuites = [{
+    schedule: {
+      issues: [{number: 1}, {number: 2}, {number: 3}],
+      pulls: []
+    }
+  }]
+  await comment.afterValidate(context, settings, result)
+  expect(context.github.issues.createComment.mock.calls.length).toBe(3)
+})
+
+const createMockContext = () => {
+  let context = Helper.mockContext()
+
+  context.github.issues.createComment = jest.fn()
+  return context
+}