E2E Tests - Quickstart
TODO
Add a gif of load tests running locally.
tl;dr Fully featured E2E Tests to verify PATH works correctly.
Quickstart
⚠️ Prerequisites: Complete the Getting Started and Pocket Cheat Sheet guides.
First, prepare the Shannon E2E test config file:
make config_copy_path_local_config_shannon_e2e
Then, run HTTP E2E tests for specific service IDs:
make e2e_test eth,xrplevm
Or, run HTTP E2E tests for all service IDs:
make e2e_test_all
WebSocket E2E Tests
For services that support WebSocket connections (like XRPLEVM), you can run WebSocket-specific tests separately:
# Run WebSocket tests for specific service IDs
make e2e_test_websocket xrplevm,xrplevm-testnet
# Run WebSocket tests for all WebSocket-compatible services
make e2e_test_websocket_all
Note: WebSocket tests are completely separate from HTTP tests. Use the regular make e2e_test commands for HTTP-only testing, and the make e2e_test_websocket commands for WebSocket-only testing.
E2E Test Config Files
| Configuration File | Custom Config Required? | Default available? | Description | Command to create or customize |
|---|---|---|---|---|
./e2e/config/.shannon.config.yaml | ✅ | ❌ | Gateway service configuration for PATH | make config_copy_path_local_config_shannon_e2e OR make config_shannon_populate |
./e2e/config/.e2e_load_test.config.yaml | ❌ | e2e/config/e2e_load_test.config.tmpl.yaml | Custom configuration for E2E tests | make config_prepare_shannon_e2e |
Supported Services in E2E Tests
To see the list of supported services for the tests, see the test_cases array in the E2E Test Config file.