rpc-tests

Collection of JSON RPC black-box testing tools

Table of Contents

1. Installation

   1. Prerequisites
   2. Obtaining rpc-tests

2. Integration Testing

3. Performance Testing

4. Contributing

Installation

Prerequisites

Using rpc-tests requires installing:

• Vegeta >= 12.8.4
• Python >= 3.10
• [python3-jsonpatch] >= 1.32 (see README on integration subfolder)
• [json-diff] using npm (see README on integration subfolder)

After installation, make sure vegeta, json-diff and json-patch-jsondiff commands are available at your shell prompt.

After installation, make sure python3 and pip3 commands are available at your shell prompt by running python3 --version and pip3 --version.

Obtaining rpc-tests

To obtain rpc-tests source code for the first time:

git clone https://github.com/erigontech/rpc-tests.git
cd rpc-tests

Create and activate Python virtual environment

Create your local virtual environment:

python3 -m venv .venv

Activate it:

source .venv/bin/activate

.\.venv\Scripts\activate

rpc-tests uses a few Python third-party libraries, so after you've updated to the latest code with

git pull

update the dependencies

pip3 install -r requirements.txt

Integration Testing

Check out the dedicated guide in Integration Tests.

Performance Testing

Check out the dedicated guide in Performance Tests.

Standalone Testing Tools

Get Latest/Safe/Finalized Blocks

python3 -m rpctests.block_by_number

Find Empty Blocks

python3 -m rpctests.empty_blocks

Query Filter Changes

python3 -m rpctests.filter_changes

Get Latest Block Logs

python3 -m rpctests.latest_block_logs

GraphQL

python3 -m rpctests.graphql

ReplayRequest

python3 -m rpctests.replay_request

ReplayTx

python3 -m rpctests.replay_tx

Subscribe-And-Listen For Notifications

python3 -m rpctests.subscriptions

Development

Unit Tests

pytest