[keytool] use a table format output and add json output support #13196
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
amnn
approved these changes
Jul 28, 2023
There was a problem hiding this comment.
PR content looks good, thanks @stefan-mysten!
On release notes, have a read of the release note guidelines I sent to redraft them. Include all the things that changed (the table and JSON formats, and dropping the encoding commands), with a brief explanation of how to use them (e.g. that table format is default, and JSON format is activated with --json), and if migration is required, a brief explanation of that as well (e.g. what to replace the hex conversion tools with).
Then, before landing, make sure @randall-Mysten or @ronny-mysten have had a chance to review the release notes as well.
ebmifa
pushed a commit
that referenced
this pull request
Aug 10, 2023
## Description Revamp the keytool CLI command to pretty print output as formatted tables and add support for json output. This is the first experimental step to gain feedback before moving to other CLI commands. The PR also removes seven commands that should not be part of the CLI and were OK'ed by @siomari and @ammn to be removed: * Base64PubKeyToAddress * BytesToBase64 * Base64ToBytes * Base64ToHex * BytesToHex * HexToBase64 * HexToBytes ## Test Plan Executed the existing tests. --- If your changes are not user-facing and not a breaking change, you can skip the following section. Otherwise, please indicate what changed, and then add to the Release Notes section as highlighted during the release process. ### Type of Change (Check all that apply) - [ ] protocol change - [x] user-visible impact - [ ] breaking change for a client SDKs - [ ] breaking change for FNs (FN binary must upgrade) - [ ] breaking change for validators or node operators (must upgrade binaries) - [ ] breaking change for on-chain data layout - [ ] necessitate either a data wipe or data migration ### Release notes This PR modifies the `CLI keytool` as follows: * Adds support for `json` output. Use the `--json` flag when invoking any `keytool` command (such as `keytool list --json`). * Changes the default output to the terminal to formatted tables with headers to improve consistency across different commands. Use `--json` if you need to parse/pipe output data. * Removes the following seven commands, which you can replace by calls to the `base64` and `xxd` utilities: ``` Base64PubKeyToAddress BytesToBase64 Base64ToBytes Base64ToHex -> input | base64 -d | xxd -p BytesToHex HexToBase64 -> input | xxd -r -p | base64 HexToBytes ```
amnn
pushed a commit
that referenced
this pull request
Aug 11, 2023
…upport (#13196) Revamp the keytool CLI command to pretty print output as formatted tables and add support for json output. This is the first experimental step to gain feedback before moving to other CLI commands. The PR also removes seven commands that should not be part of the CLI and were OK'ed by @siomari and @ammn to be removed: * Base64PubKeyToAddress * BytesToBase64 * Base64ToBytes * Base64ToHex * BytesToHex * HexToBase64 * HexToBytes Executed the existing tests. --- If your changes are not user-facing and not a breaking change, you can skip the following section. Otherwise, please indicate what changed, and then add to the Release Notes section as highlighted during the release process. - [ ] protocol change - [x] user-visible impact - [ ] breaking change for a client SDKs - [ ] breaking change for FNs (FN binary must upgrade) - [ ] breaking change for validators or node operators (must upgrade binaries) - [ ] breaking change for on-chain data layout - [ ] necessitate either a data wipe or data migration This PR modifies the `CLI keytool` as follows: * Adds support for `json` output. Use the `--json` flag when invoking any `keytool` command (such as `keytool list --json`). * Changes the default output to the terminal to formatted tables with headers to improve consistency across different commands. Use `--json` if you need to parse/pipe output data. * Removes the following seven commands, which you can replace by calls to the `base64` and `xxd` utilities: ``` Base64PubKeyToAddress BytesToBase64 Base64ToBytes Base64ToHex -> input | base64 -d | xxd -p BytesToHex HexToBase64 -> input | xxd -r -p | base64 HexToBytes ```
7 tasks
amnn
added a commit
that referenced
this pull request
Aug 12, 2023
…upport (#13374) ## Description Original PR: #13196 Revamp the keytool CLI command to pretty print output as formatted tables and add support for json output. This is the first experimental step to gain feedback before moving to other CLI commands. The PR also removes seven commands that should not be part of the CLI and were OK'ed by @siomari and @ammn to be removed: * Base64PubKeyToAddress * BytesToBase64 * Base64ToBytes * Base64ToHex * BytesToHex * HexToBase64 * HexToBytes ## Test Plan Executed the existing tests. --- If your changes are not user-facing and not a breaking change, you can skip the following section. Otherwise, please indicate what changed, and then add to the Release Notes section as highlighted during the release process. ### Type of Change (Check all that apply) - [ ] protocol change - [x] user-visible impact - [ ] breaking change for a client SDKs - [ ] breaking change for FNs (FN binary must upgrade) - [ ] breaking change for validators or node operators (must upgrade binaries) - [ ] breaking change for on-chain data layout - [ ] necessitate either a data wipe or data migration ### Release notes This PR modifies the `CLI keytool` as follows: * Adds support for `json` output. Use the `--json` flag when invoking any `keytool` command (such as `keytool list --json`). * Changes the default output to the terminal to formatted tables with headers to improve consistency across different commands. Use `--json` if you need to parse/pipe output data. * Removes the following seven commands, which you can replace by calls to the `base64` and `xxd` utilities: ``` Base64PubKeyToAddress BytesToBase64 Base64ToBytes Base64ToHex -> input | base64 -d | xxd -p BytesToHex HexToBase64 -> input | xxd -r -p | base64 HexToBytes ``` --------- Co-authored-by: stefan-mysten <135084671+stefan-mysten@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Revamp the keytool CLI command to pretty print output as formatted tables and add support for json output. This is the first experimental step to gain feedback before moving to other CLI commands.
The PR also removes seven commands that should not be part of the CLI and were OK'ed by @siomari and @ammn to be removed:
Test Plan
Executed the existing tests.
If your changes are not user-facing and not a breaking change, you can skip the following section. Otherwise, please indicate what changed, and then add to the Release Notes section as highlighted during the release process.
Type of Change (Check all that apply)
Release notes
This PR modifies the
CLI keytoolas follows:jsonoutput. Use the--jsonflag when invoking anykeytoolcommand (such askeytool list --json).--jsonif you need to parse/pipe output data.base64andxxdutilities: