智能合约与以太坊 / 系统课时
编写接收随机参数的测试函数
编写接收随机参数的测试函数
固定输入的单元测试只能证明少数案例正确,难以覆盖零地址、极小金额和异常大额等边界。本课使用 Foundry 编写接收随机地址和整数的测试函数,让 Forge 自动生成多组输入,验证存款余额属性,并学会从失败报告中定位反例。
学习目标
- 编写接收 `address` 和 `uint96` 参数的 Foundry 模糊测试函数。
- 使用 `vm.assume`、`bound` 和 `vm.deal` 构造有效测试输入。
- 运行模糊测试,解读执行次数、失败输入及属性断言。
理解参数如何触发模糊测试
Foundry 的 Forge 会识别以 `test` 开头的测试函数。普通单元测试通常在函数内部写死输入,而模糊测试通过函数参数接收 Forge 自动生成的数据。
例如,`testFuzzDeposit(address beneficiary, uint96 rawAmount)` 包含两个输入:收款地址和原始存款金额。Forge 会在多次执行中改变这两个参数,并在每次执行前恢复测试环境,避免上一轮的合约状态影响下一轮。
`address` 可以覆盖普通地址、零地址等特殊值;`uint96` 的范围为 0 到 。测试不能只判断某个固定金额是否成功,而应断言对所有有效输入均成立的属性。
对于一个不收取手续费的简单存款合约,可以定义两条属性:
- 存款成功后,指定受益人的账面余额等于存入金额。
- 新部署且仅执行一次存款的合约,其 ETH 实际余额等于存入金额。
这里测试的是单次存款场景,不代表已经覆盖多用户连续存款、提现或重入行为。
编写可直接运行的测试
准备已安装 Foundry 的环境,执行 `forge --version` 确认 Forge 可用。以下示例适用于使用 `forge-std/Test.sol` 的标准 Foundry 项目,Solidity 编译器版本为 0.8.20 或与声明兼容的更新版本。
在空目录中初始化项目:
forge init fuzz-deposit-demo
cd fuzz-deposit-demo预期结果:项目初始化成功,目录中包含 `foundry.toml`、`src`、`test` 和 `lib/forge-std`。不同版本的初始化日志可能不同。
创建 `test/FuzzVault.t.sol`,写入完整示例:
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {Test} from "forge-std/Test.sol";
contract Vault {
mapping(address => uint256) public balanceOf;
function deposit(address beneficiary) external payable {
require(beneficiary != address(0), "zero beneficiary");
require(msg.value > 0, "zero deposit");
balanceOf[beneficiary] += msg.value;
}
}
contract FuzzVaultTest is Test {
Vault internal vault;
function setUp() public {
// 每次测试执行前部署新的合约,隔离余额状态。
vault = new Vault();
}
function testFuzzDeposit(
address beneficiary,
uint96 rawAmount
) public {
// 排除业务明确禁止的零地址。
vm.assume(beneficiary != address(0));
// 将金额限制在 1 wei 到 10 ether,覆盖有效存款区间。
uint256 amount = bound(uint256(rawAmount), 1, 10 ether);
// 为测试调用方准备足够的 ETH,避免因资金不足回滚。
vm.deal(address(this), amount);
vault.deposit{value: amount}(beneficiary);
// 每组随机输入都必须满足这两条属性。
assertEq(vault.balanceOf(beneficiary), amount);
assertEq(address(vault).balance, amount);
}
}这段示例把被测合约和测试合约放在同一个文件,方便独立运行。实际项目中,应改为导入 `src` 中的真实业务合约,而不是复制一份测试专用实现。
`setUp()` 负责初始化;Forge 对每组模糊输入都会在隔离的测试状态下执行。`vm.assume` 拒绝不符合前置条件的输入,而 `bound` 将整数映射到允许区间。二者不能互换:业务禁止零地址时应排除零地址,金额只需落在有效区间时则优先使用 `bound`,避免大量输入被丢弃。
执行测试并检查结果
在项目根目录运行:
forge test --match-test testFuzzDeposit -vv预期结果:首次运行可能先下载或编译依赖;编译完成后,`testFuzzDeposit` 显示 `PASS`。使用默认 Foundry 模糊测试配置时,通常执行 256 组有效测试案例,输出中包含 `runs: 256` 和 Gas 统计。具体 Gas 数值、耗时及日志格式随环境和版本变化。
可以通过下面的命令增加运行次数:
forge test --match-test testFuzzDeposit --fuzz-runs 1000预期结果:测试通过时显示 `PASS`,并报告约定的 1000 次有效模糊执行;如果属性被破坏,则显示 `FAIL` 及相关反例信息。某些输入因 `vm.assume` 被拒绝时,生成器可能需要额外尝试。
需要长期固定测试强度,可以在 `foundry.toml` 中配置:
[fuzz]
runs = 1000这是配置片段,依赖现有 Foundry 项目;如果文件中已经存在 `[fuzz]` 表,应修改其 `runs` 字段,不要重复添加同名表。执行 `forge test` 后检查测试报告中的运行次数,即可验证配置是否生效。
测试结果中的 `runs` 表示有效案例执行次数,`μ` 表示平均 Gas,`~` 表示中位数 Gas。模糊测试通过只能说明这些输入下断言未被破坏,不能证明所有可能输入都安全。
利用失败输入定位缺陷
为了观察失败报告,可以暂时把示例中的第一条属性断言改成:
// 片段示例:替换 testFuzzDeposit 中的第一条 assertEq。
assertEq(vault.balanceOf(beneficiary), amount + 1);这条断言故意要求存款后的余额比实际存款多 1 wei,必然不符合当前合约行为。重新执行 `forge test --match-test testFuzzDeposit -vvv`。
预期结果:Forge 报告 `FAIL`,显示断言不成立,并可提供反例参数及错误信息。反例的具体地址和金额由测试生成器决定,不应预先假定为某个固定值。
阅读失败信息时,按以下顺序定位:
- 查看失败的测试函数名称,确认失败发生于哪条业务属性。
- 读取反例参数,记录 `beneficiary` 和 `rawAmount` 的具体取值。
- 检查 `bound` 后的实际金额,区分原始随机输入与真正传给合约的值。
- 使用 `-vvvv` 查看更详细的执行轨迹,确认失败来自业务合约回滚还是测试断言。
- 将稳定复现的边界情况补成固定参数的单元测试,再恢复正确属性。
模糊测试生成器通常会尝试缩减失败输入,以便得到更容易分析的反例。不过缩减结果并不保证是数学意义上的最小值。
真实项目中还要区别两类失败:预期回滚与意外缺陷。例如零地址被合约明确禁止,那么测试合法存款时使用 `vm.assume` 排除它是合理的;但如果要检验零地址保护是否有效,就应单独使用 `vm.expectRevert` 编写负向测试,而不能永远把零地址过滤掉。
避免无效随机测试
最常见的错误是只执行随机调用,却不检查交易后的资产和状态。即使 1000 次调用全部成功,也不能说明记账结果正确。至少应验证受益人余额、合约实际余额以及业务要求的事件或供应量等属性。
另一种错误是过度使用 `vm.assume`,例如将 256 位整数限制为几个极小的离散取值。生成器可能频繁丢弃输入,甚至因拒绝次数过多而中止。连续数值范围应优先考虑 `bound`;只有确实不属于业务输入域的情况才使用 `vm.assume`。
本例还有一个重要边界:`bound` 会改变随机原始金额,因此测试验证的是受限金额区间内的行为,不是所有 `uint256` 金额。若业务关心最大整数、溢出边界或零金额回滚,应另外设计覆盖这些条件的测试,不能把受限随机测试误认为全范围验证。
完成练习时,可以先恢复正确断言,再将金额上限从 `10 ether` 改为 `100 ether`,运行 1000 次模糊测试;随后单独补充一个零地址应当回滚的测试。这样既能验证大量合法输入,也能确认被排除的非法输入确实受到合约保护。