Functional tests for status-go

• Overview
• How to Install
• How to Run
  • Running Tests
• Implementation details

1. Install Docker and Docker Compose
2. Install Python 3 (tested with 3.10 and 3.12 and it works with both)
3. Set up a virtual environment (required for linting):
   • In ./tests-functional, run:

     python3 -m venv .venv source .venv/bin/activate pip install -r requirements.txt pre-commit install

   • Important: The virtual environment must be created in the ./tests-functional directory for pre-commit linting and type-checking tools like Pyright to work correctly.
   • Optional (for test development): Use Python virtual environment for better dependency management. You can follow the guide here

• In ./tests-functional 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

• In ./tests-functional run docker compose -f docker-compose.anvil.yml -f docker-compose.test.status-go.yml -f docker-compose.status-go.local.yml up --build --remove-orphans, as result:
  • a container with status-backend will be created with endpoint exposed on 0.0.0.0:3333
  • status-go will use anvil as RPCURL with ChainID 31337
  • Status-im contracts will be deployed to the network

• In ./tests-functional/tests directory run pytest -m rpc
• To run tests against binary run pytest -m <your mark> --url=http:<binary_url>:<binary_port> --user_dir=/<path>

• Functional tests are implemented in ./tests-functional/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 ./tests-functional/utils/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

When running tests with auto-creating status-backend containers, you might face this:

sock.connect(self.unix_socket) PermissionError: [Errno 13] Permission denied

Please follow this fix: docker/compose#10299 (comment)

If you're on MacOS and /var/run/docker.sock doesn't exist, you need to create a symlink to the docker socket:

sudo ln -s $HOME/.docker/run/docker.sock /var/run/docker.sock