@mojaloop/ml-testing-toolkit-client-lib 1.1.1 → 1.2.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.2.0](https://github.com/mojaloop/ml-testing-toolkit-client-lib/compare/v1.1.1...v1.2.0) (2023-03-17)
+
+
+### Features
+
+* **mojaloop/#3133:** add option to specify report name saved to TTK backend ([#6](https://github.com/mojaloop/ml-testing-toolkit-client-lib/issues/6)) ([8043e4f](https://github.com/mojaloop/ml-testing-toolkit-client-lib/commit/8043e4fb5a94972c8dae7cd6f25b303e5fce275c)), closes [mojaloop/#3133](https://github.com/mojaloop/project/issues/3133)
+
 ### [1.1.1](https://github.com/mojaloop/ml-testing-toolkit-client-lib/compare/v1.1.0...v1.1.1) (2022-12-15)
 
 ## [1.1.0](https://github.com/mojaloop/ml-testing-toolkit-client-lib/compare/v1.0.0...v1.1.0) (2022-12-15)

package/README.md

@@ -62,7 +62,7 @@ ml-ttk-cli
 
 The help screen allows you to see the usage, possible options and default values
 
-command: 
+command:
 
 ```
 ml-ttk-cli -h
@@ -81,10 +81,11 @@ Options:
   -i, --input-files <inputFiles>                            csv list of json files or directories; required when the mode is "outbound" --- supported formats: "json"
   -e, --environment-file <environmentFile>                  required when the mode is "outbound" --- supported formats: "json"
   -s, --save-report <saveReport>                            To save the report on TTK backend server. default: false --- supported values: "false/true"
+  -n, --report-name <reportName>                            Specify the name of report on TTK backend server.
   --save-report-base-url <saveReportBaseUrl>                Incase if the base-url is not accessible publicly, this option replaces the base URL in the report URLs published in console log and slack messages  default: same as base-url
   --report-format <reportFormat>                            default: "json" --- supported formats: "json", "html", "printhtml"
   --report-auto-filename-enable <reportAutoFilenameEnable>  default: false, if true the file name will be generated by the backend
-  --report-target <reportTarget>                            default: "file://<file_name_genrated_by_backend>"  --- supported targets: "file://path_to_file", "s3://<bucket_name>[/<file_path>]"
+  --report-target <reportTarget>                            default: "file://<file_name_generated_by_backend>"  --- supported targets: "file://path_to_file", "s3://<bucket_name>[/<file_path>]"
   --slack-webhook-url <slackWebhookUrl>                     default: "Disabled"  --- supported formats: "https://....."
   -h, --help                                                output usage information
 
@@ -146,7 +147,7 @@ You could Send Transfer from postman or execute outbound mode with an example fr
 
 This sections will enable you to intiate requests from the cli to your DFSP implementation.
 
-The user can create a collection of operations and add a number of assertions to these operations. The assertions can be setup and customized to support your testing requirements and verify both positive and negative requests and responses. 
+The user can create a collection of operations and add a number of assertions to these operations. The assertions can be setup and customized to support your testing requirements and verify both positive and negative requests and responses.
 
 #### Default values
 

package/audit-ci.jsonc

@@ -3,5 +3,12 @@
   // audit-ci supports reading JSON, JSONC, and JSON5 config files.
   // Only use one of ["low": true, "moderate": true, "high": true, "critical": true]
   "moderate": true,
-  "allowlist": []
-}
+  "allowlist": [
+    // @mojaloop/sdk-standard-components>jsonwebtoken
+    "GHSA-hjrf-2m68-5959",
+    "GHSA-qwph-4952-7xr6",
+    "GHSA-8cf7-32gw-wr33",
+    // request-promise-native>request-promise-core>request
+    "GHSA-p8p7-x288-28g6"
+  ]
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mojaloop/ml-testing-toolkit-client-lib",
   "description": "Testing Toolkit Client Library",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "license": "Apache-2.0",
   "author": "Vijaya Kumar Guthi, ModusBox Inc. ",
   "contributors": [
@@ -66,10 +66,10 @@
     "@mojaloop/sdk-standard-components": "17.1.1",
     "@slack/webhook": "^6.1.0",
     "atob": "2.1.2",
-    "aws-sdk": "^2.1275.0",
-    "axios": "^1.2.1",
+    "aws-sdk": "^2.1337.0",
+    "axios": "^1.3.4",
     "cli-table3": "0.6.3",
-    "commander": "9.4.1",
+    "commander": "10.0.0",
     "dotenv": "^16.0.3",
     "fs": "0.0.1-security",
     "lodash": "^4.17.21",
@@ -81,18 +81,18 @@
     "rc": "1.2.8",
     "request": "^2.88.2",
     "request-promise-native": "1.0.8",
-    "socket.io-client": "^4.5.4"
+    "socket.io-client": "^4.6.1"
   },
   "devDependencies": {
-    "audit-ci": "^6.4.0",
-    "jest": "^29.3.1",
+    "audit-ci": "^6.6.1",
+    "jest": "^29.5.0",
     "jest-junit": "^15.0.0",
-    "npm-check-updates": "16.6.0",
+    "npm-check-updates": "16.7.12",
     "nyc": "^15.1.0",
     "parse-strings-in-object": "1.6.0",
     "pre-commit": "1.2.2",
     "replace": "^1.2.2",
-    "sinon": "15.0.1",
+    "sinon": "15.0.2",
     "standard": "^17.0.0",
     "standard-version": "^9.5.0"
   },

package/src/client.js

@@ -34,6 +34,7 @@ program
   .option('-l, --log-level <logLevel>', 'default: 0 --- supported levels: "0-Show only requests and assertion counts, 1-Show failed assertions only, 2-Show all assertions"')
   .option('-b, --break-run-on-error <breakRunOnError>', 'default: false --- supported values: "false/true"')
   .option('-s, --save-report <saveReport>', 'To save the report on TTK backend server. default: false --- supported values: "false/true"')
+  .option('-n, --report-name <reportName>', 'Specify the name of report on TTK backend server. default: "test_run"')
   .option('--save-report-base-url <saveReportBaseUrl>', 'Incase if the base-url is not accessible publicly, this option replaces the base URL in the report URLs published in console log and slack messages  default: same as base-url. default: same as base-url')
   .option('--labels <labels>', 'csv list of labels, examples: "p2p,settlements,quotes"')
   .option('--report-format <reportFormat>', 'default: "none" --- supported formats: "none", "json", "html", "printhtml"')

package/src/modes/outbound.js

@@ -60,6 +60,30 @@ const printTotalProgressCounts = () => {
   process.stdout.write(progressStr)
 }
 
+const determineTemplateName = (paths) => {
+  let templateName
+  // Find folders based on string format
+  const folders = paths.filter(x => x.slice((x.lastIndexOf('.') - 1 >>> 0) + 2) === '')
+  const config = objectStore.get('config')
+  if (config.reportName) {
+    templateName = config.reportName
+  } else if (paths.length === 1) {
+    // Sanitize file path for a suitable name
+    templateName = paths[0]
+      .replace(/\.[^/.]+$/, '') // Remove extension
+      .replace(/^.+\.\//, '') // Remove relative paths
+      .replace(/\\|\//g, '_') // Convert path to snake case
+  // Ensure when a single folder is selected that all files belong to that folder
+  } else if (folders.length === 1 && paths.every(filePath => filePath.includes(folders[0]))) {
+    templateName = folders[0]
+      .replace(/^.+\.\//, '') // Remove relative paths
+      .replace(/\\|\//g, '_') // Convert path to snake case
+  } else {
+    templateName = 'test_run'
+  }
+  return templateName
+}
+
 const printProgress = (progress) => {
   const config = objectStore.get('config')
   switch (config.logLevel) {
@@ -127,6 +151,7 @@ const sendTemplate = async (sessionId) => {
     const template = await TemplateGenerator.generateTemplate(inputFiles, selectedLabels)
     template.inputValues = JSON.parse(await readFileAsync(config.environmentFile, 'utf8')).inputValues
     template.saveReport = config.saveReport
+    template.name = determineTemplateName(inputFiles)
 
     template.test_cases.forEach(testCase => {
       totalProgress.totalTestCases++
@@ -189,5 +214,6 @@ const handleIncomingProgress = async (progress) => {
 
 module.exports = {
   sendTemplate,
-  handleIncomingProgress
+  handleIncomingProgress,
+  determineTemplateName
 }

package/src/router.js

@@ -52,6 +52,7 @@ const cli = (commanderOptions) => {
     breakRunOnError: commanderOptions.breakRunOnError || configFile.breakRunOnError,
     saveReport: commanderOptions.saveReport || configFile.saveReport,
     saveReportBaseUrl: commanderOptions.saveReportBaseUrl || configFile.saveReportBaseUrl,
+    reportName: commanderOptions.reportName,
     environmentFile: commanderOptions.environmentFile,
     reportFormat: commanderOptions.reportFormat || configFile.reportFormat,
     reportAutoFilenameEnable: commanderOptions.reportAutoFilenameEnable === 'true' || configFile.reportAutoFilenameEnable === true,

package/src/utils/templateGenerator.js

@@ -52,7 +52,7 @@ const generateTemplate = async (inputFiles, selectedLabels = null) => {
     FolderParser.sequenceTestCases(testCases)
     const template = {}
     template.test_cases = testCases
-    template.name = 'multi'
+    template.name = 'test_run'
     return template
   } catch (err) {
     console.log(err)

package/test/unit/outbound-mode.test.js

@@ -189,4 +189,44 @@ describe('Cli client', () => {
       await expect(outbound.sendTemplate()).resolves.toBe(undefined)
     })
   })
+  describe('run determineTemplateName', () => {
+    it('when determineTemplateName is given a list with a single file it should use the file as the template name', () => {
+      const paths = ['sample-cli.json']
+      const name = outbound.determineTemplateName(paths)
+      expect(name).toBe('sample-cli')
+    })
+    it('when determineTemplateName is given a list with a single file path it converts to snakecase', () => {
+      const paths = ['docs/sample-cli.json']
+      const name = outbound.determineTemplateName(paths)
+      expect(name).toBe('docs_sample-cli')
+    })
+    it('when determineTemplateName is given a list with a relative path it is santitized', () => {
+      const paths = ['../sample-cli.json']
+      const name = outbound.determineTemplateName(paths)
+      expect(name).toBe('sample-cli')
+    })
+    it('when determineTemplateName is given a list with a single folder and the children', () => {
+      const paths = ['docs' , 'docs/sample-cli.json']
+      const name = outbound.determineTemplateName(paths)
+      expect(name).toBe('docs')
+    })
+    it('when determineTemplateName is run with cli flag reportName set the template sets that name', () => {
+      const paths = ['docs' , 'docs/sample-cli.json']
+      const config = {
+        reportName: "my-test-report",
+      }
+      objectStore.set('config', config)
+
+      const name = outbound.determineTemplateName(paths)
+      expect(name).toBe('my-test-report')
+    })
+    it('when determineTemplateName is run with no reportName set and mixture of files and folder paths', () => {
+      const paths = ['docs' , 'docs/sample-cli.json', 'next-test.json']
+      const config = {}
+      objectStore.set('config', config)
+
+      const name = outbound.determineTemplateName(paths)
+      expect(name).toBe('test_run')
+    })
+  })
 })