functional tests for guestfs command

The functional tests verify that the guestfs command can be run on filesystem and block based PVCs. The guestfs command should fail if the PVC is already in use by another pod. Signed-off-by: Alice Frosi <[email protected]>
alicefr · Jul 6, 2021 · dc81359 · dc81359
1 parent a033145
commit dc81359
Show file tree

Hide file tree

Showing 2 changed files with 178 additions and 0 deletions.
diff --git a/tests/storage/BUILD.bazel b/tests/storage/BUILD.bazel
@@ -6,6 +6,7 @@ go_library(
         "datavolume.go",
         "events.go",
         "framework.go",
+        "guestfs.go",
         "hotplug.go",
         "imageupload.go",
         "restore.go",
@@ -17,6 +18,7 @@ go_library(
     deps = [
         "//pkg/host-disk:go_default_library",
         "//pkg/virt-config:go_default_library",
+        "//pkg/virtctl/guestfs:go_default_library",
         "//pkg/virtctl/vm:go_default_library",
         "//staging/src/kubevirt.io/client-go/api/v1:go_default_library",
         "//staging/src/kubevirt.io/client-go/apis/snapshot/v1alpha1:go_default_library",

diff --git a/tests/storage/guestfs.go b/tests/storage/guestfs.go
@@ -0,0 +1,176 @@
+package storage
+
+import (
+	"context"
+
+	"strings"
+	"time"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+
+	corev1 "k8s.io/api/core/v1"
+	k8sv1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/api/resource"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	"kubevirt.io/client-go/kubecli"
+	"kubevirt.io/kubevirt/pkg/virtctl/guestfs"
+	"kubevirt.io/kubevirt/tests"
+	"kubevirt.io/kubevirt/tests/util"
+)
+
+type fakeAttacher struct {
+	done chan bool
+}
+
+// fakeCreateAttacher simulates the attacher to the pod console. It has to block until the test terminates.
+func (f *fakeAttacher) fakeCreateAttacher(client *guestfs.K8sClient, p *corev1.Pod, command string) error {
+	<-f.done
+	return nil
+}
+
+func (f *fakeAttacher) closeChannel() {
+	f.done <- true
+}
+
+var _ = SIGDescribe("[rfe_id:6364][[Serial]Guestfs", func() {
+	var (
+		virtClient kubecli.KubevirtClient
+		pvcClaim   string
+	)
+	execCommandLibguestfsPod := func(podName string, c []string) (string, string, error) {
+		pod, err := virtClient.CoreV1().Pods(util.NamespaceTestDefault).Get(context.Background(), podName, metav1.GetOptions{})
+		Expect(err).ToNot(HaveOccurred())
+		return tests.ExecuteCommandOnPodV2(virtClient, pod, "libguestfs", c)
+	}
+
+	createPVCFilesystem := func(name string) *corev1.PersistentVolumeClaim {
+		quantity, _ := resource.ParseQuantity("500Mi")
+		return &corev1.PersistentVolumeClaim{
+			ObjectMeta: metav1.ObjectMeta{Name: name},
+			Spec: corev1.PersistentVolumeClaimSpec{
+				AccessModes: []corev1.PersistentVolumeAccessMode{corev1.ReadWriteOnce},
+				Resources: corev1.ResourceRequirements{
+					Requests: corev1.ResourceList{
+						"storage": quantity,
+					},
+				},
+			},
+		}
+
+	}
+
+	createFakeAttacher := func() *fakeAttacher {
+		f := &fakeAttacher{}
+		f.done = make(chan bool, 1)
+		guestfs.SetAttacher(f.fakeCreateAttacher)
+		return f
+	}
+
+	runGuestfsOnPVC := func(pvcClaim string) {
+		podName := "libguestfs-tools-" + pvcClaim
+		guestfsCmd := tests.NewVirtctlCommand("guestfs",
+			pvcClaim,
+			"--namespace", util.NamespaceTestDefault)
+		go func() {
+			defer GinkgoRecover()
+			Expect(guestfsCmd.Execute()).ToNot(HaveOccurred())
+		}()
+		// Waiting until the libguestfs pod is running
+		Eventually(func() corev1.PodPhase {
+			pod, _ := virtClient.CoreV1().Pods(util.NamespaceTestDefault).Get(context.Background(), podName, metav1.GetOptions{})
+			return pod.Status.Phase
+		}, 90*time.Second, 2*time.Second).Should(Equal(k8sv1.PodRunning))
+		// Verify that the appliance has been extracted before running any tests
+		Eventually(func() bool {
+			output, _, err := execCommandLibguestfsPod(podName, []string{"ls", "/usr/local/lib/guestfs/appliance"})
+			Expect(err).ToNot(HaveOccurred())
+			if strings.Contains(output, "kernel") {
+				return true
+			}
+			return false
+		}, 30*time.Second, 2*time.Second).Should(BeTrue())
+
+	}
+
+	createGuestfsWithPVC := func(pvc *corev1.PersistentVolumeClaim) {
+		var err error
+		_, err = virtClient.CoreV1().PersistentVolumeClaims(util.NamespaceTestDefault).Create(context.Background(), pvc, metav1.CreateOptions{})
+		Expect(err).ToNot(HaveOccurred())
+		runGuestfsOnPVC(pvc.ObjectMeta.Name)
+
+	}
+
+	Context("Run libguestfs on PVCs", func() {
+		BeforeEach(func() {
+			var err error
+			virtClient, err = kubecli.GetKubevirtClient()
+			Expect(err).ToNot(HaveOccurred())
+
+		}, 120)
+
+		AfterEach(func() {
+			err := virtClient.CoreV1().PersistentVolumeClaims(util.NamespaceTestDefault).Delete(context.Background(), pvcClaim, metav1.DeleteOptions{})
+			Expect(err).ToNot(HaveOccurred())
+		})
+
+		// libguestfs-test-tool verifies the setup to run libguestfs-tools
+		It("Should successfully run libguestfs-test-tool", func() {
+			f := createFakeAttacher()
+			defer f.closeChannel()
+			pvcClaim = "pvc-verify"
+			pvc := createPVCFilesystem(pvcClaim)
+			createGuestfsWithPVC(pvc)
+			output, _, err := execCommandLibguestfsPod("libguestfs-tools-"+pvcClaim, []string{"libguestfs-test-tool"})
+			Expect(err).ToNot(HaveOccurred())
+			Expect(output).To(ContainSubstring("===== TEST FINISHED OK ====="))
+
+		})
+
+		It("[posneg:positive][test_id:6480]Should successfully run guestfs command on a filesystem-based PVC", func() {
+			f := createFakeAttacher()
+			defer f.closeChannel()
+			pvcClaim = "pvc-fs"
+			podName := "libguestfs-tools-" + pvcClaim
+			pvc := createPVCFilesystem(pvcClaim)
+			createGuestfsWithPVC(pvc)
+			stdout, stderr, err := execCommandLibguestfsPod(podName, []string{"qemu-img", "create", "/disk/disk.img", "500M"})
+			Expect(stderr).To(Equal(""))
+			Expect(stdout).To(ContainSubstring("Formatting"))
+			Expect(err).ToNot(HaveOccurred())
+			stdout, stderr, err = execCommandLibguestfsPod(podName, []string{"guestfish", "-a", "/disk/disk.img", "run"})
+			Expect(stderr).To(Equal(""))
+			Expect(stdout).To(Equal(""))
+			Expect(err).ToNot(HaveOccurred())
+
+		})
+
+		It("[posneg:negative][test_id:6480]Should fail to run the guestfs command on a PVC in use", func() {
+			f := createFakeAttacher()
+			defer f.closeChannel()
+			pvcClaim = "pvc-fail-to-run-twice"
+			pvc := createPVCFilesystem(pvcClaim)
+			createGuestfsWithPVC(pvc)
+			guestfsCmd := tests.NewVirtctlCommand("guestfs",
+				pvcClaim,
+				"--namespace", util.NamespaceTestDefault)
+			Expect(guestfsCmd.Execute()).To(HaveOccurred())
+		})
+
+		It("[posneg:positive][test_id:6479]Should successfully run guestfs command on a block-based PVC", func() {
+			f := createFakeAttacher()
+			defer f.closeChannel()
+			pvcClaim = tests.BlockDiskForTest
+			podName := "libguestfs-tools-" + pvcClaim
+			tests.CreateBlockVolumePvAndPvc("500Mi")
+			runGuestfsOnPVC(pvcClaim)
+			stdout, stderr, err := execCommandLibguestfsPod(podName, []string{"guestfish", "-a", "/dev/vda", "run"})
+			Expect(stderr).To(Equal(""))
+			Expect(stdout).To(Equal(""))
+			Expect(err).ToNot(HaveOccurred())
+
+		})
+
+	})
+})