Foundry项目中setUp与测试函数间存储状态不一致问题分析

问题现象

在Foundry测试框架中，当开发者使用setArbitraryStorage作弊码结合store操作时，可能会遇到一个特殊现象：在setUp函数中成功设置为0的存储槽值，在测试函数执行时却恢复为随机值。而当设置为非零值时，则能保持预期状态。

技术背景

Foundry测试框架提供了setArbitraryStorage作弊码，用于将合约存储设置为随机值。这一特性在模糊测试中特别有用，可以模拟合约存储的各种可能状态。同时，store作弊码允许直接修改特定存储槽的值。

问题复现

通过以下测试合约可以复现该问题：

pragma solidity ^0.8.25;

import "../lib/forge-std/src/Test.sol";

contract StorageContract {
    uint256 public value;
}

contract ArbitraryStorageTest is Test {
    uint256 constant DEFAULT_VALUE = 0;

    StorageContract target;

    function setUp() public {
        target = new StorageContract();
        vm.setArbitraryStorage(address(target));

        bytes32 valueSlot = bytes32(uint256(0));
        vm.store(address(target), valueSlot, bytes32(DEFAULT_VALUE));
        emit log_named_uint("value in setUp", target.value());
    }

    function test_stored_value() public {
        emit log_named_uint("value in test", target.value());

        assertEq(target.value(), DEFAULT_VALUE);
    }
}

当DEFAULT_VALUE为0时，测试会失败，日志显示：

value in setUp: 0
value in test: 36440280036344177981963967840477496355477405577495123809133350823800994840471

而当DEFAULT_VALUE改为1时，测试则能通过。

原因分析

Foundry内部处理存储状态时有一个特殊机制：当存储处于"冷"状态（即未被访问过）且值为0时，系统会生成一个随机值。由于setUp和测试函数在不同的交易中执行，在测试函数中访问存储时，系统会认为存储是"冷"的，如果值为0就会重新生成随机值。而当值为非零时，系统能够识别出该值已被修改过，因此不会覆盖。

解决方案

针对这一问题，开发者可以采用以下两种解决方案：

1. 将存储设置逻辑移至测试函数内部：

function _setMyTest() internal {
    target = new StorageContract();
    vm.setArbitraryStorage(address(target));
    vm.store(address(target), bytes32(uint256(0)), bytes32(DEFAULT_VALUE));
}

function test_stored_value() public {
    _setMyTest();
    assertEq(target.value(), DEFAULT_VALUE);
}

2. 使用非零初始值：如果业务逻辑允许，可以考虑使用非零值作为初始状态，这样可以避免存储被重新随机化。

最佳实践建议

1. 对于需要精确控制存储状态的测试，建议直接在测试函数中设置存储，而不是依赖setUp函数。

2. 当确实需要在setUp中设置存储状态时，考虑使用非零值作为标记，或者确保在测试函数中重新确认存储状态。

3. 理解Foundry的存储模拟机制对于编写可靠的测试非常重要，特别是在涉及存储状态变化的复杂场景中。

通过理解这一机制，开发者可以更好地利用Foundry的存储操作功能，编写出更加健壮和可靠的智能合约测试用例。