ml-testing-toolkit 18.13.0

package/src/lib/report-generator/generator.js

@@ -0,0 +1,126 @@
+/*****
+ 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 Handlebars = require('handlebars')
+const { readFileAsync } = require('../utils')
+const reportHelpers = require('./helpers')
+const customLogger = require('../requestLogger')
+const BASE_TEMPLATE_PATH = 'spec_files/reports/templates'
+
+const testResultTemplates = {
+  html: {
+    file: 'html_template.html',
+    handle: null
+  },
+  pdf: {
+    file: 'pdf_template.html',
+    handle: null
+  }
+}
+
+const testcaseDefinitionTemplates = {
+  html: {
+    file: 'table_view.html',
+    handle: null
+  }
+}
+
+const _initializeTestReports = async () => {
+  for (const key of Object.keys(testResultTemplates)) {
+    const templateContent = await readFileAsync(BASE_TEMPLATE_PATH + '/newman/' + testResultTemplates[key].file)
+    testResultTemplates[key].handle = Handlebars.compile(templateContent.toString())
+    customLogger.logMessage('debug', key + ' template compiled')
+  }
+}
+
+const _initializeTestcaseDefinition = async () => {
+  for (const key of Object.keys(testcaseDefinitionTemplates)) {
+    const templateContent = await readFileAsync(BASE_TEMPLATE_PATH + '/testcase_definition/' + testcaseDefinitionTemplates[key].file)
+    testcaseDefinitionTemplates[key].handle = Handlebars.compile(templateContent.toString())
+    customLogger.logMessage('debug', key + ' template compiled')
+  }
+}
+
+const initialize = async () => {
+  customLogger.logMessage('info', 'Initializing Report Generator...')
+  await _initializeTestReports()
+  await _initializeTestcaseDefinition()
+}
+
+const generateReport = async (jsonReport, format) => {
+  let templateHandle = testResultTemplates.html.handle
+  if (format === 'pdf' || format === 'printhtml') {
+    templateHandle = testResultTemplates.pdf.handle
+  }
+
+  if (templateHandle) {
+    try {
+      const data = jsonReport
+      const options = {
+        helpers: reportHelpers
+      }
+      const result = templateHandle(data, options)
+      customLogger.logMessage('debug', 'Report generated in ' + format + ' format')
+      return result
+    } catch (err) {
+      customLogger.logMessage('error', 'Error in generating template: ' + err.message)
+      throw (err)
+    }
+  } else {
+    customLogger.logMessage('error', 'No template generator found for ' + format)
+    throw (new Error('No template generator found for ' + format))
+  }
+}
+
+const generateTestcaseDefinition = async (template, format) => {
+  const templateHandle = testcaseDefinitionTemplates.html.handle
+
+  if (templateHandle) {
+    try {
+      const data = template
+      const options = {
+        // helpers: reportHelpers
+      }
+      const result = templateHandle(data, options)
+      customLogger.logMessage('debug', 'Report generated in ' + format + ' format')
+      return result
+    } catch (err) {
+      customLogger.logMessage('error', 'Error in generating template: ' + err.message)
+      throw (err)
+    }
+  } else {
+    customLogger.logMessage('error', 'No template generator found for ' + format)
+    throw (new Error('No template generator found for ' + format))
+  }
+}
+
+module.exports = {
+  initialize,
+  generateReport,
+  generateTestcaseDefinition
+}

package/src/lib/report-generator/helpers.js

@@ -0,0 +1,154 @@
+/*****
+ 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 now = () => {
+  return new Date().toLocaleDateString()
+}
+
+const totalAssertions = (testCases) => {
+  return testCases.reduce((total, curTestCase) => {
+    const assertionsInRequest = curTestCase.requests.reduce((assertionCountRequest, curRequest) => {
+      return assertionCountRequest + ((curRequest.request.tests && curRequest.request.tests.assertions) ? curRequest.request.tests.assertions.length : 0)
+    }, 0)
+    return total + assertionsInRequest
+  }, 0)
+}
+
+const totalPassedAssertions = (testCases) => {
+  return testCases.reduce((total, curTestCase) => {
+    const passedAssertionsInRequest = curTestCase.requests.reduce((passedAssertionCountRequest, curRequest) => {
+      return passedAssertionCountRequest + ((curRequest.request.tests && curRequest.request.tests.passedAssertionsCount) ? curRequest.request.tests.passedAssertionsCount : 0)
+    }, 0)
+    return total + passedAssertionsInRequest
+  }, 0)
+}
+
+const totalFailedAssertions = (testCases) => {
+  return totalAssertions(testCases) - totalPassedAssertions(testCases)
+}
+
+const totalTestCases = (testCases) => {
+  return testCases.length
+}
+
+const failedTestCases = (testCases) => {
+  return testCases.reduce((total, curTestCase) => {
+    const assertionsInRequest = curTestCase.requests.reduce((assertionCountRequest, curRequest) => {
+      return assertionCountRequest + ((curRequest.request.tests && curRequest.request.tests.assertions) ? curRequest.request.tests.assertions.length : 0)
+    }, 0)
+    const passedAssertionsInRequest = curTestCase.requests.reduce((passedAssertionCountRequest, curRequest) => {
+      return passedAssertionCountRequest + ((curRequest.request.tests && curRequest.request.tests.passedAssertionsCount) ? curRequest.request.tests.passedAssertionsCount : 0)
+    }, 0)
+    return total + (passedAssertionsInRequest === assertionsInRequest ? 0 : 1)
+  }, 0)
+}
+
+const totalRequests = (testCases) => {
+  return testCases.reduce((total, curTestCase) => {
+    return total + curTestCase.requests.length
+  }, 0)
+}
+
+const failedRequests = (testCases) => {
+  return testCases.reduce((total, curTestCase) => {
+    const faileRequestsCount = curTestCase.requests.reduce((failedRequestCountTemp, curRequest) => {
+      return failedRequestCountTemp + ((curRequest.request.tests && curRequest.request.tests.assertions) ? (curRequest.request.tests.assertions.length === curRequest.request.tests.passedAssertionsCount ? 0 : 1) : 0)
+    }, 0)
+    return total + faileRequestsCount
+  }, 0)
+}
+
+const testPassPercentage = (tests) => {
+  if (tests && tests.assertions) {
+    return Math.round(tests.passedAssertionsCount * 100 / tests.assertions.length)
+  } else {
+    return 100
+  }
+}
+
+const ifAllTestsPassedInRequest = (request) => {
+  if (request.tests && request.tests.assertions) {
+    return request.tests.passedAssertionsCount === request.tests.assertions.length
+  } else {
+    return true
+  }
+}
+
+const ifFailedTestCase = (testCase) => {
+  const failedRequest = testCase.requests.find((item) => {
+    if (item.request.tests && item.request.tests.assertions) {
+      return item.request.tests.passedAssertionsCount !== item.request.tests.assertions.length
+    } else {
+      return false
+    }
+  })
+  if (failedRequest) {
+    return true
+  } else {
+    return false
+  }
+}
+
+const ifSkippedRequest = (status) => {
+  if (status && status === 'SKIPPED') {
+    return true
+  } else {
+    return false
+  }
+}
+
+const jsonStringify = (inputObject) => {
+  return JSON.stringify(inputObject, null, 2)
+}
+
+const isAssertionPassed = (status) => {
+  return status === 'SUCCESS'
+}
+
+const isAssertionSkipped = (status) => {
+  return status === 'SKIPPED'
+}
+
+module.exports = {
+  now,
+  totalAssertions,
+  totalPassedAssertions,
+  totalFailedAssertions,
+  totalTestCases,
+  failedTestCases,
+  totalRequests,
+  failedRequests,
+  testPassPercentage,
+  ifAllTestsPassedInRequest,
+  ifFailedTestCase,
+  jsonStringify,
+  isAssertionPassed,
+  isAssertionSkipped,
+  ifSkippedRequest
+}

package/src/lib/requestLogger.js

@@ -0,0 +1,190 @@
+/*****
+ 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)
+ --------------
+ ******/
+
+'use strict'
+
+const util = require('node:util')
+const Logger = require('@mojaloop/central-services-logger')
+const Config = require('./config')
+const NotificationEmitter = require('./notificationEmitter')
+const DBAdapter = require('./db/adapters/dbAdapter')
+const { TraceHeaderUtils } = require('@mojaloop/ml-testing-toolkit-shared-lib')
+
+const logRequest = async (request, user) => {
+  let message = `Request: ${request.method} ${request.path}`
+  if (request.body) {
+    message += ` Body: ${request.body}`
+  }
+  const userConfig = await Config.getUserConfig()
+  logMessage('info', message, {
+    additionalData: {
+      request: {
+        uniqueId: request.customInfo ? request.customInfo.uniqueId : null,
+        headers: request.headers,
+        queryParams: request.query,
+        body: userConfig.MONITORING_LOG_INCLUDE_PAYLOAD ? request.payload : 'Payload is hidden - enable it in user-config MONITORING_LOG_INCLUDE_PAYLOAD'
+      }
+    },
+    user,
+    request,
+    messageType: 'request'
+  })
+}
+
+const logOutboundRequest = (verbosity, message, externalData = {}) => {
+  externalData.notificationType = 'newOutboundLog'
+
+  if (externalData.request.headers && externalData.request.headers.traceparent) {
+    const traceparentHeaderArr = externalData.request.headers.traceparent.split('-')
+    if (traceparentHeaderArr.length > 1) {
+      const traceID = traceparentHeaderArr[1]
+      if (!externalData.request.customInfo) {
+        externalData.request.customInfo = {}
+      }
+      externalData.request.customInfo.traceID = traceID
+      if (TraceHeaderUtils.isCustomTraceID(traceID)) {
+        externalData.request.customInfo.endToEndID = TraceHeaderUtils.getEndToEndID(traceID)
+        externalData.request.customInfo.sessionID = TraceHeaderUtils.getSessionID(traceID)
+      }
+    }
+  }
+
+  if (externalData.additionalData) {
+    if (externalData.additionalData.request) {
+      externalData.additionalData.request = {
+        url: externalData.additionalData.request.url,
+        uniqueId: externalData.uniqueId,
+        headers: externalData.additionalData.request.headers,
+        queryParams: externalData.additionalData.request.query,
+        body: externalData.additionalData.request.payload || externalData.additionalData.request.data
+      }
+    } else if (externalData.additionalData.response) {
+      const response = externalData.additionalData.response
+      externalData.additionalData.response = {
+        status: response.status,
+        statusText: response.statusText,
+        uniqueId: externalData.uniqueId,
+        headers: response.headers,
+        body: response.payload || response.data
+      }
+    }
+  }
+  logMessage(verbosity, message, externalData)
+}
+
+const logResponse = async (request, user) => {
+  if (request.response) {
+    const message = `Response: ${request.method} ${request.path} Status: ${request.response.statusCode}`
+    const userConfig = await Config.getUserConfig()
+    logMessage('info', message, {
+      additionalData: {
+        response: {
+          uniqueId: request.customInfo.uniqueId || null,
+          body: userConfig.MONITORING_LOG_INCLUDE_PAYLOAD ? request.response.source : 'Payload is hidden - enable it in user-config MONITORING_LOG_INCLUDE_PAYLOAD',
+          status: request.response.statusCode
+        }
+      },
+      user,
+      request,
+      messageType: 'response'
+    })
+  }
+}
+
+const logMessage = (verbosity, message, externalData = {}) => {
+  const data = {
+    additionalData: externalData.additionalData,
+    notification: typeof externalData.notification !== 'undefined' ? externalData.notification : true,
+    messageType: externalData.messageType || 'generic',
+    request: externalData.request || null,
+    user: externalData.user
+  }
+  switch (verbosity) {
+    case 'debug':
+      Logger.debug(message)
+      if (data.additionalData !== undefined) Logger.debug(util.inspect(data.additionalData))
+      break
+    case 'warn':
+      Logger.warn(message)
+      if (data.additionalData !== undefined) Logger.warn(util.inspect(data.additionalData))
+      break
+    case 'error':
+      Logger.error(message)
+      if (data.additionalData !== undefined) Logger.error(util.inspect(data.additionalData))
+      break
+    case 'info':
+    default: {
+      Logger.info(message)
+      if (data.additionalData !== undefined) Logger.info(util.inspect(data.additionalData))
+    }
+  }
+
+  if (data.notification) {
+    const log = {
+      uniqueId: externalData.uniqueId || ((data.request && data.request.customInfo) ? data.request.customInfo.uniqueId : null),
+      traceID: externalData.traceID || ((data.request && data.request.customInfo) ? data.request.customInfo.traceID : null),
+      resource: externalData.resource || (data.request ? { method: data.request.method, path: data.request.path } : null),
+      messageType: data.messageType,
+      notificationType: externalData.notificationType || 'newLog',
+      verbosity,
+      message,
+      additionalData: data.additionalData,
+      logTime: new Date()
+    }
+
+    let sessionID
+    const hostingEnabled = Config.getSystemConfig().HOSTING_ENABLED
+    if (hostingEnabled) {
+      if (!data.user && data.request && data.request.customInfo) {
+        data.user = data.request.customInfo.user
+      }
+      sessionID = data.user ? data.user.dfspId : null
+    } else {
+      sessionID = data.request && data.request.customInfo ? data.request.customInfo.sessionID : null
+    }
+
+    if (log.notificationType === 'newOutboundLog') {
+      NotificationEmitter.broadcastOutboundLog(log, sessionID)
+    } else {
+      NotificationEmitter.broadcastLog(log, sessionID)
+    }
+
+    if (hostingEnabled && data.user) {
+      DBAdapter.upsert('logs', log, data.user)
+    }
+  }
+}
+
+module.exports = {
+  logRequest,
+  logOutboundRequest,
+  logResponse,
+  logMessage
+}

