ml-testing-toolkit 18.13.0

package/src/lib/mocking/middleware-functions/ilpModel.js

@@ -0,0 +1,238 @@
+/*****
+ 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 { ilpFactory, ILP_VERSIONS } = require('@mojaloop/sdk-standard-components').Ilp
+const customLogger = require('../../requestLogger')
+const { logger } = require('../../logger')
+
+let ilpObj = null
+let ilpV4Obj = null
+
+const init = (secret) => {
+  ilpObj = ilpFactory(ILP_VERSIONS.v1, { secret, logger })
+  ilpV4Obj = ilpFactory(ILP_VERSIONS.v4, { secret, logger })
+}
+
+// ILP Packet inclusion functions
+const handleQuoteIlp = (context, response) => {
+  // Check whether the request is POST /quotes
+  const pathMatch = /\/quotes\/([^/]+)$/
+  if (context.request.method === 'post' && response.method === 'put' && pathMatch.test(response.path)) {
+    if (response.eventInfo && response.eventInfo.params && response.eventInfo.params.body &&
+      (response.eventInfo.params.body.ilpPacket || response.eventInfo.params.body.condition)
+    ) {
+      return null
+    }
+    // const transactionObject = {
+    //   mockData: 'This is a test data from self testing toolkit'
+    // }
+    let transactionObject
+    if (!_isIso20022(context.request)) {
+      transactionObject = {
+        transactionId: context.request.body.transactionId,
+        quoteId: context.request.body.quoteId,
+        payee: context.request.body.payee,
+        payer: context.request.body.payer,
+        amount: response.body.transferAmount,
+        transactionType: context.request.body.transactionType,
+        expiration: response.body.expiration,
+        note: response.body.note
+      }
+    } else {
+      const payeePartyIdType = context.request.body.CdtTrfTxInf.Cdtr.Id.OrgId?.Othr.Id ||
+        context.request.body.CdtTrfTxInf.Cdtr.Id.PrvtId?.Othr.Id
+      const payeePartyIdentifier = context.request.body.CdtTrfTxInf.Cdtr.Id.OrgId?.Othr.SchmeNm.Prtry ||
+        context.request.body.CdtTrfTxInf.Cdtr.Id.PrvtId?.Othr.SchmeNm.Prtry
+      const payerPartyIdType = context.request.body.CdtTrfTxInf.Dbtr.Id.OrgId?.Othr.Id ||
+        context.request.body.CdtTrfTxInf.Dbtr.Id.PrvtId?.Othr.Id
+      const payerPartyIdentifier = context.request.body.CdtTrfTxInf.Dbtr.Id.OrgId?.Othr.SchmeNm.Prtry ||
+        context.request.body.CdtTrfTxInf.Dbtr.Id.PrvtId?.Othr.SchmeNm.Prtry
+      transactionObject = {
+        transactionId: context.request.body.CdtTrfTxInf.PmtId.EndToEndId,
+        quoteId: context.request.body.CdtTrfTxInf.PmtId.TxId,
+        payee: {
+          partyIdInfo: {
+            partyIdType: payeePartyIdType,
+            partyIdentifier: payeePartyIdentifier,
+            fspId: context.request.body.CdtTrfTxInf.CdtrAgt.FinInstnId.Othr.Id
+          }
+        },
+        payer: {
+          partyIdInfo: {
+            partyIdType: payerPartyIdType,
+            partyIdentifier: payerPartyIdentifier,
+            fspId: context.request.body.CdtTrfTxInf.DbtrAgt.FinInstnId.Othr.Id
+          }
+        },
+        amount: {
+          currency: context.request.body.CdtTrfTxInf.IntrBkSttlmAmt.Ccy,
+          amount: context.request.body.CdtTrfTxInf.IntrBkSttlmAmt.ActiveCurrencyAndAmount
+        },
+        transactionType: context.request.body.GrpHdr?.CdtTrfTxInf?.Purp?.Prtry || null,
+        expiration: response.body.GrpHdr?.PmtInstrXpryDtTm,
+        note: context.request.body.CdtTrfTxInf?.InstrForNxtAgt?.InstrInf || null
+      }
+    }
+
+    let fulfilment
+    if (!_isIso20022(response)) {
+      const ilpResult = ilpObj.getResponseIlp(transactionObject)
+      fulfilment = ilpResult.fulfilment
+      response.body.ilpPacket = ilpResult.ilpPacket
+      response.body.condition = ilpResult.condition
+    } else {
+      const ilpResult = ilpV4Obj.getResponseIlp(transactionObject)
+      fulfilment = ilpResult.fulfilment
+      response.body.CdtTrfTxInf.VrfctnOfTerms = {
+        IlpV4PrepPacket: ilpResult.ilpPacket
+      }
+    }
+    return fulfilment
+  }
+  return null
+}
+
+const handleTransferIlp = (context, response) => {
+  // Check whether the request is POST /transfers
+  const pathMatch = /\/transfers\/([^/]+)$/
+  if (context.request.method === 'post' && response.method === 'put' && pathMatch.test(response.path)) {
+    if (
+      response.eventInfo && response.eventInfo.params && response.eventInfo.params.body &&
+      (
+        response.eventInfo.params.body.fulfilment ||
+        (response.eventInfo.params.body.TxInfAndSts && response.eventInfo.params.body.TxInfAndSts.ExctnConf)
+      )
+    ) {
+      return null
+    }
+    if (context.request.body.ilpPacket) {
+      const generatedFulfilment = ilpObj.calculateFulfil(context.request.body.ilpPacket).replace('"', '')
+      response.body.fulfilment = generatedFulfilment
+    }
+    if (context.request.body.CdtTrfTxInf?.VrfctnOfTerms?.IlpV4PrepPacket) {
+      const generatedFulfilment = ilpV4Obj.calculateFulfil(context.request.body.CdtTrfTxInf.VrfctnOfTerms.IlpV4PrepPacket).replace('"', '')
+      response.body.TxInfAndSts.ExctnConf = generatedFulfilment
+    }
+  }
+  if (context.request.method === 'get' && response.method === 'put' && pathMatch.test(response.path)) {
+    delete response.body.fulfilment
+  }
+}
+
+// Validation Functions
+
+// Check the contents of ILP Packet against the values from body
+const validateTransferIlpPacket = (context, request) => {
+  if (request.method === 'post' && request.path === '/transfers') {
+    customLogger.logMessage('info', 'Validating Ilp packet against the transfer request', { request })
+    try {
+      let validationBody
+      if (!_isIso20022(request)) {
+        validationBody = request.payload
+        return ilpObj.validateIlpAgainstTransferRequest(validationBody)
+      } else {
+        validationBody = {
+          payeeFsp: request.payload.CdtTrfTxInf.CdtrAgt.FinInstnId.Othr.Id,
+          payerFsp: request.payload.CdtTrfTxInf.DbtrAgt.FinInstnId.Othr.Id,
+          amount: {
+            currency: request.payload.CdtTrfTxInf.IntrBkSttlmAmt.Ccy,
+            amount: request.payload.CdtTrfTxInf.IntrBkSttlmAmt.ActiveCurrencyAndAmount
+          },
+          ilpPacket: request.payload.CdtTrfTxInf.VrfctnOfTerms.IlpV4PrepPacket
+        }
+        return ilpV4Obj.validateIlpAgainstTransferRequest(validationBody)
+      }
+    } catch (err) {
+      customLogger.logMessage('error', 'Failed to validate the Ilp packet. Error: ' + err.message, { request })
+      return false
+    }
+  }
+  return true
+}
+
+// Check the condition is matched with fulfilment stored
+const validateTransferCondition = (context, request) => {
+  if (request.method === 'post' && request.path === '/transfers') {
+    let fulfilment = null
+    if (request.customInfo.storedTransaction && request.customInfo.storedTransaction.fulfilment) {
+      fulfilment = request.customInfo.storedTransaction.fulfilment
+      customLogger.logMessage('info', 'Validating condition with the stored fulfilment', { request })
+    } else {
+      try {
+        if (request.payload.ilpPacket) {
+          fulfilment = ilpObj.calculateFulfil(request.payload.ilpPacket).replace('"', '')
+        } else if (request.payload.CdtTrfTxInf) {
+          fulfilment = ilpV4Obj.calculateFulfil(request.payload.CdtTrfTxInf.VrfctnOfTerms.IlpV4PrepPacket).replace('"', '')
+        }
+        customLogger.logMessage('info', 'Validating condition with the generated fulfilment', { request })
+      } catch (err) {
+        customLogger.logMessage('error', 'Failed to calculate the fulfilment. Error: ' + err.message, { request })
+        return false
+      }
+    }
+    let condition
+    if (!_isIso20022(request)) {
+      condition = request.payload?.condition
+    } else {
+      // Construct the ILP object from the request payload
+      // since ISO20022 expect the condition in the ilpPacket
+      condition = ilpV4Obj.getResponseIlp(ilpV4Obj.getTransactionObject(request.payload.CdtTrfTxInf.VrfctnOfTerms.IlpV4PrepPacket)).condition
+    }
+    try {
+      if (!_isIso20022(request)) {
+        return ilpObj.validateFulfil(fulfilment, condition)
+      } else {
+        return ilpV4Obj.validateFulfil(fulfilment, condition)
+      }
+    } catch (err) {
+      customLogger.logMessage('error', 'Failed to validate the fulfilment. Error: ' + err.message, { request })
+      return false
+    }
+  }
+  return true
+}
+
+// Decoding functions
+
+const getIlpTransactionObject = (ilpPacket, isIso20022) => {
+  return isIso20022 ? ilpV4Obj.getTransactionObject(ilpPacket) : ilpObj.getTransactionObject(ilpPacket)
+}
+
+const _isIso20022 = (requestOrResponse) => {
+  return requestOrResponse.body?.CdtTrfTxInf || requestOrResponse.payload?.CdtTrfTxInf
+}
+
+module.exports = {
+  init,
+  handleQuoteIlp,
+  handleTransferIlp,
+  validateTransferIlpPacket,
+  validateTransferCondition,
+  getIlpTransactionObject
+}

package/src/lib/mocking/middleware-functions/quotesAssociation.js

@@ -0,0 +1,75 @@
+/*****
+ 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 ObjectStore = require('../../objectStore')
+const IlpModel = require('./ilpModel')
+
+const handleQuotes = (context, request, fulfilment = null) => {
+  // Check whether the request is POST /quotes
+  if (request.method === 'post' && request.path === '/quotes') {
+    // Save the Transaction ID in object store
+    if (request.payload.CdtTrfTxInf?.PmtId?.EndToEndId) {
+      ObjectStore.push('transactions', request.payload.CdtTrfTxInf.PmtId.EndToEndId, { fulfilment })
+    }
+    if (request.payload.transactionId) {
+      ObjectStore.push('transactions', request.payload.transactionId, { fulfilment })
+    }
+  }
+}
+
+const handleTransfers = (context, request) => {
+  // Check whether the request is POST /transfers
+  if (request.method === 'post' && request.path === '/transfers') {
+    let ilpTransactionObject
+    try {
+      ilpTransactionObject = IlpModel.getIlpTransactionObject(
+        request.payload.ilpPacket ||
+        request.payload.CdtTrfTxInf?.VrfctnOfTerms?.IlpV4PrepPacket,
+        !!request.payload.CdtTrfTxInf?.VrfctnOfTerms?.IlpV4PrepPacket
+      )
+    } catch (err) {
+      return false
+    }
+    // Search for the Transaction ID in object store - delete it if found
+    const storedTransaction = ObjectStore.popObject('transactions', ilpTransactionObject.transactionId)
+    if (storedTransaction) {
+      request.customInfo.storedTransaction = storedTransaction
+    } else {
+      // Transaction not found, throw error callback
+      return false
+    }
+  }
+
+  return true
+}
+
+module.exports = {
+  handleQuotes,
+  handleTransfers
+}

package/src/lib/mocking/middleware-functions/transactionRequestsService.js

@@ -0,0 +1,78 @@
+/*****
+ 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 fs = require('fs')
+const { promisify } = require('util')
+const readFileAsync = promisify(fs.readFile)
+const outbound = require('../../test-outbound/outbound-initiator')
+const { TraceHeaderUtils } = require('@mojaloop/ml-testing-toolkit-shared-lib')
+const customLogger = require('../../requestLogger')
+
+const handleRequest = async (context, request, callback, triggerFolder) => {
+  // Check whether the request is POST /transactionRequests
+  if (request.method === 'post' && request.path === '/transactionRequests') {
+    if (callback.body.transactionRequestState === 'RECEIVED') {
+      const transactionRequest = request.payload
+      try {
+        const contents = await readFileAsync(triggerFolder + '/transaction_request_followup.json')
+        const outboundTemplate = JSON.parse(contents)
+        // Replace the input values in the template with inbound transactionRequest params
+        outboundTemplate.inputValues.TrsNote = transactionRequest.note
+        outboundTemplate.inputValues.TrsCurrency = transactionRequest.amount.currency
+        outboundTemplate.inputValues.TrsAmount = transactionRequest.amount.amount
+        outboundTemplate.inputValues.TrsPayerIdType = transactionRequest.payer.partyIdType
+        outboundTemplate.inputValues.TrsPayerIdValue = transactionRequest.payer.partyIdentifier
+        outboundTemplate.inputValues.TrsPayerFspId = transactionRequest.payer.fspId
+        outboundTemplate.inputValues.TrsPayeeIdType = transactionRequest.payee.partyIdInfo.partyIdType
+        outboundTemplate.inputValues.TrsPayeeIdValue = transactionRequest.payee.partyIdInfo.partyIdentifier
+        outboundTemplate.inputValues.TrsPayeeFspId = transactionRequest.payee.partyIdInfo.fspId
+        outboundTemplate.inputValues.TrsScenario = transactionRequest.transactionType.scenario
+        outboundTemplate.inputValues.TrsInitiator = transactionRequest.transactionType.initiator
+        outboundTemplate.inputValues.TrsInitiatorType = transactionRequest.transactionType.initiatorType
+        outboundTemplate.inputValues.TrsTransactionRequestId = transactionRequest.transactionRequestId
+
+        // Replace the transaction ID from the generated callback
+        outboundTemplate.inputValues.transactionId = callback.body.transactionId
+        if (request.customInfo.sessionID) {
+          outbound.OutboundSend(outboundTemplate, TraceHeaderUtils.getTraceIdPrefix() + request.customInfo.sessionID + '0000', callback.fspId)
+        } else {
+          outbound.OutboundSend(outboundTemplate, null, callback.fspId)
+        }
+      } catch (err) {
+        customLogger.logMessage('error', err.message, err, { notification: false })
+      }
+    }
+  }
+
+  return true
+}
+
+module.exports = {
+  handleRequest
+}

package/src/lib/mocking/openApiDefinitionsModel.js

@@ -0,0 +1,64 @@
+/*****
+ 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 = require('../config')
+let apiDefinitions = null
+const specFilePrefix = require('../utils').resolve('spec_files/api_definitions') + '/'
+
+const getApiDefinitions = async () => {
+  if (!apiDefinitions) {
+    refreshApiDefinitions()
+  }
+  return apiDefinitions
+}
+
+const refreshApiDefinitions = async () => {
+  apiDefinitions = Config.getSystemConfig().API_DEFINITIONS.map(item => {
+    return {
+      minorVersion: +item.version.split('.')[1],
+      majorVersion: +item.version.split('.')[0],
+      type: item.type,
+      caption: item.caption,
+      asynchronous: item.asynchronous,
+      prefix: item.prefix,
+      hostnames: item.hostnames,
+      additionalApi: item.additionalApi,
+      specFile: specFilePrefix + item.folderPath + '/api_spec.yaml',
+      callbackMapFile: specFilePrefix + item.folderPath + '/callback_map.json',
+      responseMapFile: specFilePrefix + item.folderPath + '/response_map.json',
+      jsfRefFile: specFilePrefix + item.folderPath + '/mockRef.json',
+      triggerTemplatesFolder: specFilePrefix + item.folderPath + '/trigger_templates'
+    }
+  })
+}
+
+module.exports = {
+  getApiDefinitions,
+  refreshApiDefinitions
+}