@mojaloop/ml-testing-toolkit-shared-lib 12.2.0 → 13.0.0

package/.ncurc.yaml

@@ -0,0 +1,6 @@
+## Add a TODO comment indicating the reason for each rejected dependency upgrade added to this list, and what should be done to resolve it (i.e. handle it through a story, etc).
+reject: [
+  # Downgraded to 5.5.3 - Reason: removal of functional code in faker.js - https://github.com/advisories/GHSA-5w9c-rv96-fr7g
+  "faker"
+
+]

package/.nvmrc

@@ -0,0 +1 @@
+16.15.0

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+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.
+
+## [13.0.0](https://github.com/mojaloop/ml-testing-toolkit-shared-lib/compare/v12.2.0...v13.0.0) (2022-07-21)
+
+
+### ⚠ BREAKING CHANGES
+
+* Major version bump for node v16 LTS support, re-structuring of project directories to align to core Mojaloop repositories.
+
+Major version bump since this is a big upgrade.
+
+### Features
+
+* node upgrade ([#10](https://github.com/mojaloop/ml-testing-toolkit-shared-lib/issues/10)) ([e287fb5](https://github.com/mojaloop/ml-testing-toolkit-shared-lib/commit/e287fb517671689036d63f56cb27f0af1da64451))

package/CODEOWNERS

@@ -0,0 +1,30 @@
+# Each line is a file pattern followed by one or more owners.
+## These owners will be the default owners for everything in
+## the repo. Unless a later match takes precedence,
+## @global-owner1 and @global-owner2 will be requested for
+## review when someone opens a pull request.
+#*       @global-owner1 @global-owner2
+*   @vijayg10 @mdebarros @elnyry-sam-k
+## Order is important; the last matching pattern takes the most
+## precedence. When someone opens a pull request that only
+## modifies JS files, only @js-owner and not the global
+## owner(s) will be requested for a review.
+# *.js    @js-owner
+## You can also use email addresses if you prefer. They'll be
+## used to look up users just like we do for commit author
+## emails.
+#*.go docs@example.com
+# In this example, @doctocat owns any files in the build/logs
+# directory at the root of the repository and any of its
+# subdirectories.
+# /build/logs/ @doctocat
+## The `docs/*` pattern will match files like
+## `docs/getting-started.md` but not further nested files like
+## `docs/build-app/troubleshooting.md`.
+# docs/*  docs@example.com
+## In this example, @octocat owns any file in an apps directory
+## anywhere in your repository.
+#apps/ @octocat
+## In this example, @doctocat owns any file in the `/docs`
+## directory in the root of your repository.
+#/docs/ @doctocat

package/README.md

@@ -1 +1,42 @@
 # ml-testing-toolkit-shared-lib
+Library for shared code between Mojaloop testing-toolkit backend and frontend
+
+## Auditing Dependencies
+
+We use `npm-audit-resolver` along with `npm audit` to check dependencies for node vulnerabilities, and keep track of resolved dependencies with an `audit-resolve.json` file.
+
+To start a new resolution process, run:
+
+```bash
+npm run audit:resolve
+```
+
+You can then check to see if the CI will pass based on the current dependencies with:
+
+```bash
+npm run audit:check
+```
+
+And commit the changed `audit-resolve.json` to ensure that CircleCI will build correctly.
+
+## Container Scans
+
+As part of our CI/CD process, we use anchore-cli to scan our built docker container for vulnerabilities upon release.
+
+If you find your release builds are failing, refer to the [container scanning](https://github.com/mojaloop/ci-config#container-scanning) in our shared Mojaloop CI config repo. There is a good chance you simply need to update the `mojaloop-policy-generator.js` file and re-run the circleci workflow.
+
+For more information on anchore and anchore-cli, refer to:
+- [Anchore CLI](https://github.com/anchore/anchore-cli)
+- [Circle Orb Registry](https://circleci.com/orbs/registry/orb/anchore/anchore-engine)
+
+## Automated Releases
+
+As part of our CI/CD process, we use a combination of CircleCI, standard-version
+npm package and github-release CircleCI orb to automatically trigger our releases
+and image builds. This process essentially mimics a manual tag and release.
+
+On a merge to master, CircleCI is configured to use the mojaloopci github account
+to push the latest generated CHANGELOG and package version number.
+
+Once those changes are pushed, CircleCI will pull the updated master, tag and
+push a release triggering another subsequent build that also publishes a docker image.

package/audit-ci.jsonc

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://github.com/IBM/audit-ci/raw/main/docs/schema.json",
+  // 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": [
+    // Unable to downgrade due to breaking change: glob-parent before 6.0.1 vulnerable to Regular Expression Denial of Service (ReDoS) - https://github.com/advisories/GHSA-cj88-88mr-972w
+    "GHSA-cj88-88mr-972w"
+  ]
+}

package/package.json

@@ -1,12 +1,28 @@
 {
   "name": "@mojaloop/ml-testing-toolkit-shared-lib",
-  "version": "12.2.0",
+  "version": "13.0.0",
   "description": "Shared library for ml-testing-toolkit re-usable functions",
   "main": "src/index.js",
+  "contributors": [
+    "Vijaya Kumar <vijaya.guthi@modusbox.com>",
+    "Miguel de Barros <miguel.debarros@modusbox.com>"
+  ],
+  "engines": {
+    "node": "=16.x"
+  },
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mojaloop/ml-testing-toolkit-shared-lib.git"
+  },
+  "author": "Vijaya Kumar Guthi, ModusBox Inc.",
+  "bugs": {
+    "url": "https://github.com/mojaloop/ml-testing-toolkit-shared-lib/issues"
+  },
+  "homepage": "https://github.com/mojaloop/ml-testing-toolkit-shared-lib#readme",
   "pre-commit": [
     "lint",
-    "dep:check",
-    "test:unit"
+    "dep:check"
   ],
   "scripts": {
     "start": "node src/index.js",
@@ -22,40 +38,35 @@
     "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",
-    "audit:resolve": "SHELL=sh resolve-audit",
-    "audit:check": "SHELL=sh check-audit",
+    "audit:check": "npx audit-ci --config ./audit-ci.jsonc",
     "dep:check": "npx ncu -e 2",
-    "dep:update": "npx ncu -u"
+    "dep:update": "npx ncu -u",
+    "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}}'"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/mojaloop/ml-testing-toolkit-shared-lib.git"
-  },
-  "author": "Vijaya Kumar Guthi, ModusBox Inc.",
-  "contributors": [
-    "Vijaya Kumar <vijaya.guthi@modusbox.com>",
-    "Miguel de Barros <miguel.debarros@modusbox.com>"
-  ],
-  "license": "Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/mojaloop/ml-testing-toolkit-shared-lib/issues"
-  },
-  "homepage": "https://github.com/mojaloop/ml-testing-toolkit-shared-lib#readme",
   "dependencies": {
-    "ajv": "8.5.0",
+    "ajv": "8.11.0",
     "faker": "5.5.3",
-    "json-schema-faker": "0.5.0-rcv.34",
-    "json-schema-ref-parser": "9.0.7",
+    "json-schema-faker": "0.5.0-rcv.44",
+    "json-schema-ref-parser": "9.0.9",
     "lodash": "4.17.21",
     "node-dir": "0.1.17"
   },
   "devDependencies": {
-    "@types/jest": "26.0.23",
-    "jest": "27.0.4",
-    "jest-junit": "12.1.0",
-    "npm-audit-resolver": "2.3.1",
-    "npm-check-updates": "11.6.0",
-    "standard": "^16.0.3"
+    "@types/jest": "28.1.6",
+    "audit-ci": "^6.3.0",
+    "jest": "28.1.3",
+    "jest-junit": "14.0.0",
+    "npm-check-updates": "15.3.4",
+    "pre-commit": "^1.2.2",
+    "replace": "^1.2.1",
+    "standard": "^17.0.0",
+    "standard-version": "^9.5.0"
+  },
+  "standard-version": {
+    "scripts": {
+      "postchangelog": "replace '\\[mojaloop/#(\\d+)\\]\\(https://github.com/mojaloop/(.*)/issues/(\\d+)\\)' '[mojaloop/#$1](https://github.com/mojaloop/project/issues/$1)' CHANGELOG.md"
+    }
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/src/lib/testcase-folder/folder-parser.js

@@ -61,7 +61,7 @@ const convertToFolderNestedArray = (folderRawData) => {
           const children = []
           processFileOrFolder(inputItem[fileOrFolderItem], children, (prefix ? (prefix + '/') : '') + fileOrFolderItem)
           extraInfo = extraInfo || { type: 'folder' }
-          inputArray.push({ key: (prefix ? (prefix + '/') : '') + fileOrFolderItem, title: fileOrFolderItem, extraInfo, children: children })
+          inputArray.push({ key: (prefix ? (prefix + '/') : '') + fileOrFolderItem, title: fileOrFolderItem, extraInfo, children })
         }
       }
     }
@@ -78,7 +78,7 @@ const convertToFolderNestedArray = (folderRawData) => {
         if (orderItem.type === 'file' || orderItem.type === 'folder') {
           const extraInfo = {
             type: orderItem.type
-          } 
+          }
           if (orderItem.labels) {
             extraInfo.labels = orderItem.labels
           }
@@ -163,13 +163,14 @@ const getAbsolutePathOfRelativeFileRef = (refNode) => {
 }
 
 const getLabels = (currentLabels, newLabels = []) => {
+  // eslint-disable-next-line no-unneeded-ternary
   currentLabels = currentLabels ? currentLabels : []
   const labels = (currentLabels && currentLabels.length > 0) ? [...currentLabels] : []
   newLabels.forEach(label => {
     if (!currentLabels.includes(label)) {
       labels.push(label)
     }
-  });
+  })
   return labels
 }
 
