Skip to content

Commit

Permalink
add ml-testing-toolkit documentation (#235)
Browse files Browse the repository at this point in the history
* add ml-testing-toolkit documentation
  • Loading branch information
georgi-logodazhki authored Jul 2, 2020
1 parent ac8f138 commit 07fc68e
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 2 deletions.
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@
* [Scheme Adapter to Scheme Adapter](mojaloop-technical-overview/sdk-scheme-adapter/usage/scheme-adapter-to-scheme-adapter/README.md)
* [Scheme Adapter to Local ML Cluster](mojaloop-technical-overview/sdk-scheme-adapter/usage/scheme-adapter-and-local-k8s/README.md)
* [Scheme Adapter to WSO2 API Gateway](mojaloop-technical-overview/sdk-scheme-adapter/usage/scheme-adapter-and-wso2-api-gateway/README.md)
* [ML Testing Toolkit](mojaloop-technical-overview/ml-testing-toolkit/README.md)
* [API Specifications](api/README.md)
* [Mojaloop](api/mojaloop-api-specification.md)
* [Central Ledger API](api/central-ledger-api-specification.md)
Expand Down
16 changes: 16 additions & 0 deletions mojaloop-technical-overview/ml-testing-toolkit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Mojaloop Testing Toolkit
=============================

The **Mojaloop Testing Toolkit** was designed to help Mojaloop Schemes scale effectively by easing the DFSP Onboarding process. Schemes can provide a set of rules and tests on the toolkit and DFSPs can use it for self testing (or self-certification in some cases). This ensures that DFSPs are well and truly ready with their implementations to be integrated with the Scheme and allows for a quick and smooth onboarding process for the Mojaloop Hubs, thereby increasing their scalability.

This was initially aimed at FSPs/Participants that would like to participate in a Mojaloop scheme. However, in its current form, this tool set can potentially be used by both DFSPs and _Mojaloop Hubs_ to verify integration between the 2 entities. Intentionally build as a standard integration testing tool between a _Digital Financial Service Provider (DFSP)_ and the _Mojaloop Switch_ (Hub), to facilitate testing.

For additional background on the Self Testing Toolkit, please see [Mojaloop Testing Toolkit](https://github.com/mojaloop/ml-testing-toolkit/blob/master/documents/Mojaloop-Testing-Toolkit.md). It would be to the particpant's benefit to familiarise themselves with the understanding of the [Architecture Diagram](https://github.com/mojaloop/ml-testing-toolkit/blob/master/documents/Mojaloop-Testing-Toolkit.md#7-architecture) that explains the various components and related flows.

## Usage Guides

For Web interface follow this [Usage Guide](https://github.com/mojaloop/ml-testing-toolkit/blob/master/documents/User-Guide.md)

For Command line tool follow this [CLI User Guide](https://github.com/mojaloop/ml-testing-toolkit/blob/master/documents/User-Guide-CLI.md)

**If you have your own DFSP implementation you can point the peer endpoint to Mojaloop Testing Toolkit on port 5000 and try to send requests from your implementation instead of using mojaloop-simulator.**
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "documentation",
"version": "10.5.0",
"version": "10.5.1",
"description": "Mojaloop Documentation GitBook Project",
"dependencies": {
"express": "4.17.1",
Expand Down

0 comments on commit 07fc68e

Please sign in to comment.