docs: update
This commit is contained in:
parent
aff3177395
commit
5d7a85b729
12
README.md
12
README.md
@ -1,8 +1,8 @@
|
|||||||
## cic-ussd-e2e
|
# cic-ussd-e2e
|
||||||
|
|
||||||
> Mocking user interaction with cic-ussd
|
> Mocking user interaction with cic-ussd
|
||||||
|
|
||||||
### Setup
|
## Setup
|
||||||
|
|
||||||
**Pre-requisites**
|
**Pre-requisites**
|
||||||
|
|
||||||
@ -16,25 +16,25 @@
|
|||||||
- Node.js
|
- Node.js
|
||||||
- Install dependencies with `$ npm i`
|
- Install dependencies with `$ npm i`
|
||||||
|
|
||||||
### Running tests
|
## Running tests
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ npm run test
|
$ npm run test
|
||||||
```
|
```
|
||||||
|
|
||||||
### Scenarios
|
## Scenarios
|
||||||
|
|
||||||
| Test | Description |
|
| Test | Description |
|
||||||
| ---------------- | ---------------------------- |
|
| ---------------- | ---------------------------- |
|
||||||
| 1_initial_menu | Main menu > Help > Exit |
|
| 1_initial_menu | Main menu > Help > Exit |
|
||||||
| 2_display_sarafu | Main menu > My Sarafu > Exit |
|
| 2_display_sarafu | Main menu > My Sarafu > Exit |
|
||||||
|
|
||||||
#### Writing your own scenario
|
### Writing your own scenario
|
||||||
|
|
||||||
- Each scenario should exit since this test suite doesn't pass around past session info
|
- Each scenario should exit since this test suite doesn't pass around past session info
|
||||||
- Control wait between menus with the `wait(time in ms)` function
|
- Control wait between menus with the `wait(time in ms)` function
|
||||||
- Follow any spec
|
- Follow any spec
|
||||||
- For any traversing through menus, remember to append a `*` and the next input, this is to correctly mock AT webhooks e.g.
|
- For any menu traversal, remember to append a `*` before the next input, this correctly mocks AT webhooks e.g.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Initial Main menu, no input
|
# Initial Main menu, no input
|
||||||
|
Reference in New Issue
Block a user