RegisteredLimit Actuator mutability

On-behalf-of: SAP nils.gondermann@sap.com

Author: gndrmnn

api/v1alpha1/registeredlimit_types.go

@@ -40,7 +40,6 @@ type RegisteredLimitResourceSpec struct {
 	// +kubebuilder:validation:Minimum=-1
 	// +kubebuilder:validation:Maximum=2147483647
 	// +required
-	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="defaultLimit is immutable"
 	DefaultLimit *int32 `json:"defaultLimit,omitempty"`
 }
 

config/crd/bases/openstack.k-orc.cloud_registeredlimits.yaml

@@ -191,8 +191,7 @@ func (actuator registeredlimitActuator) updateResource(ctx context.Context, obj
 	updateOpts := registeredlimits.UpdateOpts{}
 
 	handleDescriptionUpdate(&updateOpts, resource, osResource)
-
-	// TODO(scaffolding): add handler for all fields supporting mutability
+	handleDefaultLimitUpdate(&updateOpts, resource, osResource)
 
 	needsUpdate, err := needsUpdate(updateOpts)
 	if err != nil {
@@ -237,6 +236,13 @@ func handleDescriptionUpdate(updateOpts *registeredlimits.UpdateOpts, resource *
 	}
 }
 
+func handleDefaultLimitUpdate(updateOpts *registeredlimits.UpdateOpts, resource *resourceSpecT, osResource *osResourceT) {
+	defaultLimit := int(*resource.DefaultLimit)
+	if osResource.DefaultLimit != defaultLimit {
+		updateOpts.DefaultLimit = &defaultLimit
+	}
+}
+
 func (actuator registeredlimitActuator) GetResourceReconcilers(ctx context.Context, orcObject orcObjectPT, osResource *osResourceT, controller interfaces.ResourceController) ([]resourceReconciler, progress.ReconcileStatus) {
 	return []resourceReconciler{
 		actuator.updateResource,

internal/controllers/registeredlimit/actuator.go

@@ -52,6 +52,33 @@ func TestNeedsUpdate(t *testing.T) {
 	}
 }
 
+func TestHandleDefaultLimitUpdate(t *testing.T) {
+	testCases := []struct {
+		name          string
+		newValue      int
+		existingValue int
+		expectChange  bool
+	}{
+		{name: "Identical", newValue: 1, existingValue: 1, expectChange: false},
+		{name: "Different", newValue: 2, existingValue: 1, expectChange: true},
+	}
+
+	for _, tt := range testCases {
+		t.Run(tt.name, func(t *testing.T) {
+			resource := &orcv1alpha1.RegisteredLimitResourceSpec{DefaultLimit: ptr.To(int32(tt.newValue))}
+			osResource := &osResourceT{DefaultLimit: tt.existingValue}
+
+			updateOpts := registeredlimits.UpdateOpts{}
+			handleDefaultLimitUpdate(&updateOpts, resource, osResource)
+
+			got, _ := needsUpdate(updateOpts)
+			if got != tt.expectChange {
+				t.Errorf("Expected change: %v, got: %v", tt.expectChange, got)
+			}
+		})
+	}
+}
+
 func TestHandleDescriptionUpdate(t *testing.T) {
 	ptrToDescription := ptr.To[string]
 	testCases := []struct {

internal/controllers/registeredlimit/actuator_test.go

@@ -15,8 +15,8 @@ metadata:
   name: registeredlimit-update
 status:
   resource:
-    name: registeredlimit-update
-    # TODO(scaffolding): Add matches for more fields
+    resourceName: vcpus
+    defaultLimit: 5
   conditions:
   - type: Available
     status: "True"

internal/controllers/registeredlimit/tests/registeredlimit-update/00-assert.yaml

@@ -5,24 +5,22 @@ metadata:
   name: registeredlimit-update
 spec:
   cloudCredentialsRef:
-    # TODO(scaffolding): Use openstack-admin if the resource needs admin credentials to be created
-    cloudName: openstack
+    cloudName: openstack-admin
     secretName: openstack-clouds
   managementPolicy: managed
-  # TODO(scaffolding): Add the necessary fields to create the resource
-  resource: {}
+  resource:
+    type: registeredlimit-update
 ---
 apiVersion: openstack.k-orc.cloud/v1alpha1
 kind: RegisteredLimit
 metadata:
   name: registeredlimit-update
 spec:
   cloudCredentialsRef:
-    # TODO(scaffolding): Use openstack-admin if the resource needs admin credentials to be created or updated
-    cloudName: openstack
+    cloudName: openstack-admin
     secretName: openstack-clouds
   managementPolicy: managed
-  # TODO(scaffolding): Only add the mandatory fields. It's possible the resource
-  # doesn't have mandatory fields, in that case, leave it empty.
   resource:
+    resourceName: vcpus
+    defaultLimit: 5
     serviceRef: registeredlimit-update

internal/controllers/registeredlimit/tests/registeredlimit-update/00-minimal-resource.yaml

@@ -5,9 +5,9 @@ metadata:
   name: registeredlimit-update
 status:
   resource:
-    name: registeredlimit-update-updated
     description: registeredlimit-update-updated
-    # TODO(scaffolding): match all fields that were modified
+    resourceName: vcpus
+    defaultLimit: 10
   conditions:
   - type: Available
     status: "True"

internal/controllers/registeredlimit/tests/registeredlimit-update/01-assert.yaml

@@ -7,4 +7,4 @@ spec:
   resource:
     name: registeredlimit-update-updated
     description: registeredlimit-update-updated
-    # TODO(scaffolding): update all mutable fields
+    defaultLimit: 10

internal/controllers/registeredlimit/tests/registeredlimit-update/01-updated-resource.yaml

@@ -15,8 +15,8 @@ metadata:
   name: registeredlimit-update
 status:
   resource:
-    name: registeredlimit-update
-    # TODO(scaffolding): validate that updated fields were all reverted to their original value
+    resourceName: vcpus
+    defaultLimit: 5
   conditions:
   - type: Available
     status: "True"