ml-testing-toolkit 18.13.0

package/src/index.js

@@ -0,0 +1,67 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 Mojaloop Foundation
+ The Mojaloop files are made available by the Mojaloop 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
+ Mojaloop Foundation 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * ModusBox
+ * Vijaya Kumar Guthi <vijaya.guthi@modusbox.com> (Original Author)
+ --------------
+ ******/
+
+'use strict'
+const RequestLogger = require('./lib/requestLogger')
+const apiServer = require('./lib/api-server')
+const socketServer = require('./lib/socket-server')
+const Config = require('./lib/config')
+const server = require('./server')
+const mbConnectionManager = require('./lib/configuration-providers/mb-connection-manager')
+const reportGenerator = require('./lib/report-generator/generator')
+
+const welcomeMessage = `
+-------------------------------------------------------------------------------------
+                  Welcome to Mojaloop Testing Toolkit
+-------------------------------------------------------------------------------------
+You can start using the testing toolkit by opening the following URL in your browser
+
+http://localhost:5050
+
+And you can send mojaloop requests to http://localhost:4040
+
+-------------------------------------------------------------------------------------
+`
+
+const init = async () => {
+  RequestLogger.logMessage('info', 'Toolkit Initialization started...', { notification: false })
+  await Config.loadSystemConfig()
+  await Config.loadUserConfig()
+  apiServer.startServer(5050)
+  socketServer.initServer(apiServer.getHttp())
+  const systemConfig = Config.getSystemConfig()
+  if (systemConfig.CONNECTION_MANAGER.ENABLED) {
+    await mbConnectionManager.initialize()
+  }
+  await reportGenerator.initialize()
+  await server.initialize()
+  RequestLogger.logMessage('info', 'Toolkit Initialization completed.', { notification: false, additionalData: welcomeMessage })
+}
+
+init()

package/src/lib/MyEventEmitter.js

@@ -0,0 +1,54 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 Mojaloop Foundation
+ The Mojaloop files are made available by the Mojaloop 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
+ Mojaloop Foundation 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * ModusBox
+ * Vijaya Kumar Guthi <vijaya.guthi@modusbox.com> (Original Author)
+ --------------
+ ******/
+
+const EventEmitter = require('events')
+class MyEmitter extends EventEmitter {}
+const emitters = {
+  data: {
+    testOutbound: null,
+    assertionRequest: null,
+    assertionCallback: null,
+    inboundRequest: null
+  }
+}
+
+const getEmitter = (emitter, user) => {
+  const context = user ? user.dfspId : 'data'
+  if (!emitters[context]) {
+    emitters[context] = {}
+  }
+  if (!emitters[context][emitter]) {
+    emitters[context][emitter] = new MyEmitter()
+  }
+  return emitters[context][emitter]
+}
+
+module.exports = {
+  getEmitter
+}

package/src/lib/api-management.js

