@mojaloop/ml-testing-toolkit-client-lib 1.7.0 → 1.8.0-snapshot.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mojaloop/ml-testing-toolkit-client-lib",
   "description": "Testing Toolkit Client Library",
-  "version": "1.7.0",
+  "version": "1.8.0-snapshot.1",
   "license": "Apache-2.0",
   "author": "Vijaya Kumar Guthi, ModusBox Inc. ",
   "contributors": [

package/src/client.js

@@ -47,6 +47,7 @@ program
   .option('--report-auto-filename-enable <reportAutoFilenameEnable>', 'default: false, if true the file name will be generated by the backend')
   .option('--report-target <reportTarget>', 'default: "file://<file_name_genrated_by_backend>"  --- supported targets: "file://path_to_file", "s3://<bucket_name>[/<file_path>]"')
   .option('--slack-webhook-url <slackWebhookUrl>', 'default: "Disabled"  --- supported formats: "https://....."')
+  .option('--slack-webhook-url-for-failed <slackWebhookUrl>', 'default: "Disabled"  --- supported formats: "https://....."')
   .option('--extra-summary-information <Comma separated values in the format key:value>', 'default: none  --- example: "Testcase Name:something,Environment:Dev1"')
   .option('--brief-summary-prefix <Prefix to use for a brief summary in Slack>', 'default: none  --- example: "environment name, test name"')
   .on('--help', () => { // Extra information on help message

package/src/extras/slack-broadcast.js

@@ -171,10 +171,13 @@ const generateSlackBlocks = (progress, reportURL) => {
 }
 
 const sendSlackNotification = async (progress, reportURL = 'http://localhost/') => {
+  console.log('runtimeInformation: ', progress.runtimeInformation)
+
+  let blocks
   if (config.slackWebhookUrl) {
     const url = config.slackWebhookUrl
     const webhook = new IncomingWebhook(url)
-    const blocks = generateSlackBlocks(progress, reportURL)
+    blocks = generateSlackBlocks(progress, reportURL)
 
     try {
       // console.log(JSON.stringify(slackBlocks, null, 2))
@@ -187,8 +190,33 @@ const sendSlackNotification = async (progress, reportURL = 'http://localhost/')
       console.log('ERROR: Sending slack notification failed. ', err.message)
     }
   }
+
+  if (needToNotifyFailed(config, progress)) {
+    const url = config.slackWebhookUrlForFailed
+    const webhook = new IncomingWebhook(url)
+
+    if (!blocks) blocks = generateSlackBlocks(progress, reportURL)
+
+    try {
+      // console.log(JSON.stringify(slackBlocks, null, 2))
+      await webhook.send({
+        text: 'Failed Tests Report',
+        blocks
+      })
+      console.log('Slack notification sent.')
+    } catch (err) {
+      console.log('ERROR: Sending slack notification failed. ', err.message)
+    }
+  }
+}
+
+const needToNotifyFailed = (conf, totalResult) => {
+  return conf.slackWebhookUrlForFailed && (!totalResult?.runtimeInformation?.totalAssertions
+    ? true
+    : totalResult.runtimeInformation.totalPassedAssertions !== totalResult.runtimeInformation.totalAssertions)
 }
 
 module.exports = {
-  sendSlackNotification
+  sendSlackNotification,
+  needToNotifyFailed
 }

package/src/router.js

@@ -63,6 +63,7 @@ const cli = (commanderOptions) => {
     reportAutoFilenameEnable: commanderOptions.reportAutoFilenameEnable === 'true' || configFile.reportAutoFilenameEnable === true,
     reportTarget: commanderOptions.reportTarget || configFile.reportTarget,
     slackWebhookUrl: commanderOptions.slackWebhookUrl || configFile.slackWebhookUrl,
+    slackWebhookUrlForFailed: commanderOptions.slackWebhookUrlForFailed || configFile.slackWebhookUrlForFailed,
     slackPassedImage: configFile.slackPassedImage,
     slackFailedImage: configFile.slackFailedImage,
     baseURL: commanderOptions.baseUrl || configFile.baseURL,

package/test/unit/extras/slack-broadcast.test.js

@@ -134,4 +134,60 @@ describe('Cli client', () => {
       }))
     })
   })
+
+  describe.skip('needToNotify Tests -->', () => {
+    it('should not notify if slackWebhookUrl is not set', () => {
+      expect(slackBroadCast.needToNotify({})).toBeFalsy()
+    })
+
+    it('should notify if slackWebhookUrl is set and slackOnlyFailed not', () => {
+      const conf = { slackWebhookUrl: 'url' }
+      expect(slackBroadCast.needToNotify(conf)).toBe(true)
+    })
+
+    it('should notify if slackWebhookUrl is set and slackOnlyFailed is false', () => {
+      const conf = {
+        slackWebhookUrl: 'url',
+        slackOnlyFailed: false
+      }
+      expect(slackBroadCast.needToNotify(conf)).toBe(true)
+    })
+
+    it('should notify if slackOnlyFailed=true, and tests failed', () => {
+      const conf = {
+        slackWebhookUrl: 'url',
+        slackOnlyFailed: true
+      }
+      const totalResult = {
+        runtimeInformation: {
+          totalPassedAssertions: 0,
+          totalAssertion: 1
+        }
+      }
+      expect(slackBroadCast.needToNotify(conf, totalResult)).toBe(true)
+    })
+
+    it('should notify if slackOnlyFailed=true, and tests passed', () => {
+      const conf = {
+        slackWebhookUrl: 'url',
+        slackOnlyFailed: true
+      }
+      const totalResult = {
+        runtimeInformation: {
+          totalPassedAssertions: 1,
+          totalAssertion: 1
+        }
+      }
+      expect(slackBroadCast.needToNotify(conf, totalResult)).toBe(false)
+    })
+
+    it('should notify if slackOnlyFailed=true, but no totalResult.runtimeInformation', () => {
+      const conf = {
+        slackWebhookUrl: 'url',
+        slackOnlyFailed: true
+      }
+      const totalResult = {}
+      expect(slackBroadCast.needToNotify(conf, totalResult)).toBe(true)
+    })
+  })
 })

package/test/unit/router.test.js

@@ -30,17 +30,19 @@
 
 const spyExit = jest.spyOn(process, 'exit')
 const { cli } = require('../../src/router')
+// const objectStore = require('../../src/objectStore')
 
 jest.mock('../../src/utils/listeners')
 jest.mock('../../src/modes/outbound')
 jest.mock('../../src/modes/testcaseDefinitionReport')
+// jest.mock('../../src/objectStore')
 
 describe('Cli client', () => {
   describe('running router', () => {
     it('when mode is monitoring should not throw an error', async () => {
       const config = {
         "mode": "monitoring"
-      }  
+      }
       spyExit.mockImplementationOnce(jest.fn())
       expect(() => {
         cli(config)
@@ -111,5 +113,14 @@ describe('Cli client', () => {
         cli(config)
       }).not.toThrowError();
     })
+    // it('should have default slackOnlyFailed value', async () => {
+    //   spyExit.mockImplementationOnce(jest.fn())
+    //   cli({
+    //     mode: 'outbound',
+    //     inputFiles: 'test',
+    //     environmentFile: 'test'
+    //   })
+    //   expect(objectStore.set.mock.lastCall[1].slackOnlyFailed).toBe(false)
+    // })
   })
 })