test(types/address): add additional unit tests for address.LengthPrefix and a… #19964
Conversation
…ddress.MustLengthPrefix
WalkthroughWalkthroughThe recent update aims to bolster the testing suite for address handling, particularly focusing on addressing edge cases. It includes a new test to validate 0-byte address handling and introduces a test to ensure correct panic behavior for excessively long addresses. These changes aim to improve the reliability and robustness of address processing by addressing potential scenarios that might result in unexpected outcomes. Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
EmilGeorgiev
changed the title
![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
Review Status
Configuration used: .coderabbit.yml
Files selected for processing (1)
- types/address/store_key_test.go (4 hunks)
Additional Context Used
Path-based Instructions (1)
types/address/store_key_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 not posted (1)
types/address/store_key_test.go (1)
17-23: > 📝 NOTEThis review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [20-31]
LGTM! The addition of a test case for a 0-byte address in
TestLengthPrefixis a good practice for edge case testing.
types/address/store_key_test.go
Outdated
| func (suite *StoreKeySuite) TestMustLengthPrefix() { | ||
| require := suite.Require() | ||
| addr10byte := []byte{0, 1, 2, 3, 4, 5, 6, 7, 8, 9} | ||
| addr256byte := make([]byte, 256) | ||
|
|
||
| tests := []struct { | ||
| name string | ||
| addr []byte | ||
| expStoreKey []byte | ||
| expPanic bool | ||
| }{ | ||
| {"add length prefix for address", addr10byte, append([]byte{byte(10)}, addr10byte...), false}, | ||
| {"too long address must rise a panic", addr256byte, nil, true}, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| suite.Run(tt.name, func() { | ||
| defer func() { | ||
| r := recover() | ||
| if tt.expPanic { | ||
| require.NotNil(r) | ||
| } else { | ||
| require.Nil(r) | ||
| } | ||
| }() | ||
| storeKey := address.MustLengthPrefix(tt.addr) | ||
| require.Equal(tt.expStoreKey, storeKey) | ||
| }) | ||
| } | ||
| } |
There was a problem hiding this comment.
Consider refining the test case descriptions in TestMustLengthPrefix for clarity and accuracy. For example, "add length prefix for address" could be more descriptive about the expected outcome, and "too long address must rise a panic" could be corrected to "too long address must raise a panic".
- {"add length prefix for address", addr10byte, append([]byte{byte(10)}, addr10byte...), false},
- {"too long address must rise a panic", addr256byte, nil, true},
+ {"10-byte address with length prefix", addr10byte, append([]byte{byte(10)}, addr10byte...), false},
+ {"256-byte address triggers panic due to excessive length", addr256byte, nil, true},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.
| func (suite *StoreKeySuite) TestMustLengthPrefix() { | |
| require := suite.Require() | |
| addr10byte := []byte{0, 1, 2, 3, 4, 5, 6, 7, 8, 9} | |
| addr256byte := make([]byte, 256) | |
| tests := []struct { | |
| name string | |
| addr []byte | |
| expStoreKey []byte | |
| expPanic bool | |
| }{ | |
| {"add length prefix for address", addr10byte, append([]byte{byte(10)}, addr10byte...), false}, | |
| {"too long address must rise a panic", addr256byte, nil, true}, | |
| } | |
| for _, tt := range tests { | |
| suite.Run(tt.name, func() { | |
| defer func() { | |
| r := recover() | |
| if tt.expPanic { | |
| require.NotNil(r) | |
| } else { | |
| require.Nil(r) | |
| } | |
| }() | |
| storeKey := address.MustLengthPrefix(tt.addr) | |
| require.Equal(tt.expStoreKey, storeKey) | |
| }) | |
| } | |
| } | |
| func (suite *StoreKeySuite) TestMustLengthPrefix() { | |
| require := suite.Require() | |
| addr10byte := []byte{0, 1, 2, 3, 4, 5, 6, 7, 8, 9} | |
| addr256byte := make([]byte, 256) | |
| tests := []struct { | |
| name string | |
| addr []byte | |
| expStoreKey []byte | |
| expPanic bool | |
| }{ | |
| {"10-byte address with length prefix", addr10byte, append([]byte{byte(10)}, addr10byte...), false}, | |
| {"256-byte address triggers panic due to excessive length", addr256byte, nil, true}, | |
| } | |
| for _, tt := range tests { | |
| suite.Run(tt.name, func() { | |
| defer func() { | |
| r := recover() | |
| if tt.expPanic { | |
| require.NotNil(r) | |
| } else { | |
| require.Nil(r) | |
| } | |
| }() | |
| storeKey := address.MustLengthPrefix(tt.addr) | |
| require.Equal(tt.expStoreKey, storeKey) | |
| }) | |
| } | |
| } |
There was a problem hiding this comment.
@EmilGeorgiev, thank you for making the requested changes. It's great to see the test case descriptions improved for clarity and accuracy. Keep up the good work! 🚀
If you found this review helpful, would you consider giving us a shout-out on X?
Thank you for using CodeRabbit!
types/address/store_key_test.go
Outdated
| @@ -3,9 +3,8 @@ package address_test | |||
| import ( | |||
| "testing" | |||
|
|
|||
| "github.com/stretchr/testify/suite" | |||
julienrbrt
changed the title
* main: (45 commits) build(deps): Bump github.com/decred/dcrd/dcrec/secp256k1/v4 from 4.2.0 to 4.3.0 (cosmos#19913) build(deps): Bump google.golang.org/grpc from 1.62.1 to 1.63.0 (cosmos#19929) test(types/address): add additional unit tests for address.LengthPrefix and a… (cosmos#19964) refactor(x/bank)!: remove Address.String() (cosmos#19954) build(deps): Bump github.com/prometheus/common from 0.51.1 to 0.52.2 (cosmos#19930) fix(x/epochs): Fix init genesis (cosmos#19958) feat(core,runtime): transaction service (exec mode) (cosmos#19953) fix(x/authz): non utf-8 characters in logs (cosmos#19923) build(deps): Bump golang.org/x/crypto from 0.21.0 to 0.22.0 (cosmos#19960) chore: fix spelling errors (cosmos#19957) fix(x/tx): don't shadow Amino marshalling error messages (cosmos#19955) refactor(types): loosen module.AppModule interface (cosmos#19951) feat(core): add `TxValidator` interface (cosmos#19950) build(deps): Bump cosmossdk.io/store from 1.0.2 to 1.1.0 in /x/epochs (cosmos#19947) feat(x/epochs): upstream osmosis epoch module (cosmos#19697) build(deps): Bump bufbuild/buf-setup-action from 1.30.0 to 1.30.1 (cosmos#19928) refactor(x/genutil)!: remove Address.String() (cosmos#19926) docs(x/mint): Fix inconsistency in mint docs (cosmos#19915) build(deps): Bump github.com/regen-network/gocuke from 1.1.0 to 1.1.1 in /orm (cosmos#19920) feat: Integrate grpc configuration into client.toml (cosmos#19905) ...
…ddress.MustLengthPrefix
Description
Improve test coverage as added a new unit tests for the functions address.LengthPrefix and address.MustLengthPrefix
Closes: according to the CONTRIBUTING.md guidlines, issue is not needed for very small or blatantly obvious problems.
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.
I have...
Summary by CodeRabbit