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

🐛 Ensure MachinePool Version is a valid Kubernetes version #6364

Merged
merged 1 commit into from
Apr 1, 2022
Merged

🐛 Ensure MachinePool Version is a valid Kubernetes version #6364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions exp/api/v1beta1/machinepool_webhook.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package v1beta1

import (
"fmt"
"strings"

apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/runtime"
Expand All @@ -27,6 +28,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/webhook"

clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
"sigs.k8s.io/cluster-api/util/version"
)

func (m *MachinePool) SetupWebhookWithManager(mgr ctrl.Manager) error {
Expand Down Expand Up @@ -63,6 +65,12 @@ func (m *MachinePool) Default() {
if m.Spec.Template.Spec.InfrastructureRef.Namespace == "" {
m.Spec.Template.Spec.InfrastructureRef.Namespace = m.Namespace
}

// tolerate version strings without a "v" prefix: prepend it if it's not there.
if m.Spec.Template.Spec.Version != nil && !strings.HasPrefix(*m.Spec.Template.Spec.Version, "v") {
normalizedVersion := "v" + *m.Spec.Template.Spec.Version
m.Spec.Template.Spec.Version = &normalizedVersion
}
}

// ValidateCreate implements webhook.Validator so a webhook will be registered for the type.
Expand Down Expand Up @@ -125,6 +133,12 @@ func (m *MachinePool) validate(old *MachinePool) error {
)
}

if m.Spec.Template.Spec.Version != nil {
if !version.KubeSemver.MatchString(*m.Spec.Template.Spec.Version) {
allErrs = append(allErrs, field.Invalid(field.NewPath("spec", "template", "spec", "version"), *m.Spec.Template.Spec.Version, "must be a valid semantic version"))
}
}

if len(allErrs) == 0 {
return nil
}
Expand Down
56 changes: 56 additions & 0 deletions exp/api/v1beta1/machinepool_webhook_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ func TestMachinePoolDefault(t *testing.T) {
Template: clusterv1.MachineTemplateSpec{
Spec: clusterv1.MachineSpec{
Bootstrap: clusterv1.Bootstrap{ConfigRef: &corev1.ObjectReference{}},
Version: pointer.StringPtr("1.20.0"),
},
},
},
Expand All @@ -51,6 +52,7 @@ func TestMachinePoolDefault(t *testing.T) {
g.Expect(m.Spec.MinReadySeconds).To(Equal(pointer.Int32Ptr(0)))
g.Expect(m.Spec.Template.Spec.Bootstrap.ConfigRef.Namespace).To(Equal(m.Namespace))
g.Expect(m.Spec.Template.Spec.InfrastructureRef.Namespace).To(Equal(m.Namespace))
g.Expect(m.Spec.Template.Spec.Version).To(Equal(pointer.StringPtr("v1.20.0")))
}

func TestMachinePoolBootstrapValidation(t *testing.T) {
Expand Down Expand Up @@ -219,3 +221,57 @@ func TestMachinePoolClusterNameImmutable(t *testing.T) {
})
}
}

func TestMachinePoolVersionValidation(t *testing.T) {
tests := []struct {
name string
expectErr bool
version string
}{
{
name: "should succeed version is a valid kube semver",
expectErr: false,
version: "v1.23.3",
},
{
name: "should succeed version is a valid pre-release",
expectErr: false,
version: "v1.19.0-alpha.1",
},
{
name: "should fail if version is not a valid semver",
expectErr: true,
version: "v1.1",
},
{
name: "should fail if version is missing a v prefix",
expectErr: true,
version: "1.20.0",
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
g := NewWithT(t)

m := &MachinePool{
Spec: MachinePoolSpec{
Template: clusterv1.MachineTemplateSpec{
Spec: clusterv1.MachineSpec{
Bootstrap: clusterv1.Bootstrap{ConfigRef: &corev1.ObjectReference{}},
Version: &tt.version,
},
},
},
}

if tt.expectErr {
g.Expect(m.ValidateCreate()).NotTo(Succeed())
g.Expect(m.ValidateUpdate(m)).NotTo(Succeed())
} else {
g.Expect(m.ValidateCreate()).To(Succeed())
g.Expect(m.ValidateUpdate(m)).To(Succeed())
}
})
}
}