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(testutil)!: remove cmdtest #22826

Merged
merged 5 commits into from
Dec 11, 2024
Merged

refactor(testutil)!: remove cmdtest #22826

merged 5 commits into from
Dec 11, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Dec 11, 2024

Description

Reduces amount of testing framework. Similar to #22392.
This isn't used by anyone and the alternative is a two liner or using systemtests / intergration tests framework.

(reverts #15251)


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

    • Simulated nested messages in the base application.
    • Introduced a new Linux-only backend for crypto/keyring support.
    • Added support for importing hex keys via standard input.
    • Enhanced version command to return v2 server information.
  • Improvements

    • Upgraded RocksDB libraries to version 9.
    • Simplified testing frameworks by removing unnecessary components.
  • Bug Fixes

    • Resolved issues in simulation tests and command-line interface queries.
  • Documentation

    • Updated CHANGELOG.md to reflect new features, improvements, and bug fixes.

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Dec 11, 2024
@julienrbrt julienrbrt requested review from JulianToledano and a team as code owners December 11, 2024 09:54
Copy link
Contributor

coderabbitai bot commented Dec 11, 2024

Warning

Rate limit exceeded

@julienrbrt has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 2 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 373beb8 and f23b649.

📒 Files selected for processing (6)
  • client/keys/add.go (1 hunks)
  • client/keys/export.go (1 hunks)
  • client/keys/mnemonic.go (1 hunks)
  • client/keys/utils.go (1 hunks)
  • tests/go.mod (1 hunks)
  • version/version_test.go (0 hunks)
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request includes updates to the CHANGELOG.md file, documenting various changes across multiple modules, including new features, improvements, and bug fixes. Key additions are the simulation of nested messages, a new Linux-only backend for the crypto/keyring module, and enhancements to the client for importing hex keys. The RocksDB libraries were upgraded, and the testing framework was simplified by removing certain components. Additionally, several files were modified to improve error handling and output management, while some files related to testing were deleted.

Changes

File Path Change Summary
CHANGELOG.md Updated to include new entries for features, improvements, bug fixes, and API-breaking changes.
client/keys/show.go Modified ShowKeysCmd for output handling and enhanced error messaging in runShowCmd.
tests/integration/genutil/export_test.go Deleted file containing integration tests for the export functionality of the CLI.
testutil/cmdtest/system.go Deleted file providing a framework for testing Cobra commands.
version/command.go Updated NewVersionCommand to use cmd.Println for output handling.
version/version_test.go Removed TestCLI function that validated version command behavior.

Possibly related PRs

Suggested reviewers

  • akhilkumarpilli
  • kocubinski
  • sontrinh16
  • facundomedica

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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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 changed the title refactor!: remove cmdtest refactor(testutil)!: remove cmdtest Dec 11, 2024
Copy link
Contributor

@JulianToledano JulianToledano left a comment

Choose a reason for hiding this comment

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

LGTM!

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: 0

🧹 Outside diff range and nitpick comments (3)
CHANGELOG.md (3)

Line range hint 1-1: Add title to changelog file

The changelog file should start with a clear title like "# Changelog" to follow standard documentation practices.

+ # Changelog

Line range hint 12-15: Improve version header formatting consistency

The version headers should follow a consistent format with release date. Some headers are missing the release date format.

- ## [v0.47.0](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.47.0) - 2023-03-14
+ ## [v0.47.0](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.47.0) - 2023-03-14

Line range hint 2349-2349: Add missing previous versions link

The "Previous Releases" section should include a link to view the full history of changes before v0.40.0.

- [CHANGELOG of previous versions](https://github.com/cosmos/cosmos-sdk/blob/c17c3caab86a1426a1eef4541e8203f5f54a1a54/CHANGELOG.md#v0391---2020-08-11) (pre Stargate).
+ [CHANGELOG of previous versions](https://github.com/cosmos/cosmos-sdk/blob/c17c3caab86a1426a1eef4541e8203f5f54a1a54/CHANGELOG.md) (pre Stargate)
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between aa8266e and 373beb8.

📒 Files selected for processing (6)
  • CHANGELOG.md (1 hunks)
  • client/keys/show.go (1 hunks)
  • tests/integration/genutil/export_test.go (0 hunks)
  • testutil/cmdtest/system.go (0 hunks)
  • version/command.go (2 hunks)
  • version/version_test.go (0 hunks)
💤 Files with no reviewable changes (3)
  • version/version_test.go
  • tests/integration/genutil/export_test.go
  • testutil/cmdtest/system.go
🧰 Additional context used
📓 Path-based instructions (3)
version/command.go (1)

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

client/keys/show.go (1)

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

CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🔇 Additional comments (2)
version/command.go (1)

31-31: LGTM! Consistent simplification of output handling

The changes simplify output handling by using cmd.Println() instead of fmt.Fprintln(cmd.OutOrStdout(), ...). This is a good improvement as it:

  1. Reduces code verbosity
  2. Maintains the same functionality
  3. Uses Cobra's built-in output handling consistently

Also applies to: 56-56

client/keys/show.go (1)

146-146: LGTM! Consistent with codebase-wide output handling improvements

The change to use cmd.Println(out) aligns with similar improvements in other commands (e.g., version command) and:

  1. Maintains compatibility with QR code generation
  2. Preserves the existing functionality
  3. Simplifies the output handling code

Copy link
Contributor

@akhilkumarpilli akhilkumarpilli left a comment

Choose a reason for hiding this comment

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

lgtm

version/version_test.go Show resolved Hide resolved
@julienrbrt julienrbrt added this pull request to the merge queue Dec 11, 2024
Merged via the queue into main with commit 71d2571 Dec 11, 2024
73 of 74 checks passed
@julienrbrt julienrbrt deleted the julien/cmdtest-remove branch December 11, 2024 11:36
mergify bot pushed a commit that referenced this pull request Dec 11, 2024
(cherry picked from commit 71d2571)

# Conflicts:
#	CHANGELOG.md
julienrbrt added a commit that referenced this pull request Dec 11, 2024
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:CLI C:Keys Keybase, KMS and HSMs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants