sanity/controller.go: Add idempotency loop for controller operations

Add idempotency-testing loops for controller operations.
Move Create-Publish-Unpublish-Delete cycle into a function,
which is called with argument specifying repetition count.

Author: okartau

pkg/sanity/controller.go

@@ -123,6 +123,13 @@ var _ = DescribeSanity("Controller Service [Controller Server]", func(sc *TestCo
 	AfterEach(func() {
 		cl.DeleteVolumes()
 	})
+	idempotentcount := sc.Config.IdempotentCount
+	// Negative value for Idempotency repeat count means "skip idempotency testing"
+	// We also do not want zero as that would skip as well, so in special cases we
+	// reset the loop count to 1 to make this happen as regular testing.
+	if idempotentcount < 1 {
+		idempotentcount = 1
+	}
 
 	Describe("ControllerGetCapabilities", func() {
 		It("should return appropriate capabilities", func() {
@@ -1065,90 +1072,14 @@ var _ = DescribeSanity("Controller Service [Controller Server]", func(sc *TestCo
 			Expect(serverError.Code()).To(Equal(codes.InvalidArgument))
 		})
 
-		// CSI spec poses no specific requirements for the cluster/storage setups that a SP MUST support. To perform
-		// meaningful checks the following test assumes that topology-aware provisioning on a single node setup is supported
 		It("should return appropriate values (no optional values added)", func() {
+			By("lifecycle once")
+			VolumeLifecycle(n, c, sc, cl, 1)
+		})
 
-			By("getting node information")
-			ni, err := n.NodeGetInfo(
-				context.Background(),
-				&csi.NodeGetInfoRequest{})
-			Expect(err).NotTo(HaveOccurred())
-			Expect(ni).NotTo(BeNil())
-			Expect(ni.GetNodeId()).NotTo(BeEmpty())
-
-			var accReqs *csi.TopologyRequirement
-			if ni.AccessibleTopology != nil {
-				// Topology requirements are honored if provided by the driver
-				accReqs = &csi.TopologyRequirement{
-					Requisite: []*csi.Topology{ni.AccessibleTopology},
-				}
-			}
-
-			// Create Volume First
-			By("creating a single node writer volume")
-			name := UniqueString("sanity-controller-publish")
-
-			vol, err := c.CreateVolume(
-				context.Background(),
-				&csi.CreateVolumeRequest{
-					Name: name,
-					VolumeCapabilities: []*csi.VolumeCapability{
-						TestVolumeCapabilityWithAccessType(sc, csi.VolumeCapability_AccessMode_SINGLE_NODE_WRITER),
-					},
-					Secrets:                   sc.Secrets.CreateVolumeSecret,
-					Parameters:                sc.Config.TestVolumeParameters,
-					AccessibilityRequirements: accReqs,
-				},
-			)
-			Expect(err).NotTo(HaveOccurred())
-			Expect(vol).NotTo(BeNil())
-			Expect(vol.GetVolume()).NotTo(BeNil())
-			Expect(vol.GetVolume().GetVolumeId()).NotTo(BeEmpty())
-			cl.RegisterVolume(name, VolumeInfo{VolumeID: vol.GetVolume().GetVolumeId()})
-
-			// ControllerPublishVolume
-			By("calling controllerpublish on that volume")
-
-			conpubvol, err := c.ControllerPublishVolume(
-				context.Background(),
-				&csi.ControllerPublishVolumeRequest{
-					VolumeId:         vol.GetVolume().GetVolumeId(),
-					NodeId:           ni.GetNodeId(),
-					VolumeCapability: TestVolumeCapabilityWithAccessType(sc, csi.VolumeCapability_AccessMode_SINGLE_NODE_WRITER),
-					Readonly:         false,
-					Secrets:          sc.Secrets.ControllerPublishVolumeSecret,
-				},
-			)
-			Expect(err).NotTo(HaveOccurred())
-			cl.RegisterVolume(name, VolumeInfo{VolumeID: vol.GetVolume().GetVolumeId(), NodeID: ni.GetNodeId()})
-			Expect(conpubvol).NotTo(BeNil())
-
-			By("cleaning up unpublishing the volume")
-
-			conunpubvol, err := c.ControllerUnpublishVolume(
-				context.Background(),
-				&csi.ControllerUnpublishVolumeRequest{
-					VolumeId: vol.GetVolume().GetVolumeId(),
-					// NodeID is optional in ControllerUnpublishVolume
-					NodeId:  ni.GetNodeId(),
-					Secrets: sc.Secrets.ControllerUnpublishVolumeSecret,
-				},
-			)
-			Expect(err).NotTo(HaveOccurred())
-			Expect(conunpubvol).NotTo(BeNil())
-
-			By("cleaning up deleting the volume")
-
-			_, err = c.DeleteVolume(
-				context.Background(),
-				&csi.DeleteVolumeRequest{
-					VolumeId: vol.GetVolume().GetVolumeId(),
-					Secrets:  sc.Secrets.DeleteVolumeSecret,
-				},
-			)
-			Expect(err).NotTo(HaveOccurred())
-			cl.UnregisterVolume(name)
+		It("should return appropriate values (no optional values added), with idempotency", func() {
+			By("lifecycle repeated")
+			VolumeLifecycle(n, c, sc, cl, idempotentcount)
 		})
 
 		It("should fail when publishing more volumes than the node max attach limit", func() {
@@ -2065,3 +1996,92 @@ func ControllerUnpublishAndDeleteVolume(sc *TestContext, c csi.ControllerClient,
 	Expect(err).NotTo(HaveOccurred())
 	return err
 }
+
+// VolumeLifecycle performs Create-Publish-Unpublish-Delete, with optional repeat count to test idempotency.
+func VolumeLifecycle(n csi.NodeClient, c csi.ControllerClient, sc *TestContext, cl *Cleanup, count int) {
+	// CSI spec poses no specific requirements for the cluster/storage setups that a SP MUST support. To perform
+	// meaningful checks the following test assumes that topology-aware provisioning on a single node setup is supported
+	By("getting node information")
+	ni, err := n.NodeGetInfo(
+		context.Background(),
+		&csi.NodeGetInfoRequest{})
+	Expect(err).NotTo(HaveOccurred())
+	Expect(ni).NotTo(BeNil())
+	Expect(ni.GetNodeId()).NotTo(BeEmpty())
+
+	var accReqs *csi.TopologyRequirement
+	if ni.AccessibleTopology != nil {
+		// Topology requirements are honored if provided by the driver
+		accReqs = &csi.TopologyRequirement{
+			Requisite: []*csi.Topology{ni.AccessibleTopology},
+		}
+	}
+
+	// Create Volume First
+	By("creating a single node writer volume")
+	name := UniqueString("sanity-controller-publish")
+
+	vol, err := c.CreateVolume(
+		context.Background(),
+		&csi.CreateVolumeRequest{
+			Name: name,
+			VolumeCapabilities: []*csi.VolumeCapability{
+				TestVolumeCapabilityWithAccessType(sc, csi.VolumeCapability_AccessMode_SINGLE_NODE_WRITER),
+			},
+			Secrets:                   sc.Secrets.CreateVolumeSecret,
+			Parameters:                sc.Config.TestVolumeParameters,
+			AccessibilityRequirements: accReqs,
+		},
+	)
+	Expect(err).NotTo(HaveOccurred())
+	Expect(vol).NotTo(BeNil())
+	Expect(vol.GetVolume()).NotTo(BeNil())
+	Expect(vol.GetVolume().GetVolumeId()).NotTo(BeEmpty())
+	cl.RegisterVolume(name, VolumeInfo{VolumeID: vol.GetVolume().GetVolumeId()})
+
+	// ControllerPublishVolume
+	for i := 0; i < count; i++ {
+		By("calling controllerpublish on that volume")
+		conpubvol, err := c.ControllerPublishVolume(
+			context.Background(),
+			&csi.ControllerPublishVolumeRequest{
+				VolumeId:         vol.GetVolume().GetVolumeId(),
+				NodeId:           ni.GetNodeId(),
+				VolumeCapability: TestVolumeCapabilityWithAccessType(sc, csi.VolumeCapability_AccessMode_SINGLE_NODE_WRITER),
+				Readonly:         false,
+				Secrets:          sc.Secrets.ControllerPublishVolumeSecret,
+			},
+		)
+		Expect(err).NotTo(HaveOccurred())
+		Expect(conpubvol).NotTo(BeNil())
+	}
+	cl.RegisterVolume(name, VolumeInfo{VolumeID: vol.GetVolume().GetVolumeId(), NodeID: ni.GetNodeId()})
+
+	for i := 0; i < count; i++ {
+		By("cleaning up unpublishing the volume")
+		conunpubvol, err := c.ControllerUnpublishVolume(
+			context.Background(),
+			&csi.ControllerUnpublishVolumeRequest{
+				VolumeId: vol.GetVolume().GetVolumeId(),
+				// NodeID is optional in ControllerUnpublishVolume
+				NodeId:  ni.GetNodeId(),
+				Secrets: sc.Secrets.ControllerUnpublishVolumeSecret,
+			},
+		)
+		Expect(err).NotTo(HaveOccurred())
+		Expect(conunpubvol).NotTo(BeNil())
+	}
+
+	for i := 0; i < count; i++ {
+		By("cleaning up deleting the volume")
+		_, err = c.DeleteVolume(
+			context.Background(),
+			&csi.DeleteVolumeRequest{
+				VolumeId: vol.GetVolume().GetVolumeId(),
+				Secrets:  sc.Secrets.DeleteVolumeSecret,
+			},
+		)
+		Expect(err).NotTo(HaveOccurred())
+	}
+	cl.UnregisterVolume(name)
+}