Merge pull request #4248 from ethereum-optimism/jm/ctb-test-cleanup/6

Rename L1 bridge and deployer whitelist tests

packages/contracts-bedrock/.gas-snapshot

@@ -16,8 +16,8 @@ CrossDomainOwnable2_Test:test_onlyOwner_notMessenger_reverts() (gas: 8416)
 CrossDomainOwnable2_Test:test_onlyOwner_notOwner2_reverts() (gas: 61733)
 CrossDomainOwnable2_Test:test_onlyOwner_notOwner_reverts() (gas: 16588)
 CrossDomainOwnable2_Test:test_onlyOwner_succeeds() (gas: 77782)
-DeployerWhitelist_Test:test_owner() (gas: 7516)
-DeployerWhitelist_Test:test_storageSlots() (gas: 33395)
+DeployerWhitelist_Test:test_owner_succeeds() (gas: 7538)
+DeployerWhitelist_Test:test_storageSlots_succeeds() (gas: 33395)
 FeeVault_Test:test_constructor_succeeds() (gas: 10601)
 FeeVault_Test:test_minWithdrawalAmount_succeeds() (gas: 10668)
 GasPriceOracle_Test:test_baseFee_succeeds() (gas: 8291)
@@ -37,38 +37,38 @@ L1BlockTest:test_updateValues_succeeds() (gas: 60481)
 L1BlockNumberTest:test_fallback_succeeds() (gas: 18633)
 L1BlockNumberTest:test_getL1BlockNumber_succeeds() (gas: 10603)
 L1BlockNumberTest:test_receive_succeeds() (gas: 25340)
-L1CrossDomainMessenger_Test:testCannot_L1MessengerPause() (gas: 24538)
-L1CrossDomainMessenger_Test:testCannot_L1MessengerUnpause() (gas: 24496)
-L1CrossDomainMessenger_Test:test_L1MessengerMessageVersion() (gas: 24715)
-L1CrossDomainMessenger_Test:test_L1MessengerPause() (gas: 52920)
-L1CrossDomainMessenger_Test:test_L1MessengerRelayMessageFirstStuckSecondSucceeds() (gas: 197224)
-L1CrossDomainMessenger_Test:test_L1MessengerRelayMessageRevertsOnReentrancy() (gas: 190913)
-L1CrossDomainMessenger_Test:test_L1MessengerRelayMessageSucceeds() (gas: 73649)
-L1CrossDomainMessenger_Test:test_L1MessengerRelayMessageToSystemContract() (gas: 65858)
-L1CrossDomainMessenger_Test:test_L1MessengerRelayMessageV0Fails() (gas: 33236)
-L1CrossDomainMessenger_Test:test_L1MessengerRelayShouldRevertIfPaused() (gas: 60475)
-L1CrossDomainMessenger_Test:test_L1MessengerReplayMessageWithValue() (gas: 38192)
-L1CrossDomainMessenger_Test:test_L1MessengerSendMessage() (gas: 299566)
-L1CrossDomainMessenger_Test:test_L1MessengerTwiceSendMessage() (gas: 1490457)
-L1CrossDomainMessenger_Test:test_L1MessengerUnpause() (gas: 45186)
-L1CrossDomainMessenger_Test:test_L1MessengerXDomainSenderReverts() (gas: 24232)
-L1CrossDomainMessenger_Test:test_L1MessengerxDomainMessageSenderResets() (gas: 84056)
-L1StandardBridge_DepositERC20To_Test:test_depositERC20To_success() (gas: 575962)
+L1CrossDomainMessenger_Test:test_messageVersion_succeeds() (gas: 24716)
+L1CrossDomainMessenger_Test:test_pause_callerIsNotOwner_reverts() (gas: 24539)
+L1CrossDomainMessenger_Test:test_pause_succeeds() (gas: 52964)
+L1CrossDomainMessenger_Test:test_relayMessage_paused_reverts() (gas: 60498)
+L1CrossDomainMessenger_Test:test_relayMessage_reentrancy_reverts() (gas: 190881)
+L1CrossDomainMessenger_Test:test_relayMessage_retryAfterFailure_succeeds() (gas: 197235)
+L1CrossDomainMessenger_Test:test_relayMessage_succeeds() (gas: 73617)
+L1CrossDomainMessenger_Test:test_relayMessage_toSystemContract_reverts() (gas: 65858)
+L1CrossDomainMessenger_Test:test_relayMessage_v0_reverts() (gas: 33214)
+L1CrossDomainMessenger_Test:test_replayMessage_withValue_reverts() (gas: 38214)
+L1CrossDomainMessenger_Test:test_sendMessage_succeeds() (gas: 299523)
+L1CrossDomainMessenger_Test:test_sendMessage_twice_succeeds() (gas: 1490457)
+L1CrossDomainMessenger_Test:test_unpause_callerIsNotOwner_reverts() (gas: 24472)
+L1CrossDomainMessenger_Test:test_unpause_succeeds() (gas: 45149)
+L1CrossDomainMessenger_Test:test_xDomainMessageSender_reset_succeeds() (gas: 84036)
+L1CrossDomainMessenger_Test:test_xDomainSender_notSet_reverts() (gas: 24252)
+L1StandardBridge_DepositERC20To_Test:test_depositERC20To_succeeds() (gas: 575962)
 L1StandardBridge_DepositERC20_Test:test_depositERC20_succeeds() (gas: 573786)
