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

用 setUp 准备可复用测试状态

用 setUp 准备可复用测试状态

同一组 Foundry 测试通常需要反复部署合约、准备测试账户和设置 ETH 余额。将公共初始化逻辑放进 setUp(),可以让每个测试从一致的状态开始,避免依赖执行顺序。本篇通过一个接收 ETH 的捐赠合约,验证测试初始化、调用者模拟和状态隔离。

学习目标

  • 理解 setUp() 的执行时机,以及不同测试之间的状态隔离规则。
  • 使用 vm.deal() 设置账户余额,使用 vm.prank() 模拟指定账户调用。
  • 编写并运行两个独立测试,验证余额变化和合约状态不会跨测试污染。

setUp 如何为每个测试准备初始状态

Foundry 使用 Solidity 编写测试。测试合约通常继承 forge-std/Test.sol 中的 Test,测试函数以 test 开头,并声明为 public 或 external。

setUp() 是可选的公共初始化函数。Forge 会在每个测试用例执行前运行它,而不是仅在整个测试套件开始时运行一次。普通单元测试彼此隔离,前一个测试对合约状态的修改不会成为下一个测试的起点。

例如,两个测试都需要一个新部署的捐赠合约和两个有资金的账户,可以把部署和资金准备放进 setUp()。测试 A 捐赠的 1 ETH 不会出现在测试 B 的捐赠记录中。

Foundry 每个测试独立执行 setUp 的生命周期示意图

需要区分三件事:setUp() 负责创建共同起点;vm.deal(address, amount) 直接将指定地址的 ETH 余额设置为 amount Wei;vm.prank(address) 则让下一次符合条件的外部调用使用指定的 msg.sender。设置余额不会自动改变调用者身份,模拟身份也不会自动给账户充值。

编写带有共享初始化的捐赠测试

在已安装 Foundry、包含 forge-std 依赖的标准项目中,新建 test/DonationBox.t.sol。下面是完整示例,被测合约与测试合约放在同一个文件中,便于直接运行。

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

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

contract DonationBox {
    mapping(address => uint256) public donated;

    function donate() external payable {
        require(msg.value > 0, "ZERO_VALUE");
        donated[msg.sender] += msg.value;
    }
}

contract DonationBoxTest is Test {
    DonationBox internal box;
    address internal alice = address(0xA11CE);
    address internal bob = address(0xB0B);

    function setUp() public {
        // 每个测试重新部署合约,确保捐赠记录从零开始。
        box = new DonationBox();
        vm.deal(alice, 5 ether);
        vm.deal(bob, 2 ether);
    }

    function test_AliceDonates() public {
        // 仅让下一次外部调用以 Alice 身份执行。
        vm.prank(alice);
        box.donate{value: 1 ether}();

        assertEq(box.donated(alice), 1 ether);
        assertEq(alice.balance, 4 ether);
        assertEq(address(box).balance, 1 ether);
    }

    function test_BobStartsFresh() public {
        // 即使另一个测试完成过捐赠,这里仍从初始状态开始。
        assertEq(box.donated(alice), 0);
        assertEq(address(box).balance, 0);
        assertEq(bob.balance, 2 ether);

        vm.prank(bob);
        box.donate{value: 0.5 ether}();

        assertEq(box.donated(bob), 0.5 ether);
        assertEq(box.donated(alice), 0);
        assertEq(bob.balance, 1.5 ether);
    }
}

预期结果:文件能够编译,并且两个测试均通过。test_AliceDonates() 验证 Alice 捐出 1 ETH 后,个人余额从 5 ETH 降到 4 ETH,合约收到 1 ETH;test_BobStartsFresh() 先确认合约没有继承其他测试的捐赠记录,再验证 Bob 捐赠 0.5 ETH 后余额为 1.5 ETH。

这里的 5 ether 是 Solidity 的单位写法,等于 5 × 10^18 Wei。vm.deal() 接收的第二个参数是最终余额,不是增量,所以重复执行 vm.deal(alice, 5 ether) 不会让 Alice 的余额不断累加。

vm.prank(alice) 放在 box.donate{value: 1 ether}() 紧前面,是为了让合约内部的 msg.sender 正确等于 Alice。测试函数本身并不需要持有 Alice 的私钥,作弊码只在 Foundry 测试环境中生效。

运行测试并检查隔离效果

在包含 foundry.toml 的项目根目录执行以下命令,只运行 DonationBoxTest 测试合约。

bash
forge test --match-contract DonationBoxTest -vv

预期输出中的关键内容如下,具体 Gas 消耗与运行时间会随编译器和 Foundry 版本变化。

text
Ran 2 tests for test/DonationBox.t.sol:DonationBoxTest
[PASS] test_AliceDonates() (gas: <GAS>)
[PASS] test_BobStartsFresh() (gas: <GAS>)
Suite result: ok. 2 passed; 0 failed; 0 skipped; finished in <TIME> (<TIME> CPU time)

其中 <GAS> 表示实际 Gas 统计值,<TIME> 表示实际运行耗时。编译提示和其他测试套件的信息可能因项目环境而不同,应以两个 [PASS] 和 2 passed; 0 failed 作为验收依据。

还可以将测试函数顺序交换后再次执行同一命令。结果仍应全部通过,因为 Forge 不依赖源文件中的测试函数排列顺序来传递状态。

如果去掉 setUp() 中的 box = new DonationBox(),测试会因访问未初始化的合约引用而失败;如果去掉 vm.deal(alice, 5 ether),Alice 的带 ETH 调用可能因为资金不足而失败。这两种失败分别说明合约部署和余额准备都是测试前置条件。

避免初始化逻辑污染测试场景

共享初始化应只包含多个测试都需要的稳定条件。对于本例,部署空捐赠合约并准备 Alice、Bob 的初始余额适合写在 setUp();某个测试专属的捐赠交易则应该留在对应测试函数内。

操作 推荐位置 原因
部署全新 DonationBox setUp() 每个测试需要相同的空合约
设置 Alice 为 5 ETH、Bob 为 2 ETH setUp() 两个测试共用初始资金条件
执行 vm.prank(alice) 具体测试内 调用者身份应对应被测操作
Alice 捐赠 1 ETH test_AliceDonates() 不应让其他测试继承该交易
Bob 捐赠 0.5 ETH test_BobStartsFresh() 只属于 Bob 的测试场景

特别注意 vm.prank() 只影响下一次符合条件的调用,也包括静态调用。如果模拟身份后先访问另一个合约的外部函数,身份模拟可能被那次调用消耗。正确做法是让 vm.prank() 紧邻真正需要模拟身份的目标调用。

当一个测试确实需要连续多次以相同地址调用时,可以在该测试内使用 vm.startPrank(alice) 开始持续模拟,并在操作结束后执行 vm.stopPrank()。不要把持续身份模拟随意留在公共初始化函数中,以免产生不符合测试预期的调用上下文。

判断 setUp() 是否设计合理,可以检查三个条件:单独运行任意一个测试能通过,交换测试顺序后结果不变,每个测试开头的合约状态与账户余额都符合声明的初始值。满足这些条件,后续增加权限、付款失败或多账户交互测试时,就可以在同一个可复用的测试基础上独立扩展。

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

目录与阅读设置

阅读设置

17

记录一个想法

用 setUp 准备可复用测试状态

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

登录哪都通