feat(version): Add extraInfo to version cmd (#18063)

Co-authored-by: Marko <marbar3778@yahoo.com>
This commit is contained in:
samricotta 2023-10-30 23:34:20 +02:00 committed by GitHub
parent 5dae7d84e6
commit 88b76664cd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 45 additions and 3 deletions

View File

@ -67,6 +67,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
* (rpc) [#17470](https://github.com/cosmos/cosmos-sdk/pull/17470) Avoid open 0.0.0.0 to public by default and add `listen-ip-address` argument for `testnet init-files` cmd.
* (types) [#17670](https://github.com/cosmos/cosmos-sdk/pull/17670) Use `ctx.CometInfo` in place of `ctx.VoteInfos`
* [#17733](https://github.com/cosmos/cosmos-sdk/pull/17733) Ensure `buf export` exports all proto dependencies
* (version) [#18063](https://github.com/cosmos/cosmos-sdk/pull/18063) Include additional information in the Info struct. This change enhances the Info struct by adding support for additional information through the ExtraInfo field
* [#18204](https://github.com/cosmos/cosmos-sdk/pull/18204) Use streaming json parser to parse chain-id from genesis file.
### Bug Fixes

View File

@ -15,6 +15,11 @@ const (
)
// NewVersionCommand returns a CLI command to interactively print the application binary version information.
// Note: When seeking to add the extra info to the context
// The below can be added to the initRootCmd to include the extraInfo field
//
// cmdContext := context.WithValue(context.Background(), version.ContextKey{}, extraInfo)
// rootCmd.SetContext(cmdContext)
func NewVersionCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "version",
@ -28,6 +33,10 @@ func NewVersionCommand() *cobra.Command {
return nil
}
// Extract and set extra information from the context
extraInfo := extraInfoFromContext(cmd)
verInfo.ExtraInfo = &extraInfo
var (
bz []byte
err error
@ -56,3 +65,14 @@ func NewVersionCommand() *cobra.Command {
return cmd
}
func extraInfoFromContext(cmd *cobra.Command) ExtraInfo {
ctx := cmd.Context()
if ctx != nil {
extraInfo, ok := ctx.Value(ContextKey{}).(ExtraInfo)
if ok {
return extraInfo
}
}
return nil
}

View File

@ -23,6 +23,9 @@ import (
"runtime/debug"
)
// ContextKey is used to store the ExtraInfo in the context.
type ContextKey struct{}
var (
// application's name
Name = ""
@ -55,6 +58,9 @@ func getSDKVersion() string {
return sdkVersion
}
// ExtraInfo contains a set of extra information provided by apps
type ExtraInfo map[string]string
// Info defines the application version information.
type Info struct {
Name string `json:"name" yaml:"name"`
@ -65,6 +71,7 @@ type Info struct {
GoVersion string `json:"go" yaml:"go"`
BuildDeps []buildDep `json:"build_deps" yaml:"build_deps"`
CosmosSdkVersion string `json:"cosmos_sdk_version" yaml:"cosmos_sdk_version"`
ExtraInfo *ExtraInfo `json:"extra_info" yaml:"extra_info"`
}
func NewInfo() Info {

View File

@ -1,13 +1,13 @@
package version_test
import (
context "context"
"encoding/json"
"fmt"
"runtime"
"strings"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/cosmos/cosmos-sdk/client/flags"
@ -149,7 +149,7 @@ func Test_runVersionCmd(t *testing.T) {
})
require.NoError(t, cmd.Execute())
assert.Equal(t, "\n", mockOut.String())
require.Equal(t, "\n", mockOut.String())
mockOut.Reset()
cmd.SetArgs([]string{
@ -158,7 +158,21 @@ func Test_runVersionCmd(t *testing.T) {
info := version.NewInfo()
stringInfo, err := json.Marshal(info)
extraInfo := &version.ExtraInfo{"key1": "value1"}
ctx := context.WithValue(context.Background(), version.ContextKey{}, extraInfo)
require.NoError(t, err)
require.NoError(t, cmd.Execute())
assert.Equal(t, string(stringInfo)+"\n", mockOut.String())
extraInfoFromContext := ctx.Value(version.ContextKey{})
require.NotNil(t, extraInfoFromContext)
castedExtraInfo, ok := extraInfoFromContext.(*version.ExtraInfo)
require.True(t, ok)
key1Value := (*castedExtraInfo)["key1"]
require.Equal(t, "value1", key1Value)
require.Equal(t, string(stringInfo)+"\n", mockOut.String())
}