智能合约与以太坊 / 系统课时

用 setUp 固定部署与初始状态

用 setUp 固定部署与初始状态

同一份智能合约测试如果依赖其他用例留下的余额或授权,单独运行和全量运行就可能得到不同结果。使用 Foundry 的 setUp() 可以统一部署被测合约、准备测试账户与资产,让每个用例从可预期的状态开始。本篇通过一个存款合约验证夹具复用和用例隔离。

学习目标

  • 使用 setUp() 部署合约并初始化账户、余额和测试资产。
  • 将公共初始状态与单个用例的业务操作分开。
  • 通过独立运行和全量运行验证测试之间没有状态污染。

理解 setUp 的执行时机

Foundry 将测试合约中以 test 开头的 public 或 external 函数识别为测试用例。setUp() 是一个可选的公共初始化函数,在每个测试用例执行前调用。

对普通单元测试而言,Forge 会让各用例从各自的初始化状态执行。前一个用例修改的合约存储、账户余额不会自然延续到下一个用例。模糊测试的不同输入运行也会从初始化状态开始。

例如,两个测试都要求用户初始拥有 10 ETH:

  1. 为第一个测试准备 10 ETH,执行存款并检查余额。
  2. 为第二个测试重新获得初始状态,检查尚未发生任何存款。
  3. 两个测试无论按什么顺序运行,都应得到相同的断言结果。

Foundry 测试夹具与用例隔离示意图

setUp() 并不是在整个测试文件运行前只执行一次,也不是每个测试之间共享一个持续变化的链上实例。可以复用的是初始化代码和测试夹具定义,而不是前一个测试修改后的状态。

部署合约并准备共享夹具

以下示例适用于使用 Solidity 0.8.24 或兼容版本、已安装 forge-std 的 Foundry 项目。新建项目可以运行:

bash
forge init setup-demo
cd setup-demo

预期结果:项目创建成功,包含 src/、test/、foundry.toml 等文件;具体初始化日志依 Foundry 版本而异。如果已有 Foundry 项目,可以跳过这一步。

首先创建 src/Vault.sol,实现最小存款业务:

solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;

contract Vault {
    mapping(address => uint256) public deposits;

    function deposit() external payable {
        require(msg.value > 0, "zero deposit");
        deposits[msg.sender] += msg.value;
    }
}

deposits 记录各账户的累计存款,初始值为 0。该合约只用于演示测试夹具,不包含生产资金托管系统必需的提现、权限和安全控制。

然后创建 test/Vault.t.sol:

solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;

import {Test} from "forge-std/Test.sol";
import {Vault} from "../src/Vault.sol";

contract VaultTest is Test {
    Vault internal vault;
    address internal alice;
    uint256 internal constant INITIAL_BALANCE = 10 ether;

    function setUp() public {
        // 每个测试从新部署的合约开始,避免复用被修改的存款记录
        vault = new Vault();
        alice = makeAddr("alice");

        // deal 只调整测试环境中的 ETH 余额,不向 Vault 存款
        vm.deal(alice, INITIAL_BALANCE);
    }

    function test_InitialState() public view {
        assertEq(alice.balance, INITIAL_BALANCE);
        assertEq(vault.deposits(alice), 0);
        assertEq(address(vault).balance, 0);
    }

    function test_Deposit() public {
        vm.prank(alice);
        vault.deposit{value: 2 ether}();

        assertEq(vault.deposits(alice), 2 ether);
        assertEq(alice.balance, 8 ether);
        assertEq(address(vault).balance, 2 ether);
    }

    function test_StillStartsEmpty() public view {
        // 即使其他测试已经调用 deposit,本用例仍看到初始状态
        assertEq(vault.deposits(alice), 0);
        assertEq(alice.balance, INITIAL_BALANCE);
    }
}

这里的公共夹具包含三个部分:vault 是每次初始化部署的合约实例;alice 是固定标识的测试账户;INITIAL_BALANCE 是所有测试共用的初始资金配置。

