ml-testing-toolkit 18.13.0

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

@@ -0,0 +1,356 @@
+/*****
+ 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 importExport = require('../importExport')
+const rulesEngineModel = require('../rulesEngineModel')
+
+const router = new express.Router()
+
+// Validation Rules
+// Get all validation rules files
+router.get('/files/validation', async (req, res, next) => {
+  try {
+    const result = await rulesEngineModel.getValidationRulesFiles(req.user)
+    res.status(200).json(result)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to get content of a validation rule file
+router.get('/files/validation/:fileName', async (req, res, next) => {
+  const fileName = req.params.fileName
+  try {
+    const result = await rulesEngineModel.getValidationRulesFileContent(fileName, req.user)
+    res.status(200).json(result)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to edit a validation rule file
+router.put('/files/validation/:fileName', async (req, res, next) => {
+  const fileName = req.params.fileName
+
+  try {
+    await rulesEngineModel.setValidationRulesFileContent(fileName, req.body, req.user)
+    res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to delete a validation rule file
+router.delete('/files/validation/:fileName', async (req, res, next) => {
+  const fileName = req.params.fileName
+
+  try {
+    await rulesEngineModel.deleteValidationRulesFile(fileName, req.user)
+    res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to modify configuration in validation rules
+router.put('/files/validation', async (req, res, next) => {
+  const reqType = req.body.type
+  try {
+    switch (reqType) {
+      case 'activeRulesFile':
+        await rulesEngineModel.setActiveValidationRulesFile(req.body.fileName, req.user)
+        res.status(200).json({ status: 'OK' })
+        break
+      default:
+        throw (new Error('Unknown update type'))
+    }
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Callback Rules
+// Get all callback rules files
+router.get('/files/callback', async (req, res, next) => {
+  try {
+    const result = await rulesEngineModel.getCallbackRulesFiles(req.user)
+    res.status(200).json(result)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to get content of a callback rule file
+router.get('/files/callback/:fileName', async (req, res, next) => {
+  const fileName = req.params.fileName
+
+  try {
+    const result = await rulesEngineModel.getCallbackRulesFileContent(fileName, req.user)
+    res.status(200).json(result)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to edit a callback rule file
+router.put('/files/callback/:fileName', async (req, res, next) => {
+  const fileName = req.params.fileName
+
+  try {
+    await rulesEngineModel.setCallbackRulesFileContent(fileName, req.body, req.user)
+    res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to delete a callback rule file
+router.delete('/files/callback/:fileName', async (req, res, next) => {
+  const fileName = req.params.fileName
+
+  try {
+    await rulesEngineModel.deleteCallbackRulesFile(fileName, req.user)
+    res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to modify configuration in callback rules
+router.put('/files/callback', async (req, res, next) => {
+  const reqType = req.body.type
+  try {
+    switch (reqType) {
+      case 'activeRulesFile':
+        await rulesEngineModel.setActiveCallbackRulesFile(req.body.fileName, req.user)
+        res.status(200).json({ status: 'OK' })
+        break
+      default:
+        throw (new Error('Unknown update type'))
+    }
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Response Rules
+// Get all response rules files
+router.get('/files/response', async (req, res, next) => {
+  try {
+    const result = await rulesEngineModel.getResponseRulesFiles(req.user)
+    res.status(200).json(result)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to get content of a response rule file
+router.get('/files/response/:fileName', async (req, res, next) => {
+  const fileName = req.params.fileName
+
+  try {
+    const result = await rulesEngineModel.getResponseRulesFileContent(fileName, req.user)
+    res.status(200).json(result)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to edit a response rule file
+router.put('/files/response/:fileName', async (req, res, next) => {
+  const fileName = req.params.fileName
+
+  try {
+    await rulesEngineModel.setResponseRulesFileContent(fileName, req.body, req.user)
+    res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to delete a response rule file
+router.delete('/files/response/:fileName', async (req, res, next) => {
+  const fileName = req.params.fileName
+
+  try {
+    await rulesEngineModel.deleteResponseRulesFile(fileName, req.user)
+    res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to modify configuration in response rules
+router.put('/files/response', async (req, res, next) => {
+  const reqType = req.body.type
+  try {
+    switch (reqType) {
+      case 'activeRulesFile':
+        await rulesEngineModel.setActiveResponseRulesFile(req.body.fileName, req.user)
+        res.status(200).json({ status: 'OK' })
+        break
+      default:
+        throw (new Error('Unknown update type'))
+    }
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Forward Rules
+// Get all forward rules files
+router.get('/files/forward', async (req, res, next) => {
+  try {
+    const result = await rulesEngineModel.getForwardRulesFiles(req.user)
+    res.status(200).json(result)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to get content of a forward rule file
+router.get('/files/forward/:fileName', async (req, res, next) => {
+  const fileName = req.params.fileName
+  try {
+    const result = await rulesEngineModel.getForwardRulesFileContent(fileName, req.user)
+    res.status(200).json(result)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to edit a forward rule file
+router.put('/files/forward/:fileName', async (req, res, next) => {
+  const fileName = req.params.fileName
+
+  try {
+    await rulesEngineModel.setForwardRulesFileContent(fileName, req.body, req.user)
+    res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to delete a callback rule file
+router.delete('/files/forward/:fileName', async (req, res, next) => {
+  const fileName = req.params.fileName
+
+  try {
+    await rulesEngineModel.deleteForwardRulesFile(fileName, req.user)
+    res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to modify configuration in forward rules
+router.put('/files/forward', async (req, res, next) => {
+  const reqType = req.body.type
+  try {
+    switch (reqType) {
+      case 'activeRulesFile':
+        await rulesEngineModel.setActiveForwardRulesFile(req.body.fileName, req.user)
+        res.status(200).json({ status: 'OK' })
+        break
+      default:
+        throw (new Error('Unknown update type'))
+    }
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+router.get('/files/response/:fileName/export', async (req, res, next) => {
+  try {
+    const fileName = req.params.fileName
+    const path = `rules_response/${fileName}`
+    const resp = await importExport.exportSpecFile(path, req.user)
+    res.status(200).json({ status: 'OK', body: resp })
+  } catch (err) {
+    res.status(404).json({ error: err && err.message })
+  }
+})
+
+router.post('/files/response/import', async (req, res, next) => {
+  try {
+    const path = `rules_response/${req.query.rulesFilename}`
+    await importExport.importSpecFile(req.body.buffer, path, req.user)
+    await rulesEngineModel.reloadResponseRules(req.user)
+    res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    res.status(400).send(err.message)
+  }
+})
+
+router.get('/files/callback/:fileName/export', async (req, res, next) => {
+  try {
+    const fileName = req.params.fileName
+    const path = `rules_callback/${fileName}`
+    const resp = await importExport.exportSpecFile(path, req.user)
+    res.status(200).json({ status: 'OK', body: resp })
+  } catch (err) {
+    res.status(404).json({ error: err && err.message })
+  }
+})
+
+router.post('/files/callback/import', async (req, res, next) => {
+  try {
+    const path = `rules_callback/${req.query.rulesFilename}`
+    await importExport.importSpecFile(req.body.buffer, path, req.user)
+    await rulesEngineModel.reloadCallbackRules(req.user)
+    res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    res.status(400).send(err.message)
+  }
+})
+
+router.get('/files/validation/:fileName/export', async (req, res, next) => {
+  try {
+    const fileName = req.params.fileName
+    const path = `rules_validation/${fileName}`
+    const resp = await importExport.exportSpecFile(path, req.user)
+    res.status(200).json({ status: 'OK', body: resp })
+  } catch (err) {
+    res.status(404).json({ error: err && err.message })
+  }
+})
+
+router.post('/files/validation/import', async (req, res, next) => {
+  try {
+    const path = `rules_validation/${req.query.rulesFilename}`
+    await importExport.importSpecFile(req.body.buffer, path, req.user)
+    await rulesEngineModel.reloadValidationRules(req.user)
+    res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    res.status(400).send(err.message)
+  }
+})
+
+module.exports = router

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

@@ -0,0 +1,92 @@
+/*****
+ 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 loadSamples = require('../loadSamples')
+const Config = require('../config')
+
+const router = new express.Router()
+
+const filterDFSPSamples = (files) => {
+  if (Config.getSystemConfig().HOSTING_ENABLED) {
+    return files.filter(file => file.name.startsWith('examples/collections/dfsp') || file.name.startsWith('examples/environments/dfsp'))
+  }
+  return files
+}
+
+// Route to load a sample
+// query param 'collections': list of filenames
+// query param 'environment': filename
+router.get('/load', async (req, res, next) => {
+  try {
+    const files = await loadSamples.getSample(req.query)
+    return res.status(200).json({ status: 'OK', body: files })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to load a sample in folder structure format
+// query param 'collections': list of filenames
+router.get('/loadFolderWise', async (req, res, next) => {
+  try {
+    const files = await loadSamples.getSampleWithFolderWise(req.query)
+    console.log('/loadFolderWise', files)
+    return res.status(200).json({ status: 'OK', body: files })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to get root filenames
+// uri param 'exampleType': supported values: 'collections', 'environments'
+// query param 'type': examples: 'hub', 'dfsp'
+router.get('/load/:exampleType', async (req, res, next) => {
+  try {
+    const filenames = await loadSamples.getCollectionsOrEnvironments(req.params.exampleType, req.query.type)
+    console.log('/load/:exampleType', filenames)
+    return res.status(200).json({ status: 'OK', body: filenames })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+// Route to get root filenames with file size
+// uri param 'exampleType': supported values: 'collections', 'environments'
+// query param 'type': examples: 'hub', 'dfsp'
+router.get('/list/:exampleType', async (req, res, next) => {
+  try {
+    const fileList = filterDFSPSamples(await loadSamples.getCollectionsOrEnvironmentsWithFileSize(req.params.exampleType, req.query.type))
+    return res.status(200).json({ status: 'OK', body: fileList })
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+module.exports = router

package/src/lib/api-routes/server-logs.js

@@ -0,0 +1,44 @@
+/*****
+ 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
+ * Steven Oderayi <steven.oderayi@modusbox.com> (Original Author)
+ --------------
+ ******/
+
+const express = require('express')
+const router = new express.Router()
+const serverLogs = require('../server-logs')
+
+router.get('/search', async (req, res, next) => {
+  try {
+    let results = []
+    if (Object.keys(req.query).length) results = await serverLogs.search({ query: req.query })
+    res.status(200).send(results)
+  } catch (err) {
+    res.status(500).json({ error: err && err.message })
+  }
+})
+
+module.exports = router

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

