diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..1342892 --- /dev/null +++ b/Readme.md @@ -0,0 +1,32 @@ +### What is Locust? + +[Locust io](https://locust.io/) + +It is a load testing framework that allows you to write tests in actual code in your own +choice of language. + +#### How do I use Locust in python? + +Locust + +Python is the only official client for the load tests. You can find the [docs](https://docs.locust.io/en/stable/writing-a-locustfile.html#) +for writing locustfile aka tests. This most basic example of how to write a test and build it for using it with the +[Locust Operator](https://github.pie.apple.com/official-star/repo/tree/main/server/locust-operator). + +#### Files + +[Example Test](https://github.pie.apple.com/aci/python-locust-example/blob/develop/test_example.py) +This test creates two tasks that are weighted differently so task foo will be called more often. +The tasks will sleep for 1 second and then fire a success or failure. + +[Rio Config](https://github.pie.apple.com/aci/python-locust-example/blob/develop/rio.yaml) +This freestyle build will compile the tests and add them to the path the docker build will +use to add it to the container. + +[Docker build](https://github.pie.apple.com/aci/python-locust-example/blob/develop/Dockerfile) +This will build a container used for load testing in. The key part of this is the dir path that the +tests are put into. This will be used in the locust operator config + +[Example Operator config](https://github.pie.apple.com/official-star/repo/blob/main/lib/go/locust-operator/config/samples/test-python.yaml) +This example config will run this test for 2 minutes. +The testContainer is the container built by the rio container build here.