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

refactor(systemtest): Add cli.RunAndWait for common operations #21689

Merged
merged 3 commits into from
Sep 13, 2024
Merged

refactor(systemtest): Add cli.RunAndWait for common operations #21689

merged 3 commits into from
Sep 13, 2024

Conversation

alpe
Copy link
Contributor

@alpe alpe commented Sep 12, 2024 •
edited by coderabbitai bot
Loading

Description

Add new helper method to systemtest cli wrapper to make system tests more stable

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 a streamlined method for executing CLI commands that combines execution and confirmation into a single step, enhancing efficiency.

  • Bug Fixes

    • Improved reliability of staking transaction tests by ensuring commands wait for completion before proceeding, reducing potential timing issues.

@alpe alpe requested a review from a team as a code owner September 12, 2024 13:59
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 12, 2024 •
edited
Loading

Walkthrough

Walkthrough

The changes involve the introduction of a new method, RunAndWait, in the CLIWrapper struct, which streamlines the execution of CLI commands by combining command execution and transaction confirmation into a single step. This method is utilized in various test files, notably account_test.go and staking_test.go, replacing previous methods that required separate execution and confirmation handling. The modifications aim to enhance code readability and reliability in transaction handling across the test suite.

Changes

File Path Change Summary
tests/systemtests/account_test.go Updated TestAccountCreation to use cli.RunAndWait for transaction execution and confirmation, simplifying the code while preserving assertions for transaction success.
tests/systemtests/cli.go Introduced RunAndWait method in CLIWrapper, which executes a CLI command and waits for the transaction result, enhancing functionality and clarity with added comments.
tests/systemtests/staking_test.go Modified staking transaction calls to use cli.RunAndWait, ensuring that the tests wait for transaction completion, thereby improving test reliability and reducing potential timing issues.

Possibly related PRs

  • refactor(store/v2): human readable ss/sc types #21645: The changes in staking_test.go involve replacing cli.Run with cli.RunAndWait, which directly relates to the new RunAndWait method introduced in cli.go in the main PR, indicating a shared focus on improving transaction execution handling.

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

julienrbrt
julienrbrt approved these changes Sep 13, 2024
View reviewed changes
Copy link
Member

@julienrbrt julienrbrt left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Nice addition 👍🏾

@julienrbrt
Copy link
Member

You should merge main to fix the linting errors

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Sep 13, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Sep 13, 2024
Merged via the queue into main with commit 81c9172 Sep 13, 2024
71 checks passed
@julienrbrt julienrbrt deleted the alex/systemtest_fix branch September 13, 2024 12:13
mergify bot pushed a commit that referenced this pull request Sep 13, 2024
@alpe @mergify
refactor(systemtest): Add cli.RunAndWait for common operations (#21689)
15cf849 
(cherry picked from commit 81c9172)
@mergify mergify bot mentioned this pull request Sep 13, 2024
Merged
12 tasks
julienrbrt pushed a commit that referenced this pull request Sep 13, 2024
@mergify @alpe
refactor(systemtest): Add cli.RunAndWait for common operations (backp…
ff7faf5 
…ort #21689) (#21713)

Co-authored-by: Alexander Peters <alpe@users.noreply.github.com>
alpe added a commit that referenced this pull request Sep 16, 2024
@alpe
Merge branch 'main' into alex/sims2_main
1ff734d 
* main:
  test: fix sims (#21735)
  build: bump proto-builder (#21730)
  refactor(schema)!: rename IntegerStringKind and DecimalStringKind (#21694)
  feat(types/collections): add `LegacyDec` collection value (#21693)
  refactor(server): alias AppOptions to coreserver.DynamicConfig (#21711)
  refactor(simapp): simplify simapp di (#21718)
  feat: replace the cosmos-db usecases in the tests with `core/testing` (#21525)
  feat(runtime/v2): store loader on simappv2 (#21704)
  docs(x/auth): vesting (#21715)
  build(deps): Bump google.golang.org/grpc from 1.66.1 to 1.66.2 (#21670)
  refactor(systemtest): Add cli.RunAndWait for common operations (#21689)
  fix(runtime/v2): provide default factory options if unset in app builder (#21690)
  chore: remove duplicate proto files for the same proto file (#21648)
  feat(x/genutil): add better error messages for genesis validation (#21701)
  build(deps): Bump cosmossdk.io/core from 1.0.0-alpha.1 to 1.0.0-alpha.2 (#21698)
  test: migrate e2e/bank to system tests (#21607)
  chore: fix the gci lint issue in testutil (#21695)
  docs(x/authz): update grant docs (#21677)
This was referenced Sep 16, 2024
Open
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@julienrbrt julienrbrt julienrbrt approved these changes

@sontrinh16 sontrinh16 sontrinh16 approved these changes

Assignees

@julienrbrt julienrbrt

@sontrinh16 sontrinh16

Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@alpe @julienrbrt @sontrinh16