Merge pull request #4125 from ethereum-optimism/jm/ctb-test-cleanup/fuzzAndDiff

Test cleanup: rename fuzz and differential tests

packages/contracts-bedrock/.gas-snapshot

@@ -8,7 +8,6 @@ GasBenchMark_L1StandardBridge_Finalize:test_finalizeETHWithdrawal_benchmark() (g
 GasBenchMark_L2OutputOracle:test_proposeL2Output_benchmark() (gas: 88513)
 GasBenchMark_OptimismPortal:test_depositTransaction_benchmark() (gas: 74953)
 GasBenchMark_OptimismPortal:test_depositTransaction_benchmark_1() (gas: 36044)
-CrossDomainMessenger_Test:testFuzz_baseGas(uint32) (runs: 256, μ: 20196, ~: 20196)
 CrossDomainMessenger_Test:test_baseGas() (gas: 20054)
 CrossDomainOwnableThroughPortal_Test:test_depositTransaction_crossDomainOwner() (gas: 61806)
 CrossDomainOwnable_Test:test_onlyOwner() (gas: 34861)
@@ -19,7 +18,6 @@ CrossDomainOwnable2_Test:test_revertNotSetOnlyOwner2() (gas: 14565)
 CrossDomainOwnable2_Test:test_revertOnlyOwner() (gas: 61712)
 DeployerWhitelist_Test:test_owner() (gas: 7516)
 DeployerWhitelist_Test:test_storageSlots() (gas: 33395)
-Encoding_Test:test_nonceVersioning(uint240,uint16) (runs: 256, μ: 658, ~: 658)
 FeeVault_Test:test_constructor() (gas: 10623)
 FeeVault_Test:test_minWithdrawalAmount() (gas: 10689)
 GasPriceOracle_Test:test_baseFee() (gas: 8281)
@@ -29,7 +27,7 @@ GasPriceOracle_Test:test_overhead() (gas: 10568)
 GasPriceOracle_Test:test_scalar() (gas: 10610)
 GasPriceOracle_Test:test_setGasPriceReverts() (gas: 5888)
 GasPriceOracle_Test:test_setL1BaseFeeReverts() (gas: 5909)
-Hashing_Test:test_hashDepositSource() (gas: 628)
+Hashing_Test:test_hashDepositSource_succeeds() (gas: 650)
 L1BlockTest:test_basefee() (gas: 7531)
 L1BlockTest:test_hash() (gas: 7553)
 L1BlockTest:test_number() (gas: 7608)
@@ -122,9 +120,9 @@ L2StandardBridge_Test:test_receive() (gas: 131862)
 L2StandardBridge_Test:test_withdraw() (gas: 343984)
 L2StandardBridge_Test:test_withdrawTo() (gas: 344713)
 L2StandardBridge_Test:test_withdraw_onlyEOA() (gas: 251816)
-L2ToL1MessagePasserTest:test_burn() (gas: 112594)
-L2ToL1MessagePasserTest:test_initiateWithdrawal_fromContract() (gas: 70356)
-L2ToL1MessagePasserTest:test_initiateWithdrawal_fromEOA() (gas: 75874)
+L2ToL1MessagePasserTest:test_burn_succeeds() (gas: 112572)
+L2ToL1MessagePasserTest:test_initiateWithdrawal_fromContract_succeeds() (gas: 70423)
+L2ToL1MessagePasserTest:test_initiateWithdrawal_fromEOA_succeeds() (gas: 75874)
 LegacyERC20ETH_Test:test_approve() (gas: 10723)
 LegacyERC20ETH_Test:test_burn() (gas: 10615)
 LegacyERC20ETH_Test:test_crossDomain() (gas: 6339)
@@ -153,17 +151,17 @@ OptimismPortalUpgradeable_Test:test_initialize_cannotInitImpl_reverts() (gas: 10
 OptimismPortalUpgradeable_Test:test_initialize_cannotInitProxy_reverts() (gas: 15789)
 OptimismPortalUpgradeable_Test:test_params_initValuesOnProxy_success() (gas: 16033)
 OptimismPortalUpgradeable_Test:test_upgradeToAndCall_upgrading_success() (gas: 180435)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_ifOutputRootChanges_reverts() (gas: 199750)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_ifOutputRootChanges_reverts() (gas: 199706)
 OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_ifOutputTimestampIsNotFinalized_reverts() (gas: 202003)
 OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_ifWithdrawalNotProven_reverts() (gas: 39656)
 OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_ifWithdrawalProofNotOldEnough_reverts() (gas: 197092)
 OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_onInsufficientGas_reverts() (gas: 197814)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_onRecentWithdrawal_reverts() (gas: 177829)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_onReentrancy_reverts() (gas: 236177)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_onReplay_reverts() (gas: 237785)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_provenWithdrawalHash_success() (gas: 229511)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_onRecentWithdrawal_reverts() (gas: 177851)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_onReentrancy_reverts() (gas: 236156)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_onReplay_reverts() (gas: 237807)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_provenWithdrawalHash_success() (gas: 229466)
 OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_targetFails_fails() (gas: 332126)
-OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_timestampLessThanL2OracleStart_reverts() (gas: 193772)
+OptimismPortal_FinalizeWithdrawal_Test:test_finalizeWithdrawalTransaction_timestampLessThanL2OracleStart_reverts() (gas: 193794)
 OptimismPortal_FinalizeWithdrawal_Test:test_proveWithdrawalTransaction_onInvalidOutputRootProof_reverts() (gas: 83498)
 OptimismPortal_FinalizeWithdrawal_Test:test_proveWithdrawalTransaction_onSelfCall_reverts() (gas: 50732)
 OptimismPortal_FinalizeWithdrawal_Test:test_proveWithdrawalTransaction_oninvalidWithdrawalProof_reverts() (gas: 136758)

packages/contracts-bedrock/contracts/test/AddressAliasHelper.t.sol

@@ -5,7 +5,7 @@ import { Test } from "forge-std/Test.sol";
 import { AddressAliasHelper } from "../vendor/AddressAliasHelper.sol";
 
 contract AddressAliasHelper_Test is Test {
-    function test_fuzz_roundtrip(address _address) external {
+    function testFuzz_roundtrip_succeeds(address _address) external {
         address aliased = AddressAliasHelper.applyL1ToL2Alias(_address);
         address unaliased = AddressAliasHelper.undoL1ToL2Alias(aliased);
         assertEq(_address, unaliased);

packages/contracts-bedrock/contracts/test/Encoding.t.sol

@@ -10,7 +10,7 @@ contract Encoding_Test is CommonTest {
         _setUp();
     }
 
-    function test_nonceVersioning(uint240 _nonce, uint16 _version) external {
+    function testFuzz_nonceVersioning_succeeds(uint240 _nonce, uint16 _version) external {
         (uint240 nonce, uint16 version) = Encoding.decodeVersionedNonce(
             Encoding.encodeVersionedNonce(_nonce, _version)
         );
@@ -18,7 +18,7 @@ contract Encoding_Test is CommonTest {
         assertEq(nonce, _nonce);
     }
 
-    function test_decodeVersionedNonce_differential(uint240 _nonce, uint16 _version) external {
+    function testDiff_decodeVersionedNonce_succeeds(uint240 _nonce, uint16 _version) external {
         uint256 nonce = uint256(Encoding.encodeVersionedNonce(_nonce, _version));
         (uint256 decodedNonce, uint256 decodedVersion) = ffi.decodeVersionedNonce(nonce);
 
@@ -27,7 +27,7 @@ contract Encoding_Test is CommonTest {
         assertEq(_nonce, uint240(decodedNonce));
     }
 
-    function test_encodeCrossDomainMessage_differential(
+    function testDiff_encodeCrossDomainMessage_succeeds(
         uint240 _nonce,
         uint8 _version,
         address _sender,
@@ -60,7 +60,7 @@ contract Encoding_Test is CommonTest {
         assertEq(encoding, _encoding);
     }
 
-    function test_encodeDepositTransaction_differential(
+    function testDiff_encodeDepositTransaction_succeeds(
         address _from,
         address _to,
         uint256 _mint,

packages/contracts-bedrock/contracts/test/Hashing.t.sol

@@ -11,7 +11,7 @@ contract Hashing_Test is CommonTest {
         _setUp();
     }
 
-    function test_hashDepositSource() external {
+    function test_hashDepositSource_succeeds() external {
         bytes32 sourceHash = Hashing.hashDepositSource(
             0xd25df7858efc1778118fb133ac561b138845361626dfb976699c5287ed0f4959,
             0x1
@@ -20,7 +20,7 @@ contract Hashing_Test is CommonTest {
         assertEq(sourceHash, 0xf923fb07134d7d287cb52c770cc619e17e82606c21a875c92f4c63b65280a5cc);
     }
 
-    function test_hashCrossDomainMessage_differential(
+    function testDiff_hashCrossDomainMessage_succeeds(
         uint240 _nonce,
         uint16 _version,
         address _sender,
@@ -54,7 +54,7 @@ contract Hashing_Test is CommonTest {
         assertEq(hash, _hash);
     }
 
-    function test_hashWithdrawal_differential(
+    function testDiff_hashWithdrawal_succeeds(
         uint256 _nonce,
         address _sender,
         address _target,
@@ -71,7 +71,7 @@ contract Hashing_Test is CommonTest {
         assertEq(hash, _hash);
     }
 
-    function test_hashOutputRootProof_differential(
+    function testDiff_hashOutputRootProof_succeeds(
         bytes32 _version,
         bytes32 _stateRoot,
         bytes32 _messagePasserStorageRoot,
@@ -98,7 +98,7 @@ contract Hashing_Test is CommonTest {
 
     // TODO(tynes): foundry bug cannot serialize
     // bytes32 as strings with vm.toString
-    function test_hashDepositTransaction_differential(
+    function testDiff_hashDepositTransaction_succeeds(
         address _from,
         address _to,
         uint256 _mint,

packages/contracts-bedrock/contracts/test/L2ToL1MessagePasser.t.sol

@@ -25,7 +25,7 @@ contract L2ToL1MessagePasserTest is CommonTest {
         messagePasser = new L2ToL1MessagePasser();
     }
 
-    function test_fuzz_initiateWithdrawal(
+    function testFuzz_initiateWithdrawal_succeeds(
         address _sender,
         address _target,
         uint256 _value,
@@ -60,7 +60,7 @@ contract L2ToL1MessagePasserTest is CommonTest {
     }
 
     // Test: initiateWithdrawal should emit the correct log when called by a contract
-    function test_initiateWithdrawal_fromContract() external {
+    function test_initiateWithdrawal_fromContract_succeeds() external {
         bytes32 withdrawalHash = Hashing.hashWithdrawal(
             Types.WithdrawalTransaction(
                 messagePasser.messageNonce(),
@@ -88,7 +88,7 @@ contract L2ToL1MessagePasserTest is CommonTest {
     }
 
     // Test: initiateWithdrawal should emit the correct log when called by an EOA
-    function test_initiateWithdrawal_fromEOA() external {
+    function test_initiateWithdrawal_fromEOA_succeeds() external {
         uint256 gasLimit = 64000;
         address target = address(4);
         uint256 value = 100;
@@ -114,7 +114,7 @@ contract L2ToL1MessagePasserTest is CommonTest {
     }
 
     // Test: burn should destroy the ETH held in the contract
-    function test_burn() external {
+    function test_burn_succeeds() external {
         messagePasser.initiateWithdrawal{ value: NON_ZERO_VALUE }(
             NON_ZERO_ADDRESS,
             NON_ZERO_GASLIMIT,

packages/contracts-bedrock/contracts/test/OptimismPortal.t.sol

@@ -802,7 +802,7 @@ contract OptimismPortal_FinalizeWithdrawal_Test is Portal_Initializer {
         assert(address(bob).balance == bobBalanceBefore);
     }
 
-    function test_finalizeWithdrawalTransaction_differential_success(
+    function testDiff_finalizeWithdrawalTransaction_succeeds(
         address _sender,
         address _target,
         uint256 _value,

packages/contracts-bedrock/package.json

@@ -25,7 +25,7 @@
     "test": "yarn build:differential && forge test",
     "coverage": "yarn build:differential && forge coverage",
     "coverage:lcov": "yarn build:differential && forge coverage --report lcov",
-    "gas-snapshot": "yarn build:differential && forge snapshot --no-match-test 'differential|fuzz'",
+    "gas-snapshot": "yarn build:differential && forge snapshot --no-match-test 'testDiff|testFuzz'",
     "storage-snapshot": "./scripts/storage-snapshot.sh",
     "validate-spacers": "hardhat validate-spacers",
     "slither": "./scripts/slither.sh",