Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(e2e): update testdapp contract in deploy test #3042

Merged
merged 1 commit into from
Oct 25, 2024
Merged

Conversation

lumtis
Copy link
Member

@lumtis lumtis commented Oct 25, 2024

Description

TestDAppV2 has replaced TestDapp, replaces the contract in the deploy test as the later will no longer be deployed

Summary by CodeRabbit

  • New Features
    • Upgraded contract deployment functionality with the introduction of testdappv2.
    • Streamlined deployment process for ZetaChain and Ethereum contracts by simplifying parameters.

These changes enhance the efficiency and clarity of the contract deployment process for users.

@lumtis lumtis added the no-changelog Skip changelog CI check label Oct 25, 2024
Copy link
Contributor

coderabbitai bot commented Oct 25, 2024

📝 Walkthrough

Walkthrough

The pull request introduces significant updates to the contract deployment functionality in the e2etests/test_deploy_contract.go file. It replaces the testdapp package with testdappv2, updating the deployment methods for both ZetaChain and Ethereum contracts. The changes simplify the parameters for these deployment functions by removing specific arguments, indicating a refinement in the contract's deployment process and requirements.

Changes

File Path Change Summary
e2e/e2etests/test_deploy_contract.go Replaced testdapp with testdappv2, updated DeployTestDApp to DeployTestDAppV2, and simplified parameters for deployment functions.

Possibly related PRs

Suggested labels

UPGRADE_TESTS

Suggested reviewers

  • fbac
  • kingpinXD
  • swift1337
  • skosito
  • gartnera

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
e2e/e2etests/test_deploy_contract.go (1)

64-66: LGTM: Consistent implementation with ZEVM deployment

The EVM deployment changes mirror the ZEVM updates, maintaining consistency across both deployment functions. Consider adding the same documentation about parameter removal here as well.

 func deployEVMTestDApp(r *runner.E2ERunner) (ethcommon.Address, error) {
+    // Note: ConnectorEthAddr and ZetaEthAddr parameters were removed in TestDAppV2
     addr, tx, _, err := testdappv2.DeployTestDAppV2(
         r.EVMAuth,
         r.EVMClient,
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b334267 and ace199e.

📒 Files selected for processing (1)
  • e2e/e2etests/test_deploy_contract.go (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
e2e/e2etests/test_deploy_contract.go (1)

Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.

🔇 Additional comments (2)
e2e/e2etests/test_deploy_contract.go (2)

11-11: LGTM: Import statement updated correctly

The import statement has been properly updated to use the new testdappv2 package, aligning with the PR's objective to replace the deprecated TestDapp contract.


45-47: Verify TestDAppV2 contract implementation

The deployment has been updated to use TestDAppV2. Let's verify the contract's existence and implementation.

Consider documenting parameter removal

The removal of ConnectorZEVMAddr and WZetaAddr parameters suggests a significant change in contract initialization. Consider adding a comment explaining why these parameters are no longer needed.

 func deployZEVMTestDApp(r *runner.E2ERunner) (ethcommon.Address, error) {
+    // Note: ConnectorZEVMAddr and WZetaAddr parameters were removed in TestDAppV2
     addr, tx, _, err := testdappv2.DeployTestDAppV2(
         r.ZEVMAuth,
         r.ZEVMClient,
✅ Verification successful

The files exist, but we need to verify:

  1. The contract implementation to understand parameter removal
  2. Usage patterns across tests to ensure consistency

This will help us validate if the parameter removal is intentional and properly handled across the codebase.


Parameter removal is correct and well-implemented

The contract implementation shows that TestDAppV2 is designed to work without ConnectorZEVMAddr and WZetaAddr parameters. The contract focuses on message handling, ERC20 interactions, and revert scenarios without dependencies on these addresses. All deployment calls across the codebase consistently use the simplified parameter pattern.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify TestDAppV2 contract exists and check its implementation
echo "Checking TestDAppV2 contract existence and implementation..."
fd -e sol -e go "TestDAppV2" 

Length of output: 238


Script:

#!/bin/bash
# Check TestDAppV2 contract implementation and parameter changes
echo "Checking TestDAppV2 contract implementation..."
cat pkg/contracts/testdappv2/TestDAppV2.sol

echo -e "\nChecking contract deployment usage across tests..."
rg -A 3 "DeployTestDAppV2" 

Length of output: 6515

@lumtis lumtis added this pull request to the merge queue Oct 25, 2024
Merged via the queue into develop with commit 3eefe9c Oct 25, 2024
38 checks passed
@lumtis lumtis deleted the test/new-testdapp branch October 25, 2024 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Skip changelog CI check
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants