Update e2e tests with QoS policy

Update the e2e tests to add coverage for
port with QoS policy set. For this:
- enable q-qos neutron plugin on ci devstack
- update multi-network scenario to add qos
  policies using ID and filter

Author: nikParasyr

hack/ci/cloud-init/controller.yaml.tpl

@@ -38,7 +38,7 @@
 
     # Neutron
     enable_plugin neutron https://github.com/openstack/neutron stable/${OPENSTACK_RELEASE}
-    ENABLED_SERVICES+=,q-svc,neutron-trunk,ovn-controller,ovs-vswitchd,ovn-northd,ovsdb-server,q-ovn-metadata-agent
+    ENABLED_SERVICES+=,q-svc,neutron-trunk,ovn-controller,ovs-vswitchd,ovn-northd,ovsdb-server,q-ovn-metadata-agent,q-qos
 
     DISABLED_SERVICES=q-agt,q-dhcp,q-l3,q-meta,q-metering
     PUBLIC_BRIDGE_MTU=${MTU}
@@ -197,6 +197,9 @@
     openstack quota set --secgroup-rules 1000 demo
     openstack quota set --secgroups 100 admin
     openstack quota set --secgroup-rules 1000 admin
+
+    # Validate qos extension is set and create a policy
+    openstack extension list --network | grep qos
 - path: /root/devstack.sh
   permissions: "0755"
   content: |

test/e2e/data/kustomize/multi-network/patch-machine-template-networks.yaml

@@ -3,9 +3,15 @@
   path: /spec/template/spec/ports
   value:
   - description: "primary"
+    qosPolicy:
+      id: "${QOS_POLICY_ID}"
   - description: "Extra Network 1"
     network:
       id: "${CLUSTER_EXTRA_NET_1}"
+    qosPolicy:
+      id: "${QOS_POLICY_ID}"
   - description: "Extra Network 2"
     network:
       id: "${CLUSTER_EXTRA_NET_2}"
+    qosPolicy:
+      id: "${QOS_POLICY_ID}"

test/e2e/shared/openstack.go

@@ -42,6 +42,7 @@ import (
 	"github.com/gophercloud/gophercloud/v2/openstack/loadbalancer/v2/loadbalancers"
 	"github.com/gophercloud/gophercloud/v2/openstack/loadbalancer/v2/monitors"
 	"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/extensions/layer3/routers"
+	"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/extensions/qos/policies"
 	"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/extensions/security/groups"
 	"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/extensions/security/rules"
 	"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/extensions/trunks"
@@ -67,6 +68,11 @@ type ServerExtWithIP struct {
 	ip string
 }
 
+type PortWithQoS struct {
+	ports.Port
+	policies.QoSPolicyExt
+}
+
 // ensureSSHKeyPair ensures A SSH key is present under the name.
 func ensureSSHKeyPair(e2eCtx *E2EContext) {
 	Logf("Ensuring presence of SSH key %q in OpenStack", DefaultSSHKeyPairName)
@@ -1027,3 +1033,76 @@ func GetOpenStackServerConsoleLog(e2eCtx *E2EContext, id string) (string, error)
 	}
 	return computeClient.GetConsoleOutput(id)
 }
+
+// CreateOpenStackQoSPolicy creates a qos policy to be consumed by a nodes.
+func CreateOpenStackQoSPolicy(ctx context.Context, e2eCtx *E2EContext, policyName string) (*policies.Policy, error) {
+	providerClient, clientOpts, _, err := GetAdminProviderClient(e2eCtx)
+	if err != nil {
+		return nil, fmt.Errorf("error creating provider client: %s", err)
+	}
+
+	networkClient, err := openstack.NewNetworkV2(providerClient, gophercloud.EndpointOpts{
+		Region: clientOpts.RegionName,
+	})
+	if err != nil {
+		return nil, fmt.Errorf("error creating network client: %s", err)
+	}
+
+	createOpts := policies.CreateOpts{
+		Name:      policyName,
+		Shared:    true,
+		IsDefault: false,
+	}
+
+	policy, err := policies.Create(ctx, networkClient, createOpts).Extract()
+	if err != nil {
+		return nil, err
+	}
+
+	return policy, nil
+}
+
+// DeleteOpenStackQoSPolicy deletes a qos policy.
+func DeleteOpenStackQoSPolicy(ctx context.Context, e2eCtx *E2EContext, policyID string) error {
+	providerClient, clientOpts, _, err := GetAdminProviderClient(e2eCtx)
+	if err != nil {
+		return fmt.Errorf("error creating provider client: %s", err)
+	}
+
+	networkClient, err := openstack.NewNetworkV2(providerClient, gophercloud.EndpointOpts{
+		Region: clientOpts.RegionName,
+	})
+	if err != nil {
+		return fmt.Errorf("error creating network client: %s", err)
+	}
+
+	err = policies.Delete(ctx, networkClient, policyID).ExtractErr()
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+// GetOpenStackPortWithQoSPolicy gets a neutron port with info about the qos policy.
+func GetOpenStackPortWithQoSPolicy(ctx context.Context, e2eCtx *E2EContext, portID string) (*PortWithQoS, error) {
+	providerClient, clientOpts, _, err := GetTenantProviderClient(e2eCtx)
+	if err != nil {
+		return nil, fmt.Errorf("error creating provider client: %s", err)
+	}
+
+	networkClient, err := openstack.NewNetworkV2(providerClient, gophercloud.EndpointOpts{
+		Region: clientOpts.RegionName,
+	})
+	if err != nil {
+		return nil, fmt.Errorf("error creating network client: %s", err)
+	}
+
+	var port PortWithQoS
+	err = ports.Get(ctx, networkClient, portID).ExtractInto(&port)
+	if err != nil {
+		return nil, err
+	}
+
+	return &port, nil
+}

test/e2e/suites/e2e/e2e_test.go

@@ -35,6 +35,7 @@ import (
 	"github.com/gophercloud/gophercloud/v2/openstack/loadbalancer/v2/loadbalancers"
 	"github.com/gophercloud/gophercloud/v2/openstack/loadbalancer/v2/monitors"
 	"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/extensions/layer3/routers"
+	"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/extensions/qos/policies"
 	"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/extensions/security/groups"
 	"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/extensions/trunks"
 	"github.com/gophercloud/gophercloud/v2/openstack/networking/v2/networks"
@@ -680,13 +681,14 @@ var _ = Describe("e2e tests [PR-Blocking]", func() {
 		})
 	})
 
