Skip to content

fix: allow ClusterClass topology dry-run for templates #88

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

Merged
mweibel merged 2 commits into from
Sep 21, 2026
Merged

fix: allow ClusterClass topology dry-run for templates #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67c4a19
fix: allow ClusterClass topology dry-run for templates
disperate Sep 14, 2026
1112fc5
use alias for clusterv1
disperate Sep 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 20 additions & 10 deletions internal/webhook/v1beta2/cloudscalemachinetemplate_webhook.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,13 @@ package v1beta2

import (
"context"
"fmt"
"reflect"

apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/util/validation/field"
"sigs.k8s.io/cluster-api/util/topology"
ctrl "sigs.k8s.io/controller-runtime"
logf "sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
Expand Down Expand Up @@ -88,18 +90,26 @@ func (v *CloudscaleMachineTemplateCustomValidator) ValidateCreate(_ context.Cont
}

// ValidateUpdate implements webhook.CustomValidator so a webhook will be registered for the type CloudscaleMachineTemplate.
func (v *CloudscaleMachineTemplateCustomValidator) ValidateUpdate(_ context.Context, oldObj, newObj *infrastructurev1beta2.CloudscaleMachineTemplate) (admission.Warnings, error) {
func (v *CloudscaleMachineTemplateCustomValidator) ValidateUpdate(ctx context.Context, oldObj, newObj *infrastructurev1beta2.CloudscaleMachineTemplate) (admission.Warnings, error) {
cloudscalemachinetemplatelog.Info("Validation for CloudscaleMachineTemplate upon update", "name", newObj.GetName())

// MachineTemplate spec is fully immutable (CAPI convention).
if !reflect.DeepEqual(newObj.Spec.Template.Spec, oldObj.Spec.Template.Spec) {
var allErrs = make(field.ErrorList, 0, 1)
allErrs = append(allErrs, field.Forbidden(
field.NewPath("spec", "template", "spec"),
"field is immutable"))
return nil, apierrors.NewInvalid(
schema.GroupKind{Group: infrastructurev1beta2.SchemeGroupVersion.Group, Kind: "CloudscaleMachineTemplate"},
newObj.Name, allErrs)
req, err := admission.RequestFromContext(ctx)
if err != nil {
return nil, apierrors.NewBadRequest(
fmt.Sprintf("expected an admission.Request inside context: %v", err))
}

if !topology.IsDryRunRequest(req, newObj) {
// MachineTemplate spec is fully immutable (CAPI convention).
if !reflect.DeepEqual(newObj.Spec.Template.Spec, oldObj.Spec.Template.Spec) {
var allErrs = make(field.ErrorList, 0, 1)
allErrs = append(allErrs, field.Forbidden(
field.NewPath("spec", "template", "spec"),
"field is immutable"))
return nil, apierrors.NewInvalid(
schema.GroupKind{Group: infrastructurev1beta2.SchemeGroupVersion.Group, Kind: "CloudscaleMachineTemplate"},
newObj.Name, allErrs)
}
}

return nil, nil
Expand Down
56 changes: 54 additions & 2 deletions internal/webhook/v1beta2/cloudscalemachinetemplate_webhook_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"testing"

. "github.com/onsi/gomega"
clusterv1 "sigs.k8s.io/cluster-api/api/core/v1beta2"

infrastructurev1beta2 "github.com/cloudscale-ch/cluster-api-provider-cloudscale/api/v1beta2"
"github.com/cloudscale-ch/cluster-api-provider-cloudscale/internal/testutils"
Expand Down Expand Up @@ -116,7 +117,7 @@ func TestMachineTemplateValidateUpdate_FlavorChange(t *testing.T) {
validator := CloudscaleMachineTemplateCustomValidator{FlavorInfo: testutils.NewTestFlavorInfo()}
obj.Spec.Template.Spec.Flavor = "flex-16-8"

_, err := validator.ValidateUpdate(ctx, oldObj, obj)
_, err := validator.ValidateUpdate(newAdmissionContext(false), oldObj, obj)
g.Expect(err).To(HaveOccurred())
g.Expect(err.Error()).To(ContainSubstring("spec.template.spec"))
}
Expand All @@ -127,7 +128,7 @@ func TestMachineTemplateValidateUpdate_ImageChange(t *testing.T) {
validator := CloudscaleMachineTemplateCustomValidator{FlavorInfo: testutils.NewTestFlavorInfo()}
obj.Spec.Template.Spec.Image = "ubuntu-22.04"

_, err := validator.ValidateUpdate(ctx, oldObj, obj)
_, err := validator.ValidateUpdate(newAdmissionContext(false), oldObj, obj)
g.Expect(err).To(HaveOccurred())
g.Expect(err.Error()).To(ContainSubstring("spec.template.spec"))
}
Expand All @@ -144,3 +145,54 @@ func TestMachineTemplateValidateDelete_AlwaysSucceeds(t *testing.T) {
_, err := validator.ValidateDelete(ctx, obj)
g.Expect(err).NotTo(HaveOccurred())
}

// ============================================================================
// Tests for ClusterClass dry-run support
// ============================================================================

func TestMachineTemplateValidateUpdate_DryRunWithChangedSpec(t *testing.T) {
g := NewWithT(t)
obj, oldObj := newMachineTemplateWebhookTestObjects()
validator := CloudscaleMachineTemplateCustomValidator{FlavorInfo: testutils.NewTestFlavorInfo()}

// Simulate a topology-driven template rotation: the spec changed.
obj.Spec.Template.Spec.Flavor = "flex-16-8"

// Annotate the new object with the topology dry-run marker.
if obj.Annotations == nil {
obj.Annotations = map[string]string{}
}
obj.Annotations[clusterv1.TopologyDryRunAnnotation] = ""

_, err := validator.ValidateUpdate(newAdmissionContext(true), oldObj, obj)
g.Expect(err).NotTo(HaveOccurred())
}

func TestMachineTemplateValidateUpdate_DryRunWithoutAnnotationStillDenied(t *testing.T) {
g := NewWithT(t)
obj, oldObj := newMachineTemplateWebhookTestObjects()
validator := CloudscaleMachineTemplateCustomValidator{FlavorInfo: testutils.NewTestFlavorInfo()}
obj.Spec.Template.Spec.Flavor = "flex-16-8"

// No TopologyDryRunAnnotation on the object.
_, err := validator.ValidateUpdate(newAdmissionContext(true), oldObj, obj)
g.Expect(err).To(HaveOccurred())
g.Expect(err.Error()).To(ContainSubstring("spec.template.spec"))
}

func TestMachineTemplateValidateUpdate_AnnotationWithoutDryRunStillDenied(t *testing.T) {
g := NewWithT(t)
obj, oldObj := newMachineTemplateWebhookTestObjects()
validator := CloudscaleMachineTemplateCustomValidator{FlavorInfo: testutils.NewTestFlavorInfo()}
obj.Spec.Template.Spec.Flavor = "flex-16-8"

if obj.Annotations == nil {
obj.Annotations = map[string]string{}
}
obj.Annotations[clusterv1.TopologyDryRunAnnotation] = ""

// DryRun is false.
_, err := validator.ValidateUpdate(newAdmissionContext(false), oldObj, obj)
g.Expect(err).To(HaveOccurred())
g.Expect(err.Error()).To(ContainSubstring("spec.template.spec"))
}
11 changes: 11 additions & 0 deletions internal/webhook/v1beta2/webhook_suite_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/envtest"
metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
"sigs.k8s.io/controller-runtime/pkg/webhook"
"sigs.k8s.io/controller-runtime/pkg/webhook/admission"

infrastructurev1beta2 "github.com/cloudscale-ch/cluster-api-provider-cloudscale/api/v1beta2"
"github.com/cloudscale-ch/cluster-api-provider-cloudscale/internal/testenv"
Expand Down Expand Up @@ -143,3 +144,13 @@ func TestMain(m *testing.M) {
_ = testEnv.Stop()
os.Exit(code)
}

// newAdmissionContext returns a context containing an admission.Request with the given DryRun value.
// Use this helper when unit-testing ValidateUpdate directly, because the webhook now expects
// an admission.Request inside the context.
func newAdmissionContext(dryRun bool) context.Context {
req := admission.Request{
DryRun: &dryRun,
}
return admission.NewContextWithRequest(ctx, req)
}
Loading