status-go/integration-tests/README.MD

2.4 KiB

Overview

Integration tests for status-go

Table of Contents

How to Install

  • Install Docker and Docker Compose
  • Install Python 3.10.14
  • In integration-tests directory, run pip install -r requirements.txt
  • Optional (for test development): Use Python virtual environment for better dependency management. You can follow the guide here:

How to Run

Running dev RPC (anvil with contracts)

  • In integration-tests run docker compose -f docker-compose.anvil.yml up --remove-orphans --build, as result:
    • an anvil container with ChainID 31337 exposed on 0.0.0.0:8545 will start running
    • Status-im contracts will be deployed to the network

Run tests

  • In integration-tests run docker compose -f docker-compose.anvil.yml -f docker-compose.test.status-go.yml up --build --remove-orphans, as result:
    • a container with status-go as daemon will be created with APIModules exposed on 0.0.0.0:3333
    • status-go will use anvil as RPCURL with ChainID 31337
    • all Status-im contracts will be deployed to the network
  • In integration-tests/tests directory run pytest -m wallet

Implementation details

  • Integration tests are implemented in integration-tests/tests based on pytest
  • Every test has two types of verifications:
    • verify_is_valid_json_rpc_response() checks for status code 200, non-empty response, JSON-RPC structure, presence of the result field, and expected ID.
    • jsonschema.validate() is used to check that the response contains expected data, including required fields and types. Schemas are stored in /schemas/wallet_MethodName
    • New schemas can be generated using integration-tests/schema_builder.py by passing a response to the CustomSchemaBuilder(schema_name).create_schema(response.json()) method, should be used only on test creation phase, please search how to create schema: to see an example in a test