feat(version): update version command to return v2 info #22807
Conversation
aljo242
requested review from
julienrbrt,
JulianToledano and
a team
as code owners
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces several enhancements across multiple files, primarily focusing on the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
| repeated Module build_deps = 7; | ||
| string cosmos_sdk_version = 8 [(cosmos_proto.field_added_in) = "cosmos-sdk 0.43"]; | ||
| string comet_server_version = 9 [(cosmos_proto.field_added_in) = "cosmos-sdk 2.0"]; | ||
| string runtime_version = 10 [(cosmos_proto.field_added_in) = "cosmos-sdk 2.0"]; |
There was a problem hiding this comment.
Is this the proper version to be adding as an annotation here? not sure
There was a problem hiding this comment.
It should be cosmos-sdk 0.52, as this is part of the cosmos/cosmos-sdk go.mod
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (7)
api/cosmos/base/tendermint/v1beta1/query.pulsar.go (1)
11731-11743: Consider adding version format validationThe version fields are currently stored as plain strings. Consider adding validation to ensure they follow semantic versioning format or your project's version format conventions.
Example validation implementation:
+func validateVersion(version string) error { + // Add your version format validation logic here + if !regexp.MatchString(`^v?\d+\.\d+\.\d+`, version) { + return fmt.Errorf("invalid version format: %s", version) + } + return nil +}version/build_test.go (1)
119-119: Format code withgofumptfor consistencyThe file is not formatted according to
gofumptstandards. Please rungofumpt -w -extra build_test.goto ensure consistent code formatting across the project.This helps maintain code readability and adherence to the project's style guidelines.
🧰 Tools
🪛 golangci-lint (1.62.2)
119-119: File is not
gofumpt-ed with-extra(gofumpt)
version/version_test.go (1)
15-15: Organize imports usinggcifor proper import groupingThe import statements are not ordered according to the project's conventions. Please use
gciwith the provided configuration to reorder the imports:gci write --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order version_test.goThis ensures consistency in how imports are organized throughout the codebase.
🧰 Tools
🪛 golangci-lint (1.62.2)
15-15: File is not
gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order(gci)
client/grpc/cmtservice/service.go (1)
230-240: LGTM! Consider adding documentation and validation.The implementation correctly adds the new version fields as per the PR objectives. However, consider these improvements:
- Add field documentation to explain the purpose and format of the new version fields:
ApplicationVersion: &VersionInfo{ + // AppName is the application name AppName: nodeInfo.AppName, + // RuntimeVersion represents the version of the runtime/v2 dependency RuntimeVersion: nodeInfo.RuntimeVersion, + // CometServerVersion represents the version of server/v2/cometbft CometServerVersion: nodeInfo.CometServerVersion, + // StfVersion represents the version of the stf dependency StfVersion: nodeInfo.StfVersion, // ... other fields }
- Consider adding validation or default values for the new version fields:
ApplicationVersion: &VersionInfo{ // ... other fields - RuntimeVersion: nodeInfo.RuntimeVersion, - CometServerVersion: nodeInfo.CometServerVersion, - StfVersion: nodeInfo.StfVersion, + RuntimeVersion: getVersionOrDefault(nodeInfo.RuntimeVersion), + CometServerVersion: getVersionOrDefault(nodeInfo.CometServerVersion), + StfVersion: getVersionOrDefault(nodeInfo.StfVersion), }Add this helper function:
// getVersionOrDefault returns the version if non-empty or "not available" func getVersionOrDefault(version string) string { if version == "" { return "not available" } return version }CHANGELOG.md (3)
48-48: Fix inconsistent formatting in changelog entryThe changelog entry for client improvements is not properly indented and aligned with other entries in the same section.
-* (client) [#22807](https://github.com/cosmos/cosmos-sdk/pull/22807) Return v2 server information in the `version` command. +* (client) [#22807](https://github.com/cosmos/cosmos-sdk/pull/22807) Return v2 server information in the `version` command.
Line range hint
785-786: Improve clarity of breaking change descriptionThe description of the breaking change is unclear and could be expanded to better explain the impact.
-* (x/auth) [#13780](https://github.com/cosmos/cosmos-sdk/pull/13780) `id` (type of int64) in `AccountAddressByID` grpc query is now deprecated, update to account-id(type of uint64) to use `AccountAddressByID`. +* (x/auth) [#13780](https://github.com/cosmos/cosmos-sdk/pull/13780) The `id` field (type int64) in `AccountAddressByID` gRPC query is now deprecated. Use account-id (type uint64) instead when calling `AccountAddressByID`.
Line range hint
1401-1404: Fix bullet point formatting inconsistencyThe bullet points under logging improvements are not consistently formatted.
-_ Use [zerolog](https://github.com/rs/zerolog) over Tendermint's go-kit logging wrapper. -_ Introduce Tendermint's `--log_format=plain|json` flag. Using format `json` allows for emitting structured JSON -logs which can be consumed by an external logging facility (e.g. Loggly). Both formats log to STDERR. \* The existing `--log_level` flag and it's default value now solely relates to the global logging -level (e.g. `info`, `debug`, etc...) instead of `<module>:<level>`. +* Use [zerolog](https://github.com/rs/zerolog) over Tendermint's go-kit logging wrapper. +* Introduce Tendermint's `--log_format=plain|json` flag. Using format `json` allows for emitting structured JSON + logs which can be consumed by an external logging facility (e.g. Loggly). Both formats log to STDERR. +* The existing `--log_level` flag and its default value now solely relates to the global logging + level (e.g. `info`, `debug`, etc...) instead of `<module>:<level>`.
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
⛔ Files ignored due to path filters (1)
client/grpc/cmtservice/query.pb.gois excluded by!**/*.pb.go
📒 Files selected for processing (7)
CHANGELOG.md(1 hunks)api/cosmos/base/tendermint/v1beta1/query.pulsar.go(16 hunks)client/grpc/cmtservice/service.go(1 hunks)proto/cosmos/base/tendermint/v1beta1/query.proto(1 hunks)version/build_test.go(1 hunks)version/version.go(2 hunks)version/version_test.go(2 hunks)
🔥 Files not summarized due to errors (1)
- api/cosmos/base/tendermint/v1beta1/query.pulsar.go: Error: Server error: no LLM provider could handle the message
🧰 Additional context used
📓 Path-based instructions (6)
api/cosmos/base/tendermint/v1beta1/query.pulsar.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
version/version_test.go (2)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"
version/build_test.go (2)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"
client/grpc/cmtservice/service.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
version/version.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"
🪛 golangci-lint (1.62.2)
version/version_test.go
15-15: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order
(gci)
version/build_test.go
119-119: File is not gofumpt-ed with -extra
(gofumpt)
🔇 Additional comments (11)
api/cosmos/base/tendermint/v1beta1/query.pulsar.go (4)
6413-6424: LGTM: Field descriptors properly defined
The new field descriptors for version information are correctly defined following the existing pattern.
6438-6440: LGTM: Field initialization is correct
The new version fields are properly initialized in the init() function, maintaining consistency with existing field initialization patterns.
11242-11261: LGTM: Getter methods properly implemented
The getter methods for the new version fields are correctly implemented with proper null checks and default values.
11153-11163: Consider version compatibility implications
The new version fields (comet_server_version, runtime_version, stf_version) are annotated with cosmos-sdk 2.0 constraints. Ensure that this version requirement is documented and that proper fallback behavior exists for older versions.
version/version.go (4)
42-47: Definition of sdkBuildInfo struct is appropriate
The new sdkBuildInfo struct effectively encapsulates the SDK and related version information needed for enhanced version reporting.
49-65: Implementation of getSDKBuildInfo function correctly extracts version information
The getSDKBuildInfo function accurately parses the build dependencies to retrieve the required version details for each component.
67-72: extractVersionFromBuildInfo handles module replacements properly
The function accounts for module replacements, ensuring that the correct version is returned, whether or not a replacement is in place.
80-91: Addition of new fields to Info struct enriches version data
Including RuntimeVersion, StfVersion, and CometServerVersion in the Info struct enhances the granularity of version information available to users.
version/build_test.go (1)
1-166: Unit tests provide adequate coverage for new functionality
The tests in build_test.go effectively cover the new functions getSDKBuildInfo, extractVersionFromBuildInfo, and depsFromBuildInfo, ensuring they behave as expected under various scenarios.
🧰 Tools
🪛 golangci-lint (1.62.2)
119-119: File is not gofumpt-ed with -extra
(gofumpt)
version/version_test.go (1)
88-93: Update test cases to reflect changes in Info struct
The addition of CosmosSdkVersion in the Info struct necessitates updating the expected values in the test cases to ensure accurate validation.
The test adjustments correctly account for the new field, maintaining the integrity of the unit tests.
proto/cosmos/base/tendermint/v1beta1/query.proto (1)
155-157: Verify the field_added_in annotations for accuracy
Please confirm that the [(cosmos_proto.field_added_in) = "cosmos-sdk 2.0"] annotations for the fields comet_server_version, runtime_version, and stf_version correctly reflect the version in which these fields are added. Is "cosmos-sdk 2.0" the appropriate version identifier?
This ensures that documentation and tooling relying on these annotations are accurate.
version/version.go
Outdated
| info := Info{ | ||
| Name: Name, | ||
| AppName: AppName, | ||
| Version: Version, | ||
| GitCommit: Commit, | ||
| BuildTags: BuildTags, | ||
| GoVersion: fmt.Sprintf("go version %s %s/%s", runtime.Version(), runtime.GOOS, runtime.GOARCH), | ||
| BuildDeps: depsFromBuildInfo(), | ||
| CosmosSdkVersion: sdkVersion, | ||
| CosmosSdkVersion: "unable to read deps", | ||
| } | ||
|
|
||
| // use debug info more granular build info if available | ||
| debugBuildInfo, ok := debug.ReadBuildInfo() | ||
| if ok { | ||
| info.BuildDeps = depsFromBuildInfo(debugBuildInfo) | ||
| sdkBuildInfo := getSDKBuildInfo(debugBuildInfo) | ||
| info.CometServerVersion = sdkBuildInfo.sdkVersion | ||
| info.RuntimeVersion = sdkBuildInfo.runtimeVersion | ||
| info.StfVersion = sdkBuildInfo.stfVersion | ||
| info.CometServerVersion = sdkBuildInfo.cometServerVersion | ||
| } | ||
|
|
||
| return info |
There was a problem hiding this comment.
Incorrect assignments in NewInfo() function
There is an error in the NewInfo() function where info.CometServerVersion is assigned the value of sdkBuildInfo.sdkVersion instead of sdkBuildInfo.cometServerVersion. Additionally, info.CosmosSdkVersion is not updated with the actual SDK version from the build info.
Apply the following diff to correct the assignments:
if ok {
info.BuildDeps = depsFromBuildInfo(debugBuildInfo)
sdkBuildInfo := getSDKBuildInfo(debugBuildInfo)
- info.CometServerVersion = sdkBuildInfo.sdkVersion
+ info.CosmosSdkVersion = sdkBuildInfo.sdkVersion
info.RuntimeVersion = sdkBuildInfo.runtimeVersion
info.StfVersion = sdkBuildInfo.stfVersion
info.CometServerVersion = sdkBuildInfo.cometServerVersion
}This ensures that info.CosmosSdkVersion correctly reflects the SDK version, and info.CometServerVersion is assigned the appropriate value.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| info := Info{ | |
| Name: Name, | |
| AppName: AppName, | |
| Version: Version, | |
| GitCommit: Commit, | |
| BuildTags: BuildTags, | |
| GoVersion: fmt.Sprintf("go version %s %s/%s", runtime.Version(), runtime.GOOS, runtime.GOARCH), | |
| BuildDeps: depsFromBuildInfo(), | |
| CosmosSdkVersion: sdkVersion, | |
| CosmosSdkVersion: "unable to read deps", | |
| } | |
| // use debug info more granular build info if available | |
| debugBuildInfo, ok := debug.ReadBuildInfo() | |
| if ok { | |
| info.BuildDeps = depsFromBuildInfo(debugBuildInfo) | |
| sdkBuildInfo := getSDKBuildInfo(debugBuildInfo) | |
| info.CometServerVersion = sdkBuildInfo.sdkVersion | |
| info.RuntimeVersion = sdkBuildInfo.runtimeVersion | |
| info.StfVersion = sdkBuildInfo.stfVersion | |
| info.CometServerVersion = sdkBuildInfo.cometServerVersion | |
| } | |
| return info | |
| info := Info{ | |
| Name: Name, | |
| AppName: AppName, | |
| Version: Version, | |
| GitCommit: Commit, | |
| BuildTags: BuildTags, | |
| GoVersion: fmt.Sprintf("go version %s %s/%s", runtime.Version(), runtime.GOOS, runtime.GOARCH), | |
| CosmosSdkVersion: "unable to read deps", | |
| } | |
| // use debug info more granular build info if available | |
| debugBuildInfo, ok := debug.ReadBuildInfo() | |
| if ok { | |
| info.BuildDeps = depsFromBuildInfo(debugBuildInfo) | |
| sdkBuildInfo := getSDKBuildInfo(debugBuildInfo) | |
| info.CosmosSdkVersion = sdkBuildInfo.sdkVersion | |
| info.RuntimeVersion = sdkBuildInfo.runtimeVersion | |
| info.StfVersion = sdkBuildInfo.stfVersion | |
| info.CometServerVersion = sdkBuildInfo.cometServerVersion | |
| } | |
| return info |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
version/version.go (1)
49-72: Consider enhancing robustness and maintainabilityWhile the implementation is correct, consider these improvements:
- Add error handling for edge cases where version information might be missing
- Define package paths as constants to avoid string literals and make maintenance easier
+const ( + cosmosSDKPath = "github.com/cosmos/cosmos-sdk" + cometServerPath = "cosmossdk.io/server/v2/cometbft" + runtimePath = "cosmossdk.io/runtime/v2" + stfPath = "cosmossdk.io/server/v2/stf" +) func getSDKBuildInfo(debugBuildInfo *debug.BuildInfo) sdkBuildInfo { var buildInfo sdkBuildInfo for _, dep := range debugBuildInfo.Deps { switch dep.Path { - case "github.com/cosmos/cosmos-sdk": + case cosmosSDKPath: buildInfo.sdkVersion = extractVersionFromBuildInfo(dep) - case "cosmossdk.io/server/v2/cometbft": + case cometServerPath: buildInfo.cometServerVersion = extractVersionFromBuildInfo(dep) - case "cosmossdk.io/runtime/v2": + case runtimePath: buildInfo.runtimeVersion = extractVersionFromBuildInfo(dep) - case "cosmossdk.io/server/v2/stf": + case stfPath: buildInfo.stfVersion = extractVersionFromBuildInfo(dep) } }
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (1)
version/version.go(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
version/version.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
🔇 Additional comments (4)
version/version.go (4)
42-47: LGTM: Well-structured version information struct
The sdkBuildInfo struct is well-designed with clear field names that follow Go naming conventions.
80-91: LGTM: Well-defined struct with proper field tags
The Info struct is well-designed with:
- Clear field names
- Proper JSON and YAML tags
- Appropriate use of
omitemptyfor optional fields
95-116: LGTM: Version assignments have been fixed
The implementation correctly assigns version information from the build info, addressing the issues raised in the previous review.
128-132: LGTM: Clean implementation of dependency extraction
The function is simple, focused, and correctly handles the dependency extraction.
| repeated Module build_deps = 7; | ||
| string cosmos_sdk_version = 8 [(cosmos_proto.field_added_in) = "cosmos-sdk 0.43"]; | ||
| string comet_server_version = 9 [(cosmos_proto.field_added_in) = "cosmos-sdk 2.0"]; | ||
| string runtime_version = 10 [(cosmos_proto.field_added_in) = "cosmos-sdk 2.0"]; |
There was a problem hiding this comment.
It should be cosmos-sdk 0.52, as this is part of the cosmos/cosmos-sdk go.mod
version/version_test.go
Outdated
| "github.com/cosmos/cosmos-sdk/client/flags" | ||
| "github.com/cosmos/cosmos-sdk/testutil" | ||
| "github.com/cosmos/cosmos-sdk/testutil/cmdtest" | ||
| "github.com/cosmos/cosmos-sdk/version" | ||
| "github.com/stretchr/testify/require" |
| @@ -45,6 +45,7 @@ Every module contains its own CHANGELOG.md. Please refer to the module you are i | |||
| * (baseapp) [#20291](https://github.com/cosmos/cosmos-sdk/pull/20291) Simulate nested messages. | |||
| * (crypto/keyring) [#21653](https://github.com/cosmos/cosmos-sdk/pull/21653) New Linux-only backend that adds Linux kernel's `keyctl` support. | |||
| * (client/keys) [#21829](https://github.com/cosmos/cosmos-sdk/pull/21829) Add support for importing hex key using standard input. | |||
| * (client) [#22807](https://github.com/cosmos/cosmos-sdk/pull/22807) Return v2 server information in the `version` command. | |||
julienrbrt
changed the title
julienrbrt
added
the
backport/v0.52.x
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
api/cosmos/base/tendermint/v1beta1/query.pulsar.go (1)
Line range hint
1-11883: Generated code follows protobuf-go standardsThis is a generated file that correctly implements all required protobuf functionality for the new version fields. Remember not to manually modify this file; instead, update the source .proto files.
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
⛔ Files ignored due to path filters (1)
client/grpc/cmtservice/query.pb.gois excluded by!**/*.pb.go
📒 Files selected for processing (4)
api/cosmos/base/tendermint/v1beta1/query.pulsar.go(16 hunks)proto/cosmos/base/tendermint/v1beta1/query.proto(1 hunks)version/build_test.go(1 hunks)version/version_test.go(1 hunks)
🔥 Files not summarized due to errors (1)
- api/cosmos/base/tendermint/v1beta1/query.pulsar.go: Error: Server error: no LLM provider could handle the message
🚧 Files skipped from review as they are similar to previous changes (1)
- version/build_test.go
🧰 Additional context used
📓 Path-based instructions (2)
api/cosmos/base/tendermint/v1beta1/query.pulsar.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
version/version_test.go (2)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"
🔇 Additional comments (6)
proto/cosmos/base/tendermint/v1beta1/query.proto (2)
146-153: LGTM! Clean formatting improvements
The reformatting of the VersionInfo message fields improves readability while maintaining functionality.
154-156: Verify cosmos-sdk version annotation
The new fields are well-structured and align with the PR objectives. However, based on previous review discussions, we should verify the cosmos-sdk version annotation.
Let's verify the cosmos-sdk version in the repository:
✅ Verification successful
Version annotations are consistent with SDK versioning
The new fields (comet_server_version, runtime_version, stf_version) are correctly annotated with cosmos-sdk 0.52. This is consistent with other version annotations in the same file, which follow a similar pattern (e.g., cosmos_sdk_version field is annotated with cosmos-sdk 0.43). The version annotations are properly used to track field additions across SDK releases.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the cosmos-sdk version used in the repository
# Check go.mod for cosmos-sdk version
echo "Checking go.mod for cosmos-sdk version:"
rg "github.com/cosmos/cosmos-sdk" go.mod
# Check if there are any other proto files using version annotations
echo -e "\nChecking other proto files for version annotations:"
rg -A 1 "cosmos_proto.field_added_in.*cosmos-sdk" --type proto
Length of output: 442
Script:
#!/bin/bash
# Let's try a different approach to find proto files and check version annotations
# First, find all proto files
echo "Finding all proto files:"
fd -e proto
# Then check for version annotations in these files
echo -e "\nChecking version annotations in proto files:"
fd -e proto -x grep -l "cosmos_proto.field_added_in" {} \; -x cat {}
# Also check for any version-related configuration files
echo -e "\nChecking for version-related files:"
fd -g "*version*"
Length of output: 114918
Script:
#!/bin/bash
# Let's search for cosmos-sdk version 0.52 annotations in proto files
echo "Searching for cosmos-sdk 0.52 annotations:"
rg -A 1 "cosmos-sdk 0.52" --type proto
# Also check for any other version annotations in the same file
echo -e "\nChecking for other version annotations in query.proto:"
cat proto/cosmos/base/tendermint/v1beta1/query.proto
Length of output: 8567
api/cosmos/base/tendermint/v1beta1/query.pulsar.go (4)
6413-6424: Field descriptors look good!
The new field descriptors for version information are correctly defined following protobuf conventions.
6438-6440: Field initialization is properly implemented!
The new version fields are correctly initialized using the standard protobuf reflection pattern.
11153-11163: Message definition and getters are well-structured!
The new version fields are properly defined with:
- Correct protobuf field numbers and tags
- Proper JSON field name mapping
- Standard Go getter methods
Also applies to: 11242-11261
11731-11743: Verify version compatibility annotations
All new fields are annotated with cosmos-sdk 0.52. Please ensure this version requirement is intentional and matches the planned release version.
✅ Verification successful
Version annotations are consistent with codebase changes
The version annotations using cosmos-sdk 0.52 are consistent with other new fields added in the same version. The proto definitions show that these version annotations are used to track field additions across different SDK versions, with other fields also using the same version pattern (e.g., comet_server_version, runtime_version, and stf_version all marked with cosmos-sdk 0.52).
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check for other usages of cosmos-sdk version annotations
rg --type=go "cosmos-sdk.*0\.52" -A 2 -B 2
Length of output: 44
Script:
#!/bin/bash
# Let's try a broader search for version annotations in proto/generated files
rg --type=go "cosmos-sdk" -A 2 -B 2
# Also search for version-related patterns in proto files
fd -e proto -x rg -l "cosmos-sdk"
Length of output: 70252
Script:
#!/bin/bash
# Let's search for version annotations in proto files specifically
fd -e proto -x cat {} \; | rg -A 2 -B 2 "cosmos-sdk.*0\.52|cosmos-sdk.*version"
# Also check for any version-related files or configuration
fd -g "*version*" -t f
Length of output: 1062
version/version_test.go
Outdated
| Name: testName, | ||
| AppName: testAppName, | ||
| Version: testVersion, | ||
| GitCommit: testCommit, | ||
| BuildTags: testBuildTags, | ||
| CosmosSdkVersion: "unable to read deps", |
There was a problem hiding this comment.
Enhance test coverage for v2 version information
The current test case doesn't adequately cover the new version information features described in the PR objectives:
- The hardcoded
"unable to read deps"doesn't validate the actual version information that should be displayed. - Missing test cases for:
- Runtime/v2 version
- STF version
- Server/v2/cometbft version
- No validation of behavior when
COSMOS_BUILD_OPTIONS=v2is set
Consider adding these test cases:
func TestCLI(t *testing.T) {
+ tests := []struct {
+ name string
+ buildOpts string
+ wantVersion version.Info
+ }{
+ {
+ name: "with v2 build options",
+ buildOpts: "v2",
+ wantVersion: version.Info{
+ Name: testName,
+ AppName: testAppName,
+ Version: testVersion,
+ GitCommit: testCommit,
+ BuildTags: testBuildTags,
+ RuntimeVersion: "v2.0.0", // Expected v2 runtime version
+ StfVersion: "v1.0.0", // Expected STF version
+ CometServerVersion: "v0.1.0", // Expected server version
+ },
+ },
+ {
+ name: "without v2 build options",
+ buildOpts: "",
+ wantVersion: version.Info{
+ Name: testName,
+ AppName: testAppName,
+ Version: testVersion,
+ GitCommit: testCommit,
+ BuildTags: testBuildTags,
+ },
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ origBuildOpts := os.Getenv("COSMOS_BUILD_OPTIONS")
+ t.Cleanup(func() {
+ os.Setenv("COSMOS_BUILD_OPTIONS", origBuildOpts)
+ })
+ os.Setenv("COSMOS_BUILD_OPTIONS", tt.buildOpts)
+
+ // Your existing test logic here, but compare against tt.wantVersion
+ })
+ }
}Committable suggestion skipped: line range outside the PR's diff.
|
Could you check what's up: https://github.com/cosmos/cosmos-sdk/actions/runs/12244932192/job/34157747036?pr=22807 |
(cherry picked from commit 6a7ecd8) # Conflicts: # CHANGELOG.md # api/cosmos/base/tendermint/v1beta1/query.pulsar.go
) (#22818) Co-authored-by: Alex | Skip <[email protected]> Co-authored-by: Julien Robert <[email protected]>
Description
Closes: #22772
Info()fuction so internals can be testedTry it out
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...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers 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...
Summary by CodeRabbit
New Features
Improvements
Bug Fixes
Tests
Documentation