Using Brownie for Python-Based Testing

Introduction to Brownie

Brownie is a Python-based development and testing framework for Ethereum smart contracts.
Built on top of Web3.py
and pytest,
Brownie brings Python’s versatility to the blockchain space. Its minimalist design, combined with powerful testing utilities,
makes it an essential tool for Solidity developers seeking reliable, automated testing workflows.

Why Choose Brownie

• Python Ecosystem: Full access to Python libraries for scripting, data analysis, and more.
• pytest Integration: Leverage fixtures, parametrization, and plugins from the pytest community.
• Built-in Console: Interactive REPL for quick contract inspection and debugging.
• Network Management: Effortless configuration of local, testnet, and mainnet forks.
• Coverage Report: Measure test coverage and generate HTML reports.

Installation and Setup

1. Prerequisites

• Python 3.7 installed
• pip package manager
• Local Ethereum node (e.g., Ganache)

2. Installing Brownie

pip install eth-brownie
  

3. Initializing a Project

brownie init
  

This creates the standard directory structure:

Writing Your First Test

Sample Solidity Contract

// contracts/SimpleStorage.sol
pragma solidity ^0.8.0

contract SimpleStorage {
    uint256 public value

    function setValue(uint256 _value) public {
        value = _value
    }
}
  

Corresponding pytest Test

# tests/test_simple_storage.py
import pytest
from brownie import SimpleStorage, accounts

@pytest.fixture
def storage():
    return SimpleStorage.deploy({from: accounts[0]})

def test_default_value(storage):
    assert storage.value() == 0

def test_set_value(storage):
    tx = storage.setValue(42, {from: accounts[0]})
    tx.wait(1)
    assert storage.value() == 42
  

Brownie automatically makes accounts,
deploy returns a contract instance,
and pytest.fixture provides a fresh contract per test.

Advanced Testing Techniques

Parametrization

Use pytest’s @pytest.mark.parametrize
to cover multiple scenarios without code duplication.

Network Forking

Brownie can fork mainnet or testnets for realistic testing. Configure in brownie-config.yaml:

networks:
  mainnet-fork:
    cmd_settings:
      fork: https://mainnet.infura.io/v3/YOUR_INFURA_KEY
  

Coverage Analysis

Enable coverage reports with:

brownie test --coverage
  

Continuous Integration Integration

Integrate Brownie tests into GitHub Actions:

name: Brownie CI

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: 3.8
      - name: Install Dependencies
        run: 
          pip install eth-brownie
      - name: Run Tests
        run: brownie test --network mainnet-fork --coverage
  

Best Practices and Tips

• Isolate state changes: Reset fixtures for each test.
• Use meaningful test names and docstrings.
• Separate unit tests from integration tests.
• Mock external calls with interface stubs.
• Leverage brownie console for quick inspection.

Further Resources

• Brownie Documentation
• Web3.py Docs
• pytest Official Site
• Solidity Language Docs