@mojaloop/ml-testing-toolkit-client-lib 0.0.2

package/README.md

@@ -0,0 +1,213 @@
+Mojaloop Testing Toolkit Client Library and Tools
+=================================================
+
+The **Mojaloop Testing Toolkit CLI** is a command line client for connecting to "Mojaloop Testing Toolkit" instead of using web interface.
+
+For additional back ground information on the Self Testing Toolkit, please see [Mojaloop Testing Toolkit](/documents/Mojaloop-Testing-Toolkit.md). It would be to the particpant's benefit to familiarise themselves with the understanding of the  [Architecture Diagram](/documents/MojaloopÂ-Testing-Tool.md#7-architecture) that explains the various components and related flows.
+
+
+**Table of Contents**
+
+1. [Getting Started](#1-getting-started)
+2. [The Mojaloop Testing Toolkit CLI](#2-the-mojaloop-testing-toolkit)
+
+    2.1. [Help screen](#21-at-first-glance)
+
+    2.2. [Monitoring Mode](#22-monitoring-mode)
+
+    2.3. [Outbound Mode](#23-outbound-mode)
+
+    2.4. [AWS S3 Upload](#24-aws-s3-upload)
+
+    2.5. [Slack Notification](#25-slack-notification)
+
+### 1. Getting Started
+
+To get started, please follow the instructions in the [README](/README.md) document. This document covers the use-cases with the **Mojaloop Simulator**.
+
+### 2. CLI
+
+#### 2.1 Help screen
+
+The help screen allows you to see the usage, possible options and default values
+
+command: 
+
+```
+node src/client -h
+```
+
+output:
+
+```
+Usage: client [options]
+
+Options:
+  -v, --version                                             output the version number
+  -c, --config <config>                                     default configuration: {"mode": "outbound", "reportFormat": "json"}
+  -m, --mode <mode>                                         default: "outbound" --- supported modes: "monitoring", "outbound"
+  -u, --base-url <baseUrl>                                  default: "http://localhost:5050"
+  -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"
+  --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>]"
+  --slack-webhook-url <slackWebhookUrl>                     default: "Disabled"  --- supported formats: "https://....."
+  -h, --help                                                output usage information
+
+ *** If the option report-target is set to use AWS S3 service, the variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION) should be passed in environment
+```
+
+#### 2.2 Monitoring Mode
+
+The monitoring mode allows you to monitor _incoming_ requests from the **Mojaloop Simulator**.
+
+Example:
+
+command:
+
+```
+node src/client -m monitoring
+```
+
+output:
+
+```
+Listening on newLog events...
+2020-05-12T12:23:32.988Z INFO   (15892862129885sy33i)   Request: post /bulkTransfers
+{
+  "request": {
+    "uniqueId": "15892862129885sy33i",
+    "headers": {
+      "content-type": "application/vnd.interoperability.parties+json;version=1.0",
+      "accept": "application/vnd.interoperability.parties+json;version=1.0",
+      "fspiop-source": "testingtoolkitdfsp",
+      "date": "Tue, 12 May 2020 12:23:32 GMT",
+      "user-agent": "axios/0.19.2",
+      "content-length": "256",
+      "host": "localhost:5000",
+      "connection": "close"
+    },
+    "body": {
+      "bulkTransferId": "202137c6-2ca9-429d-b03b-41d5cf19258c",
+      "bulkQuoteId": "8823f09e-728c-4e04-b718-d17a24e55bb0",
+      "payerFsp": "string",
+      "payeeFsp": "string",
+      "expiration": "2020-01-01T10:10:10.000Z",
+      "extensionList": {
+        "extension": [
+          {
+            "key": "string",
+            "value": "string"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+You could Send Transfer from postman or execute outbound mode with an example from examples/test-cases folder
+
+#### 2.3 Outbound Mode
+
+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. 
+
+#### Default values
+
+mode:
+  - outbound
+reportFormat:
+  - json
+reportName:
+  - when reportFormat is json: ${test-name}-${date-now}.json
+  - when reportFormat is html/printhtml format: value is generated by the service responsible for converting the json to the given format
+
+#### Exit codes
+
+The CLI tool is able to return the proper exit codes in case of success and failures. This will enable this tool to use in automation systems (CICD).
+
+  - 0: all assertions passed
+  - 1: there is at least 1 failed assertion
+
+#### Example
+
+command:
+
+```
+node src/client -m outbound -i examples/collections/dfsp/p2p_happy_path.json -e examples/environments/dfsp_local_environment.json --report-format html
+```
+
+output:
+
+```
+Listening on outboundProgress events...
+ ████████████████████████████████████████ 100% | ETA: 0s | 3/3
+--------------------TEST CASES--------------------
+P2P Transfer Happy Path
+        Get party information - GET - /parties/{Type}/{ID} - [8/8]
+        Send quote - POST - /quotes - [11/11]
+        Send transfer - POST - /transfers - [9/9]
+--------------------TEST CASES--------------------
+┌───────────────────────────────────────────────────────┐
+│                        SUMMARY                        │
+├───────────────────────┬───────────────────────────────┤
+│ Total assertions      │ 28                            │
+├───────────────────────┼───────────────────────────────┤
+│ Passed assertions     │ 28                            │
+├───────────────────────┼───────────────────────────────┤
+│ Failed assertions     │ 0                             │
+├───────────────────────┼───────────────────────────────┤
+│ Total requests        │ 3                             │
+├───────────────────────┼───────────────────────────────┤
+│ Total test cases      │ 1                             │
+├───────────────────────┼───────────────────────────────┤
+│ Passed percentage     │ 100.00%                       │
+├───────────────────────┼───────────────────────────────┤
+│ Started time          │ Mon, 01 Jun 2020 14:46:20 GMT │
+├───────────────────────┼───────────────────────────────┤
+│ Completed time        │ Mon, 01 Jun 2020 14:46:21 GMT │
+├───────────────────────┼───────────────────────────────┤
+│ Runtime duration      │ 832 ms                        │
+├───────────────────────┼───────────────────────────────┤
+│ Average response time │ NA                            │
+└───────────────────────┴───────────────────────────────┘
+TTK-Assertion-Report-dfsp-p2p-tests-2020-06-01T14:46:21.303Z.html was generated
+Terminate with exit code 0
+```
+
+You will find a report in the project folder - 'TTK-Assertion-Report-{collection-name}-{ISO-date}.{report-format}'
+
+#### 2.4 AWS S3 Upload
+
+You can choose to upload the generated report to AWS S3 at the end of tests execution.
+
+Use the command line option **'--report-target'** to specify the target in the format `s3://<bucket_name>/<object_key>`
+
+You can use the option **'--report-auto-filename-enable'** to replace the file name specified in the target with an auto generated file name.
+
+To use AWS S3 service, the following environment variables should be set with proper credentials
+- AWS_ACCESS_KEY_ID
+- AWS_SECRET_ACCESS_KEY
+- AWS_REGION
+
+Example Command:
+
+```
+node src/client -m outbound -i examples/collections/dfsp/p2p_happy_path.json -e examples/environments/dfsp_local_environment.json --report-format html --report-auto-filename-enable true --report-target s3://qa-reports-bucket/reports-folder/report-name.html
+```
+
+#### 2.5 Slack Notification
+
+You can choose to notify over a slack channel after a completed tests execution.
+For this, you have to generate your `slack webhook` in slack portal and provide the webhook URL by the command line option **'--slack-webhook-url'**
+
+If the S3 option is also set, then a link to the uploaded report will be sent in the slack notification.
+
+Example Command:
+
+```
+node src/client -m outbound -i examples/collections/dfsp/p2p_happy_path.json -e examples/environments/dfsp_local_environment.json --slack-webhook-url=https://hooks.slack.com/services/blablabla...
+```

package/audit-resolve.json

@@ -0,0 +1,14 @@
+{
+  "decisions": {
+    "1067560|swagmock>swagger-parser>z-schema>validator": {
+      "decision": "postpone",
+      "madeAt": 1653992416102
+    },
+    "1068118|socket.io>engine.io": {
+      "decision": "postpone",
+      "madeAt": 1653992430065
+    }
+  },
+  "rules": {},
+  "version": 1
+}

package/bin/cli.js

@@ -0,0 +1,2 @@
+#! /usr/bin/env node
+require('../src/client')

package/jest.config.js

@@ -0,0 +1,16 @@
+module.exports = {
+  verbose: true,
+  collectCoverageFrom: [
+    '**/src/**/**/*.js'
+  ],
+  coverageThreshold: {
+    global: {
+      statements: 90,
+      functions: 90,
+      branches: 80,
+      lines: 90
+    }
+  },
+  modulePathIgnorePatterns: ['spec_files'],
+  testEnvironment: 'node'
+}

package/native-app-generation/assets/macos/start.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+reldir=`dirname $0`
+cd $reldir
+directory=`pwd`
+
+./ml-ttk

package/native-app-generation/build-native-app.sh

@@ -0,0 +1,57 @@
+TTK_UI_TAG="v14.0.0"
+
+HelpMessage () {
+  echo "Usage: $0 -platform [macos|linux|win] -arch [x64|x86|armv6|armv7]"
+}
+
+ARCH=""
+PLATFORM=""
+
+while [ $# -gt 0 ]
+do
+  case $1 in
+      -platform) PLATFORM=$2 ;;
+      -arch) ARCH=$2 ;;
+      -h) HelpMessage; exit 1 ;;
+      -*) echo "$0: Invalid option $1" ; HelpMessage; exit 2 ;;
+      *) echo "$0: Invalid option $1" ; HelpMessage; exit 2 ;;
+  esac
+  shift
+  shift
+done
+
+if [ ! -d "node_modules" ]; then
+  echo "Folder node_modules doesn't exist"
+  exit 1
+fi
+
+if [ -z $ARCH ]; then
+  echo "arch is not specified"
+  exit 1
+fi
+if [ -z $PLATFORM ]; then
+  echo "platform is not specified"
+  exit 1
+fi
+### Some tweak for postman-sandbox libray to be compatible for packaging
+sed '/\"type\": \"module\"/d' node_modules/uvm/node_modules/flatted/package.json > node_modules/uvm/node_modules/flatted/package2.json
+rm node_modules/uvm/node_modules/flatted/package.json
+mv node_modules/uvm/node_modules/flatted/package2.json node_modules/uvm/node_modules/flatted/package.json
+### Start packaging
+rm -rf out_native_bin/$PLATFORM-$ARCH
+mkdir -p out_native_bin/$PLATFORM-$ARCH
+pkg -t node12-$PLATFORM-$ARCH . -o out_native_bin/$PLATFORM-$ARCH/ml-ttk
+cp -R spec_files out_native_bin/$PLATFORM-$ARCH
+cp -R examples out_native_bin/$PLATFORM-$ARCH
+### Get the UI files from docker image
+docker cp $(docker create --rm mojaloop/ml-testing-toolkit-ui:$TTK_UI_TAG):/usr/share/nginx/html ./public_html
+if [ ! -d "public_html" ]; then
+  echo "Couldn't get the TTK UI from docker"
+  exit 1
+fi
+cp -R public_html out_native_bin/$PLATFORM-$ARCH
+
+### Copy files specific to platform
+if [ "$PLATFORM" = "macos" ]; then
+  cp native-app-generation/assets/$PLATFORM/start.sh out_native_bin/$PLATFORM-$ARCH
+fi

package/package.json

@@ -0,0 +1,132 @@
+{
+  "name": "@mojaloop/ml-testing-toolkit-client-lib",
+  "description": "Testing Toolkit Client Library",
+  "version": "0.0.2",
+  "license": "Apache-2.0",
+  "author": "Vijaya Kumar Guthi, ModusBox Inc. ",
+  "contributors": [
+    "Georgi Logodazhki <georgi.logodazhki@modusbox.com>",
+    "Sam Kummary <sam@modusbox.com>",
+    "Steven Oderayi <steven.oderayi@modusbox.com>",
+    "Vijay Kumar <vijaya.guthi@modusbox.com>"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mojaloop/ml-testing-toolkit-client-lib.git"
+  },
+  "bugs": "https://github.com/mojaloop/ml-testing-toolkit-client-lib/issues",
+  "config": {},
+  "bin": {
+    "ml-ttk-cli": "bin/cli.js"
+  },
+  "standard": {
+    "env": [
+      "jest"
+    ],
+    "ignore": [
+      "test",
+      "postman",
+      "documents",
+      "spec_files",
+      "simulator"
+    ]
+  },
+  "pre-commit": [
+    "standard"
+  ],
+  "scripts": {
+    "start": "node src/index.js",
+    "standard": "standard",
+    "standard:fix": "standard --fix",
+    "dev": "nodemon src/index.js",
+    "test": "npm run test:unit",
+    "test:unit": "jest --testMatch '**/test/unit/**/*.test.js'",
+    "test:int": "jest --reporters=default --reporters=jest-junit --testMatch '**/test/integration/**/*.test.js'",
+    "test:coverage": "jest --coverage --coverageThreshold='{}' --testMatch '**/test/unit/**/*.test.js'",
+    "test:coverage-check": "jest --coverage --testMatch '**/test/unit/**/*.test.js'",
+    "test:junit": "jest --reporters=default --reporters=jest-junit --testMatch '**/test/unit/**/*.test.js'",
+    "test:integration": "./test/integration-runner.sh ",
+    "cover": "npx nyc --all report --reporter=lcov npm run test",
+    "lint": "npx standard",
+    "lint:fix": "npx standard --fix",
+    "build": "docker build -t mojaloop-testing-toolkit:local -f ./Dockerfile .",
+    "run": "docker run -p 5000:5000 --rm ",
+    "generate-docs": "jsdoc -c jsdoc.json",
+    "audit:resolve": "SHELL=sh resolve-audit",
+    "audit:check": "SHELL=sh check-audit",
+    "dep:check": "npx ncu -e 2",
+    "dep:update": "npx ncu -u",
+    "genexec": "pkg -t node8-win .",
+    "cli": "node src/client.js",
+    "release": "npx standard-version --no-verify --releaseCommitMessageFormat 'chore(release): {{currentTag}} [skip ci]'",
+    "snapshot": "npx standard-version --no-verify --skip.changelog --prerelease snapshot --releaseCommitMessageFormat 'chore(snapshot): {{currentTag}}'"
+  },
+  "dependencies": {
+    "@mojaloop/central-services-logger": "^10.6.2",
+    "@mojaloop/ml-testing-toolkit-shared-lib": "^12.2.0",
+    "@mojaloop/sdk-standard-components": "10.2.0",
+    "@slack/webhook": "^6.0.0",
+    "@types/socket.io": "^2.1.4",
+    "adm-zip": "^0.4.14",
+    "atob": "2.1.2",
+    "aws-sdk": "^2.1009.0",
+    "axios": "^0.21.4",
+    "blipp": "4.0.1",
+    "cli-table3": "0.6.0",
+    "commander": "4.0.0",
+    "docdash": "1.1.1",
+    "dotenv": "^8.6.0",
+    "fs": "0.0.1-security",
+    "js-yaml": "^3.13.1",
+    "lodash": "^4.17.19",
+    "mv": "^2.1.1",
+    "node-dir": "0.1.17",
+    "node-strings": "^1.0.2",
+    "npm-run-all": "4.1.5",
+    "parse-strings-in-object": "1.2.0",
+    "path": "^0.12.7",
+    "rc": "1.2.8",
+    "request": "^2.88.2",
+    "request-promise-native": "1.0.8",
+    "selectn": "^1.1.2",
+    "socket.io": "^2.3.0",
+    "socket.io-client": "^2.3.0",
+    "uuid": "8.1.0",
+    "uuid4": "1.1.4",
+    "ws": "^7.5.5"
+  },
+  "devDependencies": {
+    "@types/jest": "24.0.22",
+    "eslint": "^8.0.1",
+    "eslint-plugin-import": "^2.25.2",
+    "get-port": "5.0.0",
+    "jest": "^27.3.0",
+    "jest-junit": "^13.0.0",
+    "jsdoc": "^3.6.10",
+    "nodemon": "^2.0.13",
+    "npm-audit-resolver": "3.0.0-7",
+    "npm-check-updates": "11.3.0",
+    "nyc": "^15.0.0",
+    "parse-strings-in-object": "1.2.0",
+    "pre-commit": "1.2.2",
+    "proxyquire": "2.1.3",
+    "sinon": "7.5.0",
+    "standard": "^16.0.4",
+    "supertest": "^4.0.2",
+    "swagmock": "1.0.0",
+    "tap-xunit": "2.4.1",
+    "standard-version": "^9.5.0"
+  },
+  "generator-swaggerize": {
+    "version": "4.1.0"
+  },
+  "pkg": {
+    "scripts": "src/**/custom-functions/*.js",
+    "options": [
+      "experimental-modules"
+    ]
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/src/client.js

@@ -0,0 +1,49 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates 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
+ Gates Foundation organization 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>.
+ * Gates Foundation
+
+ * ModusBox
+ * Georgi Logodazhki <georgi.logodazhki@modusbox.com> (Original Author)
+ --------------
+ ******/
+const commander = require('commander')
+const router = require('./router')
+
+commander
+  .version('1.0.0', '-v, --version')
+  .option('-c, --config <config>', 'default configuration: {"mode": "outbound", "reportFormat": "json"}')
+  .option('-m, --mode <mode>', 'default: "outbound" --- supported modes: "monitoring", "outbound", "testcaseDefinitionReport"')
+  .option('-u, --base-url <baseUrl>', 'default: "http://localhost:5050"')
+  .option('-i, --input-files <inputFiles>', 'csv list of json files or directories; required when the mode is "outbound" --- supported formats: "json"')
+  .option('-e, --environment-file <environmentFile>', 'required when the mode is "outbound" --- supported formats: "json"')
+  .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('--labels <labels>', 'csv list of labels, examples: "p2p,settlements,quotes"')
+  .option('--report-format <reportFormat>', 'default: "json" --- supported formats: "json", "html", "printhtml"')
+  .option('--report-auto-filename-enable <reportAutoFilenameEnable>', 'default: false, if true the file name will be generated by the backend')
+  .option('--report-target <reportTarget>', 'default: "file://<file_name_genrated_by_backend>"  --- supported targets: "file://path_to_file", "s3://<bucket_name>[/<file_path>]"')
+  .option('--slack-webhook-url <slackWebhookUrl>', 'default: "Disabled"  --- supported formats: "https://....."')
+  .option('--extra-summary-information <Comma separated values in the format key:value>', 'default: none  --- example: "Testcase Name:something,Environment:Dev1"')
+  .on('--help', () => { // Extra information on help message
+    console.log('')
+    console.log(' *** If the option report-target is set to use AWS S3 service, the variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION) should be passed in environment')
+    console.log('      ')
+  })
+  .parse(process.argv)
+
+router.cli(commander)

package/src/extras/s3-upload.js

@@ -0,0 +1,69 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates 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
+ Gates Foundation organization 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>.
+ * Gates Foundation
+
+ * ModusBox
+ * Vijay Kumar Guthi <vijaya.guthi@modusbox.com> (Original Author)
+ --------------
+ ******/
+const AWS = require('aws-sdk')
+
+// Set the region
+AWS.config.update({ region: process.env.AWS_REGION })
+
+const uploadFileDataToS3 = async (s3URL, fileData) => {
+  if (!AWS.config.credentials) {
+    console.log('ERROR: Upload to S3 failed. AWS_ACCESS_KEY_ID or AWS_SECRET_ACCESS_KEY not set')
+    return
+  }
+  if (!AWS.config.region) {
+    console.log('ERROR: Upload to S3 failed. AWS_REGION not set')
+    return
+  }
+
+  // Match with S3 regular expression
+  const s3Re = /s3:\/\/(.*)\/(.*)/g
+  const s3Arr = s3Re.exec(s3URL)
+  if (!s3Arr) {
+    return
+  }
+  const bucketName = s3Arr[1]
+  const objectKey = s3Arr[2]
+  // Create S3 service object
+  const s3 = new AWS.S3({ apiVersion: '2012-10-17' })
+  const additionalParams = {}
+  if (objectKey.endsWith('.html') || objectKey.endsWith('.htm')) {
+    additionalParams.ContentType = 'text/html'
+  }
+  // call S3 to retrieve upload file to specified bucket
+  const uploadParams = { Bucket: bucketName, Key: objectKey, Body: fileData, ...additionalParams }
+
+  try {
+    // call S3 to retrieve upload file to specified bucket
+    const result = await s3.upload(uploadParams).promise()
+    console.log('Successfully uploaded the file to S3. URL is ' + s3URL)
+    return result.Location
+  } catch (err) {
+    console.log('ERROR: Upload to S3 failed. ', err.message)
+    return null
+  }
+}
+
+module.exports = {
+  uploadFileDataToS3
+}