added tests for check functions

Author: GantMan

__tests__/__mocks__/examplePlugin.ts

@@ -0,0 +1,26 @@
+module.exports = (context) => {
+  // Register this plugin
+  context.addPlugin({
+    name: 'Example Plugin',
+    description: 'I help test plugins',
+    snapshot: async (context) => {
+      context.addedSnapshot = true
+    },
+    customChecks: {
+      checkThing: async (rule, context) => {
+        return {
+          pass: true,
+          message: 'Yeah good check!'
+        }
+      },
+      checkSecondThing: async (rule, context) => {
+        return {
+          pass: false,
+          message: 'Boooo failed check'
+        }
+      }
+    }
+  })
+
+  return context
+}

__tests__/__mocks__/mockContext.ts

@@ -1,4 +1,6 @@
 const realThing = require('gluegun')
+const realSolidarityContext = require('../../src/extensions/solidarity-extension')
+realSolidarityContext(realThing)
 
 const noConfigSolidarity = {
   checkRequirement: jest.fn(),
@@ -11,7 +13,7 @@ const noConfigSolidarity = {
 
 const mockContext = {
   ...realThing,
-  outputMode: null,
+  outputMode: undefined,
   system: {
     startTimer: jest.fn(() => jest.fn()),
   },
@@ -21,6 +23,8 @@ const mockContext = {
     info: jest.fn(),
     spin: jest.fn(() => ({
       stop: jest.fn(),
+      fail: jest.fn(),
+      succeed: jest.fn()
     })),
     table: jest.fn(),
     xmark: jest.fn(),
@@ -37,7 +41,6 @@ const mockContext = {
     },
   },
   printSeparator: jest.fn(),
-  _pluginsList: [],
   parameters: {
     options: {},
   },

__tests__/command_helpers/checkRequirement.ts

@@ -222,5 +222,6 @@ describe('checkRequirement', () => {
       const result = await checkRequirement(rule, context)
       expect(result).toEqual([customError])
     })
+
   })
 })

__tests__/command_helpers/checkRequirementPlugins.ts

@@ -0,0 +1,48 @@
+import checkRequirement from '../../src/extensions/functions/checkRequirement'
+import { toPairs } from 'ramda'
+const examplePlugin = require('examplePlugin')
+const mockContext = examplePlugin(require('mockContext'))
+
+describe('checkRequirement Plugins', () => {
+  test('successful CUSTOM rule check', async () => {
+    const rule = toPairs({
+      TestRequirement: [{ rule: 'custom', plugin: 'Example Plugin', name: 'checkThing' }],
+    })[0]
+    const result = await checkRequirement(rule, mockContext)
+    expect(result).toEqual([[]])
+  })
+
+  test('failed CUSTOM rule check', async () => {
+    const rule = toPairs({
+      TestRequirement: [{ rule: 'custom', plugin: 'Example Plugin', name: 'checkSecondThing' }],
+    })[0]
+    const result = await checkRequirement(rule, mockContext)
+    expect(result).toEqual(['Boooo failed check'])
+  })
+
+  test('failed to find plugin', async () => {
+    const rule = toPairs({
+      TestRequirement: [{ rule: 'custom', plugin: 'I do not exist', name: 'checkSecondThing' }],
+    })[0]
+    const result = await checkRequirement(rule, mockContext)
+    expect(result).toEqual(["Plugin not found 'I do not exist'"])
+  })
+
+  test('failed to find check function', async () => {
+    const rule = toPairs({
+      TestRequirement: [{ rule: 'custom', plugin: 'Example Plugin', name: 'notRealName' }],
+    })[0]
+    const result = await checkRequirement(rule, mockContext)
+    expect(result).toEqual(["NOT FOUND: Custom rule from 'Example Plugin' plugin with check function 'notRealName'"])
+  })
+
+  test('failed CUSTOM rule with custom message', async () => {
+    const error = 'CUSTOM ERROR'
+    const rule = toPairs({
+      TestRequirement: [{ rule: 'custom', plugin: 'Example Plugin', name: 'checkSecondThing', error }],
+    })[0]
+    const result = await checkRequirement(rule, mockContext)
+    expect(result).toEqual([error])
+  })
+
+})

src/extensions/functions/checkRequirement.ts

@@ -118,6 +118,7 @@ module.exports = async (
       case 'custom':
         // find correct rule function
         const correctPlugin = head(filter(plugin => plugin.name === rule.plugin, context._pluginsList))
+        if (correctPlugin === undefined) return addFailure(`Plugin not found '${rule.plugin}'`)
         const customChecker = correctPlugin.customChecks && correctPlugin.customChecks[rule.name]
         if (correctPlugin && customChecker) {
           const customResult = await customChecker(rule, context)
@@ -131,7 +132,6 @@ module.exports = async (
             return addFailure(rule.error || failMessage)
           }
         } else {
-
           return addFailure(`NOT FOUND: Custom rule from '${rule.plugin}' plugin with check function '${rule.name}'`)
         }
       default: