status-go/tests-functional/README.MD

Here’s the updated README with the additional prerequisites and instructions:

---

Overview

Functional tests for status-go

Table of Contents

• Overview
• How to Install
• How to Run
  • Running Tests
• Implementation Details
• Build Status Backend

How to Install

1. Install Docker and Docker Compose
2. Install Python 3.10.14
3. Set up a virtual environment (recommended):
   • In ./tests-functional, run:

     python -m venv .venv
     source .venv/bin/activate
     pip install -r requirements.txt
     

   • Optional (for test development): Use Python virtual environment for better dependency management. You can follow the guide here
4. Install pre-commit hooks (optional):

   pre-commit install
   

How to Run

Running dev RPC (Anvil with contracts)

In ./tests-functional:

docker compose -f docker-compose.anvil.yml up --remove-orphans --build

This command will:

• Start an Anvil container with ChainID 31337, exposed on 0.0.0.0:8545
• Deploy Status-im contracts to the Anvil network

Running Tests

To run the tests:

1. In ./tests-functional, start the testing containers:

   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
   

   This command will:

   • Create a container with status-go as daemon, exposing APIModules on 0.0.0.0:3333
   • Configure status-go to use Anvil as the RPCURL with ChainID 31337
   • Deploy all Status-im contracts to the Anvil network

2. To execute tests:

   • Run all tests:

     pytest
     

   • Run tests marked as wallet:

     pytest -m wallet
     

   • Run a specific test:

     pytest -k "test_contact_request_baseline"
     

Implementation Details

• Functional tests are implemented in ./tests-functional/tests using pytest.

• Each test performs two types of verifications:

  • verify_is_valid_json_rpc_response(): Checks for a status code 200, a non-empty response, JSON-RPC structure, presence of the result field, and the expected ID.
  • jsonschema.validate(): Validates that the response contains expected data, including required fields and types. Schemas are stored in /schemas/wallet_MethodName.

• Schema Generation:

  • New schemas can be generated with ./tests-functional/schema_builder.py by passing a response to the CustomSchemaBuilder(schema_name).create_schema(response.json()) method. This should be used only during test creation.
  • Search how to create schema: in test files for examples.

Build Status Backend

You can build the binary with the following command in the status-go root directory:

make status-backend

For further details on building and setting up status-go and status-backend, refer to the official documentation:

• status-backend README
• status-go cmd directory

Location of the binary: cmd/status-backend/status-backend

---

This README should cover your additional setup, installation, and testing instructions with clear steps for users. Let me know if there are any further modifications needed!