feat: update OCIMachineTemplate webhook validations (#75)

Author: joekr

api/v1beta1/ocimachinetemplate_webhook.go

@@ -20,6 +20,8 @@
 package v1beta1
 
 import (
+	"fmt"
+
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/util/validation/field"
@@ -83,7 +85,7 @@ func (m *OCIMachineTemplate) validate() field.ErrorList {
 		allErrs = append(
 			allErrs,
 			field.Invalid(
-				field.NewPath("Spec", "Template", "Spec", "imageId"),
+				field.NewPath("spec", "template", "spec", "imageId"),
 				m.Spec.Template.Spec.ImageId,
 				"field is invalid"),
 		)
@@ -94,12 +96,22 @@ func (m *OCIMachineTemplate) validate() field.ErrorList {
 		allErrs = append(
 			allErrs,
 			field.Invalid(
-				field.NewPath("Spec", "Template", "Spec", "compartmentId"),
+				field.NewPath("spec", "template", "spec", "compartmentId"),
 				m.Spec.Template.Spec.CompartmentId,
 				"field is invalid"),
 		)
 	}
 
+	if !validShape(m.Spec.Template.Spec.Shape) {
+		allErrs = append(
+			allErrs,
+			field.Invalid(
+				field.NewPath("spec", "template", "spec", "shape"),
+				m.Spec.Template.Spec.Shape,
+				fmt.Sprintf("shape is invalid - %s", m.Spec.Template.Spec.Shape)),
+		)
+	}
+
 	if len(allErrs) == 0 {
 		return nil
 	}

api/v1beta1/ocimachinetemplate_webhook_test.go

@@ -20,6 +20,7 @@
 package v1beta1
 
 import (
+	"strings"
 	"testing"
 
 	"github.com/onsi/gomega"
@@ -29,6 +30,7 @@ import (
 var tests = []struct {
 	name          string
 	inputTemplate *OCIMachineTemplate
+	errorField    string
 	expectErr     bool
 }{
 	{
@@ -43,7 +45,8 @@ var tests = []struct {
 				},
 			},
 		},
-		expectErr: true,
+		errorField: "imageId",
+		expectErr:  true,
 	},
 	{
 		name: "shouldn't allow bad CompartmentId",
@@ -57,7 +60,23 @@ var tests = []struct {
 				},
 			},
 		},
-		expectErr: true,
+		errorField: "compartmentId",
+		expectErr:  true,
+	},
+	{
+		name: "shouldn't allow empty shape",
+		inputTemplate: &OCIMachineTemplate{
+			ObjectMeta: metav1.ObjectMeta{},
+			Spec: OCIMachineTemplateSpec{
+				Template: OCIMachineTemplateResource{
+					Spec: OCIMachineSpec{
+						Shape: "",
+					},
+				},
+			},
+		},
+		errorField: "shape",
+		expectErr:  true,
 	},
 	{
 		name: "should succeed",
@@ -68,6 +87,7 @@ var tests = []struct {
 					Spec: OCIMachineSpec{
 						ImageId:       "ocid",
 						CompartmentId: "ocid",
+						Shape:         "DVH.DenseIO2.52",
 					},
 				},
 			},
@@ -82,7 +102,9 @@ func TestOCIMachineTemplate_ValidateCreate(t *testing.T) {
 			g := gomega.NewWithT(t)
 
 			if test.expectErr {
-				g.Expect(test.inputTemplate.ValidateCreate()).NotTo(gomega.Succeed())
+				err := test.inputTemplate.ValidateCreate()
+				g.Expect(err).NotTo(gomega.Succeed())
+				g.Expect(strings.Contains(err.Error(), test.errorField)).To(gomega.BeTrue())
 			} else {
 				g.Expect(test.inputTemplate.ValidateCreate()).To(gomega.Succeed())
 			}
@@ -96,7 +118,9 @@ func TestOCIMachineTemplate_ValidateUpdate(t *testing.T) {
 			g := gomega.NewWithT(t)
 
 			if test.expectErr {
-				g.Expect(test.inputTemplate.ValidateUpdate(nil)).NotTo(gomega.Succeed())
+				err := test.inputTemplate.ValidateUpdate(nil)
+				g.Expect(err).NotTo(gomega.Succeed())
+				g.Expect(strings.Contains(err.Error(), test.errorField)).To(gomega.BeTrue())
 			} else {
 				g.Expect(test.inputTemplate.ValidateUpdate(nil)).To(gomega.Succeed())
 			}

api/v1beta1/validator.go

@@ -19,11 +19,18 @@
 
 package v1beta1
 
+// validOcid is a simple pre-flight
+// we will let the serverside handle the more complex and compete validation
 func validOcid(ocid string) bool {
-
 	if len(ocid) >= 4 && ocid[:4] == "ocid" {
 		return true
 	}
 
 	return false
 }
+
+// validShape is a simple pre-flight
+// we will let the serverside handle the more complex and compete validation
+func validShape(shape string) bool {
+	return len(shape) > 0
+}

templates/clusterclass-example.yaml

@@ -106,7 +106,7 @@ spec:
             names:
             - worker
       jsonPatches:
-        - op: add
+        - op: replace
           path: "/spec/template/spec/shape"
           valueFrom:
             variable: shape
@@ -200,6 +200,8 @@ metadata:
 spec:
   template:
     spec:
+      # will be replaced by shape variable defined above
+      shape: VM.Standard.E4.Flex
       metadata: {}
       shapeConfig: {}
 
@@ -211,6 +213,8 @@ metadata:
 spec:
   template:
     spec:
+      # will be replaced by shape variable defined above
+      shape: VM.Standard.E4.Flex
       metadata: {}
       shapeConfig: {}
 ---

test/e2e/data/infrastructure-oci/v1beta1/cluster-template-cluster-class/clusterclass-test-cluster-class.yaml

@@ -200,6 +200,8 @@ metadata:
 spec:
   template:
     spec:
+      # will be replaced by shape variable defined above
+      shape: VM.Standard.E4.Flex
       metadata: {}
       shapeConfig: {}
 ---
@@ -210,6 +212,8 @@ metadata:
 spec:
   template:
     spec:
+      # will be replaced by shape variable defined above
+      shape: VM.Standard.E4.Flex
       metadata: {}
       shapeConfig: {}
 ---