@mojaloop/ml-testing-toolkit-client-lib 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -0
- package/README.md +42 -11
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,4 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
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.
|
|
4
4
|
|
|
5
|
+
### [0.0.3](https://github.com/mojaloop/ml-testing-toolkit-client-lib/compare/v0.0.2...v0.0.3) (2022-05-31)
|
|
6
|
+
|
|
5
7
|
### 0.0.2 (2022-05-31)
|
package/README.md
CHANGED
|
@@ -1,17 +1,25 @@
|
|
|
1
1
|
Mojaloop Testing Toolkit Client Library and Tools
|
|
2
2
|
=================================================
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
This package is intended to provide various clients and tools to connect with **Mojaloop Testing Toolkit** instead of using web interface.
|
|
5
5
|
|
|
6
|
-
For additional back ground information on the
|
|
6
|
+
For additional back ground information on the `Mojaloop Testing Toolkit`, please see [Mojaloop Testing Toolkit Documentation](https://github.com/mojaloop/ml-testing-toolkit/blob/master/documents/User-Guide.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.
|
|
7
7
|
|
|
8
|
+
## Testing Toolkit Command Line Client
|
|
9
|
+
|
|
10
|
+
The **Mojaloop Testing Toolkit CLI** is a command line client for connecting to "Mojaloop Testing Toolkit" to perform various operations (Mainly to execute test cases). It can be used in automation systems like CICD and IaC.
|
|
8
11
|
|
|
9
12
|
**Table of Contents**
|
|
10
13
|
|
|
11
14
|
1. [Getting Started](#1-getting-started)
|
|
12
|
-
2. [The Mojaloop Testing Toolkit CLI](#2-the-mojaloop-testing-toolkit)
|
|
13
15
|
|
|
14
|
-
|
|
16
|
+
1.1. [Installation](#11-installation)
|
|
17
|
+
|
|
18
|
+
1.2. [Usage](#12-usage)
|
|
19
|
+
|
|
20
|
+
2. [Command Reference](#2-command-reference)
|
|
21
|
+
|
|
22
|
+
2.1. [Help screen](#21-help-screen)
|
|
15
23
|
|
|
16
24
|
2.2. [Monitoring Mode](#22-monitoring-mode)
|
|
17
25
|
|
|
@@ -23,9 +31,32 @@ For additional back ground information on the Self Testing Toolkit, please see [
|
|
|
23
31
|
|
|
24
32
|
### 1. Getting Started
|
|
25
33
|
|
|
26
|
-
|
|
34
|
+
#### 1.1 Installation
|
|
35
|
+
|
|
36
|
+
The easiest way to use `Testing Toolkit Command Line Client` is to install it globally as a
|
|
37
|
+
Node command line program. Run the following command in Terminal:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npm install @mojaloop/ml-testing-toolkit-client-lib --global
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Or, you can install `@mojaloop/ml-testing-toolkit-client-lib` locally, for use in a single project:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
npm install @mojaloop/ml-testing-toolkit-client-lib --save-dev
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
*Note: To run the preceding commands, [Node.js](http://nodejs.org) and [npm](https://npmjs.com) must be installed.*
|
|
50
|
+
|
|
51
|
+
#### 1.2 Usage
|
|
52
|
+
|
|
53
|
+
After you've installed `@mojaloop/ml-testing-toolkit-client-lib`, you should be able to use the following command.
|
|
54
|
+
```
|
|
55
|
+
ml-ttk-cli
|
|
56
|
+
```
|
|
57
|
+
**_If this command is not found, you should add the folder path of npm global modules to your PATH._
|
|
27
58
|
|
|
28
|
-
### 2.
|
|
59
|
+
### 2. Command Reference
|
|
29
60
|
|
|
30
61
|
#### 2.1 Help screen
|
|
31
62
|
|
|
@@ -34,7 +65,7 @@ The help screen allows you to see the usage, possible options and default values
|
|
|
34
65
|
command:
|
|
35
66
|
|
|
36
67
|
```
|
|
37
|
-
|
|
68
|
+
ml-ttk-cli -h
|
|
38
69
|
```
|
|
39
70
|
|
|
40
71
|
output:
|
|
@@ -67,7 +98,7 @@ Example:
|
|
|
67
98
|
command:
|
|
68
99
|
|
|
69
100
|
```
|
|
70
|
-
|
|
101
|
+
ml-ttk-cli -m monitoring
|
|
71
102
|
```
|
|
72
103
|
|
|
73
104
|
output:
|
|
@@ -137,7 +168,7 @@ The CLI tool is able to return the proper exit codes in case of success and fail
|
|
|
137
168
|
command:
|
|
138
169
|
|
|
139
170
|
```
|
|
140
|
-
|
|
171
|
+
ml-ttk-cli -m outbound -i examples/collections/dfsp/p2p_happy_path.json -e examples/environments/dfsp_local_environment.json --report-format html
|
|
141
172
|
```
|
|
142
173
|
|
|
143
174
|
output:
|
|
@@ -196,7 +227,7 @@ To use AWS S3 service, the following environment variables should be set with pr
|
|
|
196
227
|
Example Command:
|
|
197
228
|
|
|
198
229
|
```
|
|
199
|
-
|
|
230
|
+
ml-ttk-cli -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
|
|
200
231
|
```
|
|
201
232
|
|
|
202
233
|
#### 2.5 Slack Notification
|
|
@@ -209,5 +240,5 @@ If the S3 option is also set, then a link to the uploaded report will be sent in
|
|
|
209
240
|
Example Command:
|
|
210
241
|
|
|
211
242
|
```
|
|
212
|
-
|
|
243
|
+
ml-ttk-cli -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...
|
|
213
244
|
```
|
package/package.json
CHANGED