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

refactor(lockup account): Add tests for lockup account #19772

Merged
merged 59 commits into from
Apr 24, 2024

Conversation

sontrinh16
Copy link
Member

@sontrinh16 sontrinh16 commented Mar 18, 2024

Description

Add unit and e2e test for lockup account


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features
    • Enhanced lockup account functionalities to support continuous, periodic, and permanent locking mechanisms.
    • Introduced compatibility with standard message types for delegation and banking operations in lockup scenarios.
  • Bug Fixes
    • Improved error handling for transactions involving zero or insufficient coin amounts.
  • Tests
    • Added comprehensive end-to-end test suites for continuous, delayed, periodic, and permanent lockup account functionalities.
    • Implemented utility functions for setting up and managing tests for account lockup scenarios.

Copy link
Contributor

coderabbitai bot commented Mar 18, 2024

Important

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (46)
  • client/v2/go.mod is excluded by !**/*.mod
  • client/v2/go.sum is excluded by !**/*.sum
  • go.mod is excluded by !**/*.mod
  • go.sum is excluded by !**/*.sum
  • simapp/go.mod is excluded by !**/*.mod
  • tests/go.mod is excluded by !**/*.mod
  • tests/go.sum is excluded by !**/*.sum
  • tests/starship/tests/go.mod is excluded by !**/*.mod
  • tests/starship/tests/go.sum is excluded by !**/*.sum
  • x/accounts/defaults/lockup/go.mod is excluded by !**/*.mod
  • x/accounts/go.mod is excluded by !**/*.mod
  • x/accounts/go.sum is excluded by !**/*.sum
  • x/auth/go.mod is excluded by !**/*.mod
  • x/auth/go.sum is excluded by !**/*.sum
  • x/authz/go.mod is excluded by !**/*.mod
  • x/authz/go.sum is excluded by !**/*.sum
  • x/bank/go.mod is excluded by !**/*.mod
  • x/bank/go.sum is excluded by !**/*.sum
  • x/circuit/go.mod is excluded by !**/*.mod
  • x/circuit/go.sum is excluded by !**/*.sum
  • x/distribution/go.mod is excluded by !**/*.mod
  • x/distribution/go.sum is excluded by !**/*.sum
  • x/epochs/go.mod is excluded by !**/*.mod
  • x/epochs/go.sum is excluded by !**/*.sum
  • x/evidence/go.mod is excluded by !**/*.mod
  • x/evidence/go.sum is excluded by !**/*.sum
  • x/feegrant/go.mod is excluded by !**/*.mod
  • x/feegrant/go.sum is excluded by !**/*.sum
  • x/gov/go.mod is excluded by !**/*.mod
  • x/gov/go.sum is excluded by !**/*.sum
  • x/group/go.mod is excluded by !**/*.mod
  • x/group/go.sum is excluded by !**/*.sum
  • x/mint/go.mod is excluded by !**/*.mod
  • x/mint/go.sum is excluded by !**/*.sum
  • x/nft/go.mod is excluded by !**/*.mod
  • x/nft/go.sum is excluded by !**/*.sum
  • x/params/go.mod is excluded by !**/*.mod
  • x/params/go.sum is excluded by !**/*.sum
  • x/protocolpool/go.mod is excluded by !**/*.mod
  • x/protocolpool/go.sum is excluded by !**/*.sum
  • x/slashing/go.mod is excluded by !**/*.mod
  • x/slashing/go.sum is excluded by !**/*.sum
  • x/staking/go.mod is excluded by !**/*.mod
  • x/staking/go.sum is excluded by !**/*.sum
  • x/upgrade/go.mod is excluded by !**/*.mod
  • x/upgrade/go.sum is excluded by !**/*.sum

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent updates focus on enhancing the lockup features in a blockchain application using the Cosmos SDK. Changes include adding new conditions and initializations in lockup account structures, integrating existing modules for transaction handling, and improving error checks. Additionally, comprehensive end-to-end test suites have been introduced for various lockup scenarios, ensuring robust functionality for continuous, periodic, delayed, and permanent lockup accounts.

Changes

File Path Change Summary
.../continuous_locking_account.go Added condition to check if EndTime equals StartTime in Init method.
.../lockup.go Integrated staking and bank modules for handling transactions; updated error handling.
.../periodic_locking_account.go Updated Init to set initial values for various token types.
.../lockup/continous_lockup_test_suite.go Introduced tests for continuous locking account scenarios.
.../lockup/delayed_lockup_test_suite.go Introduced tests for delayed locking account scenarios.
.../lockup/lockup_account_test.go Introduced general test suite for lockup functionality.
.../lockup/periodic_lockup_test_suite.go Introduced tests for periodic locking account scenarios.
.../lockup/permanent_lockup_test_suite.go Introduced tests for permanent locking accounts.
.../lockup/utils.go Added utilities for setting up E2E tests for lockup scenarios.
.../lockup/lockup_test.go Introduced tests for initializing and tracking lockup accounts and querying lockup account info.

This table summarizes the changes made to the files, highlighting the focus on improving lockup functionalities and testing in the application.


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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

@sontrinh16 sontrinh16 changed the title add NewMockCtx refactor[lockup account] Add tests for lockup account Mar 18, 2024
Copy link
Contributor

@likhita-809 likhita-809 left a comment

Choose a reason for hiding this comment

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

e2e tests are failing, can you please fix them

@sontrinh16
Copy link
Member Author

sontrinh16 commented Apr 17, 2024

e2e tests are failing, can you please fix them

yeah we have to merge this first because right now account executing msg twice

@sontrinh16 sontrinh16 changed the title refactor[lockup account] Add tests for lockup account refactor(lockup account): Add tests for lockup account Apr 17, 2024
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

left two comments

x/accounts/defaults/lockup/lockup.go Show resolved Hide resolved
tests/e2e/accounts/lockup_test_suite.go Outdated Show resolved Hide resolved
@tac0turtle
Copy link
Member

once this is rebased we can merge

@tac0turtle tac0turtle added this pull request to the merge queue Apr 24, 2024
Merged via the queue into main with commit 11d4e74 Apr 24, 2024
78 of 79 checks passed
@tac0turtle tac0turtle deleted the son/add_lockup_account_test branch April 24, 2024 06:58
ipangpang pushed a commit to ipangpang/cosmos-sdk that referenced this pull request Apr 24, 2024
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Marko <marko@baricevic.me>
meetrick pushed a commit to meetrick/cosmos-sdk that referenced this pull request Apr 29, 2024
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Marko <marko@baricevic.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants