add unit test for history client #5841
Merged
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
shijiesheng
requested review from
Shaddoll,
neil-xie,
davidporter-id-au,
Groxx,
agautam478,
jakobht,
3vilhamster,
sankari165,
dkrotx,
taylanisikdemir and
demirkayaender
as code owners
agautam478
approved these changes
Apr 2, 2024
Pull Request Test Coverage Report for Build 018ea086-5071-4f5f-8be5-0c42f9c6dc5cDetails
💛 - Coveralls |
| numberOfShards int | ||
| resolver membership.Resolver | ||
| namedPort string // grpc or tchannel, depends on yarpc configuration | ||
| } | ||
|
|
||
| // NewPeerResolver creates a new history peer resolver. | ||
| func NewPeerResolver(numberOfShards int, resolver membership.Resolver, namedPort string) PeerResolver { | ||
| return PeerResolver{ | ||
| return peerResolver{ |
There was a problem hiding this comment.
let's change this to &peerResolver and attach the functions to the *peerResolver
| @@ -29,15 +29,25 @@ import ( | |||
| // PeerResolver is used to resolve history peers. | |||
| // Those are deployed instances of Cadence history services that participate in the cluster ring. | |||
| // The resulting peer is simply an address of form ip:port where RPC calls can be routed to. | |||
| type PeerResolver struct { | |||
| // | |||
| //go:generate mockgen -package $GOPACKAGE -source $GOFILE -destination peerResolver_mock.go -package history github.com/uber/cadence/client/history PeerResolver | |||
There was a problem hiding this comment.
please rename this file to peer_resolver.go and the mock file to peer_resolver_test.go. we keep fixing naming inconsistencies as we touch
| }) | ||
| }, | ||
| mock: func(p *MockPeerResolver, c *MockClient) { | ||
| p.EXPECT().FromShardID(123).Return("test-peer", nil).Times(1) |
There was a problem hiding this comment.
let's add more test cases to cover
- peerResolver's corresponding method returning err causes client method to return err
- mock client's corresponding method returning err causes client method to return err
otherwise there are plenty of code branches uncovered. https://app.codecov.io/github/uber/cadence/commit/eaacb01073f6fc3c844329d557b732f3102cc41b/blob/client/history/client.go
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.
What changed?
Why?
improve test coverage
How did you test it?
Potential risks
Release notes
Documentation Changes