derberg/simulator

Simulator

The official simulator for simulating scenarios

Ever wondered what it would feel like your application to be the center of interest?

Does it seem distant or difficult to switch from development mode to production mode?

📢 ATTENTION:

This package is under development and it has not reached version 1.0.0 yet, which means its API might get breaking changes without prior notice. Once it reaches its first stable version, we'll follow semantic versioning.

Define and simulate scenarios for your applications

Usage

simulator -f ./my_api.yaml -s ./scenario.yaml
simulator -f ../subdirectory/my_api.json -s ./scenario.json

Run sample application by specifying the corresponding
AsyncApi and scenario files.

simulator -f ./example-projects/game-processor/asyncapi.yaml -s ./example-projects/game-processor/scenario.yaml
or
simulator -b ../ -f ./simulatorFolder/example-projects/game-processor/asyncapi.yaml -s ./simulatorFolder/example-projects/game-processor/scenario.yaml

Cli

Options:
  -v                     AsyncApi simulator cli version.
  -f, --filepath <type>  The filepath of a AsyncAPI document, as either yaml or json file.
  -s, --scenario <type>  The filepath of a json or yaml file which defines a scenario based on the spec.
  -b, --basedir <type>   The basePath from which relative paths are computed.
                         Defaults to the directory where simulator.sh resides. (default: "./").
  -h, --help             Display help for flags and commands.

Supported Protocols

mqtt

AsyncApi File

The file where the api you want to test is defined. By specifying the x-plot: {id} field
under a channel will automatically make the channel available for sending requests.

Scenario File

Here with the plot-{id} (where id is the same as the x-plot: {id} in the field you specified in the AsyncAPI channel) field you:

Connect your AsyncApi and scenario File.
Specify the parameters for each channel and have the options for them to be randomly generated.
Specify the payload you want to send.

Contributing

Read CONTRIBUTING guide.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{NektariosFifes} 💻 📖 🤔 🚧 ⚠️	_{Jonas Lagoni} 📖 👀 🧑‍🏫 💡

This project follows the all-contributors specification. Contributions of any kind welcome!