Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Protobuf Matcher utility #553

Merged

Conversation

AndrewSirenko
Copy link
Contributor

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/kind api-change
/kind bug
/kind cleanup
/kind design
/kind documentation
/kind failing-test
/kind feature
/kind flake

/feature

What this PR does / why we need it:

Source: @jsafrane's kubernetes-csi/external-provisioner#1262

gomock is not able to match newly generated Protobuf messages from csi-test, because their private fields differ. Implement a custom message matcher for projects that need to mock gRPCs can use.

See the passing tests in the following PRs for proof that this works as intended (which rely on a replace directive pointing to my fork of csi-test):

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Will rebase other PRs in sidecar repositories once we release a new patch version of csi-test.

We should cherry-pick this to release-5.3.

Does this PR introduce a user-facing change?:

action required: If you are upgrading CSI spec to v1.10.0 and rely on mocking gRPC calls in your tests, you may need to use the csi-test utils package's Protobuf Matcher: `example.EXPECT().ExampleRequest(Protobuf(requestMsg)).Return(responseMsg, nil).AnyTimes()`

@k8s-ci-robot k8s-ci-robot added release-note-action-required Denotes a PR that introduces potentially breaking changes that require user action. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Aug 28, 2024
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 28, 2024
utils/protobuf.go Outdated Show resolved Hide resolved
@gnufied
Copy link
Contributor

gnufied commented Aug 28, 2024

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 28, 2024
@jsafrane
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: AndrewSirenko, jsafrane

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

The pull request process is described here

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 k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 29, 2024
@k8s-ci-robot k8s-ci-robot merged commit 12190f5 into kubernetes-csi:master Aug 29, 2024
3 checks passed
@AndrewSirenko
Copy link
Contributor Author

/cherry-pick release-5.3

k8s-ci-robot added a commit that referenced this pull request Aug 30, 2024
Cherry-pick #553: Add Protobuf Matcher utility
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-action-required Denotes a PR that introduces potentially breaking changes that require user action. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants