DeviceManager/LVM: Added unit tests

Author: avalluri

Gopkg.lock

@@ -44,6 +44,10 @@
   name = "github.com/kubernetes-csi/csi-test"
   version = "2.1.0"
 
+[[constraint]]
+  name = "gopkg.in/freddierice/go-losetup.v1"
+  branch = "v1"
+
 # We have to select the right version by name because of the "kubernetes-" prefix, dep doesn't
 # recognize these as normal releases. Upstream is considering to change the tagging,
 # see https://github.com/kubernetes/kubernetes/issues/72638.

Gopkg.toml

@@ -61,6 +61,10 @@ func NewPmemDeviceManagerLVM() (PmemDeviceManager, error) {
 	}
 	ctx.Free()
 
+	return NewPmemDeviceManagerLVMForVGs(volumeGroups)
+}
+
+func NewPmemDeviceManagerLVMForVGs(volumeGroups []string) (PmemDeviceManager, error) {
 	devices, err := listDevices(volumeGroups...)
 	if err != nil {
 		return nil, err

pkg/pmem-device-manager/pmd-lvm.go

@@ -0,0 +1,229 @@
+/*
+Copyright 2019  Intel Corporation.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+package pmdmanager_test
+
+import (
+	"fmt"
+	"io/ioutil"
+	"math/rand"
+	"os"
+	"testing"
+
+	pmdmanager "github.com/intel/pmem-csi/pkg/pmem-device-manager"
+	pmemexec "github.com/intel/pmem-csi/pkg/pmem-exec"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	losetup "gopkg.in/freddierice/go-losetup.v1"
+)
+
+const (
+	vgname = "test-group"
+	nsmode = "fsdax"
+	vgsize = uint64(1) * 1024 * 1024 * 1024 // 1Gb
+)
+
+func TestPmdLVM(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "PMEM LVM Suite")
+}
+
+var _ = Describe("DeviceManage LVM", func() {
+	var dm pmdmanager.PmemDeviceManager
+	var vg *testVGS
+	var err error
+
+	BeforeEach(func() {
+		vg, err = createTestVGS(vgname, nsmode, vgsize)
+		Expect(err).Should(BeNil(), "Failed to create volume group")
+
+		dm, err = pmdmanager.NewPmemDeviceManagerLVMForVGs([]string{vg.name})
+		Expect(err).Should(BeNil(), "Failed to create LVM device manager")
+	})
+
+	AfterEach(func() {
+		if err = vg.Clean(); err != nil {
+			// Failed to clean
+		}
+	})
+
+	Context("LVM", func() {
+		It("Should create a new device", func() {
+			name := "test-dev"
+			size := uint64(2) * 1024 * 1024 // 2Mb
+			err := dm.CreateDevice(name, size, nsmode)
+			Expect(err).Should(BeNil(), "Failed to create new device")
+
+			dev, err := dm.GetDevice(name)
+			Expect(err).Should(BeNil(), "Failed to retrieve device info")
+			Expect(dev.Name).Should(Equal(name), "Name mismatch")
+			Expect(dev.Size >= size).Should(BeTrue(), "Size mismatch")
+			Expect(dev.Path).ShouldNot(BeNil(), "Null device path")
+		})
+
+		It("Should fail to retrieve non-existent device", func() {
+			_, err := dm.GetDevice("unknown")
+			Expect(err).ShouldNot(BeNil(), "Error expected")
+			//Expect(os.IsNotExist(err.Cause())).Should(BeTrue(), "expected error is os.ErrNotExist")
+			//Expect(dev).Should(BeNil(), "returned device should be nil")
+		})
+
+		It("Should list devices", func() {
+			max_devices := 4
+			max_deletes := 2
+			sizes := map[string]uint64{}
+
+			list, err := dm.ListDevices()
+			Expect(err).Should(BeNil(), "Failed to list devices")
+			Expect(len(list)).Should(BeEquivalentTo(0), "count mismatch")
+
+			for i := 1; i <= max_devices; i++ {
+				name := fmt.Sprintf("list-dev-%d", i)
+				sizes[name] = rand.Uint64() % 16 * 1024 * 1024
+				err := dm.CreateDevice(name, sizes[name], nsmode)
+				Expect(err).Should(BeNil(), "Failed to create new device")
+			}
+			list, err = dm.ListDevices()
+			Expect(err).Should(BeNil(), "Failed to list devices")
+			Expect(len(list)).Should(BeEquivalentTo(max_devices), "count mismatch")
+			for _, dev := range list {
+				size, ok := sizes[dev.Name]
+				Expect(ok).Should(BeTrue(), "Unexpected device name:"+dev.Name)
+				Expect(dev.Size >= size).Should(BeTrue(), "Device size mismatch")
+			}
+
+			for i := 1; i <= max_deletes; i++ {
+				name := fmt.Sprintf("list-dev-%d", i)
+				delete(sizes, name)
+				err = dm.DeleteDevice(name, false)
+				Expect(err).Should(BeNil(), "Error while deleting device '"+name+"'")
+			}
+
+			// List device after deleting a device
+			list, err = dm.ListDevices()
+			Expect(err).Should(BeNil(), "Failed to list devices")
+			Expect(len(list)).Should(BeEquivalentTo(max_devices-max_deletes), "count mismatch")
+			for _, dev := range list {
+				size, ok := sizes[dev.Name]
+				Expect(ok).Should(BeTrue(), "Unexpected device name:"+dev.Name)
+				Expect(dev.Size >= size).Should(BeTrue(), "Device size mismatch")
+			}
+		})
+
+		It("Should delete devices", func() {
+			name := "delete-dev"
+			size := uint64(2) * 1024 * 1024 // 2Mb
+			err := dm.CreateDevice(name, size, nsmode)
+			Expect(err).Should(BeNil(), "Failed to create new device")
+
+			dev, err := dm.GetDevice(name)
+			Expect(err).Should(BeNil(), "Failed to retrieve device info")
+			Expect(dev.Name).Should(Equal(name), "Name mismatch")
+			Expect(dev.Size >= size).Should(BeTrue(), "Size mismatch")
+			Expect(dev.Path).ShouldNot(BeNil(), "Null device path")
+
+			err = dm.DeleteDevice(name, true)
+			Expect(err).Should(BeNil(), "Failed to delete device")
+
+			_, err = dm.GetDevice(name)
+			Expect(err).ShouldNot(BeNil(), "GetDevice() should fail on deleted device")
+			//Expect(os.IsNotExist(errors.Cause())).Should(BeTrue(), "expected error is os.ErrNotExist")
+			//Expect(dev).Should(BeNil(), "returned device should be nil")
+
+			err = dm.DeleteDevice(name, true)
+			Expect(err).Should(BeNil(), "DeleteDevice() is not idempotent")
+		})
+	})
+})
+
+type testVGS struct {
+	name       string
+	loopDev    losetup.Device
+	backedFile string
+}
+
+func createTestVGS(vgname, nsmode string, size uint64) (*testVGS, error) {
+	var err error
+	var file *os.File
+	var dev losetup.Device
+
+	By("Creating temporary file")
+	if file, err = ioutil.TempFile("", "test-lvm-dev"); err != nil {
+		return nil, err
+	}
+
+	defer func() {
+		if err != nil && file != nil {
+			os.Remove(file.Name())
+		}
+	}()
+
+	By("Closing file")
+	if err = file.Close(); err != nil {
+		return nil, err
+	}
+
+	By("File truncating")
+	if err = os.Truncate(file.Name(), int64(size)); err != nil {
+		return nil, err
+	}
+
+	By("losetup.Attach")
+	dev, err = losetup.Attach(file.Name(), 0, false)
+	if err != nil {
+		return nil, err
+	}
+
+	defer func() {
+		if err != nil {
+			By("losetup.Detach")
+			dev.Detach() // nolint errcheck
+		}
+	}()
+
+	By("Creating volume group")
+	// TODO: resuse vgm code
+	cmdArgs := []string{"--force", vgname, dev.Path()}
+	if _, err := pmemexec.RunCommand("vgcreate", cmdArgs...); err != nil { // nolint gosec
+		return nil, err
+	}
+
+	defer func() {
+		if err != nil {
+			By("Removing volume group")
+			pmemexec.RunCommand("vgremove", "--force", vgname)
+		}
+	}()
+
+	By("Append tag(s) to volume group")
+	if _, err = pmemexec.RunCommand("vgchange", "--addtag", string(nsmode), vgname); err != nil {
+		return nil, err
+	}
+
+	return &testVGS{
+		name:       vgname,
+		loopDev:    dev,
+		backedFile: file.Name(),
+	}, nil
+}
+
+func (vg *testVGS) Clean() error {
+	By("Removing volume group")
+	if _, err := pmemexec.RunCommand("vgremove", "--force", vg.name); err != nil {
+		return err
+	}
+
+	By("losetup.Detach()")
+	if err := vg.loopDev.Detach(); err != nil {
+		return err
+	}
+
+	By("Removing temp file")
+	if err := os.Remove(vg.backedFile); err != nil {
+		return err
+	}
+
+	return nil
+}

pkg/pmem-device-manager/pmme-lvm_test.go

@@ -1,5 +1,6 @@
 TEST_CMD=go test
 TEST_ARGS=$(IMPORT_PATH)/pkg/...
+SUDO=$(shell [ $$(id -u) -eq 0 ] && echo env || echo sudo)
 
 .PHONY: vet
 test: vet
@@ -127,12 +128,17 @@ test_e2e: start
 
 # Execute simple unit tests.
 .PHONY: run_tests
-test: run_tests
+test: run_tests run_device_manager_tests
 RUN_TESTS = TEST_WORK=$(abspath _work) \
-	$(TEST_CMD) $(shell go list $(TEST_ARGS) | sed -e 's;$(IMPORT_PATH);.;')
+	$(TEST_CMD) $(shell go list $(TEST_ARGS) | grep -v pmem-device-manager | sed -e 's;$(IMPORT_PATH);.;')
+RUN_DM_TESTS = \
+    $(TEST_CMD) ./pkg/pmem-device-manager -exec $(SUDO)
 run_tests: _work/pmem-ca/.ca-stamp _work/evil-ca/.ca-stamp
 	$(RUN_TESTS)
 
+run_device_manager_tests:
+	$(RUN_DM_TESTS)
+
 _work/%/.ca-stamp: test/setup-ca.sh _work/.setupcfssl-stamp
 	rm -rf $(@D)
 	WORKDIR='$(@D)' PATH='$(PWD)/_work/bin/:$(PATH)' CA='$*' EXTRA_CNS="wrong-node-controller" $<

test/test.make

@@ -52,6 +52,7 @@ golang.org/x/time;golang time;BSD 3-clause "New" or "Revised" License
 google.golang.org/appengine;Golang appengine;Apache License 2.0
 google.golang.org/genproto;Google go-genproto;Apache License 2.0
 google.golang.org/grpc;grpc grpc-go;Apache License 2.0
+gopkg.in/freddierice/go-losetup.v1; Go losetup; MIt License
 gopkg.in/fsnotify.v1;fsnotify;BSD 3-clause "New" or "Revised" License
 gopkg.in/inf.v0;go-inf;BSD 3-clause "New" or "Revised" License
 gopkg.in/square/go-jose.v2;go-jose;Apache License 2.0