port: add propagationUplinkStatus field

Author: winiciusallan

.github/workflows/e2e.yaml

@@ -36,7 +36,7 @@ jobs:
       with:
         enable_workaround_docker_io: 'false'
         branch: ${{ matrix.openstack_version }}
-        enabled_services: "openstack-cli-server"
+        enabled_services: "openstack-cli-server,neutron-uplink-status-propagation"
 
     - name: Deploy a Kind Cluster
       uses: helm/kind-action@92086f6be054225fa813e0a4b13787fc9088faab

api/v1alpha1/port_types.go

@@ -185,6 +185,11 @@ type PortResourceSpec struct {
 	// +kubebuilder:validation:MaxLength=36
 	// +optional
 	HostID string `json:"hostID,omitempty"`
+
+	// propagateUplinkStatus represents the uplink status propagation of
+	// the port.
+	// +optional
+	PropagateUplinkStatus *bool `json:"propagateUplinkStatus,omitempty"`
 }
 
 type PortResourceStatus struct {
@@ -266,7 +271,7 @@ type PortResourceStatus struct {
 	// propagateUplinkStatus represents the uplink status propagation of
 	// the port.
 	// +optional
-	PropagateUplinkStatus *bool `json:"propagateUplinkStatus,omitempty"`
+	PropagateUplinkStatus bool `json:"propagateUplinkStatus,omitempty"`
 
 	// vnicType is the type of vNIC which this port is attached to.
 	// +kubebuilder:validation:MaxLength:=64

api/v1alpha1/zz_generated.deepcopy.go

@@ -347,6 +347,11 @@ spec:
                     x-kubernetes-validations:
                     - message: projectRef is immutable
                       rule: self == oldSelf
+                  propagateUplinkStatus:
+                    description: |-
+                      propagateUplinkStatus represents the uplink status propagation of
+                      the port.
+                    type: boolean
                   securityGroupRefs:
                     description: |-
                       securityGroupRefs are the names of the security groups associated

cmd/models-schema/zz_generated.openapi.go

@@ -171,12 +171,13 @@ 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,
-		AdminStateUp: resource.AdminStateUp,
-		MACAddress:   resource.MACAddress,
+		NetworkID:             *network.Status.ID,
+		Name:                  getResourceName(obj),
+		Description:           string(ptr.Deref(resource.Description, "")),
+		ProjectID:             projectID,
+		AdminStateUp:          resource.AdminStateUp,
+		MACAddress:            resource.MACAddress,
+		PropagateUplinkStatus: resource.PropagateUplinkStatus,
 	}
 
 	if len(resource.AllowedAddressPairs) > 0 {
@@ -345,6 +346,7 @@ func (actuator portActuator) updateResource(ctx context.Context, obj orcObjectPT
 		handleAllowedAddressPairsUpdate(baseUpdateOpts, resource, osResource)
 		handleSecurityGroupRefsUpdate(baseUpdateOpts, resource, osResource, secGroupMap)
 		handleAdminStateUpUpdate(baseUpdateOpts, resource, osResource)
+		handlePropagateUplinkStatusUpdate(baseUpdateOpts, resource, osResource)
 		updateOpts = baseUpdateOpts
 	}
 
@@ -530,6 +532,16 @@ func handleAdminStateUpUpdate(updateOpts *ports.UpdateOpts, resource *resourceSp
 	}
 }
 
+func handlePropagateUplinkStatusUpdate(updateOpts *ports.UpdateOpts, resource *resourceSpecT, osResource *osResourceT) {
+	// When this field is not defined, let's set this as `false` to
+	// avoid errors in environments where uplink-propagation-status
+	// extension isn't enabled.
+	propagateUplinkStatus := ptr.Deref(resource.PropagateUplinkStatus, false)
+	if propagateUplinkStatus != osResource.PropagateUplinkStatus {
+		updateOpts.PropagateUplinkStatus = &propagateUplinkStatus
+	}
+}
+
 type portHelperFactory struct{}
 
 var _ helperFactory = portHelperFactory{}

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

@@ -435,3 +435,31 @@ func TestHandleAdminStateUpUpdate(t *testing.T) {
 		})
 	}
 }
+
+func TestHandlePropagateUplinkStatusUpdate(t *testing.T) {
+	testCases := []struct {
+		name          string
+		newValue      *bool
+		existingValue bool
+		expectChange  bool
+	}{
+		{name: "Set the same value as the existing one", newValue: ptr.To(true), existingValue: true, expectChange: false},
+		{name: "Enabled when was disabled", newValue: ptr.To(true), existingValue: false, expectChange: true},
+		{name: "Disable if it is not defined on spec", newValue: nil, existingValue: true, expectChange: true},
+	}
+
+	for _, tt := range testCases {
+		t.Run(tt.name, func(t *testing.T) {
+			resource := &orcv1alpha1.PortResourceSpec{PropagateUplinkStatus: tt.newValue}
+			osResource := &osclients.PortExt{Port: ports.Port{PropagateUplinkStatus: tt.existingValue}}
+			updateOpts := &ports.UpdateOpts{}
+
+			handlePropagateUplinkStatusUpdate(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

@@ -17,6 +17,7 @@ status:
     vnicType: macvtap
     macAddress: fa:16:3e:23:fd:d7
     hostID: devstack
+    propagateUplinkStatus: true
     tags:
       - tag1
 ---

internal/controllers/port/actuator_test.go

@@ -86,3 +86,4 @@ spec:
     projectRef: port-create-full
     macAddress: fa:16:3e:23:fd:d7
     hostID: devstack
+    propagateUplinkStatus: true

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

@@ -9,7 +9,7 @@ status:
     adminStateUp: true
     portSecurityEnabled: true
     propagateUplinkStatus: false
-    revisionNumber: 1
+    revisionNumber: 2
     status: DOWN
     vnicType: normal
 ---