Add struct keys in PV controller tests

Signed-off-by: piroux <pierre.roux01@gmail.com>
2022-08-04 15:30:23 +02:00
parent aea9f9887d
commit 34b54e7646
5 changed files with 1091 additions and 894 deletions
--- a/pkg/controller/volume/persistentvolume/recycle_test.go
+++ b/pkg/controller/volume/persistentvolume/recycle_test.go
@@ -73,66 +73,73 @@ func TestRecycleSync(t *testing.T) {
 	tests := []controllerTest{
 		{
 			// recycle volume bound by controller
-			"6-1 - successful recycle",
-			newVolumeArray("volume6-1", "1Gi", "uid6-1", "claim6-1", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
-			newVolumeArray("volume6-1", "1Gi", "", "", v1.VolumeAvailable, v1.PersistentVolumeReclaimRecycle, classEmpty),
-			noclaims,
-			noclaims,
-			noevents, noerrors,
+			name:            "6-1 - successful recycle",
+			initialVolumes:  newVolumeArray("volume6-1", "1Gi", "uid6-1", "claim6-1", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
+			expectedVolumes: newVolumeArray("volume6-1", "1Gi", "", "", v1.VolumeAvailable, v1.PersistentVolumeReclaimRecycle, classEmpty),
+			initialClaims:   noclaims,
+			expectedClaims:  noclaims,
+			expectedEvents:  noevents,
+			errors:          noerrors,
 			// Inject recycler into the controller and call syncVolume. The
 			// recycler simulates one recycle() call that succeeds.
-			wrapTestWithReclaimCalls(operationRecycle, []error{nil}, testSyncVolume),
+			test: wrapTestWithReclaimCalls(operationRecycle, []error{nil}, testSyncVolume),
 		},
 		{
 			// recycle volume bound by user
-			"6-2 - successful recycle with prebound volume",
-			newVolumeArray("volume6-2", "1Gi", "uid6-2", "claim6-2", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty),
-			newVolumeArray("volume6-2", "1Gi", "", "claim6-2", v1.VolumeAvailable, v1.PersistentVolumeReclaimRecycle, classEmpty),
-			noclaims,
-			noclaims,
-			noevents, noerrors,
+			name:            "6-2 - successful recycle with prebound volume",
+			initialVolumes:  newVolumeArray("volume6-2", "1Gi", "uid6-2", "claim6-2", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty),
+			expectedVolumes: newVolumeArray("volume6-2", "1Gi", "", "claim6-2", v1.VolumeAvailable, v1.PersistentVolumeReclaimRecycle, classEmpty),
+			initialClaims:   noclaims,
+			expectedClaims:  noclaims,
+			expectedEvents:  noevents,
+			errors:          noerrors,
 			// Inject recycler into the controller and call syncVolume. The
 			// recycler simulates one recycle() call that succeeds.
-			wrapTestWithReclaimCalls(operationRecycle, []error{nil}, testSyncVolume),
+			test: wrapTestWithReclaimCalls(operationRecycle, []error{nil}, testSyncVolume),
 		},
 		{
 			// recycle failure - plugin not found
-			"6-3 - plugin not found",
-			newVolumeArray("volume6-3", "1Gi", "uid6-3", "claim6-3", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty),
-			withMessage("No recycler plugin found for the volume!", newVolumeArray("volume6-3", "1Gi", "uid6-3", "claim6-3", v1.VolumeFailed, v1.PersistentVolumeReclaimRecycle, classEmpty)),
-			noclaims,
-			noclaims,
-			[]string{"Warning VolumeFailedRecycle"}, noerrors, testSyncVolume,
+			name:            "6-3 - plugin not found",
+			initialVolumes:  newVolumeArray("volume6-3", "1Gi", "uid6-3", "claim6-3", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty),
+			expectedVolumes: withMessage("No recycler plugin found for the volume!", newVolumeArray("volume6-3", "1Gi", "uid6-3", "claim6-3", v1.VolumeFailed, v1.PersistentVolumeReclaimRecycle, classEmpty)),
+			initialClaims:   noclaims,
+			expectedClaims:  noclaims,
+			expectedEvents:  []string{"Warning VolumeFailedRecycle"},
+			errors:          noerrors,
+			test:            testSyncVolume,
 		},
 		{
 			// recycle failure - Recycle returns error
-			"6-4 - newRecycler returns error",
-			newVolumeArray("volume6-4", "1Gi", "uid6-4", "claim6-4", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty),
-			withMessage("Recycle failed: Mock plugin error: no recycleCalls configured", newVolumeArray("volume6-4", "1Gi", "uid6-4", "claim6-4", v1.VolumeFailed, v1.PersistentVolumeReclaimRecycle, classEmpty)),
-			noclaims,
-			noclaims,
-			[]string{"Warning VolumeFailedRecycle"}, noerrors,
-			wrapTestWithReclaimCalls(operationRecycle, []error{}, testSyncVolume),
+			name:            "6-4 - newRecycler returns error",
+			initialVolumes:  newVolumeArray("volume6-4", "1Gi", "uid6-4", "claim6-4", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty),
+			expectedVolumes: withMessage("Recycle failed: Mock plugin error: no recycleCalls configured", newVolumeArray("volume6-4", "1Gi", "uid6-4", "claim6-4", v1.VolumeFailed, v1.PersistentVolumeReclaimRecycle, classEmpty)),
+			initialClaims:   noclaims,
+			expectedClaims:  noclaims,
+			expectedEvents:  []string{"Warning VolumeFailedRecycle"},
+			errors:          noerrors,
+			test:            wrapTestWithReclaimCalls(operationRecycle, []error{}, testSyncVolume),
 		},
 		{
 			// recycle failure - recycle returns error
-			"6-5 - recycle returns error",
-			newVolumeArray("volume6-5", "1Gi", "uid6-5", "claim6-5", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty),
-			withMessage("Recycle failed: Mock recycle error", newVolumeArray("volume6-5", "1Gi", "uid6-5", "claim6-5", v1.VolumeFailed, v1.PersistentVolumeReclaimRecycle, classEmpty)),
-			noclaims,
-			noclaims,
-			[]string{"Warning VolumeFailedRecycle"}, noerrors,
-			wrapTestWithReclaimCalls(operationRecycle, []error{errors.New("Mock recycle error")}, testSyncVolume),
+			name:            "6-5 - recycle returns error",
+			initialVolumes:  newVolumeArray("volume6-5", "1Gi", "uid6-5", "claim6-5", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty),
+			expectedVolumes: withMessage("Recycle failed: Mock recycle error", newVolumeArray("volume6-5", "1Gi", "uid6-5", "claim6-5", v1.VolumeFailed, v1.PersistentVolumeReclaimRecycle, classEmpty)),
+			initialClaims:   noclaims,
+			expectedClaims:  noclaims,
+			expectedEvents:  []string{"Warning VolumeFailedRecycle"},
+			errors:          noerrors,
+			test:            wrapTestWithReclaimCalls(operationRecycle, []error{errors.New("Mock recycle error")}, testSyncVolume),
 		},
 		{
 			// recycle success(?) - volume is deleted before doRecycle() starts
-			"6-6 - volume is deleted before recycling",
-			newVolumeArray("volume6-6", "1Gi", "uid6-6", "claim6-6", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty),
-			novolumes,
-			noclaims,
-			noclaims,
-			noevents, noerrors,
-			wrapTestWithInjectedOperation(wrapTestWithReclaimCalls(operationRecycle, []error{}, testSyncVolume), func(ctrl *PersistentVolumeController, reactor *pvtesting.VolumeReactor) {
+			name:            "6-6 - volume is deleted before recycling",
+			initialVolumes:  newVolumeArray("volume6-6", "1Gi", "uid6-6", "claim6-6", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty),
+			expectedVolumes: novolumes,
+			initialClaims:   noclaims,
+			expectedClaims:  noclaims,
+			expectedEvents:  noevents,
+			errors:          noerrors,
+			test: wrapTestWithInjectedOperation(wrapTestWithReclaimCalls(operationRecycle, []error{}, testSyncVolume), func(ctrl *PersistentVolumeController, reactor *pvtesting.VolumeReactor) {
 				// Delete the volume before recycle operation starts
 				reactor.DeleteVolume("volume6-6")
 			}),
@@ -141,13 +148,14 @@ func TestRecycleSync(t *testing.T) {
 			// recycle success(?) - volume is recycled by previous recycler just
 			// at the time new doRecycle() starts. This simulates "volume no
 			// longer needs recycling, skipping".
-			"6-7 - volume is deleted before recycling",
-			newVolumeArray("volume6-7", "1Gi", "uid6-7", "claim6-7", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
-			newVolumeArray("volume6-7", "1Gi", "", "", v1.VolumeAvailable, v1.PersistentVolumeReclaimRecycle, classEmpty),
-			noclaims,
-			noclaims,
-			noevents, noerrors,
-			wrapTestWithInjectedOperation(wrapTestWithReclaimCalls(operationRecycle, []error{}, testSyncVolume), func(ctrl *PersistentVolumeController, reactor *pvtesting.VolumeReactor) {
+			name:            "6-7 - volume is deleted before recycling",
+			initialVolumes:  newVolumeArray("volume6-7", "1Gi", "uid6-7", "claim6-7", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
+			expectedVolumes: newVolumeArray("volume6-7", "1Gi", "", "", v1.VolumeAvailable, v1.PersistentVolumeReclaimRecycle, classEmpty),
+			initialClaims:   noclaims,
+			expectedClaims:  noclaims,
+			expectedEvents:  noevents,
+			errors:          noerrors,
+			test: wrapTestWithInjectedOperation(wrapTestWithReclaimCalls(operationRecycle, []error{}, testSyncVolume), func(ctrl *PersistentVolumeController, reactor *pvtesting.VolumeReactor) {
 				// Mark the volume as Available before the recycler starts
 				reactor.MarkVolumeAvailable("volume6-7")
 			}),
@@ -157,13 +165,14 @@ func TestRecycleSync(t *testing.T) {
 			// recycler just at the time new doRecycle() starts. This simulates
 			// "volume no longer needs recycling, skipping" with volume bound by
 			// user.
-			"6-8 - prebound volume is deleted before recycling",
-			newVolumeArray("volume6-8", "1Gi", "uid6-8", "claim6-8", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty),
-			newVolumeArray("volume6-8", "1Gi", "", "", v1.VolumeAvailable, v1.PersistentVolumeReclaimRecycle, classEmpty),
-			noclaims,
-			noclaims,
-			noevents, noerrors,
-			wrapTestWithInjectedOperation(wrapTestWithReclaimCalls(operationRecycle, []error{}, testSyncVolume), func(ctrl *PersistentVolumeController, reactor *pvtesting.VolumeReactor) {
+			name:            "6-8 - prebound volume is deleted before recycling",
+			initialVolumes:  newVolumeArray("volume6-8", "1Gi", "uid6-8", "claim6-8", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty),
+			expectedVolumes: newVolumeArray("volume6-8", "1Gi", "", "", v1.VolumeAvailable, v1.PersistentVolumeReclaimRecycle, classEmpty),
+			initialClaims:   noclaims,
+			expectedClaims:  noclaims,
+			expectedEvents:  noevents,
+			errors:          noerrors,
+			test: wrapTestWithInjectedOperation(wrapTestWithReclaimCalls(operationRecycle, []error{}, testSyncVolume), func(ctrl *PersistentVolumeController, reactor *pvtesting.VolumeReactor) {
 				// Mark the volume as Available before the recycler starts
 				reactor.MarkVolumeAvailable("volume6-8")
 			}),
@@ -171,64 +180,73 @@ func TestRecycleSync(t *testing.T) {
 		{
 			// recycle success - volume bound by user is recycled, while a new
 			// claim is created with another UID.
-			"6-9 - prebound volume is recycled while the claim exists",
-			newVolumeArray("volume6-9", "1Gi", "uid6-9", "claim6-9", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty),
-			newVolumeArray("volume6-9", "1Gi", "", "claim6-9", v1.VolumeAvailable, v1.PersistentVolumeReclaimRecycle, classEmpty),
-			newClaimArray("claim6-9", "uid6-9-x", "10Gi", "", v1.ClaimPending, nil),
-			newClaimArray("claim6-9", "uid6-9-x", "10Gi", "", v1.ClaimPending, nil),
-			noevents, noerrors,
+			name:            "6-9 - prebound volume is recycled while the claim exists",
+			initialVolumes:  newVolumeArray("volume6-9", "1Gi", "uid6-9", "claim6-9", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty),
+			expectedVolumes: newVolumeArray("volume6-9", "1Gi", "", "claim6-9", v1.VolumeAvailable, v1.PersistentVolumeReclaimRecycle, classEmpty),
+			initialClaims:   newClaimArray("claim6-9", "uid6-9-x", "10Gi", "", v1.ClaimPending, nil),
+			expectedClaims:  newClaimArray("claim6-9", "uid6-9-x", "10Gi", "", v1.ClaimPending, nil),
+			expectedEvents:  noevents,
+			errors:          noerrors,
 			// Inject recycler into the controller and call syncVolume. The
 			// recycler simulates one recycle() call that succeeds.
-			wrapTestWithReclaimCalls(operationRecycle, []error{nil}, testSyncVolume),
+			test: wrapTestWithReclaimCalls(operationRecycle, []error{nil}, testSyncVolume),
 		},
 		{
 			// volume has unknown reclaim policy - failure expected
-			"6-10 - unknown reclaim policy",
-			newVolumeArray("volume6-10", "1Gi", "uid6-10", "claim6-10", v1.VolumeBound, "Unknown", classEmpty),
-			withMessage("Volume has unrecognized PersistentVolumeReclaimPolicy", newVolumeArray("volume6-10", "1Gi", "uid6-10", "claim6-10", v1.VolumeFailed, "Unknown", classEmpty)),
-			noclaims,
-			noclaims,
-			[]string{"Warning VolumeUnknownReclaimPolicy"}, noerrors, testSyncVolume,
+			name:            "6-10 - unknown reclaim policy",
+			initialVolumes:  newVolumeArray("volume6-10", "1Gi", "uid6-10", "claim6-10", v1.VolumeBound, "Unknown", classEmpty),
+			expectedVolumes: withMessage("Volume has unrecognized PersistentVolumeReclaimPolicy", newVolumeArray("volume6-10", "1Gi", "uid6-10", "claim6-10", v1.VolumeFailed, "Unknown", classEmpty)),
+			initialClaims:   noclaims,
+			expectedClaims:  noclaims,
+			expectedEvents:  []string{"Warning VolumeUnknownReclaimPolicy"},
+			errors:          noerrors,
+			test:            testSyncVolume,
 		},
 		{
 			// volume is used by a running pod - failure expected
-			"6-11 - used by running pod",
-			newVolumeArray("volume6-11", "1Gi", "uid6-11", "runningClaim", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
-			newVolumeArray("volume6-11", "1Gi", "uid6-11", "runningClaim", v1.VolumeReleased, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
-			noclaims,
-			noclaims,
-			[]string{"Normal VolumeFailedRecycle"}, noerrors, testSyncVolume,
+			name:            "6-11 - used by running pod",
+			initialVolumes:  newVolumeArray("volume6-11", "1Gi", "uid6-11", "runningClaim", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
+			expectedVolumes: newVolumeArray("volume6-11", "1Gi", "uid6-11", "runningClaim", v1.VolumeReleased, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
+			initialClaims:   noclaims,
+			expectedClaims:  noclaims,
+			expectedEvents:  []string{"Normal VolumeFailedRecycle"},
+			errors:          noerrors,
+			test:            testSyncVolume,
 		},
 		{
 			// volume is used by a pending pod - failure expected
-			"6-12 - used by pending pod",
-			newVolumeArray("volume6-12", "1Gi", "uid6-12", "pendingClaim", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
-			newVolumeArray("volume6-12", "1Gi", "uid6-12", "pendingClaim", v1.VolumeReleased, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
-			noclaims,
-			noclaims,
-			[]string{"Normal VolumeFailedRecycle"}, noerrors, testSyncVolume,
+			name:            "6-12 - used by pending pod",
+			initialVolumes:  newVolumeArray("volume6-12", "1Gi", "uid6-12", "pendingClaim", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
+			expectedVolumes: newVolumeArray("volume6-12", "1Gi", "uid6-12", "pendingClaim", v1.VolumeReleased, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
+			initialClaims:   noclaims,
+			expectedClaims:  noclaims,
+			expectedEvents:  []string{"Normal VolumeFailedRecycle"},
+			errors:          noerrors,
+			test:            testSyncVolume,
 		},
 		{
 			// volume is used by a completed pod - recycle succeeds
-			"6-13 - used by completed pod",
-			newVolumeArray("volume6-13", "1Gi", "uid6-13", "completedClaim", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
-			newVolumeArray("volume6-13", "1Gi", "", "", v1.VolumeAvailable, v1.PersistentVolumeReclaimRecycle, classEmpty),
-			noclaims,
-			noclaims,
-			noevents, noerrors,
+			name:            "6-13 - used by completed pod",
+			initialVolumes:  newVolumeArray("volume6-13", "1Gi", "uid6-13", "completedClaim", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
+			expectedVolumes: newVolumeArray("volume6-13", "1Gi", "", "", v1.VolumeAvailable, v1.PersistentVolumeReclaimRecycle, classEmpty),
+			initialClaims:   noclaims,
+			expectedClaims:  noclaims,
+			expectedEvents:  noevents,
+			errors:          noerrors,
 			// Inject recycler into the controller and call syncVolume. The
 			// recycler simulates one recycle() call that succeeds.
-			wrapTestWithReclaimCalls(operationRecycle, []error{nil}, testSyncVolume),
+			test: wrapTestWithReclaimCalls(operationRecycle, []error{nil}, testSyncVolume),
 		},
 		{
 			// volume is used by a completed pod, pod using claim with the same name bound to different pv is running, should recycle
-			"6-14 - seemingly used by running pod",
-			newVolumeArray("volume6-14", "1Gi", "uid6-14", "completedClaim", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
-			newVolumeArray("volume6-14", "1Gi", "", "", v1.VolumeAvailable, v1.PersistentVolumeReclaimRecycle, classEmpty),
-			newClaimArray("completedClaim", "uid6-14-x", "10Gi", "", v1.ClaimBound, nil),
-			newClaimArray("completedClaim", "uid6-14-x", "10Gi", "", v1.ClaimBound, nil),
-			noevents, noerrors,
-			wrapTestWithReclaimCalls(operationRecycle, []error{nil}, testSyncVolume),
+			name:            "6-14 - seemingly used by running pod",
+			initialVolumes:  newVolumeArray("volume6-14", "1Gi", "uid6-14", "completedClaim", v1.VolumeBound, v1.PersistentVolumeReclaimRecycle, classEmpty, volume.AnnBoundByController),
+			expectedVolumes: newVolumeArray("volume6-14", "1Gi", "", "", v1.VolumeAvailable, v1.PersistentVolumeReclaimRecycle, classEmpty),
+			initialClaims:   newClaimArray("completedClaim", "uid6-14-x", "10Gi", "", v1.ClaimBound, nil),
+			expectedClaims:  newClaimArray("completedClaim", "uid6-14-x", "10Gi", "", v1.ClaimBound, nil),
+			expectedEvents:  noevents,
+			errors:          noerrors,
+			test:            wrapTestWithReclaimCalls(operationRecycle, []error{nil}, testSyncVolume),
 		},
 	}
 	runSyncTests(t, tests, []*storage.StorageClass{}, pods)