-	Describe("Workload cluster (multiple attached networks)", func() {
+	Describe("Workload cluster (multiple attached networks and qos policies)", func() {
 		var (
 			clusterName   string
 			configCluster clusterctl.ConfigClusterInput
 			md            []*clusterv1.MachineDeployment
 
 			extraNet1, extraNet2 *networks.Network
+			qosPolicy            *policies.Policy
 		)
 
 		BeforeEach(func(ctx context.Context) {
@@ -717,6 +719,19 @@ var _ = Describe("e2e tests [PR-Blocking]", func() {
 			os.Setenv("CLUSTER_EXTRA_NET_1", extraNet1.ID)
 			os.Setenv("CLUSTER_EXTRA_NET_2", extraNet2.ID)
 
+			shared.Logf("Creating qos policy")
+
+			qosPolicy, err = shared.CreateOpenStackQoSPolicy(ctx, e2eCtx, fmt.Sprintf("%s-qos-policy", namespace.Name))
+			Expect(err).NotTo(HaveOccurred())
+			postClusterCleanup = append(postClusterCleanup, func(ctx context.Context) {
+				shared.Logf("Deleting qos policy %s", qosPolicy.ID)
+				err := shared.DeleteOpenStackQoSPolicy(ctx, e2eCtx, qosPolicy.ID)
+				Expect(err).NotTo(HaveOccurred())
+			})
+
+			os.Setenv("QOS_POLICY_ID", qosPolicy.ID)
+			os.Setenv("QOS_POLICY_NAME", qosPolicy.Name)
+
 			shared.Logf("Creating a cluster")
 			clusterName = fmt.Sprintf("cluster-%s", namespace.Name)
 			configCluster = defaultConfigCluster(clusterName, namespace.Name)
@@ -727,7 +742,7 @@ var _ = Describe("e2e tests [PR-Blocking]", func() {
 			md = clusterResources.MachineDeployments
 		})
 
-		It("should attach all machines to multiple networks", func(ctx context.Context) {
+		It("should attach all machines to multiple networks and qos policy", func(ctx context.Context) {
 			workerMachines := framework.GetMachinesByMachineDeployments(ctx, framework.GetMachinesByMachineDeploymentsInput{
 				Lister:            e2eCtx.Environment.BootstrapClusterProxy.GetClient(),
 				ClusterName:       clusterName,
@@ -756,6 +771,8 @@ var _ = Describe("e2e tests [PR-Blocking]", func() {
 				extraNet2.ID:                       "Extra Network 2",
 			}
 
+			expectedPolicyID := qosPolicy.ID
+
 			for i := range allMachines {
 				machine := &allMachines[i]
 				shared.Logf("Checking ports for machine %s", machine.Name)
@@ -788,6 +805,14 @@ var _ = Describe("e2e tests [PR-Blocking]", func() {
 					}
 				}
 
+				// all ports should have the same qos policy id
+				for j := range ports {
+					port := &ports[j]
+					qosPort, err := shared.GetOpenStackPortWithQoSPolicy(ctx, e2eCtx, port.ID)
+					Expect(err).NotTo(HaveOccurred())
+					Expect(qosPort.QoSPolicyID).To(Equal(expectedPolicyID))
+				}
+
 				// All IP addresses on all ports should be reported in Addresses
 				Expect(machine.Status.Addresses).To(ContainElements(seenAddresses))