zeta-chain / protocol-contracts

Protocol contracts implementing the core logic of the protocol, deployed on ZetaChain and on connected chains
MIT License
70 stars 58 forks source link

test: migrate v2 contracts unit tests to foundry #226

Closed skosito closed 4 months ago

skosito commented 4 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The updates include version upgrades for GitHub Actions, Solidity pragma changes for multiple contracts, new Foundry test files, and the addition of OpenZeppelin submodules. It also refines the Node.js version in workflows and enhances test scripts and configurations. The overall improvements focus on compatibility, testing efficiency, and better contract management.

Changes

File/Path Summary
.github/workflows/... Updated GitHub Actions versions, refined Node.js version, and added steps for Foundry installation and testing.
.gitmodules Added submodule for "lib/openzeppelin-foundry-upgrades".
contracts/prototypes/... Changed Solidity pragma directives to ^0.8.0; added constructors, initializers, and updated functions.
echidna.yaml Added balanceAddr field with a specific hexadecimal value.
foundry.toml Updated settings related to testing, optimization, FFI, AST, build info, output, permissions, and EVM version.
lib/types.ts Reorganized and reordered exported types without adding or removing values.
package.json Updated lint scripts and renamed test:forge to test:foundry with forge clean command.
remappings.txt Added new remapping for @openzeppelin/contracts-upgradeable/.
test/fuzz/... Added new imports, created proxy addresses, and updated constructor and initialization logic in fuzz tests.
testFoundry/... Introduced new test contracts and functions for testing various functionalities, including proxy upgrades.
.gitignore Added lcov.info to the ignore list.
lib/openzeppelin-foundry-upgrades Introduced a subproject commit with a specific hash.

Sequence Diagram(s)


Poem

In the land of code, a rabbit hops, With updates fresh, it never stops. Solidity’s tune now sings anew, With version bumps and tests to do. Foundry’s forge, a gleaming tool, Ensures our contracts always rule. From workflows to the deepest core, We’ve made them better, that’s for sure!


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov-commenter commented 4 months ago

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 58.29%. Comparing base (180b8c8) to head (e90cd2c).

Files Patch % Lines
contracts/prototypes/evm/GatewayEVM.sol 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #226 +/- ## ========================================= + Coverage 0 58.29% +58.29% ========================================= Files 0 11 +11 Lines 0 235 +235 Branches 0 61 +61 ========================================= + Hits 0 137 +137 - Misses 0 98 +98 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

skosito commented 4 months ago

Would be great if we can merge #231 to it

The coverage looks good https://app.codecov.io/github/zeta-chain/protocol-contracts I think we're mainly missing tests for ERC20Custody withdraw

@lumtis thanks for adding coverage unfortunately we can not change src in foundry.toml because it overwrites hardhat config contracts path so everything else is not compiled, and because of that other tests are failing (on coverage PR: https://github.com/zeta-chain/protocol-contracts/actions/runs/9958513626/job/27513101458), this is mentioned on hardhat-foundry plugin repo as well (https://github.com/NomicFoundation/hardhat/blob/main/packages/hardhat-foundry/README.md#how-it-works)

i fixed this with simplest way i found which is to overwrite this part of the config just for coverage script: https://github.com/zeta-chain/protocol-contracts/pull/226/commits/05d2a4aab1f61e914961dfac8d5b0dc3e0f8f175

and improved coverage: https://github.com/zeta-chain/protocol-contracts/pull/226/commits/e90cd2c916dddca2b874b17fdaef7db098e97b76 tests build is failing here, fix is on this PR so we can ignore here: https://github.com/zeta-chain/protocol-contracts/pull/232