test(precompiles): add missing test in staking by fbac · Pull Request #3017 · zeta-chain/node

fbac · 2024-10-17T10:07:17Z

Description

Add missings tests for stake, unstake and moveStake. All these functions should fail if called through staticcall (readOnly = true).

This PR has to be merged before #3010

How Has This Been Tested?

Summary by CodeRabbit

Tests
- Introduced new test cases for staking, unstaking, and moving stake functionalities in read-only mode.
- Enhanced error handling to ensure appropriate error messages are raised during restricted operations.
- Maintained consistent test structure for improved clarity and feedback on operations.

coderabbitai · 2024-10-17T10:07:29Z

📝 Walkthrough

Walkthrough

The changes in this pull request enhance the test suite for the IStakingContract by introducing new test cases that validate the contract's behavior in read-only mode. Specifically, tests for staking, unstaking, and moving stakes have been added to ensure that these operations correctly fail when the contract is in read-only mode. Additionally, error handling assertions have been implemented to confirm that appropriate errors are raised under these conditions, thereby improving the robustness of the tests.

Changes

File Path	Change Summary
precompiles/staking/staking_test.go	Added new test cases for `Test_Stake`, `Test_Unstake`, and `Test_MoveStake` to check failures in read-only mode. Enhanced error handling with assertions for correct error messages.

Possibly related PRs

fix: calling precompile through sc with sc state update #2853: Modifies the TestStaking contract and associated files, potentially relating to the newly added test cases for staking operations.
feat: emit events from staking precompile #2861: Introduces event emissions for staking operations, relevant to the main PR's focus on testing staking function behavior.
refactor(precompile): do not execute write functions on staticcall #3001: Refactors the Run method to prevent write operations in read-only mode, directly connecting to the enhancements tested in this PR.

Suggested labels

UPGRADE_TESTS, TSS_MIGRATION_TESTS

Suggested reviewers

swift1337
kingpinXD
ws4charlie
brewmaster012
skosito
lumtis

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.

coderabbitai

Actionable comments posted: 6

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 250b90e and e67bcc9.

📒 Files selected for processing (1)

precompiles/staking/staking_test.go (4 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

precompiles/staking/staking_test.go (1)

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

🔇 Additional comments (1)

precompiles/staking/staking_test.go (1)

26-26: Import statement added appropriately

The import of ptypes is correctly added to handle error types related to precompile methods.

precompiles/staking/staking_test.go

codecov · 2024-10-17T11:26:42Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.29%. Comparing base (250b90e) to head (05610a1).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3017      +/-   ##
===========================================
+ Coverage    66.25%   66.29%   +0.03%     
===========================================
  Files          406      406              
  Lines        22772    22772              
===========================================
+ Hits         15088    15097       +9     
+ Misses        6907     6901       -6     
+ Partials       777      774       -3

see 1 file with indirect coverage changes

precompiles/staking/staking_test.go

test(precompiles): add missing test in staking

e67bcc9

fbac added no-changelog Skip changelog CI check stateful-precompile A new stateful precompile contract that is user facing labels Oct 17, 2024

fbac marked this pull request as ready for review October 17, 2024 10:07

fbac requested review from brewmaster012, kingpinXD, lumtis, skosito, swift1337 and ws4charlie as code owners October 17, 2024 10:07

coderabbitai bot reviewed Oct 17, 2024

View reviewed changes

lumtis approved these changes Oct 17, 2024

View reviewed changes

precompiles/staking/staking_test.go Outdated Show resolved Hide resolved

remove redundant require

05610a1

fbac enabled auto-merge October 17, 2024 11:38

skosito approved these changes Oct 17, 2024

View reviewed changes

fbac added this pull request to the merge queue Oct 17, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 17, 2024

fbac added this pull request to the merge queue Oct 17, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 17, 2024

fbac added this pull request to the merge queue Oct 17, 2024

Merged via the queue into develop with commit 920779b Oct 17, 2024

fbac deleted the test/add-missing-staking-test branch October 17, 2024 12:32

This was referenced Oct 17, 2024

feat: erc20 auth calls #3012

Merged

test: simulation import and export #3033

Merged

coderabbitai bot mentioned this pull request Oct 24, 2024

feat: distribute ZRC20 rewards function #3019

Merged

5 tasks

coderabbitai bot mentioned this pull request Nov 18, 2024

feat: add function to withdraw and check delegator rewards #3088

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test(precompiles): add missing test in staking#3017

test(precompiles): add missing test in staking#3017
fbac merged 2 commits intodevelopfrom
test/add-missing-staking-test

fbac commented Oct 17, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Oct 17, 2024 •

edited

Loading

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Oct 17, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

fbac commented Oct 17, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How Has This Been Tested?

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Oct 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Oct 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

fbac commented Oct 17, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 17, 2024 •

edited

Loading

codecov bot commented Oct 17, 2024 •

edited

Loading