Skip to content

Conversation

@zhijun42
Copy link
Contributor

The test helper function eqErrGRPC has always been flawed since introduced in 2016.

func eqErrGRPC(err1 error, err2 error) bool {
	return !(err1 == nil && err2 != nil) || err1.Error() == err2.Error()
}

When the first argument was non-nil (usually the case in tests), it will always return true. This has made all error assertions using this helper effectively no-ops.

Changes:

  • Replace broken implementation with correct gRPC status comparison using status.Convert()
  • Add unit tests covering code/message permutations and edge cases
  • Fix test bugs in v3_auth_test.go exposed by the fix (ErrUserEmptyErrGRPCUserEmpty)
  • Add documentation explaining gRPC error wire serialization behavior and the correct usage.

@k8s-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: zhijun42
Once this PR has been reviewed and has the lgtm label, please assign spzala for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot
Copy link

Hi @zhijun42. Thanks for your PR.

I'm waiting for a etcd-io member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

//
// // For errors from clientv3, use errors.Is() with client-side error types:
// errors.Is(err, rpctypes.ErrUserEmpty)
func eqErrGRPC(err1 error, err2 error) bool {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function is badly designed, it promises too much, validates too little. Instead of writing a essay on how to use a test function, just panic if user provides incorrect input.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! Refactored to just panic. And removed my essay.

Comment on lines +1964 to +1965
// eqErrGRPC validates both inputs must be gRPC status errors
// (e.g., rpctypes.ErrGRPCXxx) or nil, and then compares them.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of writing comments improve function name.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't come up with a better name.

  • matchGRPCErrors
  • errorsEqualByGRPCStatus
  • mustEqualGRPCErrors
  • mustGRPCErrorsEqual
  • verifyGRPCErrorsEqual
  • requireGRPCErrorsEqual
  • validateAndCompareGRPCErrors
  • grpcStatusCodeAndMessageEqual

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

3 participants