makeAddr("alice") 生成稳定的测试地址,vm.deal 设置地址的 ETH 余额,vm.prank(alice) 让紧接着的一次合约调用以 Alice 身份发起。2 ether 表示 2 ETH 对应的 Wei 数值,并不是整数 2。

执行:

bash
forge test --match-contract VaultTest

预期输出(省略编译耗时及环境相关信息):

text
[PASS] test_Deposit()
[PASS] test_InitialState()
[PASS] test_StillStartsEmpty()
Suite result: ok. 3 passed; 0 failed; 0 skipped

测试函数展示顺序及日志格式可能随 Foundry 版本变化,但应有 3 个通过、0 个失败。

验证测试之间的状态隔离

验证隔离不能只看一次全量测试是否通过,还要让单个用例脱离其他测试独立执行。

先单独执行初始状态检查:

bash
forge test --match-contract VaultTest --match-test test_StillStartsEmpty

预期结果:只运行 test_StillStartsEmpty(),显示 1 个通过、0 个失败。随后再次运行完整测试文件,应仍然有 3 个通过。

这个检查能识别两类常见问题:一是某个测试要求先执行另一个测试;二是测试读取了文件或外部服务中的持久数据,而这些数据没有被重新准备。

特别注意,Foundry 的链上状态隔离不等于所有外部副作用都会回滚。使用 FFI 写入本地文件、访问外部 API 或修改其他进程的数据时,应另行设计清理措施。

如果为每个用例部署的合约与状态相同,可以放入 setUp();如果只有某个测试需要特殊余额、角色或时间,则应在那个测试中单独准备,避免让公共夹具携带不必要的业务前提。

处理共享夹具中的常见错误

不要把业务操作提前放入 setUp

假设在 setUp() 中直接让 Alice 存入 2 ETH,那么所有测试开始时 deposits(alice) 都会是 2 ETH。此时名为 test_InitialState 的用例无法再检查空存款状态。

更合适的组织方式是让公共夹具只创建账户、部署合约和准备资金,在 test_Deposit 中执行存款。若多个测试确实都需要已存款状态,可抽取 internal 辅助函数,在相关测试里显式调用。

不要依赖测试声明顺序

错误假设是先执行 test_Deposit,再让 test_StillStartsEmpty 读取前者的存款结果。两个测试应独立准备和验证状态。如果需要验证连续存款,应该在同一个测试函数中按顺序调用两次 deposit(),然后断言累计金额。

不要混淆 ETH 余额和代币余额

vm.deal(alice, 10 ether) 设置的是原生 ETH 余额,不会自动给 ERC-20 合约铸造代币,也不会创建代币授权。测试 ERC-20 业务时,需要明确部署代币、铸造测试资产,并根据实际接口调用 approve。

不要忽略初始化成本

复杂系统如果每个测试都部署大量合约,测试运行时间会增长。可以将部署与授权等公共步骤整理为小型辅助函数,按测试类别拆分夹具,并通过 forge test --gas-report 观察链上 Gas 使用情况。但 Gas 报告不能直接代表测试运行耗时,不能仅凭它判断测试速度。

按验收清单检查夹具

交付一份新的 Foundry 测试文件前,可以按以下标准检查:

  • setUp() 是 public 函数,负责每个测试共同需要的初始化。
  • 合约实例、测试地址、原生 ETH 资金或代币资产在使用前明确准备。
  • 每个测试自行执行业务操作,不读取其他测试的执行结果。
  • 初始余额与存款记录使用 assertEq 等断言明确验证。
  • 单独运行任一测试与运行整个测试合约,都能独立通过。

当前示例的可观察验收结果是 Alice 初始拥有 10 ETH,Vault 初始存款为 0;存入 2 ETH 后,Alice 剩余 8 ETH,Vault 持有 2 ETH;另一个测试重新检查时仍看到 0 存款。这说明公共部署逻辑得到了复用,同时用例之间没有依赖执行顺序。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

用 setUp 固定部署与初始状态

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通