package/src/lib/resources/wso2carbon-publickey.cert

@@ -0,0 +1,20 @@
+-----BEGIN CERTIFICATE-----
+MIIDSTCCAjGgAwIBAgIEAoLQ/TANBgkqhkiG9w0BAQsFADBVMQswCQYDVQQGEwJV
+UzELMAkGA1UECBMCQ0ExFjAUBgNVBAcTDU1vdW50YWluIFZpZXcxDTALBgNVBAoT
+BFdTTzIxEjAQBgNVBAMTCWxvY2FsaG9zdDAeFw0xNzA3MTkwNjUyNTFaFw0yNzA3
+MTcwNjUyNTFaMFUxCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDQTEWMBQGA1UEBxMN
+TW91bnRhaW4gVmlldzENMAsGA1UEChMEV1NPMjESMBAGA1UEAxMJbG9jYWxob3N0
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAluZFdW1ynitztkWLC6xK
+egbRWxky+5P0p4ShYEOkHs30QI2VCuR6Qo4Bz5rTgLBrky03W1GAVrZxuvKRGj9V
+9+PmjdGtau4CTXu9pLLcqnruaczoSdvBYA3lS9a7zgFU0+s6kMl2EhB+rk7gXluE
+ep7lIOenzfl2f6IoTKa2fVgVd3YKiSGsyL4tztS70vmmX121qm0sTJdKWP4HxXyq
+K9neolXI9fYyHOYILVNZ69z/73OOVhkh/mvTmWZLM7GM6sApmyLX6OXUp8z0pkY+
+vT/9+zRxxQs7GurC4/C1nK3rI/0ySUgGEafO1atNjYmlFN+M3tZX6nEcA6g94Iav
+yQIDAQABoyEwHzAdBgNVHQ4EFgQUtS8kIYxQ8UVvVrZSdgyide9OHxUwDQYJKoZI
+hvcNAQELBQADggEBABfk5mqsVUrpFCYTZZhOxTRRpGXqoW1G05bOxHxs42Paxw8r
+AJ06Pty9jqM1CgRPpqvZa2lPQBQqZrHkdDE06q4NG0DqMH8NT+tNkXBe9YTre3EJ
+CSfsvswtLVDZ7GDvTHKojJjQvdVCzRj6XH5Truwefb4BJz9APtnlyJIvjHk1hdoz
+qyOniVZd0QOxLAbcdt946chNdQvCm6aUOputp8Xogr0KBnEy3U8es2cAfNZaEkPU
+8Va5bU6Xjny8zGQnXCXxPKp7sMpgO93nPBt/liX1qfyXM7xEotWoxmm6HZx8oWQ8
+U5aiXjZ5RKDWCCq4ZuXl6wVsUz1iE61suO5yWi8=
+-----END CERTIFICATE-----

package/src/lib/rulesEngine.js

@@ -0,0 +1,95 @@
+/*****
+ 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 { Engine } = require('json-rules-engine')
+const customLogger = require('./requestLogger')
+
+class RulesEngine {
+  constructor (config) {
+    this.config = config
+    this.init()
+  }
+
+  init () {
+    this.engine = new Engine()
+    this._addCustomOperators()
+  }
+
+  _addCustomOperators () {
+    this.engine.addOperator('numberStringLessThanInclusive', (a, b) => Number(a) <= b)
+    this.engine.addOperator('numberStringGreaterThanInclusive', (a, b) => Number(a) >= b)
+    this.engine.addOperator('numericEqual', (a, b) => Number(a) === Number(b))
+    this.engine.addOperator('numericNotEqual', (a, b) => Number(a) !== Number(b))
+    this.engine.addOperator('numericLessThan', (a, b) => Number(a) < Number(b))
+    this.engine.addOperator('numericGreaterThan', (a, b) => Number(a) > Number(b))
+    this.engine.addOperator('numericLessThanInclusive', (a, b) => Number(a) <= Number(b))
+    this.engine.addOperator('numericGreaterThanInclusive', (a, b) => Number(a) >= Number(b))
+    this.engine.addOperator('includesString', (a, b) => a.includes(b))
+    this.engine.addOperator('excludesString', (a, b) => !a.includes(b))
+  }
+
+  /**
+   * Loads an array of rules into the engine
+   *
+   * @param {object[]} rules - an array of rules to load into the engine
+   * @returns {undefined}
+   */
+  loadRules (rules, user) {
+    try {
+      this.init()
+      const rulesLength = rules.length
+      rules.forEach((r, index) => {
+        r.priority = rulesLength - index
+        this.engine.addRule(r)
+      })
+    } catch (err) {
+      customLogger.logMessage('error', 'Error loading rules ' + err, { notification: false })
+      throw err
+    }
+  }
+
+  /**
+   * Runs the engine to evaluate facts
+   *
+   * @async
+   * @param {Object} facts facts to evalute
+   * @returns {Promise.<Object>} response
+   */
+  async evaluate (facts) {
+    return new Promise((resolve, reject) => {
+      this.engine
+        .run(facts)
+        .then((events) => {
+          return resolve(events.events.length === 0 ? null : events.events)
+        }).catch(reject)
+    })
+  }
+}
+
+module.exports = RulesEngine