Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nndi-oss/dialoguss

CLI tool for testing HTTP based USSD applications
https://github.com/nndi-oss/dialoguss

africastalking cli golang integration-testing testing tnm-ussd ussd ussd-applications

Last synced: 11 days ago
JSON representation

CLI tool for testing HTTP based USSD applications

Host: GitHub
URL: https://github.com/nndi-oss/dialoguss
Owner: nndi-oss
License: mit
Created: 2018-02-28T16:26:18.000Z (almost 7 years ago)
Default Branch: main
Last Pushed: 2024-08-08T09:30:32.000Z (6 months ago)
Last Synced: 2024-08-09T11:38:48.251Z (6 months ago)
Topics: africastalking, cli, golang, integration-testing, testing, tnm-ussd, ussd, ussd-applications
Language: Go
Homepage: https://nndi.cloud/oss/dialoguss/
Size: 99.6 KB
Stars: 15
Watchers: 8
Forks: 9
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Dialoguss
=========

`dialoguss` is a cli tool to test USSD applications that are implemented
as HTTP services - particularly those implemented via:

* [AfricasTalking's](https://africastalking.com/) service or
* Using [ussd-adapter](https://github.com/saulchelewani/ussd-adapter)

`dialoguss` is useful for testing your USSD applications during development.

It can be used in two ways:
1. You can simulate a session and interact with that session via a simple CLI based interface or,
2. You can describe the steps required for a session and automate the session, i.e. automated testing

## Usage

`dialoguss` requires a YAML file to run. The file describes one application
and has to contain atleast `url` to the application, `dial` the USSD shortcode for your
app and a `phoneNumber` to use for the session tests.

For the automated dialogue tests you are required to define `steps` which
describe the sequence of steps for one USSD session. Steps define the text
to send to the USSD application and the expected output after sending that
text.

Please refer to the examples below:

### Interactive Dialogue

```yaml
# app.yaml
url: http://localhost:9000/ussd
dial: *123*1234#
phoneNumber: 265888123456
```

```sh
$ dialoguss --interactive --file=app.yaml simulate
```

`dialoguss` will start hitting your USSD endpoint to enable you to simulate
interaction, the whole session can be performed from the command-line.

An example output is below:

```
What is your name?
> name: Zikani

Hello Zikani, choose an item:
1. Account detail
2. Balance
3. Something else
# Exit
> 2

Your balance is: MK 500
> ok
```

### Automated Dialogue

```yaml
# app.yml
url: http://localhost:7654
dial: "*1234*1234#"
# 'global' phone number, overriden per session
phoneNumber: 265888123456
sessions:
- id: 12345678910
phoneNumber: 265888123456
description: "Should return a balance of 500 for Zikani"
steps:
# The first step is the response after dialing the ussd code
- expect: "What is your name?"
- userInput: "Zikani"
expect: |-
Welcome, Zikani
Choose an item:
1. Account detail
2. Balance
3. Something else
# Exit
- userInput: "2"
expect: "Your balance is: MK 500"
```

```sh
$ dialoguss --file=app.yml run
All steps in session 12345678910 run successfully
```

## Why should I use this?

Glad you asked! Well, mostly this tool will help you reduce costs
related to testing your USSD applications.
The current approach for testing your applications could be to upload
the code to your server, pull out your phone and dial the USSD service
code linked to your application.

_That's too much work and costs you time and monies!_

You should use this if you'd like to test your application before deploying
it to production.

---