cdscih/stairable

A tool to test whether or not an endpoint is able to work with the load it's supposed to handle.

stairable's Issues

add: live results

Currently the tests are being executed entirely before showing the result. It would be much better to have a constant live streaming of the tests that are being done.

add: support for more than one endpoint

add: dind to run sample servers inside dev container

Last time I tried I had issues with docker not being able to connect the already running host.

I tried reassigning the DOCKER_HOST variable to multiple things but it didn't work.

It's quite ugly to be forced to launch the sample servers that run in python from the outside. This should be supported asap imo.

Useful links:
https://docs.docker.com/engine/install/debian/#install-using-the-repository
https://docs.docker.com/engine/install/linux-postinstall/
https://www.caktusgroup.com/blog/2020/02/25/docker-image/
https://stackoverflow.com/questions/25234792/what-does-the-docker-host-variable-do

add: CONTRIBUTING.md

A file with the instructions to contribute needs to be created.

add: CI pipeline to deploy an image to docker hub

There should be one triggered after every tag on master and perhaps one for every branch commit.

add: web server that exposes the basic UI

This tool is supposed to be used primarily through a graphical interface exposed by a web server.

Ideally it would need to have a way to:

• setup all the required fields
• setup the endpoint you want to test
• a way to visualise the status of the test (live)
• an input space where to insert a javascript snippet that allows the user to create a function which creates the input to the http/s call

Note: This is probably going to be divided into subtasks later on.

add: CLI support

Ideally this tool would also have a CLI interface.

It's not supposed to be too hard to do, the Options object would simply need to be created through CLI params, but it's not of high priority since it's supposed to be a UI tool first.

Notes:

• this "bin feature" of the package.json seems very interesting for this purpose.
• I really like the CLI implementation of autocannon, we could take inspiration on how to do it there.

add: support for body creation function

This library wants to help the end user to test if the endpoint can sustain the load also by the amount/size of the input.

The only way to meaningfully do that is by allowing the use to choose how the "createNs" function works.

This task is supposed to add this createNs function to the Options object and utilise it to test the endpoint.

add: support for consistent load tests

This issue is to implement a way to test a consistent amount of requests & connections over "X" amount of time.

An extension to the basic feature could be the option to test with randomly created bodies through a function.

add: support for multiple tests with same class

add: support for connections and rps offset

This is issue is to implement a way to start testing an endpoint after a custom offset for both RPS and simultaneous connections.

add: more example endpoints

It'd be great to have an example folder, on the top level of the project, where to put inside a docker-compose which exposes 3 endpoints:

• one hat retrieves data from a postgres
• one that does the same but adds a Redis cache on top of it
• one that retrieves data from a mongodb

I'm gonna to try to do one written in Golang as well.

add: tests for main usecases

Everything needs to be tested as soon as everything is somewhat stable.