feat: optionally submit the test result to a release tagging service (#16)

Author: kalinkrustev

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@mojaloop/ml-testing-toolkit-client-lib",
   "description": "Testing Toolkit Client Library",
-  "version": "1.5.1",
+  "version": "1.6.0-snapshot.1",
   "license": "Apache-2.0",
   "author": "Vijaya Kumar Guthi, ModusBox Inc. ",
   "contributors": [
@@ -63,7 +63,7 @@
     "snapshot": "npx standard-version --no-verify --skip.changelog --prerelease snapshot --releaseCommitMessageFormat 'chore(snapshot): {{currentTag}}'"
   },
   "dependencies": {
-    "@mojaloop/central-services-logger": "11.5.4",
+    "@mojaloop/central-services-logger": "11.5.5",
     "@mojaloop/ml-testing-toolkit-shared-lib": "14.0.3",
     "@mojaloop/sdk-standard-components": "19.6.4",
     "@slack/webhook": "7.0.4",
@@ -80,7 +80,7 @@
     "node-strings": "1.0.2",
     "parse-strings-in-object": "1.6.0",
     "path": "0.12.7",
-    "rc": "1.2.8",
+    "rc": "^1.2.8",
     "socket.io-client": "4.8.1"
   },
   "devDependencies": {

package.json

@@ -0,0 +1,38 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+
+ * Infitx
+ - Kalin Krustev <[email protected]> (Original Author)
+ --------------
+ ******/
+const axios = require('axios').default
+const config = require('rc')('release_cd', {})
+
+module.exports = async function (name, result) {
+  if (!config.reportUrl) return
+  const data = {
+    [`tests.${name}`]: result
+  }
+  console.log(`Sending report to ${config.reportUrl}`, data)
+  await axios({
+    method: 'post',
+    url: config.reportUrl,
+    data
+  })
+}

src/extras/release-cd.js

@@ -29,6 +29,7 @@ const fs = require('fs')
 const { promisify } = require('util')
 const objectStore = require('../objectStore')
 const slackBroadcast = require('../extras/slack-broadcast')
+const releaseCd = require('../extras/release-cd')
 const TemplateGenerator = require('../utils/templateGenerator')
 const { TraceHeaderUtils } = require('@mojaloop/ml-testing-toolkit-shared-lib')
 
@@ -193,6 +194,11 @@ const handleIncomingProgress = async (progress) => {
           console.log(fStr.red(`Report not saved: ${progress.saveReportStatus.message}`))
         }
       }
+      try {
+        await releaseCd(config.reportName, progress.totalResult.runtimeInformation)
+      } catch (err) {
+        console.error(err)
+      }
       await slackBroadcast.sendSlackNotification(progress.totalResult, resultReport.uploadedReportURL)
     } catch (err) {
       console.log(err)

src/modes/outbound.js

@@ -0,0 +1,60 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+
+ * Infitx
+ - Kalin Krustev <[email protected]> (Original Author)
+ --------------
+ ******/
+
+const rc = require('rc')
+jest.mock('rc')
+const axios = require('axios')
+jest.spyOn(axios, 'default')
+axios.default.mockImplementation(() => Promise.resolve({}))
+
+const config = {}
+rc.mockImplementation(() => config)
+
+const releaseCd = require('../../../src/extras/release-cd')
+
+describe('Release CD', () => {
+  describe('Post test results', () => {
+    it('Posts test result to configured URL', async () => {
+      const name = 'test'
+      const result = {}
+      config.reportUrl = 'http://example.com'
+      await releaseCd(name, result)
+      expect(axios.default).toHaveBeenCalledWith({
+        method: 'post',
+        url: 'http://example.com',
+        data: {
+          [`tests.${name}`]: result
+        }
+      })
+    })
+    it('Does not post test result if no report URL is configured', async () => {
+      const name = 'test'
+      const result = {}
+      config.reportUrl = undefined
+      axios.default.mockClear()
+      await releaseCd(name, result)
+      expect(axios.default).not.toHaveBeenCalled()
+    })
+  })
+})