This repository is home to public load tests for edX software components. New tests should be developed here. Old tests should be scrubbed and moved here over time.

If you have not already done so, create and activate a virtualenv. Unless otherwise stated, assume all commands below are executed within said virtualenv.

Next, install load testing requirements.

$ pip install -r requirements.txt

Start Locust by providing the Locust CLI with a target host and pointing it to the location of your desired locustfile. For example,

$ locust --host=http://localhost:8009 -f programs

Tests are organized into top-level packages. For examples, see csm and programs. A module called locustfile.py is included inside each test package, within which a subclass of the Locust class is defined. This subclass is imported into the test package's __init__.py to facilitate discovery at runtime.

The code in this repository is licensed under the AGPLv3 unless otherwise noted. Please see LICENSE.txt for details.

Contributions are very welcome.

Please read How To Contribute for details.

Even though they were written with edx-platform in mind, the guidelines should be followed for Open edX code in general.

Please do not report security issues in public. Please email security@edx.org.

You can discuss this code in the edx-code Google Group or in the #edx-code IRC channel on Freenode.