@@ -0,0 +1,143 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 Mojaloop Foundation
+ The Mojaloop files are made available by the Mojaloop 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
+ Mojaloop Foundation 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * ModusBox
+ * Vijaya Kumar Guthi <vijaya.guthi@modusbox.com> (Original Author)
+ --------------
+ ******/
+
+const addFormats = require('ajv-formats')
+const OpenApiBackend = require('openapi-backend').default
+const Utils = require('./utils')
+const path = require('path')
+const Config = require('./config')
+const OpenApiDefinitionsModel = require('./mocking/openApiDefinitionsModel')
+const OpenApiMockHandler = require('./mocking/openApiMockHandler')
+
+const apiDefinitionsPath = 'spec_files/api_definitions/'
+
+const validateDefinition = async (apiFilePath) => {
+  const newApi = new OpenApiBackend({
+    definition: path.join(apiFilePath),
+    customizeAjv: ajv => addFormats(ajv),
+    strict: true,
+    quick: true
+  })
+  await newApi.loadDocument()
+  newApi.validateDefinition()
+  return newApi.document
+}
+
+const addDefinition = async (apiFilePath, name, version, asynchronous) => {
+  // Validate the definition first
+  await validateDefinition(apiFilePath)
+  // Create a folder with api name and copy the uploaded file there
+  await Utils.makeDirectoryAsync(apiDefinitionsPath + name + '_' + version)
+  await Utils.mvAsync(apiFilePath, apiDefinitionsPath + name + '_' + version + '/api_spec.yaml')
+  // Add the entry to system config
+  const apiDefinitions = Config.getSystemConfig().API_DEFINITIONS
+  apiDefinitions.push({
+    type: name,
+    version,
+    folderPath: name + '_' + version,
+    asynchronous: asynchronous === 'true' || asynchronous === 'TRUE',
+    additionalApi: true
+  })
+  await Config.setSystemConfig({ API_DEFINITIONS: apiDefinitions })
+
+  // Reload the opneapi definitions model
+  await OpenApiDefinitionsModel.refreshApiDefinitions()
+
+  // Reload the openapimock handlers
+  OpenApiMockHandler.initilizeMockHandler()
+}
+
+const deleteDefinition = async (name, version) => {
+  // Make sure the requested API is not an inbuilt API
+  const apiDefinitions = Config.getSystemConfig().API_DEFINITIONS
+  const matchedApiIndex = apiDefinitions.findIndex(item => {
+    return item.type === name && item.version === version
+  })
+
+  if (matchedApiIndex === -1) {
+    throw new Error('Requested API is not found')
+  }
+  const matchedApi = apiDefinitions[matchedApiIndex]
+  if (!matchedApi.additionalApi) {
+    throw new Error('Requested API is an inbuilt API and can not be deleted')
+  }
+
+  // Remove entry in system config file
+  apiDefinitions.splice(matchedApiIndex, 1)
+  await Config.setSystemConfig({ API_DEFINITIONS: apiDefinitions })
+
+  // Remove the folder from spec_files
+  await Utils.rmdirAsync(apiDefinitionsPath + name, { recursive: true })
+
+  // Refresh openapi Definitions
+  await OpenApiDefinitionsModel.refreshApiDefinitions()
+
+  // Reload the openapimock handlers
+  OpenApiMockHandler.initilizeMockHandler()
+
+  return true
+}
+
+const patchDefinitionParams = async (name, version, patchParams) => {
+  const apiDefinitions = Config.getSystemConfig().API_DEFINITIONS
+  const matchedApiIndex = apiDefinitions.findIndex(item => {
+    return item.type === name && item.version === version
+  })
+
+  if (matchedApiIndex === -1) {
+    throw new Error('Requested API is not found')
+  }
+  const matchedApi = apiDefinitions[matchedApiIndex]
+
+  // Mutate only editable values based on patchParams
+  if (patchParams.hostnames !== undefined) {
+    matchedApi.hostnames = patchParams.hostnames
+  }
+  if (patchParams.prefix !== undefined) {
+    matchedApi.prefix = patchParams.prefix
+  }
+
+  // Update the vlaues
+  await Config.setSystemConfig({ API_DEFINITIONS: apiDefinitions })
+
+  // Refresh openapi Definitions
+  await OpenApiDefinitionsModel.refreshApiDefinitions()
+
+  // Reload the openapimock handlers
+  OpenApiMockHandler.initilizeMockHandler()
+
+  return true
+}
+
+module.exports = {
+  validateDefinition,
+  addDefinition,
+  deleteDefinition,
+  patchDefinitionParams
+}

package/src/lib/api-routes/config.js

