docs: update

This commit is contained in:
Mohamed Sohail 2022-03-24 19:40:15 +03:00
parent aff3177395
commit 5d7a85b729
Signed by: kamikazechaser
GPG Key ID: 7DD45520C01CD85D

View File

@ -1,8 +1,8 @@
## cic-ussd-e2e
# cic-ussd-e2e
> Mocking user interaction with cic-ussd
### Setup
## Setup
**Pre-requisites**
@ -16,25 +16,25 @@
- Node.js
- Install dependencies with `$ npm i`
### Running tests
## Running tests
```bash
$ npm run test
```
### Scenarios
## Scenarios
| Test | Description |
| ---------------- | ---------------------------- |
| 1_initial_menu | Main menu > Help > 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
- Control wait between menus with the `wait(time in ms)` function
- 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
# Initial Main menu, no input