refactor(test): cleanup of L2 test structure and documentation #15901

aliersh · 2025-05-13T21:57:34Z

This PR refactors a portion of the test suite within the /L2 folder as part of a broader effort to standardize structure, documentation, and formatting across the codebase.

Changes applied to each file:

Consolidated shared test initialization into dedicated *_TestInit contracts
Organized test functions into logically separated contracts inheriting from TestInit
Added @title and @notice tags to all test contracts
Added function-level @notice comments describing expected behavior under test
Replaced @dev tags with @notice where appropriate
Enforced a 100-character limit for inline comments

Progress

Refactored 25 of 25 test files (100.0% complete)

Note: GasPriceOracle.t.sol will be refactored in a later PR.

@title

- rename test contract to OperatorFeeVault_Constructor_Test - add @title and @notice tags to test contract - convert @dev tag to @notice

@title

- rename test contract to L1FeeVault_Constructor_Test - add @title and @notice tags to test contract - convert @dev tag to @notice

@title

- rename test contract to BaseFeeVault_Constructor_Test - add @title and @notice tags to test contract - convert @dev tag to @notice

@title

…and documentation - rename OptimismSuperchainERC20BeaconTest to OptimismSuperchainERC20Beacon_TestInit - move implementation test into dedicated OptimismSuperchainERC20Beacon_Implementation_Test contract - improve test contract documentation with more specific @title and @notice tags

@title

- organize individual test functions into separate contracts - add @title and @notice tags to all test contracts - convert @dev tags to @notice where appropriate

@title

…and documentation - consolidate test initialization into a single OptimismMintableERC721Factory_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - add @title and @notice tags to all test contracts - add function-level @notice comments describing expected behavior under test - ensure comment lines stay within 100 character limit

@title

… and documentation - consolidate test initialization into a single OptimismSuperchainERC20Factory_TestInit contract - organize individual test functions into separate contract inheriting from TestInit - add @title and @notice tags to all test contracts

- ensure comment lines stay within 100 character limit in OptimismSuperchainERC20Beacon test - Update WETH test functions descriptions to explicitly mention default values

@title

…ntation - organize individual test functions into separate contracts - add @title and @notice tags to all test contracts - convert @dev tags to @notice where appropriate

@title

…cumentation - consolidate test initialization into a single ExecutingMessageEmitted_TestInit contract - rename ExecutingMessageEmittedTest to ExecutingMessageEmitted_Test - add @title and @notice tags to all test contracts - ensure comment lines stay within 100 character limit

@title

- consolidate test initialization into a single Predeploys_TestInit contract - rename PredeploysTest and PredeploysInteropTest to Predeploys_Test and Predeploys_Interop_Test - add @title and @notice tags to all test contracts - ensure comment lines stay within 100 character limit

@title

…umentation - consolidate test initialization into a single OptimismMintableERC721_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - group tests not directly tied to a base contract function into OptimismMintableERC721_Unclassified_Test - add @title and @notice tags to all test contracts - convert @dev tags to @notice where appropriate - add function-level @notice comments describing expected behavior under test - ensure comment lines stay within 100 character limit

@title

- consolidate test initialization into a single SuperchainERC20_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - add @title and @notice tags to all test contracts - ensure comment lines stay within 100 character limit

@title

…ntation - consolidate test initialization into a single SuperchainETHBridge_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - add @title and @notice tags to all test contracts - ensure comment lines stay within 100 character limit

@title

- consolidate test initialization into a single ETHLiquidity_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - add @title and @notice tags to all test contracts - ensure comment lines stay within 100 character limit

…part1

aliersh · 2025-05-13T21:58:56Z

🔁 Continues work from the closed PR #15862, after renaming the branch.

packages/contracts-bedrock/test/L2/OptimismMintableERC721.t.sol

packages/contracts-bedrock/test/L2/ExecutingMessageEmitted.t.sol

@title

…mentation - consolidate test initialization into a single SuperchainTokenBridge_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - add @title and @notice tags to all test contracts - ensure comment lines stay within 100 character limit

@title

