Load Tests Quickstart (< 10min)

TODO

Add a gif of load tests running locally.

tl;dr Fully featured Load Tests to verify PATH works correctly.

Load Testing using Local PATH

⚠️ Prerequisites: Complete the Getting Started and Shannon Cheat Sheet guides ⚠️

First, prepare the Shannon test config file at ./e2e/config/.shannon.config.yaml by running:

make config_copy_path_local_config_shannon_e2e

Then, run load tests for specific service IDs:

make load_test eth,xrplevm

Or, run load tests for all service IDs:

make load_test_all

Production Grove Portal Testing Only

🛑 STOP HERE if you only need local PATH testing!

The remainder of this document is only relevant if you intend to load test the Grove's Portal in production.

If you're only testing your local PATH instance, the commands above are sufficient.

🌿 Grove Employees

You can obtain the required Portal Application ID and API Key from the Grove Portal App Credentials for PATH Load Testing on 1Password.

You can export like so to your shell:

op item get iznzvqegxbl4y73d5lppm4y6r4 --fields notesPlain --format json | jq -r '.value'

First, setup your configs & credentials:

make config_copy_e2e_load_test

You will be prompted to enter your Grove Portal Application ID and API Key.

Next, run load tests against Grove Portal:

# Shannon load tests with specified service IDs only
make load_test eth,xrplevm

# Shannon load tests with all service IDs
make load_test_all

🌿 Grove Employees Only

This section is exclusively for Grove employees who need to test PATH's fallback endpoint functionality.

First, download the PATH config from 1Password (see the existing Grove Portal section above for credentials access).

Next, enable fallback endpoints for all services:

make config_enable_grove_fallback

Then, restart PATH to apply the config updates:

make path_down; make path_up

Finally, run load tests:

make load_test eth,xrplevm