client-go: Move custom <resource> struct methods to <resource>_expansion files #11928
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
kubevirt-bot
added
the
release-note-none
|
Skipping CI for Draft Pull Request. |
kubevirt-bot
added
do-not-merge/work-in-progress
|
/test all |
kubevirt-bot
added
the
sig/buildsystem
fossedihelm
force-pushed
the
custom-fake-client-enhance
branch
from
87c688c
to
a8a2b4f
Compare
|
/test all |
kubevirt-bot
removed
the
do-not-merge/work-in-progress
8 tasks
Our `vm` struct embed generated `VirtualMachineInterface`. The latter defines the custom methods but does not implement them, which are defined in the `vm`. We can move the expanded methods implementations in the `virtualmachine_expansion` file so that our `vm` can simply inherit them. Also, switched using full `AbsPath` with fmt.Sprintf() to request composition with `Namespace()`, `Resource()`, `Name()` and `SubResource()`. N.B. the `PortForward` method implementation remains in our `vm` struct because we cannot still implement it in the expansion file, due to the lack of the clientConfig. Signed-off-by: fossedihelm <ffossemo@redhat.com>
fossedihelm
force-pushed
the
custom-fake-client-enhance
branch
from
a8a2b4f
to
4a6304d
Compare
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: acardace 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 |
kubevirt-bot
added
the
approved
|
@vasiliy-ul Can you have a look? Thanks |
vasiliy-ul
reviewed
May 22, 2024
...-go/generated/kubevirt/clientset/versioned/typed/core/v1/virtualmachineinstance_expansion.go
Outdated
Show resolved
Hide resolved
Our `vmi` struct embed generated `VirtualMachineInstanceInterface`. The latter defines the custom methods but does not implement them, which are defined in the `vm`. We can move the expanded methods implementations in the `virtualmachineinstance_expansion` file so that our `vmi` can simply inherit them. Also, switched using full `AbsPath` with fmt.Sprintf() to request composition with `Namespace()`, `Resource()`, `Name()` and `SubResource()`. N.B. the methods that return StreamInterface remain in our `vmi` struct because we cannot still implement it in the expansion file, due to the lack of the clientConfig. Signed-off-by: fossedihelm <ffossemo@redhat.com>
Our `kv` struct embed generated `KubeVirtInterface`. The latter defines the custom methods but does not implement them, which are defined in the `kv`. We can move the expanded methods implementations in the `kubevirt_expansion` file so that our `kv` can simply inherit them. Signed-off-by: fossedihelm <ffossemo@redhat.com>
Our `vmirs` struct embed generated `VirtualMachineInstanceResplicasetInterface`. The latter defines the custom methods but does not implement them, which are defined in the `vmirs`. We can move the expanded methods implementations in the `vmirs_expansion` file so that our `vmirs` can simply inherit them. Signed-off-by: fossedihelm <ffossemo@redhat.com>
fossedihelm
force-pushed
the
custom-fake-client-enhance
branch
from
4a6304d
to
d9ab0c6
Compare
vasiliy-ul
approved these changes
May 22, 2024
|
Required labels detected, running phase 2 presubmits: |
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 this PR does
Before this PR:
Our
vm,vmi,kv,vmirsstructs respectively embed generatedVirtualMachineInterface,VirtualMachineInstanceInterface,KubeVirtInterfaceandVirtualMachineInstanceResplicasetInterface.The latter define the custom methods but do not
implement them, which are only defined in the custom structs.
After this PR:
We can move the expanded methods implementations
in the
virtualmachine_expansion,virtualmachineinstance_expansion,kubevirt_expansion,virtualmachineinstancereplicaset_expansionfiles so that our custom structscan simply inherit them.
Also, switched to using full
AbsPathwith fmt.Sprintf()to request composition with
Namespace(),Resource(),Name()andSubResource().Special notes for your reviewer
N.B. methods that require clientConfig, like
PortForward, remain implemented onlyin our custom structs because we still cannot implement them in the
expansion files, due to the lack of the clientConfig.
Checklist
This checklist is not enforcing, but it's a reminder of items that could be relevant to every PR.
Approvers are expected to review this list.
Release note