ml-testing-toolkit 18.13.0

package/src/lib/importExport.js

@@ -0,0 +1,186 @@
+/*****
+ 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 { rmdirAsync } = require('./utils')
+const AdmZip = require('adm-zip')
+const Config = require('./config')
+const { Engine } = require('json-rules-engine')
+const CONFIG_FILE_NAME = 'config.json'
+const storageAdapter = require('./storageAdapter')
+
+const exportSpecFiles = async (ruleTypes, user) => {
+  const zip = new AdmZip()
+
+  for (const index in ruleTypes) {
+    const ruleType = ruleTypes[index]
+    if (user) {
+      if (ruleType.endsWith('.json')) {
+        const filename = `spec_files/${ruleType}`
+        const document = await storageAdapter.read(filename, user)
+        zip.addFile(filename, Buffer.from(JSON.stringify(document.data)))
+      } else {
+        const filename = `spec_files/${ruleType}/`
+        const documents = await storageAdapter.read(filename, user)
+        for (const index in documents) {
+          const id = filename + documents[index]
+          const document = await storageAdapter.read(id, user)
+          zip.addFile(id, Buffer.from(JSON.stringify(document.data)))
+        }
+      }
+    } else {
+      if (ruleType.endsWith('.json')) {
+        const filename = `spec_files/${ruleType}`
+        zip.addLocalFile(filename)
+      } else {
+        const filename = `spec_files/${ruleType}/`
+        zip.addLocalFolder(filename, ruleType)
+      }
+    }
+  }
+  return {
+    namePrefix: ruleTypes.length > 1 ? 'spec_files' : ruleTypes[0],
+    buffer: zip.toBuffer()
+  }
+}
+
+const validateRules = (entryName, ruleType, ruleVersion, rules) => {
+  const engine = new Engine()
+  rules.forEach(rule => {
+    if (rule.type !== ruleType) {
+      throw new Error(`validation error: rule ${rule.ruleId} in ${entryName} should be of type ${ruleType}`)
+    }
+    if (rule.version > ruleVersion) {
+      throw new Error(`validation error: rule ${rule.ruleId} in ${entryName} version should at most ${ruleVersion}`)
+    }
+    try {
+      engine.addRule(rule)
+    } catch (err) {
+      throw new Error(`validation error: rule ${rule.ruleId} in ${entryName} is not valid: ${err.message}`)
+    }
+  })
+}
+
+const validateInputData = (zipEntries, options) => {
+  const entries = []
+  zipEntries.forEach((zipEntry) => {
+    const entryName = zipEntry.entryName
+    const entryData = JSON.parse(zipEntry.getData().toString('utf-8'))
+    entries.push({
+      name: entryName,
+      data: entryData
+    })
+    const element = entryName.split('/')[0]
+    if (options.includes(element)) {
+      switch (element) {
+        case 'rules_response': {
+          if (entryName !== `rules_response/${CONFIG_FILE_NAME}`) {
+            validateRules(entryName, 'response', Config.getSystemConfig().CONFIG_VERSIONS.response, entryData)
+          }
+          break
+        }
+        case 'rules_validation': {
+          if (entryName !== `rules_validation/${CONFIG_FILE_NAME}`) {
+            validateRules(entryName, 'validation', Config.getSystemConfig().CONFIG_VERSIONS.validation, entryData)
+          }
+          break
+        }
+        case 'rules_callback': {
+          if (entryName !== `rules_callback/${CONFIG_FILE_NAME}`) {
+            validateRules(entryName, 'callback', Config.getSystemConfig().CONFIG_VERSIONS.callback, entryData)
+          }
+          break
+        }
+        case 'user_config.json': {
+          const userSettingsVersion = Config.getSystemConfig().CONFIG_VERSIONS.userSettings
+          if (entryData.VERSION > userSettingsVersion) {
+            throw new Error(`validation error: user_config.json version ${entryData.VERSION} not supproted be at most ${userSettingsVersion}`)
+          }
+          break
+        }
+      }
+    }
+  })
+  return entries
+}
+
+const extractData = async (zip, options, entries, user) => {
+  for (const index in options) {
+    if (user) {
+      for (const index in entries) {
+        const id = entries[index].name
+        const data = entries[index].data
+        await storageAdapter.upsert(id, data, user)
+      }
+    } else {
+      const option = options[index]
+      if (option === 'user_config.json') {
+        zip.extractEntryTo(option, 'spec_files', false, true)
+      } else {
+        let deleted = false
+        for (const index in entries) {
+          const entry = entries[index].name
+          if (entry.startsWith(option)) {
+            if (!deleted) {
+              await rmdirAsync(`spec_files/${option}`, { recursive: true })
+              deleted = true
+            }
+            zip.extractEntryTo(entry, `spec_files/${option}`, false)
+          }
+        }
+      }
+    }
+  }
+}
+
+const importSpecFiles = async (data, options, user) => {
+  const zip = new AdmZip(Buffer.from(data))
+  const entries = validateInputData(zip.getEntries(), options)
+  await extractData(zip, options, entries, user)
+}
+
+const exportSpecFile = async (filepath, user) => {
+  const filename = `spec_files/${filepath}`
+  const document = await storageAdapter.read(filename, user)
+  const documentBuffer = Buffer.from(JSON.stringify(document.data))
+  return {
+    buffer: documentBuffer
+  }
+}
+
+const importSpecFile = async (data, filePath, user) => {
+  const dataBuffer = JSON.parse(Buffer.from(data).toString())
+  await storageAdapter.upsert(`spec_files/${filePath}`, dataBuffer, user)
+}
+
+module.exports = {
+  exportSpecFiles,
+  importSpecFiles,
+  exportSpecFile,
+  importSpecFile
+}

package/src/lib/jws/JwsSigning.js

@@ -0,0 +1,141 @@
+/*****
+ 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 config = {}
+
+const Config = require('../config')
+const { Jws } = require('@mojaloop/sdk-standard-components')
+const ConnectionProvider = require('../configuration-providers/mb-connection-manager')
+const atob = require('atob')
+
+const validate = async (req) => {
+  const userConfig = await Config.getUserConfig()
+  if (userConfig.VALIDATE_INBOUND_JWS) {
+    if (req.method === 'get') {
+      return false
+    }
+    if (req.method === 'put' && req.path.startsWith('/parties/') && !userConfig.VALIDATE_INBOUND_PUT_PARTIES_JWS) {
+      return false
+    }
+
+    const certificate = await ConnectionProvider.getUserDfspJWSCerts(req.headers['fspiop-source'])
+    return validateWithCert(req.headers, req.payload, certificate)
+  }
+}
+
+const validateWithCert = (headers, body, certificate) => {
+  const reqOpts = {
+    headers,
+    body,
+    resolveWithFullResponse: true,
+    simple: false
+  }
+  const keys = {}
+  keys[headers['fspiop-source']] = certificate
+
+  const jwsValidator = new Jws.validator({ // eslint-disable-line
+    validationKeys: keys
+  })
+
+  try {
+    jwsValidator.validate(reqOpts)
+    return true
+  } catch (err) {
+    throw new Error(err.toString())
+  }
+}
+
+const validateProtectedHeaders = (headers) => {
+  if (!headers['fspiop-signature']) {
+    throw new Error('fspiop-signature is missing in the headers')
+  }
+  const { protectedHeader } = JSON.parse(headers['fspiop-signature'])
+  const decodedProtectedHeader = JSON.parse(atob(protectedHeader))
+  const jwsValidator = new Jws.validator({ // eslint-disable-line
+    validationKeys: []
+  })
+  jwsValidator._validateProtectedHeader(headers, decodedProtectedHeader)
+  return true
+}
+
+const sign = async (req) => {
+  const userConfig = await Config.getUserConfig()
+  if (userConfig.JWS_SIGN) {
+    if (req.method === 'get') {
+      return false
+    }
+
+    if (req.method === 'put' && req.path.startsWith('/parties/') && !userConfig.JWS_SIGN_PUT_PARTIES) {
+      return false
+    }
+    const jwsSigningKey = await ConnectionProvider.getTestingToolkitDfspJWSPrivateKey()
+    return signWithKey(req, jwsSigningKey)
+  }
+}
+
+const signWithKey = (req, jwsSigningKey) => {
+  const jwsSigner = new Jws.signer({ // eslint-disable-line
+    signingKey: jwsSigningKey
+  })
+  const reqOpts = {
+    method: req.method,
+    uri: req.url,
+    headers: req.headers,
+    body: JSON.stringify(req.data),
+    agent: 'testingtoolkit',
+    resolveWithFullResponse: true,
+    simple: false
+  }
+  if (reqOpts.headers['FSPIOP-Source']) {
+    reqOpts.headers['fspiop-source'] = reqOpts.headers['FSPIOP-Source']
+    delete reqOpts.headers['FSPIOP-Source']
+  }
+  if (reqOpts.headers['FSPIOP-Destination']) {
+    reqOpts.headers['fspiop-destination'] = reqOpts.headers['FSPIOP-Destination']
+    delete reqOpts.headers['FSPIOP-Destination']
+  }
+  delete reqOpts.headers['FSPIOP-Signature']
+  delete reqOpts.headers['FSPIOP-URI']
+  delete reqOpts.headers['FSPIOP-HTTP-Method']
+
+  try {
+    jwsSigner.sign(reqOpts)
+    return true
+  } catch (err) {
+    throw new Error(err.toString())
+  }
+}
+
+module.exports = {
+  validate,
+  validateWithCert,
+  validateProtectedHeaders,
+  sign,
+  signWithKey
+}

package/src/lib/loadSamples.js

@@ -0,0 +1,128 @@
+/*****
+ 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 { readFileAsync, readRecursiveAsync, fileStatAsync } = require('./utils')
+const fs = require('fs')
+
+// load collections or environments
+const getCollectionsOrEnvironments = async (exampleType, type) => {
+  const data = await readRecursiveAsync(`examples/${exampleType}/${type || ''}`)
+  return data.filter(filename => filename.endsWith('.json'))
+}
+
+// load collections or environments with file sizes
+const getCollectionsOrEnvironmentsWithFileSize = async (exampleType, type) => {
+  const dir = `examples/${exampleType}/${type || ''}`
+  const data = await readRecursiveAsync(dir)
+  const jsonFileList = data.filter(filename => filename.endsWith('.json'))
+  const jsonFileListWithFileSize = jsonFileList.map(file => {
+    return {
+      name: file,
+      size: fs.statSync(file).size
+    }
+  })
+  return jsonFileListWithFileSize
+}
+
+// load samples content
+const getSample = async (queryParams) => {
+  const collections = []
+  if (queryParams.collections) {
+    for (const i in queryParams.collections) {
+      const collection = await readFileAsync(queryParams.collections[i], 'utf8')
+      collections.push(JSON.parse(collection))
+    }
+  }
+  const sample = {
+    name: null,
+    options: null,
+    inputValues: null,
+    test_cases: null
+  }
+
+  if (queryParams.environment) {
+    const envContent = JSON.parse(await readFileAsync(queryParams.environment, 'utf8'))
+    sample.inputValues = envContent.inputValues
+    sample.options = envContent.options
+  }
+
+  if (collections.length > 1) {
+    sample.name = 'multi'
+    sample.test_cases = []
+    let index = 1
+    collections.forEach(collection => {
+      collection.test_cases.forEach(testCase => {
+        const { id, ...remainingTestCaseProps } = testCase
+        sample.test_cases.push({
+          id: index++,
+          ...remainingTestCaseProps
+        })
+      })
+    })
+  } else if (collections.length === 1) {
+    sample.name = collections[0].name
+    sample.test_cases = collections[0].test_cases
+  }
+  return sample
+}
+
+// load samples content
+const getSampleWithFolderWise = async (queryParams) => {
+  const collections = []
+  if (queryParams.collections) {
+    for (const i in queryParams.collections) {
+      const fileContent = await readFileAsync(queryParams.collections[i], 'utf8')
+      const fileStat = await fileStatAsync(queryParams.collections[i])
+      // collections.push(JSON.parse(collection))
+      collections.push({
+        name: queryParams.collections[i],
+        path: queryParams.collections[i],
+        size: fileStat.size,
+        modified: fileStat.mtime,
+        content: JSON.parse(fileContent)
+      })
+    }
+  }
+
+  let environment = {}
+  if (queryParams.environment) {
+    environment = JSON.parse(await readFileAsync(queryParams.environment, 'utf8')).inputValues
+  }
+
+  return {
+    collections,
+    environment
+  }
+}
+
+module.exports = {
+  getCollectionsOrEnvironments,
+  getCollectionsOrEnvironmentsWithFileSize,
+  getSample,
+  getSampleWithFolderWise
+}

package/src/lib/logger.js

@@ -0,0 +1,20 @@
+const { loggerFactory, LOG_LEVELS } = require('@mojaloop/sdk-standard-components').Logger
+const { hostname } = require('node:os')
+
+const createLogger = (conf = {}) => {
+  const {
+    context = {
+      hostname: hostname()
+    },
+    isJsonOutput = false
+  } = conf
+
+  return loggerFactory({ context, isJsonOutput })
+}
+
+const logger = createLogger() // global logger
+
+module.exports = {
+  logger,
+  LOG_LEVELS
+}

package/src/lib/longpollingEmitter.js

@@ -0,0 +1,56 @@
+/*****
+ 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 MyEventEmitter = require('./MyEventEmitter')
+const objectStore = require('./objectStore')
+
+const LONGPOLLING_TIMEOUT = 5000
+
+const setAssertionStoreEmitter = (storedObject, eventPath, res, user) => {
+  let emitterType
+  switch (storedObject) {
+    case 'requests': emitterType = 'assertionRequest'; break
+    case 'callbacks': emitterType = 'assertionCallback'; break
+  }
+  const emitter = MyEventEmitter.getEmitter(emitterType, user)
+  const timer = setTimeout(() => {
+    emitter.removeAllListeners(eventPath)
+    res.status(500).json({ error: 'Timed out' })
+  }, LONGPOLLING_TIMEOUT)
+
+  emitter.once(eventPath, (data) => {
+    clearTimeout(timer)
+    objectStore.popObject(storedObject, eventPath, user)
+    res.status(200).json(data)
+  })
+}
+
+module.exports = {
+  setAssertionStoreEmitter
+}

package/src/lib/metrics.js

@@ -0,0 +1,51 @@
+const Metrics = require('@mojaloop/central-services-metrics')
+
+module.exports = function metricsMiddleware (config = {}) {
+  Metrics.getDefaultRegister().clear()
+  Metrics.setup({
+    timeout: 5000,
+    defaultLabels: {},
+    ...config
+  })
+
+  const client = Metrics.getClient()
+  const assertSuccess = new client.Counter({
+    name: 'assert_success_total',
+    help: 'Successful assertions',
+    labelNames: ['request', 'test']
+  })
+  const assertFail = new client.Counter({
+    name: 'assert_fail_total',
+    help: 'Failed assertions',
+    labelNames: ['request', 'test']
+  })
+  const testSuccess = new client.Counter({
+    name: 'test_success_total',
+    help: 'Successful tests',
+    labelNames: ['template']
+  })
+  const testFail = new client.Counter({
+    name: 'test_fail_total',
+    help: 'Failed tests',
+    labelNames: ['template']
+  })
+
+  const metrics = {
+    assertSuccess: { add (value, labels) { assertSuccess.inc(labels, value) } },
+    assertFail: { add (value, labels) { assertFail.inc(labels, value) } },
+    testSuccess: { add (value, labels) { testSuccess.inc(labels, value) } },
+    testFail: { add (value, labels) { testFail.inc(labels, value) } }
+  }
+
+  return (req, res, next) => {
+    if (req.url === '/metrics') {
+      res.set('Content-Type', 'text/plain; version=0.0.4')
+      Metrics.getMetricsForPrometheus().then(metrics => {
+        res.send(metrics)
+      })
+    } else {
+      req.metrics = metrics
+      next()
+    }
+  }
+}

package/src/lib/mocking/custom-functions/generic.js

@@ -0,0 +1,57 @@
+/*****
+ 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 { monotonicFactory } = require('ulidx')
+
+const generateUUID = () => {
+  const uuid = require('uuid')
+  return uuid.v4()
+}
+
+const curDate = () => {
+  return (new Date()).toUTCString()
+}
+
+const curDateISO = () => {
+  return (new Date()).toISOString()
+}
+
+const generateULID = monotonicFactory()
+
+const generateID = (options) => {
+  return options.generateIDType === 'uuid' ? generateUUID() : generateULID()
+}
+
+module.exports = {
+  generateUUID,
+  generateULID,
+  generateID,
+  curDate,
+  curDateISO
+}