-L1StandardBridge_DepositERC20_TestFail:test_depositERC20_revert_notEoa() (gas: 22298)
-L1StandardBridge_DepositETHTo_Test:test_depositETHTo() (gas: 324702)
-L1StandardBridge_DepositETH_Test:test_depositETH_success() (gas: 367538)
-L1StandardBridge_DepositETH_TestFail:test_DepositETH_revert_notEoa() (gas: 40758)
-L1StandardBridge_FinalizeBridgeETH_TestFail:test_finalizeBridgeETH_revert_incorrectValue() (gas: 34207)
-L1StandardBridge_FinalizeBridgeETH_TestFail:test_finalizeBridgeETH_revert_sendToMessenger() (gas: 34266)
-L1StandardBridge_FinalizeBridgeETH_TestFail:test_finalizeBridgeETH_revert_sendToSelf() (gas: 34257)
-L1StandardBridge_FinalizeERC20Withdrawal_Test:test_finalizeERC20Withdrawal() (gas: 492896)
-L1StandardBridge_FinalizeERC20Withdrawal_TestFail:test_finalizeERC20Withdrawal_revert_notMessenger() (gas: 31116)
-L1StandardBridge_FinalizeERC20Withdrawal_TestFail:test_finalizeERC20Withdrawal_revert_notOtherBridge() (gas: 31537)
-L1StandardBridge_FinalizeETHWithdrawal_Test:test_finalizeETHWithdrawal() (gas: 58708)
-L1StandardBridge_Getter_Test:test_getters_success() (gas: 31472)
-L1StandardBridge_Initialize_Test:test_initialize_success() (gas: 22027)
-L1StandardBridge_Receive_Test:test_receive_success() (gas: 514476)
+L1StandardBridge_DepositERC20_TestFail:test_depositERC20_notEoa_reverts() (gas: 22320)
+L1StandardBridge_DepositETHTo_Test:test_depositETHTo_succeeds() (gas: 324724)
+L1StandardBridge_DepositETH_Test:test_depositETH_succeeds() (gas: 367539)
+L1StandardBridge_DepositETH_TestFail:test_depositETH_notEoa_reverts() (gas: 40780)
+L1StandardBridge_FinalizeBridgeETH_TestFail:test_finalizeBridgeETH_incorrectValue_reverts() (gas: 34207)
+L1StandardBridge_FinalizeBridgeETH_TestFail:test_finalizeBridgeETH_sendToMessenger_reverts() (gas: 34288)
+L1StandardBridge_FinalizeBridgeETH_TestFail:test_finalizeBridgeETH_sendToSelf_reverts() (gas: 34257)
+L1StandardBridge_FinalizeERC20Withdrawal_Test:test_finalizeERC20Withdrawal_succeeds() (gas: 492896)
+L1StandardBridge_FinalizeERC20Withdrawal_TestFail:test_finalizeERC20Withdrawal_notMessenger_reverts() (gas: 31148)
+L1StandardBridge_FinalizeERC20Withdrawal_TestFail:test_finalizeERC20Withdrawal_notOtherBridge_reverts() (gas: 31504)
+L1StandardBridge_FinalizeETHWithdrawal_Test:test_finalizeETHWithdrawal_succeeds() (gas: 58686)
+L1StandardBridge_Getter_Test:test_getters_succeeds() (gas: 31449)
+L1StandardBridge_Initialize_Test:test_initialize_succeeds() (gas: 22005)
+L1StandardBridge_Receive_Test:test_receive_succeeds() (gas: 514475)
 L2CrossDomainMessenger_Test:testCannot_L2MessengerPause() (gas: 10860)
 L2CrossDomainMessenger_Test:test_L1MessengerRelayMessageRevertsOnReentrancy() (gas: 167775)
 L2CrossDomainMessenger_Test:test_L2MessengerMessageVersion() (gas: 8389)

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

