test: add pods and descriptions dump (#1519)

This is required to get more information about the state of test case resources when a test fails.

Signed-off-by: Roman Sysoev <[email protected]>
(cherry picked from commit 0ed00cf)

Author: hardcoretime

tests/e2e/affinity_toleration_test.go

@@ -71,7 +71,7 @@ var _ = Describe("VirtualMachineAffinityAndToleration", framework.CommonE2ETestD
 
 	AfterEach(func() {
 		if CurrentSpecReport().Failed() {
-			SaveTestResources(testCaseLabel, CurrentSpecReport().LeafNodeText)
+			SaveTestCaseDump(testCaseLabel, CurrentSpecReport().LeafNodeText, ns)
 		}
 	})
 

tests/e2e/complex_test.go

@@ -44,7 +44,7 @@ var _ = Describe("ComplexTest", Serial, framework.CommonE2ETestDecorators(), fun
 
 	AfterEach(func() {
 		if CurrentSpecReport().Failed() {
-			SaveTestResources(testCaseLabel, CurrentSpecReport().LeafNodeText)
+			SaveTestCaseDump(testCaseLabel, CurrentSpecReport().LeafNodeText, ns)
 		}
 	})
 

tests/e2e/image_hotplug_test.go

@@ -69,7 +69,7 @@ var _ = Describe("ImageHotplug", framework.CommonE2ETestDecorators(), func() {
 
 	AfterEach(func() {
 		if CurrentSpecReport().Failed() {
-			SaveTestResources(testCaseLabel, CurrentSpecReport().LeafNodeText)
+			SaveTestCaseDump(testCaseLabel, CurrentSpecReport().LeafNodeText, ns)
 		}
 	})
 

tests/e2e/images_creation_test.go

@@ -69,7 +69,7 @@ var _ = Describe("VirtualImageCreation", framework.CommonE2ETestDecorators(), fu
 
 	AfterEach(func() {
 		if CurrentSpecReport().Failed() {
-			SaveTestResources(testCaseLabel, CurrentSpecReport().LeafNodeText)
+			SaveTestCaseDump(testCaseLabel, CurrentSpecReport().LeafNodeText, ns)
 		}
 	})
 

tests/e2e/importer_network_policy_test.go

@@ -53,7 +53,7 @@ var _ = Describe("ImporterNetworkPolicy", framework.CommonE2ETestDecorators(), f
 
 	AfterEach(func() {
 		if CurrentSpecReport().Failed() {
-			SaveTestResources(testCaseLabel, CurrentSpecReport().LeafNodeText)
+			SaveTestCaseDump(testCaseLabel, CurrentSpecReport().LeafNodeText, ns)
 		}
 	})
 

tests/e2e/kubectl/kubectl.go

@@ -93,11 +93,12 @@ type DeleteOptions struct {
 }
 
 type GetOptions struct {
-	ExcludedLabels []string
-	IgnoreNotFound bool
-	Labels         map[string]string
-	Namespace      string
-	Output         string
+	ExcludedLabels    []string
+	IgnoreNotFound    bool
+	Labels            map[string]string
+	Namespace         string
+	Output            string
+	ShowManagedFields bool
 }
 
 type LogOptions struct {
@@ -368,6 +369,13 @@ func (k KubectlCMD) addFollow(cmd string, follow bool) string {
 	return cmd
 }
 
+func (k KubectlCMD) addShowManagedFields(cmd string, showManagedFields bool) string {
+	if showManagedFields {
+		return fmt.Sprintf("%s --show-managed-fields=true", cmd)
+	}
+	return cmd
+}
+
 func (k KubectlCMD) applyOptions(cmd string, opts ApplyOptions) string {
 	var resourceEmptyValue Resource = ""
 	cmd = k.addFilenameOptions(cmd, resourceEmptyValue, opts.FilenameOption, opts.Recursive, opts.Filename...)
@@ -387,6 +395,7 @@ func (k KubectlCMD) getOptions(cmd string, opts GetOptions) string {
 	cmd = k.addOutput(cmd, opts.Output)
 	cmd = k.addIgnoreNotFound(cmd, opts.IgnoreNotFound)
 	cmd = k.addLabels(cmd, opts.Labels, opts.ExcludedLabels)
+	cmd = k.addShowManagedFields(cmd, opts.ShowManagedFields)
 	return cmd
 }
 

tests/e2e/sizing_policy_test.go

@@ -72,7 +72,7 @@ var _ = Describe("SizingPolicy", framework.CommonE2ETestDecorators(), func() {
 
 	AfterEach(func() {
 		if CurrentSpecReport().Failed() {
-			SaveTestResources(testCaseLabel, CurrentSpecReport().LeafNodeText)
+			SaveTestCaseDump(testCaseLabel, CurrentSpecReport().LeafNodeText, ns)
 		}
 	})
 

tests/e2e/util_test.go

@@ -731,11 +731,11 @@ func IsContainsLabelWithValue(obj client.Object, label, value string) bool {
 	return ok && val == value
 }
 
-// SaveTestResources dump some resources that may help in further diagnostic.
+// SaveTestCaseDump dump some resources, logs and descriptions that may help in further diagnostic.
 //
 // NOTE: This method is called in AfterEach for failed specs only. Avoid to use Expect,
 // as it fails without reporting. Better use GinkgoWriter to report errors at this point.
-func SaveTestResources(labels map[string]string, additional string) {
+func SaveTestCaseDump(labels map[string]string, additional, namespace string) {
 	replacer := strings.NewReplacer(
 		" ", "_",
 		":", "_",
@@ -753,10 +753,24 @@ func SaveTestResources(labels map[string]string, additional string) {
 	if tmpDir == "" {
 		tmpDir = "/tmp"
 	}
-	resFileName := fmt.Sprintf("%s/e2e_failed__%s__%s.yaml", tmpDir, labels["testcase"], additional)
-	errorFileName := fmt.Sprintf("%s/e2e_failed__%s__%s_error.txt", tmpDir, labels["testcase"], additional)
 
-	cmdr := kubectl.Get("virtualization,intvirt,po,volumesnapshot -A", kc.GetOptions{Output: "yaml", Labels: labels})
+	SaveTestCaseResources(labels, additional, namespace, tmpDir)
+	SavePodLogsAndDescriptions(labels, additional, namespace, tmpDir)
+}
+
+func SaveTestCaseResources(labels map[string]string, additional, namespace, dumpPath string) {
+	resFileName := fmt.Sprintf("%s/e2e_failed__%s__%s.yaml", dumpPath, labels["testcase"], additional)
+	errorFileName := fmt.Sprintf("%s/e2e_failed__%s__%s_error.txt", dumpPath, labels["testcase"], additional)
+
+	cmdr := kubectl.Get(
+		"virtualization,cvi,vmc,intvirt,pod,volumesnapshot",
+		kc.GetOptions{
+			Labels:            labels,
+			Namespace:         namespace,
+			Output:            "yaml",
+			ShowManagedFields: true,
+		},
+	)
 	if cmdr.Error() != nil {
 		errReport := fmt.Sprintf("cmd: %s\nerror: %s\nstderr: %s\n", cmdr.GetCmd(), cmdr.Error(), cmdr.StdErr())
 		GinkgoWriter.Printf("Get resources error:\n%s\n", errReport)
@@ -775,6 +789,42 @@ func SaveTestResources(labels map[string]string, additional string) {
 	}
 }
 
+func SavePodLogsAndDescriptions(labels map[string]string, additional, namespace, dumpPath string) {
+	pods := &corev1.PodList{}
+	err := GetObjects(kc.ResourcePod, pods, kc.GetOptions{Namespace: namespace, Labels: labels})
+	if err != nil {
+		GinkgoWriter.Printf("Failed to get PodList:\n%s\n", err)
+	}
+
+	if len(pods.Items) == 0 {
+		GinkgoWriter.Println("The list of pods is empty; nothing to dump.")
+	}
+
+	for _, pod := range pods.Items {
+		logCmd := kubectl.RawCommand(fmt.Sprintf("logs %s --namespace %s", pod.Name, pod.Namespace), framework.ShortTimeout)
+		if logCmd.Error() != nil {
+			GinkgoWriter.Printf("Failed to get logs:\nPodName: %s\nError: %s\n", pod.Name, logCmd.StdErr())
+		}
+
+		fileName := fmt.Sprintf("%s/e2e_failed__%s__%s__%s__logs.json", dumpPath, labels["testcase"], additional, pod.Name)
+		err := os.WriteFile(fileName, logCmd.StdOutBytes(), 0o644)
+		if err != nil {
+			GinkgoWriter.Printf("Failed to save logs:\nPodName: %s\nError: %s\n", pod.Name, err)
+		}
+
+		describeCmd := kubectl.RawCommand(fmt.Sprintf("describe pod %s --namespace %s", pod.Name, pod.Namespace), framework.ShortTimeout)
+		if describeCmd.Error() != nil {
+			GinkgoWriter.Printf("Failed to describe pod:\nPodName: %s\nError: %s\n", pod.Name, describeCmd.StdErr())
+		}
+
+		fileName = fmt.Sprintf("%s/e2e_failed__%s__%s__%s__describe", dumpPath, labels["testcase"], additional, pod.Name)
+		err = os.WriteFile(fileName, describeCmd.StdOutBytes(), 0o644)
+		if err != nil {
+			GinkgoWriter.Printf("Failed to save pod description:\nPodName: %s\nError: %s\n", pod.Name, err)
+		}
+	}
+}
+
 type Watcher interface {
 	Watch(ctx context.Context, opts metav1.ListOptions) (watch.Interface, error)
 }

tests/e2e/vd_snapshots_test.go

@@ -77,7 +77,7 @@ var _ = Describe("VirtualDiskSnapshots", framework.CommonE2ETestDecorators(), fu
 
 	AfterEach(func() {
 		if CurrentSpecReport().Failed() {
-			SaveTestResources(testCaseLabel, CurrentSpecReport().LeafNodeText)
+			SaveTestCaseDump(testCaseLabel, CurrentSpecReport().LeafNodeText, ns)
 		}
 	})
 

tests/e2e/vm_configuration_test.go

@@ -57,7 +57,7 @@ var _ = Describe(fmt.Sprintf("VirtualMachineConfiguration %d", GinkgoParallelPro
 
 	AfterEach(func() {
 		if CurrentSpecReport().Failed() {
-			SaveTestResources(testCaseLabel, CurrentSpecReport().LeafNodeText)
+			SaveTestCaseDump(testCaseLabel, CurrentSpecReport().LeafNodeText, ns)
 		}
 	})