TestCanaryRoute: Add more logging.

* test/e2e/canary_test.go (TestCanaryRoute): Add some more logging to make it
easier to diagnose test failures.

Author: Miciah

test/e2e/canary_test.go

@@ -36,65 +36,66 @@ import (
 func TestCanaryRoute(t *testing.T) {
 	kubeConfig, err := config.GetConfig()
 	if err != nil {
-		t.Fatalf("failed to get kube config: %v", err)
+		t.Fatalf("Failed to get kube config: %v", err)
 	}
 
 	client, err := kubernetes.NewForConfig(kubeConfig)
 	if err != nil {
-		t.Fatalf("failed to create kube client: %v", err)
+		t.Fatalf("Failed to create kube client: %v", err)
 	}
 
-	// check that the default ingress controller is ready.
+	t.Log("Checking that the default ingresscontroller is ready...")
 	def := &operatorv1.IngressController{}
 	if err := waitForIngressControllerCondition(t, kclient, 5*time.Minute, defaultName, defaultAvailableConditions...); err != nil {
-		t.Fatalf("failed to observe expected conditions: %v", err)
+		t.Fatalf("Failed to observe expected conditions: %v", err)
 	}
 
 	if err := kclient.Get(context.TODO(), defaultName, def); err != nil {
-		t.Fatalf("failed to get default ingresscontroller: %v", err)
+		t.Fatalf("Failed to get the default ingresscontroller: %v", err)
 	}
 
-	// Get default ingress controller deployment.
+	t.Log("Getting the default ingresscontroller deployment...")
 	deployment := &appsv1.Deployment{}
 	if err := kclient.Get(context.TODO(), controller.RouterDeploymentName(def), deployment); err != nil {
-		t.Fatalf("failed to get ingresscontroller deployment: %v", err)
+		t.Fatalf("Failed to get the router deployment: %v", err)
 	}
 
-	// Get canary route.
+	t.Log("Getting the canary route...")
 	canaryRoute := &routev1.Route{}
 	name := controller.CanaryRouteName()
 	err = wait.PollImmediate(1*time.Second, 1*time.Minute, func() (bool, error) {
 		if err := kclient.Get(context.TODO(), name, canaryRoute); err != nil {
-			t.Logf("failed to get canary route %s: %v", name, err)
+			t.Logf("Failed to get route %s: %v", name, err)
 			return false, nil
 		}
 
 		return true, nil
 	})
 	if err != nil {
-		t.Fatalf("failed to observe canary route: %v", err)
+		t.Fatalf("Failed to observe canary route: %v", err)
 	}
 
 	canaryRouteHost := getRouteHost(canaryRoute, defaultName.Name)
 	if canaryRouteHost == "" {
-		t.Fatalf("failed to find host name for the %q router in route %s/%s: %#v", defaultName.Name, name.Namespace, name.Name, canaryRoute)
+		t.Fatalf("Failed to find host name for the %q router in route %s: %+v", defaultName.Name, name, canaryRoute)
 	}
 
 	image := deployment.Spec.Template.Spec.Containers[0].Image
 	clientPod := buildCanaryCurlPod("canary-route-check", canaryRoute.Namespace, image, canaryRouteHost)
 	if err := kclient.Create(context.TODO(), clientPod); err != nil {
-		t.Fatalf("failed to create pod %s/%s: %v", clientPod.Namespace, clientPod.Name, err)
+		t.Fatalf("Failed to create pod %s/%s: %v", clientPod.Namespace, clientPod.Name, err)
 	}
 	t.Cleanup(func() {
 		if err := kclient.Delete(context.TODO(), clientPod); err != nil {
 			if errors.IsNotFound(err) {
 				return
 			}
-			t.Errorf("failed to delete pod %s/%s: %v", clientPod.Namespace, clientPod.Name, err)
+			t.Errorf("Failed to delete pod %s/%s: %v", clientPod.Namespace, clientPod.Name, err)
 		}
 	})
 
-	// Test canary route and verify that the hello-openshift echo pod is running properly.
+	t.Log("Curl the canary route and verify that it sends the expected response...")
+	var lines []string
 	err = wait.PollImmediate(1*time.Second, 5*time.Minute, func() (bool, error) {
 		readCloser, err := client.CoreV1().Pods(clientPod.Namespace).GetLogs(clientPod.Name, &corev1.PodLogOptions{
 			Container: "curl",
@@ -103,14 +104,17 @@ func TestCanaryRoute(t *testing.T) {
 		if err != nil {
 			return false, nil
 		}
+
 		scanner := bufio.NewScanner(readCloser)
-		t.Cleanup(func() {
+		defer func() {
 			if err := readCloser.Close(); err != nil {
-				t.Errorf("failed to close reader for pod %s: %v", clientPod.Name, err)
+				t.Errorf("Failed to close reader for logs from pod %s/%s: %v", clientPod.Namespace, clientPod.Name, err)
 			}
-		})
+		}()
+
 		foundBody := false
 		foundRequestPortHeader := false
+		lines = []string{}
 		for scanner.Scan() {
 			line := scanner.Text()
 			if strings.Contains(line, canarycontroller.CanaryHealthcheckResponse) {
@@ -119,14 +123,19 @@ func TestCanaryRoute(t *testing.T) {
 			if strings.Contains(strings.ToLower(line), "x-request-port:") {
 				foundRequestPortHeader = true
 			}
-			if foundBody && foundRequestPortHeader {
-				return true, nil
-			}
+			lines = append(lines, line)
 		}
+
+		if foundBody && foundRequestPortHeader {
+			return true, nil
+		}
+
 		return false, nil
 	})
 	if err != nil {
-		t.Fatalf("failed to observe the expected canary response body: %v", err)
+		t.Logf("Got pods logs:\n%s", strings.Join(lines, "\n"))
+
+		t.Fatalf("Failed to observe the expected canary response body: %v", err)
 	}
 }