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: fix v1.6.1 upgrade test #1680

Closed
wants to merge 2 commits into from
Closed

Conversation

tuantran1702
Copy link
Contributor

@tuantran1702 tuantran1702 commented Jun 29, 2024

1. Summary

Fix the upgrade test failed to run due to wrong chain-id.

2.Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

3. Implementation details

4. How to test/use

5. Checklist

  • Does the Readme need to be updated?

6. Limitations (optional)

7. Future Work (optional)

Summary by CodeRabbit

  • Bug Fixes
    • Ensured upgrades are correctly applied only on the production chain by setting the chain ID during the upgrade process.

Copy link

vercel bot commented Jun 29, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
quicksilver ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 9, 2024 2:32am

Copy link
Contributor

coderabbitai bot commented Jun 29, 2024

Walkthrough

The TestV010601UpgradeHandler test in the app/upgrades_test.go file now sets the chain ID to upgrades.ProductionChainID within its context before calling the V010601UpgradeHandler function. This ensures that the upgrade handler runs only on the production chain during testing.

Changes

File Change Summary
app/upgrades_test.go Modified TestV010601UpgradeHandler to set the chain ID to production before running the upgrade handler.

Poem

Amidst the lines of code so swift,
Came a change, quiet but swift,
Context now holds a chain of pride,
To guide the tests where they abide.
Production’s path, so clear, so fair,
Ensures the upgrade runs with care. 🌟🛠


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>.
    • 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 Configration 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 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 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.

@tuantran1702 tuantran1702 force-pushed the fix-v1.6.1-upgradetest branch from 7b31b4c to 08bd2c9 Compare June 29, 2024 14:12
ctx := s.chainA.GetContext()

// upgrade only run on production chain
ctx = ctx.WithChainID(upgrades.ProductionChainID)
Copy link
Contributor

Choose a reason for hiding this comment

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

A better fix would be to make the IsMainnet() check in the upgrade to a IsMainnet() || IsTest()

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@joe-bowman I guess adjusting the test for local, testnet or mainnet a better pattern? In my opinion upgrade handler should not take the test into account.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey @joe-bowman IsTest() won't work since the chain id here is not testnet2 but some chain-id provided by the ibc test suite. I think my solution/workaround is good for now.

Copy link

codecov bot commented Jun 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.92%. Comparing base (154b78d) to head (afdf333).
Report is 4 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1680      +/-   ##
==========================================
- Coverage   63.93%   63.92%   -0.01%     
==========================================
  Files         195      195              
  Lines       13757    13792      +35     
==========================================
+ Hits         8795     8816      +21     
- Misses       4099     4109      +10     
- Partials      863      867       +4     
Flag Coverage Δ
unittests 63.92% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5fd3a24 and 08bd2c9.

Files selected for processing (1)
  • app/upgrades_test.go (1 hunks)
Additional comments not posted (1)
app/upgrades_test.go (1)

900-901: Ensure the chain ID is correctly set.

The context modification sets the chain ID to upgrades.ProductionChainID to ensure the upgrade handler runs only on the production chain. Verify that upgrades.ProductionChainID is correctly defined and used across the codebase.

Verification successful

ProductionChainID is correctly defined and used.

The ProductionChainID is defined in app/upgrades/types.go and is consistently used across the codebase to ensure that the upgrade handler runs only on the production chain.

  • app/upgrades/types.go:

    • Definition: ProductionChainID = "quicksilver-2"
    • Usage: return ctx.ChainID() == ProductionChainID
  • app/upgrades_test.go:

    • Usage: ctx = ctx.WithChainID(upgrades.ProductionChainID)
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that upgrades.ProductionChainID is correctly defined and used.

# Test: Search for the definition and usage of ProductionChainID. Expect: Proper definition and usage.
rg --type go 'ProductionChainID'

Length of output: 228

@odeke-em
Copy link
Contributor

odeke-em commented Jul 4, 2024

Kind ping @joe-bowman @tropicaldog as this PR has stalled other PRs and CI being green :-)

@tuantran1702 tuantran1702 enabled auto-merge (squash) July 11, 2024 08:22
@joe-bowman
Copy link
Contributor

This is resolved in #1696 - the fix here doesn't actually test the upgrade handler.

@joe-bowman joe-bowman closed this Jul 12, 2024
auto-merge was automatically disabled July 12, 2024 15:27

Pull request was closed

@joe-bowman joe-bowman deleted the fix-v1.6.1-upgradetest branch November 18, 2024 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants