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.

Sign up for GitHub

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

Jump to bottom

🐛 Fix ClusterClass variables status & RuntimeExtension and add test coverage #10337

Merged
merged 1 commit into from
Mar 28, 2024
Merged

🐛 Fix ClusterClass variables status & RuntimeExtension and add test coverage #10337

merged 1 commit into from
Mar 28, 2024

Conversation

chrischdi
Copy link
Member

What this PR does / why we need it:

  • adds // +optional to the metadata
  • also adds metadata to the variables in ClusterClass.Status and adds test-coverage for this.
  • adds test-coverage to ensure metadata of variables in ClusterClass.Status also gets populated.

Background:

  • a user should only consume the ClusterClasses variables from status because of that the metadata is also required there.
  • Runtime extensions may add variables too and they only end up in the ClusterClass.status

Follow-up for:

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 #

/area runtime-sdk

@k8s-ci-robot k8s-ci-robot added area/runtime-sdk Issues or PRs related to Runtime SDK cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 28, 2024
@sbueringer
Copy link
Member

/cherry-pick release-1.6

@k8s-infra-cherrypick-robot
Copy link

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

In response to this:

/cherry-pick release-1.6

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 @chrischdi
Fix ClusterClass variables status & RuntimeExtension and add test cov…
6e70554 
…erage

Co-authored-by: Stefan Büringer buringerst@vmware.com
@chrischdi
Copy link
Member Author

/test help

@k8s-ci-robot
Copy link
Contributor

@chrischdi: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

  • /test pull-cluster-api-build-main
  • /test pull-cluster-api-e2e-blocking-main
  • /test pull-cluster-api-e2e-conformance-ci-latest-main
  • /test pull-cluster-api-e2e-conformance-main
  • /test pull-cluster-api-e2e-dualstack-and-ipv6-main
  • /test pull-cluster-api-e2e-main
  • /test pull-cluster-api-e2e-mink8s-main
  • /test pull-cluster-api-e2e-upgrade-1-29-1-30-main
  • /test pull-cluster-api-test-main
  • /test pull-cluster-api-test-mink8s-main
  • /test pull-cluster-api-verify-main

The following commands are available to trigger optional jobs:

  • /test pull-cluster-api-apidiff-main

Use /test all to run the following jobs that were automatically triggered:

  • pull-cluster-api-apidiff-main
  • pull-cluster-api-build-main
  • pull-cluster-api-e2e-blocking-main
  • pull-cluster-api-test-main
  • pull-cluster-api-verify-main

In response to this:

/test help

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.

@chrischdi
Copy link
Member Author

/test pull-cluster-api-e2e-main

@sbueringer
Copy link
Member

/lgtm
/approve

/hold
Let's verify via test artifacts that the variable metadata from the Runtime Extension ends up in the CC status

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 28, 2024
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 28, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 7ebe7c3db66840fb2194f4bfcdd21774375c6391

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

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 Mar 28, 2024
fabriziopandini
fabriziopandini reviewed Mar 28, 2024
View reviewed changes
Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

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

Nice! (just a note for a possible future improvement)

/lgtm

internal/controllers/clusterclass/clusterclass_controller.go
@@ -343,7 +345,7 @@ func addDefinitionToExistingStatusVariable(variable clusterv1.ClusterClassVariab
// If definitions already conflict, no need to check.
if !combinedVariable.DefinitionsConflict {
currentDefinition := combinedVariable.Definitions[0]
if !(currentDefinition.Required == newVariableDefinition.Required && reflect.DeepEqual(currentDefinition.Schema, newVariableDefinition.Schema)) {
if !(currentDefinition.Required == newVariableDefinition.Required && reflect.DeepEqual(currentDefinition.Schema, newVariableDefinition.Schema) && reflect.DeepEqual(currentDefinition.Metadata, newVariableDefinition.Metadata)) {
Copy link
Member

Choose a reason for hiding this comment

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

note: I think this is ok for now, but in the future we can think about making this more tolerant to definitions with different metadata.
E.g. we merge metadata if there are no conflicting values

Copy link
Member Author

Choose a reason for hiding this comment

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

That's a great idea.

Copy link
Member

Choose a reason for hiding this comment

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

We intentionally made a different choice with the metadata we already have within the scheme (description, example, ...)

Copy link
Member

Choose a reason for hiding this comment

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

The idea there was that we shouldn't merge something that might not be the same. Merging it could be risky if the semantic differs.

@sbueringer
Copy link
Member

Verified that metadata shows up in status: https://storage.googleapis.com/kubernetes-jenkins/pr-logs/pull/kubernetes-sigs_cluster-api/10337/pull-cluster-api-e2e-main/1773305962350776320/artifacts/clusters/bootstrap/resources/k8s-upgrade-with-runtimesdk-7ossxu/ClusterClass/quick-start-runtimesdk.yaml

The e2e test failures have been caused by another change. This will be fixed in: #10340

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 28, 2024
@sbueringer
Copy link
Member

/override pull-cluster-api-e2e-main

See above

@k8s-ci-robot
Copy link
Contributor

@sbueringer: Overrode contexts on behalf of sbueringer: pull-cluster-api-e2e-main

In response to this:

/override pull-cluster-api-e2e-main

See above

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-ci-robot k8s-ci-robot merged commit f61d895 into kubernetes-sigs:main Mar 28, 2024
22 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.7 milestone Mar 28, 2024
@k8s-infra-cherrypick-robot
Copy link

@sbueringer: #10337 failed to apply on top of branch "release-1.6":

Applying: Fix ClusterClass variables status & RuntimeExtension and add test coverage
Using index info to reconstruct a base tree...
M	api/v1beta1/zz_generated.openapi.go
M	config/crd/bases/cluster.x-k8s.io_clusterclasses.yaml
M	internal/controllers/clusterclass/clusterclass_controller.go
M	internal/controllers/clusterclass/clusterclass_controller_test.go
M	test/extension/handlers/topologymutation/handler.go
Falling back to patching base and 3-way merge...
Auto-merging test/extension/handlers/topologymutation/handler.go
Auto-merging internal/controllers/clusterclass/clusterclass_controller_test.go
CONFLICT (content): Merge conflict in internal/controllers/clusterclass/clusterclass_controller_test.go
Auto-merging internal/controllers/clusterclass/clusterclass_controller.go
Auto-merging config/crd/bases/cluster.x-k8s.io_clusterclasses.yaml
Auto-merging api/v1beta1/zz_generated.openapi.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 ClusterClass variables status & RuntimeExtension and add test coverage
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.6

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.

This was referenced Mar 28, 2024
Merged
Merged
@sbueringer sbueringer mentioned this pull request Jun 18, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sbueringer sbueringer sbueringer left review comments

@fabriziopandini fabriziopandini fabriziopandini left review comments

@elmiko elmiko Awaiting requested review from elmiko

@jackfrancis jackfrancis Awaiting requested review from jackfrancis

Assignees

@sbueringer sbueringer

@fabriziopandini fabriziopandini

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/runtime-sdk Issues or PRs related to Runtime SDK 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. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
v1.7
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@chrischdi @sbueringer @k8s-infra-cherrypick-robot @k8s-ci-robot @fabriziopandini