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(client): check name validation for keys add|import|rename #18950

Merged
merged 8 commits into from
Jan 8, 2024

Conversation

levisyin
Copy link
Contributor

@levisyin levisyin commented Jan 5, 2024

Motivation

When I set the $name variable by mistake, and after running keys add $name command, it created a key with the empty name.

This looks odd when I ran keys list to check the created key, see the screenshot below. I'm confused about the name, is it empty or just the "" itself.
image

Also, an unnormal name isn't friendly to keys delete, keys show, and keys export subcommand.

So I think we should prevent from creating a key with an unnormal name

@levisyin levisyin requested a review from a team as a code owner January 5, 2024 03:18
Copy link
Contributor

coderabbitai bot commented Jan 5, 2024

Walkthrough

The recent changes involve enhancing the validation of user input for key management operations within a CLI application. Specifically, the updates ensure that the "name" variable for keys is not empty after any leading or trailing whitespace is removed. This validation has been added to the addition and import commands, and error handling has been implemented for renaming keys, particularly for private keys stored on a ledger device. The associated tests have been updated to cover these new validation scenarios.

Changes

Files Change Summary
client/keys/add.go, client/keys/import.go Added strings import and validation for trimmed "name" variable.
client/keys/add_test.go, client/keys/import_test.go Updated and added tests for empty name validation in key addition and import commands.
client/keys/rename.go, client/keys/rename_test.go Implemented error handling for empty new names in key renaming and updated tests to check for proper handling of empty new names.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@levisyin levisyin changed the title refactor: check name validation for keys add|import|rename refactor(client/keys): check name validation for keys add|import|rename Jan 5, 2024
@github-actions github-actions bot added C:CLI C:Keys Keybase, KMS and HSMs labels Jan 5, 2024
@coderabbitai coderabbitai bot changed the title refactor(client/keys): check name validation for keys add|import|rename refactor: check name validation for keys add|import|rename Jan 5, 2024
client/keys/add.go Outdated Show resolved Hide resolved
client/keys/rename.go Outdated Show resolved Hide resolved
client/keys/import.go Outdated Show resolved Hide resolved
@julienrbrt julienrbrt changed the title refactor: check name validation for keys add|import|rename refactor(client): check name validation for keys add|import|rename Jan 5, 2024
client/keys/add.go Outdated Show resolved Hide resolved
@levisyin
Copy link
Contributor Author

levisyin commented Jan 6, 2024

@julienrbrt Hi sir, suggestion changes addressed

@julienrbrt
Copy link
Member

@julienrbrt Hi sir, suggestion changes addressed

Awesome, can we get a changelog?

@levisyin
Copy link
Contributor Author

levisyin commented Jan 6, 2024

@julienrbrt Hi sir, suggestion changes addressed

Awesome, can we get a changelog?

Done 😀

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, ty!

Copy link
Contributor

@likhita-809 likhita-809 left a comment

Choose a reason for hiding this comment

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

utACK

@julienrbrt julienrbrt added this pull request to the merge queue Jan 8, 2024
Merged via the queue into cosmos:main with commit c307001 Jan 8, 2024
48 of 55 checks passed
@levisyin levisyin deleted the refactor/check-name-valid branch January 8, 2024 12:51
relyt29 pushed a commit to relyt29/cosmos-sdk that referenced this pull request Jan 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:CLI C:Keys Keybase, KMS and HSMs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants