pitaya-bot

README

pitaya-bot

Pitaya-Bot is an easy to use, fast and lightweight test server framework for Pitaya. The goal of pitaya-bot is to provide a basic development framework for testing pitaya servers via integration tests or stress tests.

Getting Started

Prerequisites

• Go >= 1.10
• etcd (optional: for running the testing example)
• nats (optional: for running the testing example)
• docker (optional: for running the testing example)

Installing

clone the repo

go get -u github.com/topfreegames/pitaya-bot

setup pitaya-bot dependencies

cd $GOPATH/src/github.com/topfreegames/pitaya-bot/
make setup

Running pitaya-bot

Here's how to run the testing example with JSON serializer:

Start etcd and nats (this command requires docker-compose and will run etcd and nats containers locally, you may run etcd and/or nats without docker if you prefer)

docker-compose -f ./testing/json/docker-compose.yml up -d etcd

run the server from testing example

make run-testing-server

Now a pitaya server should be running in one terminal. In another one, you can use pitaya-bot testing example:

$ pitaya-bot run -d ./testing/json/specs/ --config ./testing/json/config/config.yaml
testing/json/specs/default.json 1755
INFO[0000] Found 1 specs to be executed                  function=launch source=pitaya-bot
...

To run the protobuf example you can run:

make run-testing-proto-server
pitaya-bot run -d ./testing/protobuffer/specs --config ./testing/protobuffer/config/config.yaml

Running the tests

make test

Contributing

#TODO

Authors

• TFG Co - Initial work

License

MIT License

Resources

• Other pitaya-related projects

  • libpitaya
  • libpitaya-cluster
  • pitaya
  • pitaya-admin
  • pitaya-cli
  • pitaya-protos

• Documents

  • API Reference