ml-testing-toolkit 18.14.4 → 18.15.1-url-handling.0

package/src/lib/api-management.js

@@ -29,7 +29,6 @@
 
 const addFormats = require('ajv-formats')
 const OpenApiBackend = require('openapi-backend').default
-const fs = require('node:fs')
 const Utils = require('./utils')
 const path = require('path')
 const Config = require('./config')
@@ -38,24 +37,9 @@ const OpenApiMockHandler = require('./mocking/openApiMockHandler')
 
 const apiDefinitionsPath = 'spec_files/api_definitions/'
 
-// check if the file contains URL and return it instead of the file name
-const checkUrl = async fileName => {
-  const buffer = Buffer.alloc(10)
-  const fileHandle = await fs.promises.open(fileName, 'r')
-  try {
-    await fileHandle.read(buffer, 0, 10, 0)
-  } finally {
-    await fileHandle.close()
-  }
-  const prefix = buffer.toString('utf8').replace('\uFEFF', '') // Remove BOM
-  return (prefix.startsWith('"http'))
-    ? JSON.parse(fs.readFileSync(fileName).toString('utf8'))
-    : fileName
-}
-
 const validateDefinition = async (apiFilePath) => {
   const newApi = new OpenApiBackend({
-    definition: await checkUrl(path.join(apiFilePath)),
+    definition: await Utils.checkUrl(path.join(apiFilePath)),
     customizeAjv: ajv => addFormats(ajv),
     strict: true,
     quick: true

package/src/lib/config.js

@@ -107,6 +107,7 @@ const _getSecretsFromEnvironment = () => {
     process.env.REPORTING_DB_SSL_ENABLED ||
     process.env.REPORTING_DB_SSL_VERIFY ||
     process.env.REPORTING_DB_SSL_CA_FILE_PATH ||
+    process.env.REPORTING_DB_SSL_CLIENT_CERT_FILE_PATH ||
     process.env.REPORTING_DB_PARAMS
   ) {
     try {
@@ -115,6 +116,7 @@ const _getSecretsFromEnvironment = () => {
       const reportingDbSslEnabled = process.env.REPORTING_DB_SSL_ENABLED === 'true'
       const reportingDbSslVerify = process.env.REPORTING_DB_SSL_VERIFY !== 'false'
       const reportingDbSslCa = process.env.REPORTING_DB_SSL_CA_FILE_PATH
+      const reportingDbClientCert = process.env.REPORTING_DB_SSL_CLIENT_CERT_FILE_PATH
       const reportingDbConnectionParams = process.env.REPORTING_DB_PARAMS
         ? JSON.parse(process.env.REPORTING_DB_PARAMS)
         : undefined
@@ -131,13 +133,17 @@ const _getSecretsFromEnvironment = () => {
       if (
         process.env.REPORTING_DB_SSL_ENABLED ||
         process.env.REPORTING_DB_SSL_VERIFY ||
-        process.env.REPORTING_DB_SSL_CA_FILE_PATH
+        process.env.REPORTING_DB_SSL_CA_FILE_PATH ||
+        process.env.REPORTING_DB_SSL_CLIENT_CERT_FILE_PATH
       ) {
         secretsFromEnvironment.DB.SSL_ENABLED = reportingDbSslEnabled
         secretsFromEnvironment.DB.SSL_VERIFY = reportingDbSslVerify
         if (reportingDbSslCa) {
           secretsFromEnvironment.DB.SSL_CA_FILE_PATH = reportingDbSslCa
         }
+        if (reportingDbClientCert) {
+          secretsFromEnvironment.DB.SSL_CLIENT_CERT_FILE_PATH = reportingDbClientCert
+        }
       }
 
       // Hide CA from being logged
@@ -145,6 +151,7 @@ const _getSecretsFromEnvironment = () => {
       if (logSecrets.DB && logSecrets.DB.SSL_CA_FILE_PATH) logSecrets.DB.SSL_CA_FILE_PATH = mask(logSecrets.DB.SSL_CA_FILE_PATH)
       if (logSecrets.DB && logSecrets.DB.PASSWORD) logSecrets.DB.PASSWORD = mask(logSecrets.DB.PASSWORD)
       if (logSecrets.DB && logSecrets.DB.CONNECTION_STRING) logSecrets.DB.CONNECTION_STRING = mask(logSecrets.DB.CONNECTION_STRING)
+      if (logSecrets.DB && logSecrets.DB.SSL_CLIENT_CERT_FILE_PATH) logSecrets.DB.SSL_CLIENT_CERT_FILE_PATH = mask(logSecrets.DB.SSL_CLIENT_CERT_FILE_PATH)
       console.log('Secrets retrieved from environment to be merged into system config', logSecrets)
       if (logSecrets.DB && logSecrets.DB.PARAMS) logSecrets.DB.PARAMS = JSON.stringify(logSecrets.DB.PARAMS)
     } catch (err) {

package/src/lib/db/adapters/dbAdapter.js

@@ -62,6 +62,9 @@ const getConnection = async () => {
       if (systemConfig.DB.SSL_CA_FILE_PATH) {
         mongoOptions.tlsCAFile = systemConfig.DB.SSL_CA_FILE_PATH
       }
+      if (systemConfig.DB.SSL_CLIENT_CERT_FILE_PATH) {
+        mongoOptions.tlsCertificateKeyFile = systemConfig.DB.SSL_CLIENT_CERT_FILE_PATH
+      }
     }
 
     const csMongoDBObj = new ConnectionString()

package/src/lib/mocking/openApiMockHandler.js

@@ -64,9 +64,9 @@ module.exports.initilizeMockHandler = async () => {
   // Get API Definitions from configuration
   const apiDefinitions = await OpenApiDefinitionsModel.getApiDefinitions()
   // Create create openApiBackend objects for all the api definitions
-  apis = apiDefinitions.map(item => {
+  apis = await Promise.all(apiDefinitions.map(async item => {
     const tempObj = new OpenApiBackend({
-      definition: path.join(item.specFile),
+      definition: await utils.checkUrl(path.join(item.specFile)),
       customizeAjv: ajv => addFormats(ajv),
       strict: true,
       quick: true,
@@ -100,7 +100,7 @@ module.exports.initilizeMockHandler = async () => {
       ...item,
       openApiBackendObject: tempObj
     }
-  })
+  }))
 
   for (const api of apis) {
     customLogger.logMessage('info', 'Initializing the api spec file: ' + api.specFile, { notification: false })

package/src/lib/utils.js

@@ -70,6 +70,21 @@ const resolveRoot = path => resolve(process.env.TTK_ROOT || '.', path)
 const resolve1 = fn => (arg1, ...rest) => fn(resolveRoot(arg1), ...rest)
 const resolve2 = fn => (arg1, arg2, ...rest) => fn(resolveRoot(arg1), resolveRoot(arg2), ...rest)
 
+// check if the file contains URL and return it instead of the file name
+const checkUrl = async fileName => {
+  const buffer = Buffer.alloc(10)
+  const fileHandle = await fs.promises.open(fileName, 'r')
+  try {
+    await fileHandle.read(buffer, 0, 10, 0)
+  } finally {
+    await fileHandle.close()
+  }
+  const prefix = buffer.toString('utf8').replace('\uFEFF', '') // Remove BOM
+  return (prefix.startsWith('"http'))
+    ? JSON.parse(fs.readFileSync(fileName).toString('utf8'))
+    : fileName
+}
+
 module.exports = {
   readFileAsync: resolve1(readFileAsync),
   writeFileAsync: resolve1(writeFileAsync),
@@ -85,5 +100,6 @@ module.exports = {
   getHeader,
   headersToLowerCase,
   urlToPath,
+  checkUrl,
   resolve: resolveRoot
 }