ml-testing-toolkit 18.13.0

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

@@ -0,0 +1,149 @@
+/*****
+ 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 jwt = require('jsonwebtoken')
+const { verifyUser } = require('../api-server')
+const Config = require('../config')
+const LoginService = require('../oauth/LoginService')
+
+router.post('/login', async (req, res, next) => {
+  try {
+    const response = await LoginService.loginUser(req.body.username, req.body.password, req, res)
+    res.status(200).json(response)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.get('/logout', verifyUser(), async (req, res, next) => {
+  try {
+    await LoginService.logoutUser(req, res)
+    res.status(200).json({ message: 'logout successful' })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.post('/token', async (req, res, next) => {
+  try {
+    const plainIdToken = {
+      username: req.body.username,
+      dfspId: req.body.username,
+      userguid: 'userguid'
+    }
+    let groupsData = [
+      'Application/MTA',
+      'Application/DFSP:' + req.body.username,
+      'Internal/everyone'
+    ]
+    const systemConfig = Config.getSystemConfig()
+    if (req.body.username === systemConfig.CONNECTION_MANAGER.HUB_USERNAME) {
+      groupsData = [
+        'Application/PTA',
+        'Internal/everyone'
+      ]
+    } else if (systemConfig.HOSTING_ENABLED) {
+      // Check whether the DFSP exists in mock list
+      const dfspDB = require('../db/dfspMockUsers')
+      const dfspValid = await dfspDB.checkDFSP(req.body.username)
+      if (!dfspValid) {
+        throw (new Error('Invalid DFSP ID'))
+      }
+    }
+    const expiresIn = 3600
+    const iat = Date.now() / 1000
+    const plainAccessToken = {
+      exp: iat + expiresIn,
+      iat,
+      aud: systemConfig.OAUTH.APP_OAUTH_CLIENT_KEY,
+      sub: plainIdToken.username,
+      iss: systemConfig.OAUTH.OAUTH2_ISSUER,
+      groups: groupsData,
+      dfspId: plainIdToken.dfspId,
+      userguid: plainIdToken.userguid
+    }
+    res.status(200).json({
+      expires_in: expiresIn,
+      access_token: jwt.sign(plainAccessToken, systemConfig.OAUTH.EMBEDDED_CERTIFICATE),
+      id_token: jwt.sign(plainIdToken, systemConfig.OAUTH.EMBEDDED_CERTIFICATE)
+    })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// router.post('/token', async (req, res, next) => {
+//   try {
+//     let userDfspId = 'userdfsp'
+//     if (Config.getSystemConfig().HOSTING_ENABLED) {
+//       // Check whether the DFSP exists in mock list
+//       const dfspDB = require('../db/dfspMockUsers')
+//       const dfspValid = await dfspDB.checkDFSP(req.body.username)
+//       if (!dfspValid) {
+//         throw (new Error('Invalid DFSP ID'))
+//       }
+//       userDfspId = req.body.username
+//     }
+//     const idToken = jwt.sign(
+//       {
+//         at_hash: 'bJi28CeD9HLPf1ouOVkQTA',
+//         aud: 'CLIENT_KEY',
+//         sub: 'dfsp1',
+//         nbf: 1558709500,
+//         azp: 'CLIENT_KEY',
+//         amr: [
+//           'password'
+//         ],
+//         iss: 'https://SERVERIP:9443/oauth2/token',
+//         groups: [
+//           'Application/MTA',
+//           'Application/DFSP:DFSP1',
+//           'Internal/everyone'
+//         ],
+//         exp: 1558713100,
+//         iat: 1558709500,
+//         dfspId: userDfspId,
+//         userguid: 'userguid'
+//       }
+//       , 'password')
+//     res.status(200).json(
+//       {
+//         access_token: 'sometoken',
+//         id_token: idToken
+//       }
+//     )
+//   } catch (err) {
+//     res.status(500).json({ error: err && err.message })
+//   }
+// })
+
+module.exports = router

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

@@ -0,0 +1,53 @@
+/*****
+ 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 objectStore = require('../objectStore')
+
+// Get runtime and stored user config
+router.get('/:object', async (req, res, next) => {
+  try {
+    const object = objectStore.get(req.params.object, undefined, req.user)
+    res.status(200).json(object)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.delete('/:object', async (req, res, next) => {
+  try {
+    objectStore.set(req.params.object, {}, req.user)
+    res.status(200).json({})
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+module.exports = router

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

@@ -0,0 +1,224 @@
+/*****
+ 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 router = new express.Router()
+const utils = require('../utils')
+const multer = require('multer')
+const upload = multer({ dest: 'uploads/' })
+const APIManagement = require('../api-management')
+
+router.get('/api_versions', async (req, res, next) => {
+  try {
+    const apiDefinitions = await require('../mocking/openApiDefinitionsModel').getApiDefinitions()
+
+    if (apiDefinitions) {
+      res.status(200).json(apiDefinitions.map(item => {
+        return item
+      }))
+    } else {
+      res.status(404).json({ error: 'Can not read API versions' })
+    }
+  } catch (err) {
+    // next(err)
+    res.status(404).json({ error: err && err.message })
+  }
+})
+
+router.get('/definition/:type/:version', async (req, res, next) => {
+  try {
+    const openApiObjects = require('../mocking/openApiMockHandler').getOpenApiObjects()
+    const reqVersionArr = req.params.version.split('.')
+    const apiType = req.params.type
+
+    const reqOpenApiObject = openApiObjects.find((item) => {
+      if (item.majorVersion === +reqVersionArr[0] && item.minorVersion === +reqVersionArr[1] && item.type === apiType) {
+        return true
+      } else {
+        return false
+      }
+    })
+    if (reqOpenApiObject) {
+      res.status(200).json(reqOpenApiObject.openApiBackendObject.definition)
+    } else {
+      res.status(404).json({ error: 'Unknown Version' })
+    }
+  } catch (err) {
+    // next(err)
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.post('/definition', upload.single('file'), async (req, res, next) => {
+  const regex = /^([0-9]+)\.([0-9]+)$/
+  if (!regex.test(req.body.version)) {
+    return res.status(422).json({ errors: ['Version should be in the format x.x'] })
+  }
+  if (req.file) {
+    try {
+      await APIManagement.addDefinition(req.file.path, req.body.name, req.body.version, req.body.asynchronous)
+      // Remove temporary file
+      try { await utils.deleteFileAsync(req.file.path) } catch (err2) {}
+      res.status(200).json({ message: 'API has been added successfully', fileName: req.file })
+    } catch (err) {
+      try { await utils.deleteFileAsync(req.file.path) } catch (err2) {}
+      res.status(404).json({ error: 'Unknown format', message: err.message })
+    }
+  } else {
+    res.status(404).json({ error: 'File not found' })
+  }
+})
+
+router.delete('/definition/:type/:version', async (req, res, next) => {
+  const apiType = req.params.type
+  const apiVersion = req.params.version
+  try {
+    await APIManagement.deleteDefinition(apiType, apiVersion)
+    res.status(200).json({ message: 'API has been removed successfully' })
+  } catch (err) {
+    console.log(err)
+    res.status(404).json({ error: 'Unknown format', message: err.message })
+  }
+})
+
+router.put('/definition/:type/:version', async (req, res, next) => {
+  const apiType = req.params.type
+  const apiVersion = req.params.version
+  try {
+    await APIManagement.patchDefinitionParams(apiType, apiVersion, req.body)
+    res.status(200).json({ message: 'API parameters have been modified successfully' })
+  } catch (err) {
+    console.log(err)
+    res.status(404).json({ error: 'Unknown error', message: err.message })
+  }
+})
+
+router.post('/validate_definition', upload.single('file'), async (req, res, next) => {
+  if (req.file) {
+    try {
+      const document = await APIManagement.validateDefinition(req.file.path)
+      // Remove temporary file
+      try { await utils.deleteFileAsync(req.file.path) } catch (err2) {}
+      res.status(200).json({ apiDefinition: document, fileName: req.file })
+    } catch (err) {
+      try { await utils.deleteFileAsync(req.file.path) } catch (err2) {}
+      res.status(404).json({ error: 'Unknown format', message: err.message })
+    }
+  } else {
+    res.status(404).json({ error: 'File not found' })
+  }
+})
+
+router.get('/callback_map/:type/:version', async (req, res, next) => {
+  try {
+    const apiDefinitions = await require('../mocking/openApiDefinitionsModel').getApiDefinitions()
+    const reqVersionArr = req.params.version.split('.')
+    const apiType = req.params.type
+
+    const reqApiDefinition = apiDefinitions.find((item) => {
+      if (item.majorVersion === +reqVersionArr[0] && item.minorVersion === +reqVersionArr[1] && item.type === apiType) {
+        return true
+      } else {
+        return false
+      }
+    })
+    if (reqApiDefinition) {
+      try {
+        const rawdata = await utils.readFileAsync(reqApiDefinition.callbackMapFile)
+        const reqCallbackMap = JSON.parse(rawdata)
+
+        res.status(200).json(reqCallbackMap)
+      } catch (err) {
+        res.status(404).json({ error: 'Unknown Version' })
+      }
+    } else {
+      res.status(404).json({ error: 'Unknown Version' })
+    }
+  } catch (err) {
+    // next(err)
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.put('/callback_map/:type/:version', async (req, res, next) => {
+  try {
+    const apiDefinitions = await require('../mocking/openApiDefinitionsModel').getApiDefinitions()
+    const reqVersionArr = req.params.version.split('.')
+    const apiType = req.params.type
+
+    const reqApiDefinition = apiDefinitions.find((item) => {
+      if (item.majorVersion === +reqVersionArr[0] && item.minorVersion === +reqVersionArr[1] && item.type === apiType) {
+        return true
+      } else {
+        return false
+      }
+    })
+    if (reqApiDefinition) {
+      await utils.writeFileAsync(reqApiDefinition.callbackMapFile, JSON.stringify(req.body, null, 2))
+      res.status(200).json({})
+    } else {
+      res.status(404).json({ error: 'Unknown Version' })
+    }
+  } catch (err) {
+    // next(err)
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.get('/response_map/:type/:version', async (req, res, next) => {
+  try {
+    const apiDefinitions = await require('../mocking/openApiDefinitionsModel').getApiDefinitions()
+    const reqVersionArr = req.params.version.split('.')
+    const apiType = req.params.type
+
+    const reqApiDefinition = apiDefinitions.find((item) => {
+      if (item.majorVersion === +reqVersionArr[0] && item.minorVersion === +reqVersionArr[1] && item.type === apiType) {
+        return true
+      } else {
+        return false
+      }
+    })
+    if (reqApiDefinition) {
+      try {
+        const rawdata = await utils.readFileAsync(reqApiDefinition.responseMapFile)
+        const reqResponseMap = JSON.parse(rawdata)
+        res.status(200).json(reqResponseMap)
+      } catch (err) {
+        res.status(404).json({ error: 'Unknown Version' })
+      }
+    } else {
+      res.status(404).json({ error: 'Unknown Version' })
+    }
+  } catch (err) {
+    // next(err)
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+module.exports = router

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

@@ -0,0 +1,134 @@
+/*****
+ 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 axios = require('axios').default
+const Config = require('../config')
+const customLogger = require('../requestLogger')
+const outbound = require('../test-outbound/outbound-initiator')
+const { check, validationResult } = require('express-validator')
+
+// Route to send a single outbound request
+router.post('/request', [
+  check('method').notEmpty(),
+  check('path').notEmpty()
+],
+async (req, res, next) => {
+  const errors = validationResult(req)
+  if (!errors.isEmpty()) {
+    return res.status(422).json({ errors: errors.array() })
+  }
+  try {
+    axios({
+      method: req.body.method,
+      url: req.body.url ? req.body.url : (await Config.getUserConfig(req.user)).CALLBACK_ENDPOINT + req.body.path,
+      headers: req.body.headers,
+      data: req.body.body,
+      timeout: 3000,
+      validateStatus: (status) => {
+        return status < 900 // Reject only if the status code is greater than or equal to 900
+      }
+    }).then((result) => {
+      customLogger.logMessage('info', 'Received response ' + result.status + ' ' + result.statusText, { additionalData: result.data, notification: false, user: req.user })
+    }, (err) => {
+      customLogger.logMessage('info', 'Failed to send request ' + req.body.method + ' ' + req.body.path, { additionalData: err, notification: false, user: req.user })
+    })
+    res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to send series of outbound requests based on the given template
+router.post('/template/:traceID', [
+  check('name').notEmpty(),
+  check('test_cases').notEmpty()
+], async (req, res, next) => {
+  try {
+    const errors = validationResult(req)
+    if (!errors.isEmpty()) {
+      return res.status(422).json({ errors: errors.array() })
+    }
+    const traceID = req.params.traceID
+    const inputJson = JSON.parse(JSON.stringify(req.body))
+    // TODO: Change the following value to the dfspId based on the login incase HOSTING_ENABLED
+    const dfspId = req.user ? req.user.dfspId : null
+    if (req.query?.sync === 'true') {
+      const result = await outbound.OutboundSend(inputJson, traceID, dfspId, true, req.metrics)
+      return res.status(200).json(result)
+    } else {
+      outbound.OutboundSend(inputJson, traceID, dfspId, false, req.metrics)
+      return res.status(200).json({ status: 'OK' })
+    }
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.post('/template_iterations/:traceID', [
+  check('name').notEmpty(),
+  check('iterationCount').notEmpty(),
+  check('test_cases').notEmpty()
+], async (req, res, next) => {
+  try {
+    const errors = validationResult(req)
+    if (!errors.isEmpty()) {
+      return res.status(422).json({ errors: errors.array() })
+    }
+    if (+req.query.iterationCount === 0) {
+      throw new Error('Iteration count is zero')
+    }
+    const traceID = req.params.traceID
+    const inputJson = JSON.parse(JSON.stringify(req.body))
+    // TODO: Change the following value to the dfspId based on the login incase HOSTING_ENABLED
+    const dfspId = req.user ? req.user.dfspId : null
+    outbound.OutboundSendLoop(inputJson, traceID, dfspId, req.query.iterationCount)
+
+    return res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to terminate the given execution
+router.delete('/template/:traceID', async (req, res, next) => {
+  try {
+    const traceID = req.params.traceID
+    outbound.terminateOutbound(traceID)
+
+    return res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+module.exports = router

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

@@ -0,0 +1,72 @@
+/*****
+ 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 router = new express.Router()
+// const { check, validationResult } = require('express-validator')
+const reportGenerator = require('../report-generator/generator')
+
+// Generate report
+router.post('/testcase/:format', async (req, res, next) => {
+  const jsonReport = req.body
+  const format = req.params.format
+  let downloadFileSuffix = '.html'
+
+  if (jsonReport.runtimeInformation) {
+    downloadFileSuffix = '-' + jsonReport.runtimeInformation.completedTimeISO + downloadFileSuffix
+  }
+  downloadFileSuffix = '-' + jsonReport.name + downloadFileSuffix
+  try {
+    const result = await reportGenerator.generateReport(jsonReport, format)
+    res.setHeader('Content-disposition', 'attachment; filename=TTK-Assertion-Report' + downloadFileSuffix)
+    res.setHeader('TTK-FileName', 'TTK-Assertion-Report' + downloadFileSuffix)
+    res.status(200).send(result)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Generate report
+router.post('/testcase_definition/:format', async (req, res, next) => {
+  const template = req.body
+  const format = req.params.format
+  let downloadFileSuffix = '.html'
+
+  downloadFileSuffix = '-' + template.name + downloadFileSuffix
+  try {
+    const result = await reportGenerator.generateTestcaseDefinition(template, format)
+    res.setHeader('Content-disposition', 'attachment; filename=TTK-Testcase-Definition' + downloadFileSuffix)
+    res.setHeader('TTK-FileName', 'TTK-Testcase-Definition' + downloadFileSuffix)
+    res.status(200).send(result)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+module.exports = router