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

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.8.0](https://github.com/mojaloop/ml-testing-toolkit-client-lib/compare/v1.7.0...v1.8.0) (2025-03-17)
+
+
+### Features
+
+* **csi-1309:** added notifications for failed tests only ([#21](https://github.com/mojaloop/ml-testing-toolkit-client-lib/issues/21)) ([6bf47f7](https://github.com/mojaloop/ml-testing-toolkit-client-lib/commit/6bf47f7e39ab76d954b0dc818e53dd7aaeb0b9f7))
+
 ## [1.7.0](https://github.com/mojaloop/ml-testing-toolkit-client-lib/compare/v1.6.1...v1.7.0) (2025-03-13)
 
 

package/package.json

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

package/src/extras/slack-broadcast.js

@@ -38,6 +38,10 @@ const millisecondsToTime = (milliseconds) => {
   return `${String(hours).padStart(2, '0')}:${String(minutes % 60).padStart(2, '0')}:${String(seconds % 60).padStart(2, '0')}`
 }
 
+/**
+ * @param {FinalReport} progress
+ * @param {string} reportURL - URL of the report
+ */
 const generateSlackBlocks = (progress, reportURL) => {
   const slackBlocks = []
   let totalAssertionsCount = 0
@@ -88,10 +92,10 @@ const generateSlackBlocks = (progress, reportURL) => {
         text: [
           `${totalAssertionsCount === totalPassedAssertionsCount ? '🟢' : '🔴'}`,
           reportURL ? `<${reportURL}|${config.briefSummaryPrefix}>` : `${config.briefSummaryPrefix}`,
+          `tests: \`${progress.test_cases.length}\`,`,
+          `requests: \`${totalRequestsCount}\`,`,
           `failed: \`${totalAssertionsCount - totalPassedAssertionsCount}/${totalAssertionsCount}`,
           `(${(100 * ((totalAssertionsCount - totalPassedAssertionsCount) / totalAssertionsCount)).toFixed(2)}%)\`,`,
-          `requests: \`${totalRequestsCount}\`,`,
-          `tests: \`${progress.test_cases.length}\`,`,
           `duration: \`${millisecondsToTime(progress.runtimeInformation.runDurationMs)}\``,
           top5FailedTestCases.length > 0 && '\nTop 5 failed test cases:\n',
           top5FailedTestCases.length > 0 && top5FailedTestCases.map(tc => `• ${tc.name}: \`${tc.failedAssertions}\``).join('\n')
@@ -170,53 +174,52 @@ const generateSlackBlocks = (progress, reportURL) => {
   return slackBlocks
 }
 
+/**
+ * @param {FinalReport} progress
+ * @param {string} reportURL - URL of the report
+ */
 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)
-    blocks = generateSlackBlocks(progress, reportURL)
-
-    try {
-      // console.log(JSON.stringify(slackBlocks, null, 2))
-      await webhook.send({
-        text: 'Test Report',
-        blocks
-      })
-      console.log('Slack notification sent.')
-    } catch (err) {
-      console.log('ERROR: Sending slack notification failed. ', err.message)
-    }
+  const { slackWebhookUrl, slackWebhookUrlForFailed } = config
+
+  if (!slackWebhookUrl && !needToNotifyFailed(slackWebhookUrlForFailed, progress)) {
+    console.log('No Slack webhook URLs configured.')
+    return
   }
+  const blocks = generateSlackBlocks(progress, reportURL)
 
-  if (needToNotifyFailed(config, progress)) {
-    const url = config.slackWebhookUrlForFailed
-    const webhook = new IncomingWebhook(url)
+  if (slackWebhookUrl) {
+    await sendWebhook(slackWebhookUrl, 'Test Report', blocks)
+  }
 
-    if (!blocks) blocks = generateSlackBlocks(progress, reportURL)
+  if (needToNotifyFailed(slackWebhookUrlForFailed, progress)) {
+    await sendWebhook(slackWebhookUrlForFailed, 'Failed Tests Report', blocks)
+  }
+}
 
-    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 sendWebhook = async (url, text, blocks) => {
+  const webhook = new IncomingWebhook(url)
+  try {
+    await webhook.send({ text, 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
+/**
+ * Determines if a notification for failed tests needs to be sent.
+ * @param {string | undefined} webhookUrl
+ * @param {FinalReport} progress
+ * @returns {boolean}
+ */
+const needToNotifyFailed = (webhookUrl, progress) => {
+  return webhookUrl && (!progress?.runtimeInformation?.totalAssertions
     ? true
-    : totalResult.runtimeInformation.totalPassedAssertions !== totalResult.runtimeInformation.totalAssertions)
+    : progress.runtimeInformation.totalPassedAssertions !== progress.runtimeInformation.totalAssertions)
 }
 
 module.exports = {
   sendSlackNotification,
+  sendWebhook,
   needToNotifyFailed
 }

package/src/modes/outbound.js

@@ -180,6 +180,36 @@ const sendTemplate = async (sessionId) => {
   }
 }
 
+/**
+ * Consolidated final report, created by generateFinalReport function (ml-testing-toolkit repo).
+ * @typedef {Object} FinalReport
+ * @property {RuntimeInformation} runtimeInformation - Provides metadata about the runtime environment or execution context.
+ * @property {Array<Object>} test_cases - An array of objects where each object represents a test case and its results.
+ * @property {string} status
+ * @property {Object} totalResult
+ * @property {Object} saveReportStatus
+ * @property {unknown} [otherFields] - see ml-testing-toolkit repo.
+ */
+
+/**
+ * @typedef {Object} RuntimeInformation
+ * @property {string} testReportId - Test report ID
+ * @property {string} completedTimeISO - Completed time in ISO format
+ * @property {string} startedTime - Started time in readable format
+ * @property {string} completedTime - Completed time in readable format
+ * @property {string} completedTimeUTC - Completed time in UTC format
+ * @property {number} startedTS - Started timestamp
+ * @property {number} completedTS - Completed timestamp
+ * @property {number} runDurationMs - Run duration in milliseconds
+ * @property {number} totalAssertions - Total number of assertions
+ * @property {number} totalPassedAssertions - Total number of passed assertions
+ */
+
+/**
+ * Handles incoming progress updates and processes them as needed.
+ * @param {FinalReport} progress
+ * @returns {Promise<void>}
+ */
 const handleIncomingProgress = async (progress) => {
   const config = objectStore.get('config')
   if (progress.status === 'FINISHED') {

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

@@ -135,59 +135,31 @@ describe('Cli client', () => {
     })
   })
 
-  describe.skip('needToNotify Tests -->', () => {
-    it('should not notify if slackWebhookUrl is not set', () => {
-      expect(slackBroadCast.needToNotify({})).toBeFalsy()
+  describe('needToNotifyFailed Tests -->', () => {
+    it('should not notify if slackWebhookUrlForFailed is not configured', () => {
+      expect(slackBroadCast.needToNotifyFailed(undefined, {})).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 webhookUrl is set, but no progress.runtimeInformation info', () => {
+      expect(slackBroadCast.needToNotifyFailed('url', {})).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 = {
+    it('should NOT notify success tests', () => {
+      expect(slackBroadCast.needToNotifyFailed('url', {
         runtimeInformation: {
-          totalPassedAssertions: 0,
-          totalAssertion: 1
+          totalAssertions: 1,
+          totalPassedAssertions: 1
         }
-      }
-      expect(slackBroadCast.needToNotify(conf, totalResult)).toBe(true)
+      })).toBe(false)
     })
 
-    it('should notify if slackOnlyFailed=true, and tests passed', () => {
-      const conf = {
-        slackWebhookUrl: 'url',
-        slackOnlyFailed: true
-      }
-      const totalResult = {
+    it('should notify in case failed tests', () => {
+      expect(slackBroadCast.needToNotifyFailed('url', {
         runtimeInformation: {
-          totalPassedAssertions: 1,
-          totalAssertion: 1
+          totalAssertions: 1,
+          totalPassedAssertions: 0
         }
-      }
-      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)
+      })).toBe(true)
     })
   })
 })

package/test/unit/router.test.js

@@ -30,12 +30,10 @@
 
 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', () => {
@@ -113,14 +111,5 @@ 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)
-    // })
   })
 })