- consolidate test initialization into a single L1Block_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - add @title and @notice tags to all test contracts - convert @dev tags to @notice where appropriate - add function-level @notice comments describing expected behavior under test - ensure comment lines stay within 100 character limit

@title

- consolidate test initialization into a single CrossL2Inbox_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - add @title and @notice tags to all test contracts - add @notice tag to test function comments - ensure comment lines stay within 100 character limit

@title

…cumentation - consolidate test initialization into a single L2StandardBridgeInterop_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - add @title and @notice tags to all test contracts - ensure comment lines stay within 100 character limit

@title

- consolidate test initialization into a single L2ERC721Bridge_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - group tests not directly tied to a base contract function into L2ERC721Bridge_Unclassified_Test - add @title and @notice tags to all test contracts - convert @dev tags to @notice where appropriate - ensure comment lines stay within 100 character limit

@title

…cumentation - consolidate test initialization into a single OptimismSuperchainERC20_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - group tests not directly tied to a base contract function into OptimismSuperchainERC20_Unclassified_Test - add @title and @notice tags to all test contracts - ensure comment lines stay within 100 character limit

@title

…umentation - consolidate test initialization into a single L2CrossDomainMessenger_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - group tests not directly tied to a base contract function into L2CrossDomainMessenger_Unclassified_Test - add @title and @notice tags to all test contracts - ensure comment lines stay within 100 character limit

@title

… documentation - consolidate test initialization into a single L2ToL2CrossDomainMessenger_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - add @title and @notice tags to all test contracts - ensure comment lines stay within 100 character limit

- Update test initialization contract naming format to use _TestInit suffix - Add backticks around contract names in documentation comments - Fix duplicated notice tag in OptimismMintableERC721.t.sol - Fix contract naming convention in ExecutingMessageEmitted.t.sol

- remove Predeploys.t.sol refactor - remove ExecutingMessageEmmited.t.sol refactor

@title

…tation - consolidate test initialization into a single CrossDomainOwnable_TestInit contract - organize tests into logical groups based on functionality (AccessControl and PortalIntegration) - add @title and @notice tags to all test contracts - convert @dev tags to @notice where appropriate - ensure comment lines stay within 100 character limit

@title

…ntation - consolidate test initialization into a single CrossDomainOwnable2_TestInit contract - organize tests into logical groups (RevertConditions and SuccessConditions) - add @title and @notice tags to all test contracts - convert @dev tags to @notice where appropriate - ensure comment lines stay within 100 character limit

@title

…ntation - consolidate test initialization into a single CrossDomainOwnable3_TestInit contract - organize tests into logical groups (BasicFunctionality, TransferOwnership, and CrossDomainAccess) - add @title and @notice tags to all test contracts - convert @dev tags to @notice where appropriate - ensure comment lines stay within 100 character limit

@title

…tion - consolidate test initialization into a single L2StandardBridge_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - group tests not directly tied to a base contract function into L2StandardBridge_Unclassified_Test - add @title and @notice tags to all test contracts - convert @dev tags to @notice where appropriate - ensure comment lines stay within 100 character limit

@title

…ation - consolidate test initialization into a single SequencerFeeVault_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - add @title and @notice tags to all test contracts - convert @dev tags to @notice where appropriate - ensure comment lines stay within 100 character limit

smartcontracts · 2025-05-27T16:30:30Z

/ci authorize 61973cb

packages/contracts-bedrock/test/L2/L2ToL2CrossDomainMessenger.t.sol

…argets in L2ToL2CrossDomainMessenger tests

@title

- rena test Initializer contract to AssetReceiver_TestInit contract - organize individual test functions into separate contracts inheriting from TestInit - refactor test function names to follow naming convention - add @title and @notice tags to test contracts - ensure comment stay within 100 character limit

…mentation" This reverts commit dd4a5a3.

smartcontracts · 2025-05-28T20:18:34Z

/ci authorize 80f630e

aliersh added 16 commits May 9, 2025 15:37

refactor(test): improve OperatorFeeVault test documentation

1248d14

