potential direction for refactoring differential tests

ProjectOpenSea · Nov 17, 2023 · a9ab358 · a9ab358
1 parent 180be2a
commit a9ab358
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 13 deletions.
diff --git a/test/foundry/offerers/ContractOffersNativeTokenOfferItems.t.sol b/test/foundry/offerers/ContractOffersNativeTokenOfferItems.t.sol
@@ -62,28 +62,20 @@ contract ContractOffersNativeTokenOfferItems is
 
     TestERC721 erc721;
 
-    function setUp() public override {
+    function setUp() public override snapshotted {
         super.setUp();
         erc721 = new TestERC721();
     }
 
-    function test(
-        function(Context memory) external fn,
-        Context memory context
-    ) internal {
-        try fn(context) {} catch (bytes memory reason) {
-            assertPass(reason);
-        }
-    }
-
     function testEthForErc721(
         FuzzArgs memory args
     ) public validateInputs(args) {
-        test(this.ethForErc721, Context(consideration,args));
-        test(this.ethForErc721, Context(referenceConsideration,args));
+        ethForErc721(Context(consideration,args));
+        revertToSetup();
+        ethForErc721(Context(referenceConsideration,args));
     }
 
-    function ethForErc721(Context memory context) public stateless {
+    function ethForErc721(Context memory context) public {
         TestContractOffererNativeToken contractOfferer = new TestContractOffererNativeToken(
                 address(context.seaport)
             );

diff --git a/test/foundry/utils/DifferentialTest.sol b/test/foundry/utils/DifferentialTest.sol
@@ -4,6 +4,9 @@ pragma solidity ^0.8.17;
 import { Test } from "forge-std/Test.sol";
 
 contract DifferentialTest is Test {
+    // identifier for a snapshot taken at the end of a setUp function for a differential test
+    uint256 snapshot;
+
     ///@dev error to supply
     error RevertWithFailureStatus(bool status);
     error DifferentialTestAssertionFailed();
@@ -24,6 +27,18 @@ contract DifferentialTest is Test {
         revert RevertWithFailureStatus(readHevmFailureSlot());
     }
 
+    /// @notice setup the snapshot at the end of the setUp function
+    /// @dev apply modifier to `setUp` function, then run differential tests using `revertToSetup`
+    modifier snapshotted() {
+        _;
+        snapshot = vm.snapshot();
+    }
+
+    /// @notice revert to the state at the end of setUp
+    function revertToSetup() public {
+        vm.revertTo(snapshot);
+    }
+
     ///@dev revert if the supplied bytes do not match the expected "passing" revert bytes
     function assertPass(bytes memory reason) internal view {
         // hash the reason and compare to the hash of the passing revert bytes