Merge pull request #617 from winiciusallan/port-asu

Port: add adminStateUp field

Author: mandre

api/v1alpha1/port_types.go

@@ -36,6 +36,11 @@ type PortFilter struct {
 	// +optional
 	ProjectRef *KubernetesNameRef `json:"projectRef,omitempty"`
 
+	// adminStateUp is the administrative state of the port,
+	// which is up (true) or down (false).
+	// +optional
+	AdminStateUp *bool `json:"adminStateUp,omitempty"`
+
 	FilterByNeutronTags `json:",inline"`
 }
 
@@ -126,6 +131,12 @@ type PortResourceSpec struct {
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="addresses is immutable"
 	Addresses []Address `json:"addresses,omitempty"`
 
+	// adminStateUp is the administrative state of the port,
+	// which is up (true) or down (false). The default value is true.
+	// +kubebuilder:default:=true
+	// +optional
+	AdminStateUp *bool `json:"adminStateUp,omitempty"`
+
 	// securityGroupRefs are the names of the security groups associated
 	// with this port.
 	// +kubebuilder:validation:MaxItems:=64

api/v1alpha1/zz_generated.deepcopy.go

@@ -95,6 +95,11 @@ spec:
                       error state and will not continue to retry.
                     minProperties: 1
                     properties:
+                      adminStateUp:
+                        description: |-
+                          adminStateUp is the administrative state of the port,
+                          which is up (true) or down (false).
+                        type: boolean
                       description:
                         description: description of the existing resource
                         maxLength: 255
@@ -251,6 +256,12 @@ spec:
                     x-kubernetes-validations:
                     - message: addresses is immutable
                       rule: self == oldSelf
+                  adminStateUp:
+                    default: true
+                    description: |-
+                      adminStateUp is the administrative state of the port,
+                      which is up (true) or down (false). The default value is true.
+                    type: boolean
                   allowedAddressPairs:
                     description: allowedAddressPairs are allowed addresses associated
                       with this port.

cmd/models-schema/zz_generated.openapi.go

@@ -132,14 +132,15 @@ func (actuator portActuator) ListOSResourcesForImport(ctx context.Context, obj o
 	}
 
 	listOpts := ports.ListOpts{
-		Name:        string(ptr.Deref(filter.Name, "")),
-		Description: string(ptr.Deref(filter.Description, "")),
-		NetworkID:   ptr.Deref(network.Status.ID, ""),
-		ProjectID:   ptr.Deref(project.Status.ID, ""),
-		Tags:        tags.Join(filter.Tags),
-		TagsAny:     tags.Join(filter.TagsAny),
-		NotTags:     tags.Join(filter.NotTags),
-		NotTagsAny:  tags.Join(filter.NotTagsAny),
+		Name:         string(ptr.Deref(filter.Name, "")),
+		Description:  string(ptr.Deref(filter.Description, "")),
+		NetworkID:    ptr.Deref(network.Status.ID, ""),
+		ProjectID:    ptr.Deref(project.Status.ID, ""),
+		Tags:         tags.Join(filter.Tags),
+		TagsAny:      tags.Join(filter.TagsAny),
+		NotTags:      tags.Join(filter.NotTags),
+		NotTagsAny:   tags.Join(filter.NotTagsAny),
+		AdminStateUp: filter.AdminStateUp,
 	}
 
 	return actuator.osClient.ListPort(ctx, listOpts), nil
@@ -191,10 +192,11 @@ func (actuator portActuator) CreateResource(ctx context.Context, obj *orcv1alpha
 	}
 
 	createOpts := ports.CreateOpts{
-		NetworkID:   *network.Status.ID,
-		Name:        getResourceName(obj),
-		Description: string(ptr.Deref(resource.Description, "")),
-		ProjectID:   projectID,
+		NetworkID:    *network.Status.ID,
+		Name:         getResourceName(obj),
+		Description:  string(ptr.Deref(resource.Description, "")),
+		ProjectID:    projectID,
+		AdminStateUp: resource.AdminStateUp,
 	}
 
 	if len(resource.AllowedAddressPairs) > 0 {
@@ -361,6 +363,7 @@ func (actuator portActuator) updateResource(ctx context.Context, obj orcObjectPT
 		handleDescriptionUpdate(baseUpdateOpts, resource, osResource)
 		handleAllowedAddressPairsUpdate(baseUpdateOpts, resource, osResource)
 		handleSecurityGroupRefsUpdate(baseUpdateOpts, resource, osResource, secGroupMap)
+		handleAdminStateUpUpdate(baseUpdateOpts, resource, osResource)
 		updateOpts = baseUpdateOpts
 	}
 
@@ -527,6 +530,15 @@ func handlePortSecurityUpdate(updateOpts ports.UpdateOptsBuilder, resource *reso
 	return updateOpts
 }
 
+func handleAdminStateUpUpdate(updateOpts *ports.UpdateOpts, resource *resourceSpecT, osResouce *osResourceT) {
+	adminStateUp := resource.AdminStateUp
+	if adminStateUp != nil {
+		if *adminStateUp != osResouce.AdminStateUp {
+			updateOpts.AdminStateUp = adminStateUp
+		}
+	}
+}
+
 type portHelperFactory struct{}
 
 var _ helperFactory = portHelperFactory{}

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

@@ -407,3 +407,31 @@ func TestHandlePortSecurityUpdate(t *testing.T) {
 		})
 	}
 }
+
+func TestHandleAdminStateUpUpdate(t *testing.T) {
+	testCases := []struct {
+		name          string
+		newValue      *bool
+		existingValue bool
+		expectChange  bool
+	}{
+		{name: "Enabled when already enabled", newValue: ptr.To(true), existingValue: true, expectChange: false},
+		{name: "Enabled when was disabled", newValue: ptr.To(true), existingValue: false, expectChange: true},
+		{name: "Keep the existing value if newValue is not set", newValue: nil, existingValue: true, expectChange: false},
+	}
+
+	for _, tt := range testCases {
+		t.Run(tt.name, func(t *testing.T) {
+			resource := &orcv1alpha1.PortResourceSpec{AdminStateUp: tt.newValue}
+			osResource := &osclients.PortExt{Port: ports.Port{AdminStateUp: tt.existingValue}}
+			updateOpts := &ports.UpdateOpts{}
+
+			handleAdminStateUpUpdate(updateOpts, resource, osResource)
+
+			got, _ := needsUpdate(updateOpts)
+			if got != tt.expectChange {
+				t.Errorf("expected needsUpdate=%v, got %v", tt.expectChange, got)
+			}
+		})
+	}
+}

internal/controllers/port/actuator.go

@@ -72,7 +72,8 @@ func (portStatusWriter) ApplyResourceStatus(log logr.Logger, osResource *osResou
 		WithPortSecurityEnabled(osResource.PortSecurityEnabled).
 		WithRevisionNumber(int64(osResource.RevisionNumber)).
 		WithCreatedAt(metav1.NewTime(osResource.CreatedAt)).
-		WithUpdatedAt(metav1.NewTime(osResource.UpdatedAt))
+		WithUpdatedAt(metav1.NewTime(osResource.UpdatedAt)).
+		WithAdminStateUp(osResource.AdminStateUp)
 
 	if osResource.Description != "" {
 		resourceStatus.WithDescription(osResource.Description)

internal/controllers/port/actuator_test.go

@@ -7,7 +7,7 @@ status:
   resource:
     name: port-create-full-override
     description: Port from "create full" test
-    adminStateUp: true
+    adminStateUp: false
     allowedAddressPairs:
       - ip: 192.168.122.14
         mac: 92:42:9c:13:98:82

internal/controllers/port/status.go

@@ -69,6 +69,7 @@ spec:
   resource:
     name: port-create-full-override
     description: Port from "create full" test
+    adminStateUp: false
     networkRef: port-create-full
     allowedAddressPairs:
       - ip: "192.168.122.14"

internal/controllers/port/tests/port-create-full/00-assert.yaml

@@ -12,5 +12,6 @@ spec:
     filter:
       name: port-import-external
       description: Port from "port-import" test
+      adminStateUp: false
       tags:
         - tag1