@@ -0,0 +1,71 @@
+/*****
+ 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 Config = require('../config')
+const importExport = require('../importExport')
+const RulesEngineModel = require('../rulesEngineModel')
+
+// export and import from spec files
+
+router.get('/export', async (req, res, next) => {
+  try {
+    if (!req.query || !req.query.options) {
+      res.status(400).send('options query param is required')
+    } else {
+      const resp = await importExport.exportSpecFiles(req.query.options, req.user)
+      res.status(200).json({ status: 'OK', body: resp })
+    }
+  } catch (err) {
+    // next(err)
+    res.status(404).json({ error: err && err.message })
+  }
+})
+
+router.post('/import', async (req, res, next) => {
+  try {
+    const options = req.query.options
+    await importExport.importSpecFiles(req.body.buffer, options, req.user)
+    for (const index in options) {
+      switch (options[index]) {
+        case 'rules_response': await RulesEngineModel.reloadResponseRules(req.user); break
+        case 'rules_callback': await RulesEngineModel.reloadCallbackRules(req.user); break
+        case 'rules_validation': await RulesEngineModel.reloadValidationRules(req.user); break
+        case 'user_config.json': await Config.loadUserConfig(req.user); break
+      }
+    }
+    res.status(200).json({ status: 'OK' })
+  } catch (err) {
+    res.status(400).send(err.message)
+    // next(err)
+  }
+})
+
+module.exports = router