eugenepolschikov / ml-self-testing-toolkit

Experimental: A functional / testing tool kit that FSPs and Hub / Switch entities can take and use for self-testing to streamline on-boarding and FSP feature development

Mojaloop Self Testing Toolkit

A self testing tool to test the mojaloop implementations.

Table of Contents

• 1. Quick Start
• 2. Running the toolkit

  • 2.1 With Docker (Preferred way)

  • 2.2 Running locally

• 3. Ports
• 4. Testing

  • 4.1 With Postman

  • 4.2 With Mojaloop Simulator

• 5. Usgae
• 6. Rules Engine

1. Quick Start

For getting started with Self Testing Toolkit quickly please follow the below steps.

• Deploy Self-Testing Toolkit using docker method
• Deploy Mojaloop Simulator
• Follow Usage guide

2. Running the toolkit

2.1 With Docker

This is the easiest way to run the self testing toolkit.

The following softwares should be installed on your system to run the toolkit.

• Git
• Docker

Please execute the following lines to run the tool.

git clone https://github.com/mojaloop/ml-self-testing-toolkit
cd ml-self-testing-toolkit
docker-compose up

2.2 Running locally

The following softwares should be installed on your system to run the toolkit.

• Git
• NodeJS

Please execute the following lines to run the tool.

git clone https://github.com/mojaloop/ml-self-testing-toolkit.git
cd ml-self-testing-toolkit
npm install
npm start

3. Ports

The server will start and listen on port 5000. You can send the mojaloop api requests to this port number.

And you can get the web interface on http://localhost:5050/

4. Testing

4.1 With Postman

Once the server is started on a particular port, you can send api requests from the sample postman collection included in this repository to test the basic functionalities like schema validation and version negotiation.

• Install the postman tool
• postman/mojaloop-pdp-testing-tool.postman_environment.json - Import this file as environment in postman.
• postman/mojaloop-pdp-testing-tool.postman_collection.json - Import this file as a collection in the postman.
• Run this whole collection using the "Runner" button at the top.

4.2 With Mojaloop Simulator

If you want to test the tool for the whole functionality like schema validation, additional validation and callback generation ..etc, you can initiate a transfer cycle from mojaloop simulator UI.

Please follow the below steps from the ml-self-testing-toolkit folder

cd simulator
docker-compose up

The above command will start the services scheme-adapter, mojaloop-simulator and mojaloop-simulator-ui.

Open the following URLs in your browser and send a transfer from simulator and observe the toolkit logs in web frontend.

• http://localhost:5050 (Front end for Self Testing Toolkit)
• http://localhost (Front end for Mojaloop Simulator)

5. Usage

After installation you can follow thsi Usage Guide

6. Rules

After you can send a successful transfer from mojaloop simulator, please observe the validation rules and callback generation rules in the front-end.

You can follow the following documentation and change the rules as per your needs.

Rules Documentation

**If you have your own DFSP implementation you can point the peer endpoint to self testing toolkit on port 5000 and try to send requests from your implementation instead of using mojaloop-simulator.