@@ -12,12 +12,12 @@ contract DeployerWhitelist_Test is CommonTest {
     }
 
     // The owner should be address(0)
-    function test_owner() external {
+    function test_owner_succeeds() external {
         assertEq(list.owner(), address(0));
     }
 
     // The storage slot for the owner must be the same
-    function test_storageSlots() external {
+    function test_storageSlots_succeeds() external {
         vm.prank(list.owner());
         list.setOwner(address(1));
 

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

@@ -30,21 +30,21 @@ contract L1CrossDomainMessenger_Test is Messenger_Initializer {
     }
 
     // pause: should pause the contract when called by the current owner
-    function test_L1MessengerPause() external {
+    function test_pause_succeeds() external {
         vm.prank(alice);
         L1Messenger.pause();
         assert(L1Messenger.paused());
     }
 
     // pause: should not pause the contract when called by account other than the owner
-    function testCannot_L1MessengerPause() external {
+    function test_pause_callerIsNotOwner_reverts() external {
         vm.expectRevert("Ownable: caller is not the owner");
         vm.prank(address(0xABBA));
         L1Messenger.pause();
     }
 
     // unpause: should unpause the contract when called by the current owner
-    function test_L1MessengerUnpause() external {
+    function test_unpause_succeeds() external {
         vm.prank(alice);
         L1Messenger.pause();
         assert(L1Messenger.paused());
@@ -55,14 +55,14 @@ contract L1CrossDomainMessenger_Test is Messenger_Initializer {
     }
 
     // unpause: should not unpause the contract when called by account other than the owner
-    function testCannot_L1MessengerUnpause() external {
+    function test_unpause_callerIsNotOwner_reverts() external {
         vm.expectRevert("Ownable: caller is not the owner");
         vm.prank(address(0xABBA));
         L1Messenger.unpause();
     }
 
     // the version is encoded in the nonce
-    function test_L1MessengerMessageVersion() external {
+    function test_messageVersion_succeeds() external {
         (, uint16 version) = Encoding.decodeVersionedNonce(L1Messenger.messageNonce());
         assertEq(version, L1Messenger.MESSAGE_VERSION());
     }
@@ -70,7 +70,7 @@ contract L1CrossDomainMessenger_Test is Messenger_Initializer {
     // sendMessage: should be able to send a single message
     // TODO: this same test needs to be done with the legacy message type
     // by setting the message version to 0
-    function test_L1MessengerSendMessage() external {
+    function test_sendMessage_succeeds() external {
         // deposit transaction on the optimism portal should be called
         vm.expectCall(
             address(op),
@@ -123,7 +123,7 @@ contract L1CrossDomainMessenger_Test is Messenger_Initializer {
     }
 
     // sendMessage: should be able to send the same message twice
-    function test_L1MessengerTwiceSendMessage() external {
+    function test_sendMessage_twice_succeeds() external {
         uint256 nonce = L1Messenger.messageNonce();
         L1Messenger.sendMessage(recipient, hex"aa", uint32(500_000));
         L1Messenger.sendMessage(recipient, hex"aa", uint32(500_000));
@@ -131,7 +131,7 @@ contract L1CrossDomainMessenger_Test is Messenger_Initializer {
         assertEq(nonce + 2, L1Messenger.messageNonce());
     }
 
-    function test_L1MessengerXDomainSenderReverts() external {
+    function test_xDomainSender_notSet_reverts() external {
         vm.expectRevert("CrossDomainMessenger: xDomainMessageSender is not set");
         L1Messenger.xDomainMessageSender();
     }
@@ -140,7 +140,7 @@ contract L1CrossDomainMessenger_Test is Messenger_Initializer {
     // TODO: might need a test contract
     // function test_xDomainSenderSetCorrectly() external {}
 
-    function test_L1MessengerRelayMessageV0Fails() external {
+    function test_relayMessage_v0_reverts() external {
         address target = address(0xabcd);
         address sender = Predeploys.L2_CROSS_DOMAIN_MESSENGER;
 
@@ -162,7 +162,7 @@ contract L1CrossDomainMessenger_Test is Messenger_Initializer {
     }
 
     // relayMessage: should send a successful call to the target contract
-    function test_L1MessengerRelayMessageSucceeds() external {
+    function test_relayMessage_succeeds() external {
         address target = address(0xabcd);
         address sender = Predeploys.L2_CROSS_DOMAIN_MESSENGER;
 
@@ -201,7 +201,7 @@ contract L1CrossDomainMessenger_Test is Messenger_Initializer {
     }
 
     // relayMessage: should revert if attempting to relay a message sent to an L1 system contract
-    function test_L1MessengerRelayMessageToSystemContract() external {
+    function test_relayMessage_toSystemContract_reverts() external {
         // set the target to be the OptimismPortal
         address target = address(op);
         address sender = Predeploys.L2_CROSS_DOMAIN_MESSENGER;
@@ -231,7 +231,7 @@ contract L1CrossDomainMessenger_Test is Messenger_Initializer {
     }
 
     // relayMessage: should revert if eth is sent from a contract other than the standard bridge
-    function test_L1MessengerReplayMessageWithValue() external {
+    function test_replayMessage_withValue_reverts() external {
         address target = address(0xabcd);
         address sender = Predeploys.L2_CROSS_DOMAIN_MESSENGER;
         bytes memory message = hex"1111";
@@ -250,7 +250,7 @@ contract L1CrossDomainMessenger_Test is Messenger_Initializer {
     }
 
     // relayMessage: the xDomainMessageSender is reset to the original value
-    function test_L1MessengerxDomainMessageSenderResets() external {
+    function test_xDomainMessageSender_reset_succeeds() external {
         vm.expectRevert("CrossDomainMessenger: xDomainMessageSender is not set");
         L1Messenger.xDomainMessageSender();
 
@@ -272,7 +272,7 @@ contract L1CrossDomainMessenger_Test is Messenger_Initializer {
     }
 
     // relayMessage: should revert if paused
-    function test_L1MessengerRelayShouldRevertIfPaused() external {
+    function test_relayMessage_paused_reverts() external {
         vm.prank(L1Messenger.owner());
         L1Messenger.pause();
 
@@ -282,7 +282,7 @@ contract L1CrossDomainMessenger_Test is Messenger_Initializer {
 
     // relayMessage: should send a successful call to the target contract after the first message
     // fails and ETH gets stuck, but the second message succeeds
-    function test_L1MessengerRelayMessageFirstStuckSecondSucceeds() external {
+    function test_relayMessage_retryAfterFailure_succeeds() external {
         address target = address(0xabcd);
         address sender = Predeploys.L2_CROSS_DOMAIN_MESSENGER;
         uint256 value = 100;
@@ -338,7 +338,7 @@ contract L1CrossDomainMessenger_Test is Messenger_Initializer {
     }
 
     // relayMessage: should revert if recipient is trying to reenter
-    function test_L1MessengerRelayMessageRevertsOnReentrancy() external {
+    function test_relayMessage_reentrancy_reverts() external {
         address target = address(0xabcd);
         address sender = Predeploys.L2_CROSS_DOMAIN_MESSENGER;
         bytes memory message = abi.encodeWithSelector(

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

@@ -11,7 +11,7 @@ import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import { stdStorage, StdStorage } from "forge-std/Test.sol";
 
 contract L1StandardBridge_Getter_Test is Bridge_Initializer {
-    function test_getters_success() external {
+    function test_getters_succeeds() external {
         assert(L1Bridge.l2TokenBridge() == address(L2Bridge));
         assert(L1Bridge.OTHER_BRIDGE() == L2Bridge);
         assert(L1Bridge.messenger() == L1Messenger);
@@ -21,7 +21,7 @@ contract L1StandardBridge_Getter_Test is Bridge_Initializer {
 }
 
 contract L1StandardBridge_Initialize_Test is Bridge_Initializer {
-    function test_initialize_success() external {
+    function test_initialize_succeeds() external {
         assertEq(address(L1Bridge.messenger()), address(L1Messenger));
 
         assertEq(address(L1Bridge.OTHER_BRIDGE()), Predeploys.L2_STANDARD_BRIDGE);
@@ -35,7 +35,7 @@ contract L1StandardBridge_Initialize_TestFail is Bridge_Initializer {}
 contract L1StandardBridge_Receive_Test is Bridge_Initializer {
     // receive
     // - can accept ETH
-    function test_receive_success() external {
+    function test_receive_succeeds() external {
         assertEq(address(op).balance, 0);
 
         vm.expectEmit(true, true, true, true);
@@ -72,7 +72,7 @@ contract L1StandardBridge_DepositETH_Test is Bridge_Initializer {
     // - calls optimismPortal.depositTransaction
     // - only EOA
     // - ETH ends up in the optimismPortal
-    function test_depositETH_success() external {
+    function test_depositETH_succeeds() external {
         assertEq(address(op).balance, 0);
 
         vm.expectEmit(true, true, true, true);
@@ -101,7 +101,7 @@ contract L1StandardBridge_DepositETH_Test is Bridge_Initializer {
 }
 
 contract L1StandardBridge_DepositETH_TestFail is Bridge_Initializer {
-    function test_DepositETH_revert_notEoa() external {
+    function test_depositETH_notEoa_reverts() external {
         // turn alice into a contract
         vm.etch(alice, address(L1Token).code);
 
@@ -117,7 +117,7 @@ contract L1StandardBridge_DepositETHTo_Test is Bridge_Initializer {
     // - calls optimismPortal.depositTransaction
     // - EOA or contract can call
     // - ETH ends up in the optimismPortal
-    function test_depositETHTo() external {
+    function test_depositETHTo_succeeds() external {
         assertEq(address(op).balance, 0);
 
         vm.expectEmit(true, true, true, true);
@@ -195,7 +195,7 @@ contract L1StandardBridge_DepositERC20_Test is Bridge_Initializer {
 }
 
 contract L1StandardBridge_DepositERC20_TestFail is Bridge_Initializer {
-    function test_depositERC20_revert_notEoa() external {
+    function test_depositERC20_notEoa_reverts() external {
         // turn alice into a contract
         vm.etch(alice, hex"ffff");
 
@@ -211,7 +211,7 @@ contract L1StandardBridge_DepositERC20To_Test is Bridge_Initializer {
     // - emits ERC20DepositInitiated
     // - calls optimismPortal.depositTransaction
     // - callable by a contract
-    function test_depositERC20To_success() external {
+    function test_depositERC20To_succeeds() external {
         vm.expectEmit(true, true, true, true);
         emit ERC20DepositInitiated(address(L1Token), address(L2Token), alice, bob, 1000, hex"");
 
@@ -238,7 +238,7 @@ contract L1StandardBridge_FinalizeETHWithdrawal_Test is Bridge_Initializer {
     // finalizeETHWithdrawal
     // - emits ETHWithdrawalFinalized
     // - only callable by L2 bridge
-    function test_finalizeETHWithdrawal() external {
+    function test_finalizeETHWithdrawal_succeeds() external {
         uint256 aliceBalance = alice.balance;
 
         vm.expectEmit(true, true, true, true);
@@ -270,7 +270,7 @@ contract L1StandardBridge_FinalizeERC20Withdrawal_Test is Bridge_Initializer {
     // - updates bridge.deposits
     // - emits ERC20WithdrawalFinalized
     // - only callable by L2 bridge
-    function test_finalizeERC20Withdrawal() external {
+    function test_finalizeERC20Withdrawal_succeeds() external {
         deal(address(L1Token), address(L1Bridge), 100, true);
 
         uint256 slot = stdstore
@@ -313,7 +313,7 @@ contract L1StandardBridge_FinalizeERC20Withdrawal_Test is Bridge_Initializer {
 }
 
 contract L1StandardBridge_FinalizeERC20Withdrawal_TestFail is Bridge_Initializer {
-    function test_finalizeERC20Withdrawal_revert_notMessenger() external {
+    function test_finalizeERC20Withdrawal_notMessenger_reverts() external {
         vm.mockCall(
             address(L1Bridge.messenger()),
             abi.encodeWithSelector(CrossDomainMessenger.xDomainMessageSender.selector),
@@ -331,7 +331,7 @@ contract L1StandardBridge_FinalizeERC20Withdrawal_TestFail is Bridge_Initializer
         );
     }
 
-    function test_finalizeERC20Withdrawal_revert_notOtherBridge() external {
+    function test_finalizeERC20Withdrawal_notOtherBridge_reverts() external {
         vm.mockCall(
             address(L1Bridge.messenger()),
             abi.encodeWithSelector(CrossDomainMessenger.xDomainMessageSender.selector),
@@ -357,7 +357,7 @@ contract L1StandardBridge_FinalizeBridgeETH_Test is Bridge_Initializer {
 }
 
 contract L1StandardBridge_FinalizeBridgeETH_TestFail is Bridge_Initializer {
-    function test_finalizeBridgeETH_revert_incorrectValue() external {
+    function test_finalizeBridgeETH_incorrectValue_reverts() external {
         address messenger = address(L1Bridge.messenger());
         vm.mockCall(
             messenger,
@@ -370,7 +370,7 @@ contract L1StandardBridge_FinalizeBridgeETH_TestFail is Bridge_Initializer {
         L1Bridge.finalizeBridgeETH{ value: 50 }(alice, alice, 100, hex"");
     }
 
-    function test_finalizeBridgeETH_revert_sendToSelf() external {
+    function test_finalizeBridgeETH_sendToSelf_reverts() external {
         address messenger = address(L1Bridge.messenger());
         vm.mockCall(
             messenger,
@@ -383,7 +383,7 @@ contract L1StandardBridge_FinalizeBridgeETH_TestFail is Bridge_Initializer {
         L1Bridge.finalizeBridgeETH{ value: 100 }(alice, address(L1Bridge), 100, hex"");
     }
 
-    function test_finalizeBridgeETH_revert_sendToMessenger() external {
+    function test_finalizeBridgeETH_sendToMessenger_reverts() external {
         address messenger = address(L1Bridge.messenger());
         vm.mockCall(
             messenger,