add apivalidations tests to ensure that identityRef field is immutable and can't be set on created machine

Signed-off-by: MatthieuFin <[email protected]>

Author: MatthieuFin

api/v1beta1/identity_types.go

@@ -18,6 +18,7 @@ package v1beta1
 
 // OpenStackIdentityReference is a reference to an infrastructure
 // provider identity to be used to provision cluster resources.
+// +kubebuilder:validation:XValidation:rule="(!has(self.region) && !has(oldSelf.region)) || self.region == oldSelf.region",message="region is immutable"
 type OpenStackIdentityReference struct {
 	// Name is the name of a secret in the same namespace as the resource being provisioned.
 	// The secret must contain a key named `clouds.yaml` which contains an OpenStack clouds.yaml file.
@@ -32,7 +33,6 @@ type OpenStackIdentityReference struct {
 	// Region specifies an OpenStack region to use. If specified, it overrides
 	// any value in clouds.yaml. If specified for an OpenStackMachine, its
 	// value will be included in providerID.
-	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="region is immutable"
 	// +optional
 	Region string `json:"region,omitempty"`
 }

config/crd/bases/infrastructure.cluster.x-k8s.io_openstackclusters.yaml

@@ -133,6 +133,35 @@ var _ = Describe("OpenStackMachine API validations", func() {
 		Expect(k8sClient.Create(ctx, machine)).To(Succeed(), "Creating a machine with max metadata key and value should succeed")
 	})
 
+	It("should allow server identityRef Region field or unset on creation", func() {
+		machine := defaultMachine()
+
+		By("Creating a machine with identityRef Region field set on creation")
+		machine.Spec.IdentityRef = &infrav1.OpenStackIdentityReference{
+			Name:      "secretName",
+			CloudName: "cloudName",
+			Region:    "regionName",
+		}
+		Expect(k8sClient.Create(ctx, machine)).To(Succeed(), "Creating a machine with a spec.identityRef.Region field should be allowed")
+
+		By("Updating the identityRef Region field")
+		machine.Spec.IdentityRef.Region = "anotherRegionName"
+		Expect(k8sClient.Update(ctx, machine)).NotTo(Succeed(), "Updating spec.identityRef.Region field should fail")
+
+		machine = defaultMachine()
+		By("Creating a machine with identityRef Region field not set on creation")
+		machine.Spec.IdentityRef = &infrav1.OpenStackIdentityReference{
+			Name:      "secretName",
+			CloudName: "cloudName",
+		}
+		Expect(k8sClient.Create(ctx, machine)).To(Succeed(), "Creating a machine without a spec.identityRef.Region field should be allowed")
+
+		By("Setting the identityRef Region field")
+		machine.Spec.IdentityRef.Region = "regionName"
+		Expect(k8sClient.Update(ctx, machine)).NotTo(Succeed(), "Setting spec.identityRef.Region field should fail")
+
+	})
+
 	Context("flavors", func() {
 		It("should require either a flavor or flavorID", func() {
 			machine := defaultMachine()