- rename test contract to OperatorFeeVault_Constructor_Test - add @title and @notice tags to test contract - convert @dev tag to @notice

refactor(test): improve L1FeeVault test documentation

e205338

- rename test contract to L1FeeVault_Constructor_Test - add @title and @notice tags to test contract - convert @dev tag to @notice

refactor(test): improve BaseFeeVault test documentation

5e51723

- rename test contract to BaseFeeVault_Constructor_Test - add @title and @notice tags to test contract - convert @dev tag to @notice

refactor(test): improve WETH test structure and documentation

d9f6750

- organize individual test functions into separate contracts - add @title and @notice tags to all test contracts - convert @dev tags to @notice where appropriate

docs(test): improve test documentation clarity

7efb181

- ensure comment lines stay within 100 character limit in OptimismSuperchainERC20Beacon test - Update WETH test functions descriptions to explicitly mention default values

refactor(test): improve L2ToL1MessagePasser test structure and docume…

6ce3d5a

…ntation - organize individual test functions into separate contracts - add @title and @notice tags to all test contracts - convert @dev tags to @notice where appropriate

Merge branch 'ari/l2-tests-cleanup-part2' into ari/l2-tests-cleanups-…

3dd996a

…part1

aliersh requested a review from a team as a code owner May 13, 2025 21:57

aliersh requested a review from Inphi May 13, 2025 21:57

aliersh marked this pull request as draft May 13, 2025 21:58

aliersh mentioned this pull request May 13, 2025

refactor(test): begin cleanup of L2 test structure and documentation #15862

Closed

graphite-app bot reviewed May 13, 2025

View reviewed changes

packages/contracts-bedrock/test/L2/OptimismMintableERC721.t.sol Outdated Show resolved Hide resolved

packages/contracts-bedrock/test/L2/ExecutingMessageEmitted.t.sol Outdated Show resolved Hide resolved

aliersh added 8 commits May 14, 2025 10:59

aliersh added 7 commits May 15, 2025 18:01

revert(test): remove refactor of files not belonging to L2 cleanup scope

eabbc31

- remove Predeploys.t.sol refactor - remove ExecutingMessageEmmited.t.sol refactor

aliersh marked this pull request as ready for review May 22, 2025 16:09

smartcontracts approved these changes May 28, 2025

View reviewed changes

smartcontracts reviewed May 28, 2025

View reviewed changes

packages/contracts-bedrock/test/L2/L2ToL2CrossDomainMessenger.t.sol Show resolved Hide resolved

aliersh added 3 commits May 28, 2025 13:39

fix(test): adds assumeNotForgeAddress to prevent Forge addresses as t…

0a1a07b

…argets in L2ToL2CrossDomainMessenger tests

Revert "refactor(test): improve AssetReceiver test structure and docu…

80f630e

…mentation" This reverts commit dd4a5a3.

mds1 approved these changes May 29, 2025

View reviewed changes

mds1 added this pull request to the merge queue May 29, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 29, 2025

aliersh added this pull request to the merge queue May 30, 2025

Merged via the queue into ethereum-optimism:develop with commit ef93ca1 May 30, 2025
58 checks passed

aliersh deleted the ari/l2-tests-cleanup branch May 30, 2025 14:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor(test): cleanup of L2 test structure and documentation #15901

refactor(test): cleanup of L2 test structure and documentation #15901

Uh oh!

aliersh commented May 13, 2025 •

edited

Loading

Uh oh!

aliersh commented May 13, 2025

Uh oh!

Uh oh!

Uh oh!

smartcontracts commented May 27, 2025

Uh oh!

Uh oh!

smartcontracts commented May 28, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

refactor(test): cleanup of L2 test structure and documentation #15901

refactor(test): cleanup of L2 test structure and documentation #15901

Uh oh!

Conversation

aliersh commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes applied to each file:

Progress

Uh oh!

aliersh commented May 13, 2025

Uh oh!

Uh oh!

Uh oh!

smartcontracts commented May 27, 2025

Uh oh!

Uh oh!

smartcontracts commented May 28, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aliersh commented May 13, 2025 •

edited

Loading