🐛 Fix potential panics when retrieving VSphereCluster from Cluster.spec.infrastructureRef

[sbueringer]

Signed-off-by: Stefan Büringer [email protected]

What this PR does / why we need it:
To be honest. Not sure how Machines can exist before Cluster.spec.infrastructureRef is set, but given someone hit this case with CAPD (kubernetes-sigs/cluster-api#9673), I think there is no reason not to play it safe in CAPV as well.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

[sbueringer]

/cherry-pick release-1.8

[k8s-infra-cherrypick-robot]

@sbueringer: once the present PR merges, I will cherry-pick it on top of release-1.8 in a new PR and assign it to you.

In response to this:

/cherry-pick release-1.8

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/test-infra repository.

[sbueringer]

/cherry-pick release-1.7

[k8s-infra-cherrypick-robot]

@sbueringer: once the present PR merges, I will cherry-pick it on top of release-1.7 in a new PR and assign it to you.

In response to this:

/cherry-pick release-1.7

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/test-infra repository.

[sbueringer]

/assign @fabriziopandini @chrischdi

[codecov]

Codecov Report

Attention: 18 lines in your changes are missing coverage. Please review.

Comparison is base (ea2041d) 63.69% compared to head (1b211d9) 63.73%.
Report is 37 commits behind head on main.

Files	Patch %	Lines
controllers/vspherecluster_reconciler.go	0.00%	8 Missing ⚠️
pkg/util/cluster.go	0.00%	6 Missing and 2 partials ⚠️
controllers/vspheremachine_controller.go	93.10%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2505      +/-   ##
==========================================
+ Coverage   63.69%   63.73%   +0.04%     
==========================================
  Files         123      123              
  Lines        8746     8786      +40     
==========================================
+ Hits         5571     5600      +29     
- Misses       2761     2767       +6     
- Partials      414      419       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[chrischdi]

/lgtm

ok with the requeue for now. But let's clarify and open an issue for that if we want to add a watch instead.

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: b7fa108e2b6cf096e5935596898e35a6e2cf532c

[sbueringer]

Thx! I'm leaning towards just changing the watch. I see no reason why we couldn't watch the cluster in the supervisor mode. But I want to give Naadir some time to respond

/hold

[sbueringer]

@fabriziopandini @chrischdi PTAL :)

[sbueringer]

/test pull-cluster-api-provider-vsphere-e2e-full-main

[chrischdi]

/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chrischdi

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:

• OWNERS [chrischdi]

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

[sbueringer]

/hold cancel

@fabriziopandini @randomvariable an lgtm would be great :)

[sbueringer]

@chrischdi Can you lgtm?

[chrischdi]

/lgtm

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: 49251e308f8f9779fb7eb18df176778339661fe7

[chrischdi]

/retest

[randomvariable]

/lgtm

/retest

[sbueringer]

/retest

[k8s-infra-cherrypick-robot]

@sbueringer: #2505 failed to apply on top of branch "release-1.8":

Applying: Fix potential panics when retrieving VSphereCluster from Cluster.spec.infrastructureRef
Using index info to reconstruct a base tree...
M	controllers/vspherecluster_reconciler.go
M	controllers/vspheremachine_controller.go
M	controllers/vspherevm_controller.go
M	pkg/util/cluster.go
Falling back to patching base and 3-way merge...
Auto-merging pkg/util/cluster.go
Auto-merging controllers/vspherevm_controller.go
Auto-merging controllers/vspheremachine_controller.go
CONFLICT (content): Merge conflict in controllers/vspheremachine_controller.go
Auto-merging controllers/vspherecluster_reconciler.go
CONFLICT (content): Merge conflict in controllers/vspherecluster_reconciler.go
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Fix potential panics when retrieving VSphereCluster from Cluster.spec.infrastructureRef
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-1.8

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/test-infra repository.

[k8s-infra-cherrypick-robot]

@sbueringer: #2505 failed to apply on top of branch "release-1.7":

Applying: Fix potential panics when retrieving VSphereCluster from Cluster.spec.infrastructureRef
Using index info to reconstruct a base tree...
M	controllers/vspherecluster_reconciler.go
M	controllers/vspheremachine_controller.go
M	controllers/vspherevm_controller.go
M	pkg/util/cluster.go
Falling back to patching base and 3-way merge...
Auto-merging pkg/util/cluster.go
Auto-merging controllers/vspherevm_controller.go
Auto-merging controllers/vspheremachine_controller.go
CONFLICT (content): Merge conflict in controllers/vspheremachine_controller.go
Auto-merging controllers/vspherecluster_reconciler.go
CONFLICT (content): Merge conflict in controllers/vspherecluster_reconciler.go
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Fix potential panics when retrieving VSphereCluster from Cluster.spec.infrastructureRef
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-1.7

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/test-infra repository.

[sbueringer]

Given the merge conflicts I would skip cherry-picking. I mostly opened this PR because we did similar changes to CAPD. There are no reports of CAPV observing this issue.