@@ -213,7 +214,7 @@ const addChildrenToTestCases = (folderData, nodeChildren, testCases, selectedFil
             let isSelected = false
             if (testCase.fileInfo.labels && testCase.fileInfo.labels.length > 0) {
               for (let j = 0; j < testCase.fileInfo.labels.length; j++) {
-                const l = testCase.fileInfo.labels[j];
+                const l = testCase.fileInfo.labels[j]
                 if (selectedLabels.includes(l)) {
                   isSelected = true
                   break

package/.circleci/config.yml

@@ -1,301 +0,0 @@
-# CircleCI v2 Config
-version: 2
-
-defaults_working_directory: &defaults_working_directory
-  working_directory: /home/circleci/project
-
-defaults_docker_node: &defaults_docker_node
-  docker:
-    - image: mhart/alpine-node:12.16.0
-
-defaults_Dependencies: &defaults_Dependencies |
-    apk --no-cache add git
-    apk --no-cache add ca-certificates
-    apk --no-cache add curl
-    apk --no-cache add openssh-client
-    apk --no-cache add bash
-    apk add --no-cache -t build-dependencies make gcc g++ python libtool autoconf automake
-    npm config set unsafe-perm true
-    npm install -g node-gyp
-
-defaults_awsCliDependencies: &defaults_awsCliDependencies |
-    apk --no-cache add \
-            python \
-            py-pip \
-            groff \
-            less \
-            mailcap
-    pip install --upgrade awscli==1.14.5 s3cmd==2.0.1 python-magic
-    apk -v --purge del py-pip
-
-defaults_license_scanner: &defaults_license_scanner
-  name: Install and set up license-scanner
-  command: |
-    git clone https://github.com/mojaloop/license-scanner /tmp/license-scanner
-    cd /tmp/license-scanner && make build default-files set-up
-
-defaults_npm_auth: &defaults_npm_auth
-  name: Update NPM registry auth token
-  command: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > .npmrc
-
-defaults_npm_publish_version: &defaults_npm_publish
-  name: Update version to prerelease
-  command: |
-    source $BASH_ENV
-    echo "Publishing tag $CIRCLE_TAG"
-    npm publish --tag $CIRCLE_TAG --access public
-
-defaults_npm_publish_release: &defaults_npm_publish_release
-  name: Publish NPM $RELEASE_TAG artifact
-  command: |
-    source $BASH_ENV
-    echo "Publishing tag $RELEASE_TAG"
-    npm publish --tag $RELEASE_TAG --access public
-
-defaults_slack_announcement: &defaults_slack_announcement
-  name: Slack announcement for tag releases
-  command: |
-    curl -X POST \
-      $SLACK_WEBHOOK_ANNOUNCEMENT \
-      -H 'Content-type: application/json' \
-      -H 'cache-control: no-cache' \
-      -d "{
-      \"text\": \"*${CIRCLE_PROJECT_REPONAME}* - Release \`${CIRCLE_TAG}\`: https://github.com/mojaloop/${CIRCLE_PROJECT_REPONAME}/releases/tag/${CIRCLE_TAG}\"
-    }"
-
-jobs:
-  setup:
-    <<: *defaults_working_directory
-    <<: *defaults_docker_node
-    steps:
-      - run:
-          name: Install general dependencies
-          command: *defaults_Dependencies
-      - checkout
-      - run:
-          name: Update NPM install
-          command: npm install
-      - save_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-          paths:
-            - node_modules
-
-  test-unit:
-    <<: *defaults_working_directory
-    <<: *defaults_docker_node
-    steps:
-      - run:
-          name: Install general dependencies
-          command: *defaults_Dependencies
-      - checkout
-      - restore_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-      - run:
-          name: Create dir for test results
-          command: mkdir -p ./test/results
-      - run:
-          name: Execute unit tests
-          command: npm -s run test:junit
-      - store_artifacts:
-          path: ./test/results
-          prefix: test
-      - store_test_results:
-          path: ./test/results
-
-  test-coverage:
-    <<: *defaults_working_directory
-    <<: *defaults_docker_node
-    steps:
-      - run:
-          name: Install general dependencies
-          command: *defaults_Dependencies
-      - run:
-          name: Install AWS CLI dependencies
-          command: *defaults_awsCliDependencies
-      - checkout
-      - restore_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-      - run:
-          name: Execute code coverage check
-          command: npm -s run test:coverage-check
-      - store_artifacts:
-          path: coverage
-          prefix: test
-      - store_test_results:
-          path: coverage
-      - run:
-          name: Copy code coverage to SonarQube
-          command: |
-            if [ "${CIRCLE_BRANCH}" == "master" ];
-            then
-                echo "Sending lcov.info to SonarQube..."
-                aws s3 cp coverage/lcov.info $AWS_S3_DIR_SONARQUBE/ml-testing-toolkit-shared-lib/lcov.info
-            else
-                echo "Not a release (env CIRCLE_BRANCH != 'master'), skipping sending lcov.info to SonarQube."
-            fi
-
-  vulnerability-check:
-    <<: *defaults_working_directory
-    <<: *defaults_docker_node
-    steps:
-      - run:
-          name: Install general dependencies
-          command: *defaults_Dependencies
-      - checkout
-      - restore_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-      - run:
-          name: Create dir for test results
-          command: mkdir -p ./audit/results
-      - run:
-          name: Check for new npm vulnerabilities
-          command: npm run audit:check --silent -- --json > ./audit/results/auditResults.json
-      - store_artifacts:
-          path: ./audit/results
-          prefix: audit
-
-  audit-licenses:
-    <<: *defaults_working_directory
-    <<: *defaults_docker_node
-    steps:
-      - run:
-          name: Install general dependencies
-          command: *defaults_Dependencies
-      - run:
-          <<: *defaults_license_scanner
-      - checkout
-      - restore_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-      - run:
-          name: Prune non-production packages before running license-scanner
-          command: npm prune --production
-      - run:
-          name: Run the license-scanner
-          command: cd /tmp/license-scanner && pathToRepo=$CIRCLE_WORKING_DIRECTORY make run
-      - store_artifacts:
-          path: /tmp/license-scanner/results
-          prefix: licenses
-
-  build-snapshot:
-    <<: *defaults_working_directory
-    <<: *defaults_docker_node
-    steps:
-      - run:
-          name: Install general dependencies
-          command: *defaults_Dependencies
-      - checkout
-      - run:
-          name: setup environment vars for SNAPSHOT release
-          command: |
-            echo 'export RELEASE_TAG=$RELEASE_TAG_SNAPSHOT' >> $BASH_ENV
-      - run:
-          <<: *defaults_npm_auth
-      - run:
-          <<: *defaults_npm_publish_release
-      - run:
-          <<: *defaults_slack_announcement
-
-  build:
-    <<: *defaults_working_directory
-    <<: *defaults_docker_node
-    steps:
-      - run:
-          name: Install general dependencies
-          command: *defaults_Dependencies
-      - checkout
-      - run:
-          name: setup environment vars for LATEST release
-          command: |
-            echo 'export RELEASE_TAG=$RELEASE_TAG_PROD' >> $BASH_ENV
-      - run:
-          <<: *defaults_npm_auth
-      - run:
-          <<: *defaults_npm_publish_release
-      - run:
-          <<: *defaults_slack_announcement
-
-workflows:
-  version: 2
-  build_and_test:
-    jobs:
-      - setup:
-          context: org-global
-          filters:
-            tags:
-              only: /.*/
-            branches:
-              ignore:
-                - /feature*/
-                - /bugfix*/
-      - test-unit:
-          context: org-global
-          requires:
-            - setup
-          filters:
-            tags:
-              only: /.*/
-            branches:
-              ignore:
-                - /feature*/
-                - /bugfix*/
-      - test-coverage:
-          context: org-global
-          requires:
-            - setup
-          filters:
-            tags:
-              only: /.*/
-            branches:
-              ignore:
-                - /feature*/
-                - /bugfix*/
-      - vulnerability-check:
-          context: org-global
-          requires:
-            - setup
-          filters:
-            tags:
-              only: /.*/
-            branches:
-              ignore:
-                - /feature*/
-                - /bugfix*/
-      - audit-licenses:
-          context: org-global
-          requires:
-            - setup
-          filters:
-            tags:
-              only: /.*/
-            branches:
-              ignore:
-                - /feature*/
-                - /bugfix*/
-      - build-snapshot:
-          context: org-global
-          requires:
-            - setup
-            - test-unit
-            - test-coverage
-            - vulnerability-check
-            - audit-licenses
-          filters:
-            tags:
-              only: /v[0-9]+(\.[0-9]+)*\-snapshot+((\.[0-9]+)?)/
-            branches:
-              ignore:
-                - /.*/
-      - build:
-          context: org-global
-          requires:
-            - setup
-            - test-unit
-            - test-coverage
-            - vulnerability-check
-            - audit-licenses
-          filters:
-            tags:
-              only: /v[0-9]+(\.[0-9]+)*/
-            branches:
-              ignore:
-                - /.*/