tests(e2e): add traffic split test using shared service account (#1867)

tests/e2e/e2e_trafficsplit_same_sa_test.go

@@ -0,0 +1,257 @@
+package e2e
+
+import (
+	"context"
+	"fmt"
+	"sync"
+	"time"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+
+	corev1 "k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+var _ = Describe("Test TrafficSplit where each backend shares the same ServiceAccount", func() {
+	Context("ClientServerTrafficSplitSameSA", func() {
+		const (
+			// to name the header we will use to identify the server that replies
+			HTTPHeaderName = "podname"
+		)
+		clientAppBaseName := "client"
+		serverNamespace := "server"
+		trafficSplitName := "traffic-split"
+
+		// Scale number of client services/pods here
+		numberOfClientServices := 2
+		clientReplicaSet := 5
+
+		// Scale number of server services/pods here
+		numberOfServerServices := 5
+		serverReplicaSet := 2
+
+		clientServices := []string{}
+		serverServices := []string{}
+		allNamespaces := []string{}
+
+		for i := 0; i < numberOfClientServices; i++ {
+			clientServices = append(clientServices, fmt.Sprintf("%s%d", clientAppBaseName, i))
+		}
+
+		for i := 0; i < numberOfServerServices; i++ {
+			serverServices = append(serverServices, fmt.Sprintf("%s%d", serverNamespace, i))
+		}
+
+		allNamespaces = append(allNamespaces, clientServices...)
+		allNamespaces = append(allNamespaces, serverNamespace) // 1 namespace for all server services (for the trafficsplit)
+
+		// Used across the test to wait for concurrent steps to finish
+		var wg sync.WaitGroup
+
+		It("Tests HTTP traffic from Clients to the traffic split Cluster IP", func() {
+			// For Cleanup only
+			for _, ns := range allNamespaces {
+				td.cleanupNamespaces[ns] = true
+			}
+
+			// Install OSM
+			Expect(td.InstallOSM(td.GetOSMInstallOpts())).To(Succeed())
+			Expect(td.WaitForPodsRunningReady(td.osmNamespace, 90*time.Second, 1)).To(Succeed())
+
+			// Create NSs
+			Expect(td.CreateMultipleNs(allNamespaces...)).To(Succeed())
+			Expect(td.AddNsToMesh(true, allNamespaces...)).To(Succeed())
+
+			// Create server apps
+			svcAcc := &corev1.ServiceAccount{
+				ObjectMeta: metav1.ObjectMeta{
+					Name: "server",
+				},
+			}
+			_, err := td.CreateServiceAccount(serverNamespace, svcAcc)
+			Expect(err).NotTo(HaveOccurred())
+
+			for _, serverApp := range serverServices {
+				_, deploymentDef, svcDef := td.SimpleDeploymentApp(
+					SimpleDeploymentAppDef{
+						name:         serverApp,
+						namespace:    serverNamespace,
+						replicaCount: int32(serverReplicaSet),
+						image:        "simonkowallik/httpbin",
+						ports:        []int{80},
+					})
+
+				// Expose an env variable such as XHTTPBIN_X_POD_NAME:
+				// This httpbin fork will pick certain env variable formats and reply the values as headers.
+				// We will expose pod name as one of these env variables, and will use it
+				// to identify the pod that replies to the request, and validate the test
+				deploymentDef.Spec.Template.Spec.Containers[0].Env = []v1.EnvVar{
+					{
+						Name: fmt.Sprintf("XHTTPBIN_%s", HTTPHeaderName),
+						ValueFrom: &v1.EnvVarSource{
+							FieldRef: &v1.ObjectFieldSelector{
+								FieldPath: "metadata.name",
+							},
+						},
+					},
+				}
+
+				deploymentDef.Spec.Template.Spec.ServiceAccountName = svcAcc.Name
+
+				_, err = td.CreateDeployment(serverNamespace, deploymentDef)
+				Expect(err).NotTo(HaveOccurred())
+				_, err = td.CreateService(serverNamespace, svcDef)
+				Expect(err).NotTo(HaveOccurred())
+			}
+			wg.Add(1)
+			go func() {
+				defer wg.Done()
+				Expect(td.WaitForPodsRunningReady(serverNamespace, 200*time.Second, numberOfServerServices*serverReplicaSet)).To(Succeed())
+			}()
+
+			// Client apps
+			for _, clientApp := range clientServices {
+				svcAccDef, deploymentDef, svcDef := td.SimpleDeploymentApp(
+					SimpleDeploymentAppDef{
+						name:         clientApp,
+						namespace:    clientApp,
+						replicaCount: int32(clientReplicaSet),
+						command:      []string{"/bin/bash", "-c", "--"},
+						args:         []string{"while true; do sleep 30; done;"},
+						image:        "songrgg/alpine-debug",
+						ports:        []int{80},
+					})
+
+				_, err := td.CreateServiceAccount(clientApp, &svcAccDef)
+				Expect(err).NotTo(HaveOccurred())
+				_, err = td.CreateDeployment(clientApp, deploymentDef)
+				Expect(err).NotTo(HaveOccurred())
+				_, err = td.CreateService(clientApp, svcDef)
+				Expect(err).NotTo(HaveOccurred())
+
+				wg.Add(1)
+				go func(app string) {
+					defer wg.Done()
+					Expect(td.WaitForPodsRunningReady(app, 200*time.Second, clientReplicaSet)).To(Succeed())
+				}(clientApp)
+			}
+
+			wg.Wait()
+
+			// Put allow traffic target rules
+			for _, srcClient := range clientServices {
+				httpRG, trafficTarget := td.CreateSimpleAllowPolicy(
+					SimpleAllowPolicy{
+						RouteGroupName:    srcClient + "-server",
+						TrafficTargetName: srcClient + "-server",
+
+						SourceNamespace:      srcClient,
+						SourceSVCAccountName: srcClient,
+
+						DestinationNamespace:      serverNamespace,
+						DestinationSvcAccountName: svcAcc.Name,
+					})
+
+				_, err := td.CreateHTTPRouteGroup(srcClient, httpRG)
+				Expect(err).NotTo(HaveOccurred())
+				_, err = td.CreateTrafficTarget(srcClient, trafficTarget)
+				Expect(err).NotTo(HaveOccurred())
+			}
+
+			// Create traffic split service. Use simple Pod to create a simple service definition
+			_, _, trafficSplitService := td.SimplePodApp(SimplePodAppDef{
+				name:      trafficSplitName,
+				namespace: serverNamespace,
+				ports:     []int{80},
+			})
+
+			// Creating trafficsplit service in K8s
+			_, err = td.CreateService(serverNamespace, trafficSplitService)
+			Expect(err).NotTo(HaveOccurred())
+
+			// Create Traffic split with all server processes as backends
+			trafficSplit := TrafficSplitDef{
+				Name:                    trafficSplitName,
+				Namespace:               serverNamespace,
+				TrafficSplitServiceName: trafficSplitName,
+				Backends:                []TrafficSplitBackend{},
+			}
+			assignation := 100 / len(serverServices) // Spreading equitatively
+			for _, dstServer := range serverServices {
+				trafficSplit.Backends = append(trafficSplit.Backends,
+					TrafficSplitBackend{
+						Name:   dstServer,
+						Weight: assignation,
+					},
+				)
+			}
+			// Get the Traffic split structures
+			tSplit, err := td.CreateSimpleTrafficSplit(trafficSplit)
+			Expect(err).To(BeNil())
+
+			// Push them in K8s
+			_, err = td.CreateTrafficSplit(serverNamespace, tSplit)
+			Expect(err).To(BeNil())
+
+			// Test traffic
+			// Create Multiple HTTP request structure
+			requests := HTTPMultipleRequest{
+				Sources: []HTTPRequestDef{},
+			}
+			for _, ns := range clientServices {
+				pods, err := td.client.CoreV1().Pods(ns).List(context.Background(), metav1.ListOptions{})
+				Expect(err).To(BeNil())
+
+				for _, pod := range pods.Items {
+					requests.Sources = append(requests.Sources, HTTPRequestDef{
+						SourceNs:        ns,
+						SourcePod:       pod.Name,
+						SourceContainer: ns, // container_name == NS for this test
+
+						// Targeting the trafficsplit FQDN
+						Destination: fmt.Sprintf("%s.%s", trafficSplitName, serverNamespace),
+					})
+				}
+			}
+
+			var results HTTPMultipleResults
+			var serversSeen map[string]bool = map[string]bool{} // Just counts unique servers seen
+			success := td.WaitForRepeatedSuccess(func() bool {
+				curlSuccess := true
+
+				// Get results
+				results = td.MultipleHTTPRequest(&requests)
+
+				// Print results
+				td.PrettyPrintHTTPResults(&results)
+
+				// Verify REST status code results
+				for _, ns := range results {
+					for _, podResult := range ns {
+						if podResult.Err != nil || podResult.StatusCode != 200 {
+							curlSuccess = false
+						} else {
+							// We should see pod header populated
+							dstPod, ok := podResult.Headers[HTTPHeaderName]
+							if ok {
+								// Store and mark that we have seen a response for this server pod
+								serversSeen[dstPod] = true
+							}
+						}
+					}
+				}
+				td.T.Logf("Unique servers replied %d/%d",
+					len(serversSeen), numberOfServerServices*serverReplicaSet)
+
+				// Success conditions:
+				// - All clients have been answered consecutively 5 successful HTTP requests
+				// - We have seen all servers from the traffic split reply at least once
+				return curlSuccess && (len(serversSeen) == numberOfServerServices*serverReplicaSet)
+			}, 5, 150*time.Second)
+
+			Expect(success).To(BeTrue())
+		})
+	})
+})