Skip to content
This repository has been archived by the owner on Sep 11, 2023. It is now read-only.
/ pitaya-bot Public archive

Testing framework for Pitaya, providing automated tests

License

Notifications You must be signed in to change notification settings

topfreegames/pitaya-bot

Repository files navigation

Deprecation Notice

Pitaya-bot is no longer the recommended way to load test pitaya applications. We recommend using xk6-pitaya

pitaya-bot GoDoc Docs Go Report Card MIT licensed Build Status Coverage Status

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 the dependencies (this command requires docker-compose, but you may run the dependencies locally if need be) and the pitaya server:

$ make run-testing-json-server

Now a pitaya server should be running in one terminal. In another one, you can run pitaya-bot with the test specs:

$ make run-testing-json-bots

For the examples with protobuf, instead run:

$ make run-testing-proto-server
$ make run-testing-proto-bots

Running the tests

make test

Contributing

#TODO

Authors

  • TFG Co - Initial work

License

MIT License

Resources