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.

Sign up for GitHub

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

Jump to bottom

[CORE-517] add integration tests for prices governance messages #808

Merged
merged 2 commits into from
Nov 29, 2023
Merged

[CORE-517] add integration tests for prices governance messages #808

merged 2 commits into from
Nov 29, 2023

Conversation

tqin7
Copy link
Contributor

@tqin7 tqin7 commented Nov 27, 2023 •
edited
Loading

Changelist

add integration tests for MsgUpdateMarketParam

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

@linear Linear
Copy link

linear bot commented Nov 27, 2023

CORE-517 [E2E Test] Gov: update param

https://www.notion.so/dydx/Core-Products-Core-User-Flow-Testing-1ab9d2df6f454627bca503406826ce11?pvs=4#adcf31be692c4aef81d8bba8643fcbe8

  • Owner: tian
  • Reviewer: individual module owner

CORE-567 integration tests for governance messages

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 27, 2023 •
edited
Loading

Walkthrough

The changes involve the addition of a new test function TestUpdateMarketParam to ensure the correct functionality of the MsgUpdateMarketParam in the x/prices module. This includes various scenarios to validate successful updates, handling of non-existent or invalid parameters, and authority verification. Additionally, a utility function WithMinPriceChangePpm has been added to the pricestypes package to facilitate setting the minimum price change per million for market parameters during testing.

Changes

File Path Change Summary
.../e2e/gov/prices_test.go Added TestUpdateMarketParam function to test MsgUpdateMarketParam functionality with scenarios for success, failure, and authority checks.
.../testutil/prices/market_param_price.go Introduced WithMinPriceChangePpm function to set MinPriceChangePpm in MarketParamPrice.
Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

coderabbitai[bot]
coderabbitai bot reviewed Nov 27, 2023
View reviewed 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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 37e5119 and 82120e7.
Files selected for processing (2)
  • protocol/testing/e2e/gov/prices_test.go (1 hunks)
  • protocol/testutil/prices/market_param_price.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • protocol/testing/e2e/gov/prices_test.go
Additional comments: 1
protocol/testutil/prices/market_param_price.go (1)
  • 43-47: The new function WithMinPriceChangePpm is implemented correctly and follows the established pattern of the other MarketParamPriceModifierOption functions.

clemire
clemire reviewed Nov 27, 2023
View reviewed changes
protocol/testing/e2e/gov/prices_test.go Outdated
MODIFIED_MARKET_PARAM = pricestypes.MarketParam{
Id: 0,
Pair: "eth-adv4tnt",
Exponent: -8,
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: you can use GENESIS_MARKET_PARAM.Exponent here instead of -8 with a comment that exponents cannot change.

Copy link
Contributor

Choose a reason for hiding this comment

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

... you could also use GENESIS_MARKET_PARAM.Id to populate the Id field.

protocol/testing/e2e/gov/prices_test.go Outdated
msg: &pricestypes.MsgUpdateMarketParam{
Authority: lib.GovModuleAddress.String(),
MarketParam: pricestypes.MarketParam{
Id: GENESIS_MARKET_PARAM.Id,
Copy link
Contributor

Choose a reason for hiding this comment

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

Question: if you are using GENESIS_MARKET_PARAM.Id instead of MODIFIED_MARKET_PARAM.Id here (presumably to show the id doesn't change,) does it also make sense to do the same thing with the exponent field? It seems like the treatment of these two fields is inconsistent.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good call. modified to MODIFIED_MARKET_PARAM.Id to be consistent

coderabbitai[bot]
coderabbitai bot reviewed Nov 28, 2023
View reviewed 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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 82120e7 and 60299da.
Files selected for processing (1)
  • protocol/testing/e2e/gov/prices_test.go (1 hunks)

protocol/testing/e2e/gov/prices_test.go Show resolved Hide resolved
@tqin7 tqin7 merged commit 26938c8 into main Nov 29, 2023
14 of 15 checks passed
@tqin7 tqin7 deleted the tq/core-567-prices branch November 29, 2023 03:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@clemire clemire clemire approved these changes

Assignees
No one assigned
Labels
protocol
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tqin7 @clemire