@@ -0,0 +1,83 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 Mojaloop Foundation
+ The Mojaloop files are made available by the Mojaloop 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
+ Mojaloop Foundation 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * ModusBox
+ * Vijaya Kumar Guthi <vijaya.guthi@modusbox.com> (Original Author)
+ --------------
+ ******/
+
+const express = require('express')
+const Config = require('../config')
+const router = new express.Router()
+const { check, validationResult } = require('express-validator')
+
+const userConfigView = (obj) => {
+  if (!Config.getSystemConfig().HOSTING_ENABLED) {
+    return obj
+  }
+
+  const hiddenProperties = [
+    'HUB_ONLY_MODE',
+    'ENDPOINTS_DFSP_WISE'
+  ]
+  const newConfig = {}
+  Object.keys(obj).forEach(key => {
+    if (!hiddenProperties.includes(key)) {
+      newConfig[key] = obj[key]
+    }
+  })
+  return newConfig
+}
+
+// Get runtime and stored user config
+router.get('/user', async (req, res, next) => {
+  try {
+    const runtime = userConfigView(await Config.getUserConfig(req.user))
+    const stored = userConfigView(await Config.getStoredUserConfig(req.user))
+    res.status(200).json({ runtime, stored })
+  } catch (err) {
+    // next(err)
+    res.status(404).json({ error: err && err.message })
+  }
+})
+
+// Route to edit the user configuration
+router.put('/user', [
+  check('CALLBACK_ENDPOINT').notEmpty()
+], async (req, res, next) => {
+  const errors = validationResult(req)
+  if (!errors.isEmpty()) {
+    return res.status(422).json({ errors: errors.array() })
+  }
+  try {
+    await Config.setStoredUserConfig(req.body, req.user)
+    await Config.loadUserConfig(req.user)
+    res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    // next(err)
+    res.status(404).json({ error: err && err.message })
+  }
+})
+
+module.exports = router

package/src/lib/api-routes/history.js

