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: add x/circuit system tests #22331

Merged
merged 4 commits into from
Oct 24, 2024
Merged

test: add x/circuit system tests #22331

merged 4 commits into from
Oct 24, 2024

Conversation

akhilkumarpilli
Copy link
Contributor

@akhilkumarpilli akhilkumarpilli commented Oct 22, 2024

Description

Closes: #22301


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, you can find examples of the prefixes below:
  • 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

    • Introduced comprehensive system tests for circuit commands, validating governance and permission functionalities.
    • Added tests for authorizing different addresses with varying permission levels and handling transaction requests.
  • Bug Fixes

    • Corrected formatting in the Example field of the AuthorizeCircuitBreaker method to prevent parsing issues.

@akhilkumarpilli akhilkumarpilli changed the title test: add x/circuit systemtests test: add x/circuit system tests Oct 22, 2024
@akhilkumarpilli akhilkumarpilli marked this pull request as ready for review October 22, 2024 10:55
Copy link
Contributor

coderabbitai bot commented Oct 22, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes introduce a new system test file, circuit_test.go, which validates the functionality of circuit commands in a blockchain context. It includes tests for governance and permissions, ensuring correct operation of commands via a CLI wrapper. Additionally, modifications to the Example field of the RpcCommandOptions in x/circuit/autocli.go correct a formatting issue in a JSON string. The tests cover various scenarios, including governance proposal submissions and permission authorizations.

Changes

File Change Summary
tests/systemtests/circuit_test.go Introduced comprehensive system tests for circuit commands, including governance proposals and permissions. Functions added: TestCircuitCommands and testCircuitTxCommand.
x/circuit/autocli.go Modified the Example field of RpcCommandOptions for AuthorizeCircuitBreaker to correct JSON formatting.

Possibly related PRs

Suggested labels

Type: CI

Suggested reviewers

  • kocubinski
  • sontrinh16
  • julienrbrt
  • tac0turtle

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 228fb8c and 7473e10.

📒 Files selected for processing (1)
  • tests/systemtests/circuit_test.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
tests/systemtests/circuit_test.go (3)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

🔇 Additional comments (2)
tests/systemtests/circuit_test.go (2)

18-158: Comprehensive testing of circuit breaker commands

The TestCircuitCommands function provides thorough and well-structured tests for circuit breaker functionalities, including proposal submission, voting processes, and permission assignments. The use of subtests with t.Run enhances readability and maintainability.


160-243: Effective testing of transaction commands

The testCircuitTxCommand helper function efficiently tests the disable and reset transaction commands across multiple scenarios. The test cases are comprehensive, and the iterative approach improves code reusability and clarity.


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.

@akhilkumarpilli akhilkumarpilli requested review from alpe, tac0turtle and julienrbrt and removed request for kocubinski and raynaudoe October 22, 2024 10:55
@akhilkumarpilli akhilkumarpilli added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Oct 22, 2024
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: 6

🧹 Outside diff range and nitpick comments (2)
tests/systemtests/circuit_test.go (2)

28-32: Check for empty validator addresses before proceeding.

While require.NotEmpty(t, superAdmin) ensures the addresses are not empty, consider adding explicit error messages for clearer debugging if the test fails.

Enhance the require statements with custom error messages:

-	require.NotEmpty(t, superAdmin)
+	require.NotEmpty(t, superAdmin, "superAdmin address should not be empty")
-	require.NotEmpty(t, superAdmin2)
+	require.NotEmpty(t, superAdmin2, "superAdmin2 address should not be empty")

131-134: Simplify permission JSON construction to avoid redundancy.

The construction of permissionJSON can be streamlined for better readability.

Refactor the code as follows:

permission := map[string]interface{}{
  "level": tc.level,
}
if len(tc.limitTypeURLs) != 0 {
  permission["limit_type_urls"] = tc.limitTypeURLs
} else {
  permission["limit_type_urls"] = []string{}
}
permissionJSONBytes, err := json.Marshal(permission)
require.NoError(t, err)
permissionJSON := string(permissionJSONBytes)

This ensures proper JSON formatting and handles empty slices correctly.

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3e65a61 and 228fb8c.

📒 Files selected for processing (2)
  • tests/systemtests/circuit_test.go (1 hunks)
  • x/circuit/autocli.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
tests/systemtests/circuit_test.go (3)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

x/circuit/autocli.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

🔇 Additional comments (2)
x/circuit/autocli.go (1)

46-46: Approve: Corrected JSON string formatting in example

The change correctly fixes the formatting of the JSON string in the Example field. This is important because:

  1. It resolves a potential parsing issue that could occur with the previous incorrect string concatenation.
  2. It provides a valid example for users of the authorize command, which is crucial for proper usage.
  3. It aligns with the expected format for the permissions parameter.

The modification adheres to the Uber Golang style guide and improves the overall quality of the documentation.

tests/systemtests/circuit_test.go (1)

86-90: Verify that proposal votes are successfully included in blocks.

Ensure that the voting transactions are included in blocks and not only accepted by the CLI.

Run the following script to confirm that the votes are committed:

This script queries the blocks to confirm that the vote transactions were successfully included.

tests/systemtests/circuit_test.go Outdated Show resolved Hide resolved
tests/systemtests/circuit_test.go Show resolved Hide resolved
tests/systemtests/circuit_test.go Show resolved Hide resolved
tests/systemtests/circuit_test.go Outdated Show resolved Hide resolved
tests/systemtests/circuit_test.go Outdated Show resolved Hide resolved
tests/systemtests/circuit_test.go Outdated Show resolved Hide resolved
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

lgtm! @coderabbitai comments look like a valid improvements btw.

@julienrbrt julienrbrt added this pull request to the merge queue Oct 24, 2024
Merged via the queue into main with commit 33e3231 Oct 24, 2024
76 of 77 checks passed
@julienrbrt julienrbrt deleted the akhil/circuit-system-tests branch October 24, 2024 09:35
mergify bot pushed a commit that referenced this pull request Oct 24, 2024
julienrbrt pushed a commit that referenced this pull request Oct 24, 2024
alpe added a commit that referenced this pull request Oct 25, 2024
* main: (157 commits)
  feat(core): add ConfigMap type (#22361)
  test: migrate e2e/genutil to systemtest (#22325)
  feat(accounts): re-introduce bundler (#21562)
  feat(log): add slog-backed Logger type (#22347)
  fix(x/tx): add feePayer as signer (#22311)
  test: migrate e2e/baseapp to integration tests (#22357)
  test: add x/circuit system tests (#22331)
  test: migrate e2e/tx tests to systemtest (#22152)
  refactor(simdv2): allow non-comet server components (#22351)
  build(deps): Bump rtCamp/action-slack-notify from 2.3.1 to 2.3.2 (#22352)
  fix(server/v2): respect context cancellation in start command (#22346)
  chore(simdv2): allow overriding the --home flag (#22348)
  feat(server/v2): add SimulateWithState to AppManager (#22335)
  docs(x/accounts): improve comments (#22339)
  chore: remove unused local variables (#22340)
  test: x/accounts systemtests (#22320)
  chore(client): use command's configured output (#22334)
  perf(log): use sonic json lib  (#22233)
  build(deps): bump x/tx (#22327)
  fix(x/accounts/lockup): fix proto path (#22319)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:x/circuit
Projects
None yet
Development

Successfully merging this pull request may close these issues.

System tests for circuit
6 participants