智能合约与以太坊 / 系统课时
用 assume 约束有效输入空间
用 assume 约束有效输入空间
模糊测试会自动生成大量输入,但并非每个输入都符合业务前置条件。使用 Foundry 的 vm.assume 可以跳过不适合当前测试的输入,让测试集中检查有效调用的性质。本篇通过存款合约演示合理约束、非法输入单独验证,以及如何避免过度拒绝导致测试效率下降。
学习目标
- 理解
vm.assume的执行语义,区分跳过测试样本与合约调用失败。 - 在 Foundry 中组合
vm.assume和bound,编写覆盖有效输入的模糊测试。 - 识别过度约束造成的拒绝次数过高,并为非法输入建立独立测试。
assume 如何筛选输入
Foundry 的模糊测试通过带参数的 testFuzz_ 函数接收生成器提供的输入。例如 testFuzz_Deposit(uint256 amount) 会使用多个不同金额执行测试。
vm.assume(bool condition) 是 Foundry 测试环境提供的作弊码,不是业务合约的校验函数。条件为 true 时继续执行,为 false 时丢弃当前模糊测试样本,由测试框架尝试生成新的输入。
例如下面的片段只允许非零地址进入后续检查。
// 片段示例:位于继承 forge-std/Test.sol 中 Test 的测试合约内
function testFuzz_ValidActor(address actor) public {
// 零地址不属于当前测试的有效参与者集合
vm.assume(actor != address(0));
assertTrue(actor != address(0));
}预期结果:该测试能够通过;零地址样本会被拒绝,不会执行后面的断言。通过不代表已经验证业务合约是否正确拒绝零地址。
vm.assume、require 和 assertEq 承担不同职责:
| 工具 | 用途 | 条件不满足时 |
|---|---|---|
vm.assume |
筛选测试输入 | 丢弃当前样本并重新生成 |
require |
校验合约业务条件 | 合约执行回滚 |
assertEq |
验证测试预期 | 测试失败 |
在存款合约中约束有效调用
假设一个存款记账合约规定:单次存款金额为 100~10000 个记账单位,调用者不得为零地址。我们希望验证每次有效存款都会正确增加调用者的余额。
在已经安装 Foundry 的项目中,新建 test/DepositAssume.t.sol,写入以下完整示例。这里的存款单位是演示用整数,并非实际转入的 ETH。
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {Test} from "forge-std/Test.sol";
contract DepositBook {
mapping(address => uint256) public balances;
function deposit(uint256 amount) external {
require(msg.sender != address(0), "invalid sender");
require(amount >= 100 && amount <= 10000, "invalid amount");
balances[msg.sender] += amount;
}
}
contract DepositAssumeTest is Test {
DepositBook internal book;
function setUp() public {
book = new DepositBook();
}
function testFuzz_ValidDeposit(address actor, uint256 rawAmount) public {
// 排除无效调用者,这是一个极窄的过滤条件
vm.assume(actor != address(0));
// 使用 bound 构造合法金额,避免大范围随机拒绝
uint256 amount = bound(rawAmount, 100, 10000);
uint256 beforeBalance = book.balances(actor);
vm.prank(actor);
book.deposit(amount);
assertEq(book.balances(actor), beforeBalance + amount);
}
function testFuzz_RejectSmallDeposit(uint256 rawAmount) public {
// 非法金额在单独测试中验证,而不是直接忽略
uint256 amount = bound(rawAmount, 0, 99);
vm.expectRevert(bytes("invalid amount"));
book.deposit(amount);
}
}vm.prank(actor) 将下一次外部调用的 msg.sender 设置为指定地址。bound 来自 Forge Standard Library 的 Test 基类,用于把输入映射到指定闭区间。
在项目根目录执行:
forge test --match-contract DepositAssumeTest -vv预期输出示意:
[PASS] testFuzz_RejectSmallDeposit(uint256)
[PASS] testFuzz_ValidDeposit(address,uint256)实际输出还会包含运行次数、Gas 统计和测试套件汇总,具体格式随 Foundry 版本变化。两个测试均通过,分别说明有效存款的余额性质成立,以及小于 100 的金额能够按预期回滚。
为什么过度拒绝会拖慢测试
vm.assume 最适合排除占比极小的无效样本。如果直接对完整 uint256 空间使用 vm.assume(amount >= 100 && amount <= 10000),有效值只占全部可能整数中极小的一部分。
忽略生成器对特殊值的偏好,按均匀随机抽样估算,有效概率为:
如此低的接受概率意味着测试可能耗费大量时间重新生成输入,最终触及拒绝次数上限,出现类似 Too many global rejects 的失败。实际 Foundry 模糊生成器并非严格均匀分布,因此该计算是风险说明,不是实际运行次数预测。
常见约束可按下面的方式选择:
| 输入限制 | 推荐做法 | 原因 |
|---|---|---|
actor != address(0) |
vm.assume |
仅排除一个地址 |
| 金额在 100~10000 | bound |
防止大范围拒绝 |
a != b |
vm.assume |
通常仅排除少量组合 |
| 金额必须等于 500 | 定向单元测试 | 不值得等待随机命中 |
如果测试出现拒绝次数过高,先检查 vm.assume 是否过滤了绝大多数输入,再考虑调整生成策略。不同 Foundry 版本可能使用不同的拒绝上限配置,具体以当前安装版本的 forge config 输出及官方配置文档为准。单纯提高上限通常不能解决输入空间设计错误。
区分有效输入与非法输入测试
约束是否合理,取决于当前测试要验证什么,而不是输入是否合法。
对于存款业务,至少应分别覆盖以下性质:
- 有效区间:100~10000 的每次存款应正确增加余额。
- 下边界:99 应回滚,100 应成功。
- 上边界:10000 应成功,10001 应回滚。
- 地址约束:零地址调用应被拒绝,非零地址调用应遵守相同金额规则。
在 Foundry 的普通测试中,可以通过 vm.prank(address(0)) 模拟零地址作为调用者,再用 vm.expectRevert 验证业务合约的错误处理。这里应注意,零地址不能在真实链上作为普通外部账户主动签名发起交易,因此该检查主要是在验证合约自身的防御性条件。
判断约束是否过度,可以做一个简单复核:删除某条 vm.assume 后,新增输入是否可能揭露真实缺陷?如果答案是可能,例如零金额可能导致错误记账,就必须保留对应的非法输入测试,而不能仅靠筛选绕开。
建议将模糊测试分成有效输入性质测试、非法输入回滚测试和关键边界定向测试。vm.assume 只负责缩小当前性质的输入范围,业务正确性仍然依靠断言和预期回滚验证。