@@ -0,0 +1,139 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 Mojaloop Foundation
+ The Mojaloop files are made available by the Mojaloop 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
+ Mojaloop Foundation 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * ModusBox
+ * Georgi Logodazhki <georgi.logodazhki@modusbox.com> (Original Author)
+ --------------
+ ******/
+
+const express = require('express')
+const router = new express.Router()
+const dbAdapter = require('../db/adapters/dbAdapter')
+const arrayStore = require('../arrayStore')
+const reportGenerator = require('../report-generator/generator')
+
+router.get('/reports', async (req, res, next) => {
+  try {
+    const reports = (await dbAdapter.read('reports', req.user, { query: req.query }))
+    res.status(200).send(reports)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.post('/reports', async (req, res, next) => {
+  try {
+    await dbAdapter.upsert('reports', req.body, req.user)
+    res.status(200).send()
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.get('/logs', async (req, res, next) => {
+  try {
+    const logs = (await dbAdapter.read('logs', req.user, { query: req.query }))
+    res.status(200).send(logs)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Endpoints for getting the requests to TTK and callbacks from TTK
+router.get('/requests', async (req, res, next) => {
+  try {
+    const requestsHistoryData = arrayStore.get('requestsHistory', undefined, req.user)
+    res.status(200).json((requestsHistoryData && requestsHistoryData.map(item => item.data)) || [])
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.delete('/requests', async (req, res, next) => {
+  try {
+    arrayStore.reset('requestsHistory', req.user)
+    res.status(200).send()
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.get('/callbacks', async (req, res, next) => {
+  try {
+    const callbacksHistoryData = arrayStore.get('callbacksHistory', undefined, req.user)
+    res.status(200).json((callbacksHistoryData && callbacksHistoryData.map(item => item.data)) || [])
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.delete('/callbacks', async (req, res, next) => {
+  try {
+    arrayStore.reset('callbacksHistory', req.user)
+    res.status(200).send()
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.get('/test-reports', async (req, res, next) => {
+  try {
+    const result = await dbAdapter.listReports(req.query)
+    res.status(200).send(result)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.get('/test-reports/:reportId', async (req, res, next) => {
+  try {
+    let finalReport
+    const dbResult = await dbAdapter.getReport(req.params.reportId)
+    if (!dbResult) {
+      return res.status(404).json({ error: 'Report Not Found' })
+    }
+    const jsonReport = dbResult._doc
+    if (req.query.format === 'html' || req.query.format === 'printhtml') {
+      finalReport = await reportGenerator.generateReport(jsonReport, req.query.format)
+      if (req.query.download) {
+        const downloadFileSuffix = '-' + req.params.reportId + '.html'
+        res.setHeader('Content-disposition', 'attachment; filename=TTK-Assertion-Report' + downloadFileSuffix)
+        res.setHeader('TTK-FileName', 'TTK-Assertion-Report' + downloadFileSuffix)
+      }
+    } else {
+      finalReport = jsonReport
+      if (req.query.download) {
+        const downloadFileSuffix = '-' + req.params.reportId + '.json'
+        res.setHeader('Content-disposition', 'attachment; filename=TTK-Assertion-Report' + downloadFileSuffix)
+        res.setHeader('TTK-FileName', 'TTK-Assertion-Report' + downloadFileSuffix)
+      }
+    }
+
+    res.status(200).send(finalReport)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+module.exports = router

package/src/lib/api-routes/keycloak.js

@@ -0,0 +1,54 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 Mojaloop Foundation
+ The Mojaloop files are made available by the Mojaloop 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
+ Mojaloop Foundation 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * ModusBox
+ * Georgi Logodazhki <georgi.logodazhki@modusbox.com>
+ * Vijaya Kumar Guthi <vijaya.guthi@modusbox.com> (Original Author)
+ --------------
+ ******/
+
+const express = require('express')
+const router = new express.Router()
+const KeycloakHelper = require('../oauth/KeycloakHelper')
+
+router.get('/clientinfo', async (req, res, next) => {
+  try {
+    const response = await KeycloakHelper.getClientAuthInfo(req.user)
+    res.status(200).json(response)
+  } catch (err) {
+    console.log(err)
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.post('/tokeninfo', async (req, res, next) => {
+  try {
+    const response = await KeycloakHelper.getTokenInfo(req.body)
+    res.status(200).json(response)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+module.exports = router

package/src/lib/api-routes/longpolling.js

@@ -0,0 +1,70 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 Mojaloop Foundation
+ The Mojaloop files are made available by the Mojaloop 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
+ Mojaloop Foundation 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>.
+
+ * Mojaloop Foundation
+ - Name Surname <name.surname@mojaloop.io>
+
+ * ModusBox
+ * Vijaya Kumar Guthi <vijaya.guthi@modusbox.com> (Original Author)
+ --------------
+ ******/
+
+const express = require('express')
+const objectStore = require('../objectStore')
+const longpollingEmitter = require('../longpollingEmitter')
+// const Config = require('../config')
+
+const router = new express.Router()
+// const { check, validationResult } = require('express-validator')
+
+// Method to monitor requests came to toolkit
+router.get('/requests/{*splat}', async (req, res, next) => {
+  const eventPath = req.path.replace('/requests', '')
+  try {
+    // Check if the required path is already in the assertion store
+    const storedAssertion = objectStore.popObject('requests', eventPath, req.user)
+    if (storedAssertion) {
+      res.status(200).json({ headers: storedAssertion.headers, data: storedAssertion.body })
+    } else {
+      longpollingEmitter.setAssertionStoreEmitter('requests', eventPath, res, req.user)
+    }
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Method to monitor callbacks generated by toolkit
+router.get('/callbacks/{*splat}', async (req, res, next) => {
+  const eventPath = req.path.replace('/callbacks', '')
+  try {
+    // Check if the required path is already in the assertion store
+    const storedAssertion = objectStore.popObject('callbacks', eventPath)
+    if (storedAssertion) {
+      res.status(200).json({ headers: storedAssertion.headers, data: storedAssertion.body })
+    } else {
+      longpollingEmitter.setAssertionStoreEmitter('callbacks', eventPath, res, req.user)
+    }
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+module.exports = router