Skip to content

Commit 05efba2

Browse files
ggriffithsggriffiths
committed
Add more snapshot and content sync tests
Signed-off-by: Grant Griffiths <[email protected]>
1 parent 7811e59 commit 05efba2

File tree

3 files changed

+96
-21
lines changed

3 files changed

+96
-21
lines changed

‎pkg/common-controller/framework_test.go

+21-2
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,6 @@ func withSnapshotFinalizers(snapshots []*crdv1.VolumeSnapshot, finalizers ...str
175175

176176
func withContentFinalizer(content *crdv1.VolumeSnapshotContent) *crdv1.VolumeSnapshotContent {
177177
content.ObjectMeta.Finalizers = append(content.ObjectMeta.Finalizers, utils.VolumeSnapshotContentFinalizer)
178-
metav1.SetMetaDataAnnotation(&content.ObjectMeta, utils.AnnVolumeSnapshotBeingDeleted, "yes")
179178
return content
180179
}
181180

@@ -826,6 +825,18 @@ func newContent(contentName, boundToSnapshotUID, boundToSnapshotName, snapshotHa
826825
return &content
827826
}
828827

828+
func withContentAnnotations(contents []*crdv1.VolumeSnapshotContent, annotations map[string]string) []*crdv1.VolumeSnapshotContent {
829+
for i := range contents {
830+
if contents[i].ObjectMeta.Annotations == nil {
831+
contents[i].ObjectMeta.Annotations = make(map[string]string)
832+
}
833+
for k, v := range annotations {
834+
contents[i].ObjectMeta.Annotations[k] = v
835+
}
836+
}
837+
return contents
838+
}
839+
829840
func newContentArray(contentName, boundToSnapshotUID, boundToSnapshotName, snapshotHandle, snapshotClassName, desiredSnapshotHandle, volumeHandle string,
830841
deletionPolicy crdv1.DeletionPolicy, size, creationTime *int64,
831842
withFinalizer bool) []*crdv1.VolumeSnapshotContent {
@@ -907,7 +918,7 @@ func newSnapshot(
907918
}
908919
}
909920
if withAllFinalizers {
910-
return withSnapshotFinalizers([]*crdv1.VolumeSnapshot{&snapshot}, utils.VolumeSnapshotContentFinalizer, utils.VolumeSnapshotAsSourceFinalizer, utils.VolumeSnapshotBoundFinalizer)[0]
921+
return withSnapshotFinalizers([]*crdv1.VolumeSnapshot{&snapshot}, utils.VolumeSnapshotAsSourceFinalizer, utils.VolumeSnapshotBoundFinalizer)[0]
911922
}
912923
return &snapshot
913924
}
@@ -1073,6 +1084,14 @@ func testSyncContent(ctrl *csiSnapshotCommonController, reactor *snapshotReactor
10731084
return ctrl.syncContent(test.initialContents[0])
10741085
}
10751086

1087+
func testSyncContentError(ctrl *csiSnapshotCommonController, reactor *snapshotReactor, test controllerTest) error {
1088+
err := ctrl.syncContent(test.initialContents[0])
1089+
if err != nil {
1090+
return nil
1091+
}
1092+
return fmt.Errorf("syncContent succeeded when failure was expected")
1093+
}
1094+
10761095
func testAddPVCFinalizer(ctrl *csiSnapshotCommonController, reactor *snapshotReactor, test controllerTest) error {
10771096
return ctrl.ensurePVCFinalizer(test.initialSnapshots[0])
10781097
}

‎pkg/common-controller/snapshot_delete_test.go

+20-18
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ limitations under the License.
1717
package common_controller
1818

1919
import (
20-
//"errors"
20+
"errors"
2121
"testing"
2222

2323
crdv1 "github.com/kubernetes-csi/external-snapshotter/v2/pkg/apis/volumesnapshot/v1beta1"
@@ -174,22 +174,7 @@ func TestDeleteSync(t *testing.T) {
174174
initialSecrets: []*v1.Secret{secret()},
175175
//expectedDeleteCalls: []deleteCall{{"sid1-3", map[string]string{"foo": "bar"}, nil}},
176176
test: testSyncContent,
177-
}, /*{
178-
name: "1-6 - api server delete content returns error",
179-
initialContents: newContentArray("content1-6", "sid1-6", "snap1-6", "sid1-6", validSecretClass, "", "", deletionPolicy, nil, nil, true),
180-
expectedContents: newContentArray("content1-6", "sid1-6", "snap1-6", "sid1-6", validSecretClass, "", "", deletionPolicy, nil, nil, true),
181-
initialSnapshots: nosnapshots,
182-
expectedSnapshots: nosnapshots,
183-
initialSecrets: []*v1.Secret{secret()},
184-
//expectedDeleteCalls: []deleteCall{{"sid1-6", map[string]string{"foo": "bar"}, nil}},
185-
expectedEvents: []string{"Warning SnapshotContentObjectDeleteError"},
186-
errors: []reactorError{
187-
// Inject error to the first client.VolumesnapshotV1beta1().VolumeSnapshotContents().Delete call.
188-
// All other calls will succeed.
189-
{"delete", "volumesnapshotcontents", errors.New("mock delete error")},
190-
},
191-
test: testSyncContent,
192-
},*/
177+
},
193178
{
194179
// delete success - snapshot that the content was pointing to was deleted, and another
195180
// with the same name created.
@@ -304,14 +289,31 @@ func TestDeleteSync(t *testing.T) {
304289
expectedContents: nocontents,
305290
initialSnapshots: newSnapshotArray("snap3-1", "snapuid3-1", "claim3-1", "", validSecretClass, "content3-1", &False, nil, nil, nil, false, true, &timeNowMetav1),
306291
expectedSnapshots: withSnapshotFinalizers(newSnapshotArray("snap3-1", "snapuid3-1", "claim3-1", "", validSecretClass, "content3-1", &False, nil, nil, nil, false, false, &timeNowMetav1),
307-
utils.VolumeSnapshotContentFinalizer, utils.VolumeSnapshotBoundFinalizer,
292+
utils.VolumeSnapshotBoundFinalizer,
308293
),
309294
initialClaims: newClaimArray("claim3-1", "pvc-uid3-1", "1Gi", "volume3-1", v1.ClaimBound, &classEmpty),
310295
expectedEvents: noevents,
311296
initialSecrets: []*v1.Secret{secret()},
312297
errors: noerrors,
313298
test: testSyncSnapshot,
314299
},
300+
{
301+
name: "3-2 - content will not be deleted if deletion API call fails",
302+
initialContents: newContentArray("content3-2", "", "snap3-2", "sid3-2", validSecretClass, "", "", deletePolicy, nil, nil, true),
303+
expectedContents: newContentArray("content3-2", "", "snap3-2", "sid3-2", validSecretClass, "", "", deletePolicy, nil, nil, true),
304+
initialSnapshots: newSnapshotArray("snap3-2", "snapuid3-2", "claim3-2", "", validSecretClass, "content3-2", &False, nil, nil, nil, false, true, &timeNowMetav1),
305+
expectedSnapshots: newSnapshotArray("snap3-2", "snapuid3-2", "claim3-2", "", validSecretClass, "content3-2", &False, nil, nil, nil, false, true, &timeNowMetav1),
306+
initialClaims: newClaimArray("claim3-2", "pvc-uid3-2", "1Gi", "volume3-2", v1.ClaimBound, &classEmpty),
307+
expectedEvents: []string{"Warning SnapshotContentObjectDeleteError"},
308+
initialSecrets: []*v1.Secret{secret()},
309+
errors: []reactorError{
310+
// Inject error to the first client.VolumesnapshotV1beta1().VolumeSnapshotContents().Delete call.
311+
// All other calls will succeed.
312+
{"delete", "volumesnapshotcontents", errors.New("mock delete error")},
313+
},
314+
expectSuccess: false,
315+
test: testSyncSnapshotError,
316+
},
315317
}
316318
runSyncTests(t, tests, snapshotClasses)
317319
}

‎pkg/common-controller/snapshot_update_test.go

+55-1
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ limitations under the License.
1717
package common_controller
1818

1919
import (
20-
//"errors"
20+
"errors"
2121
"testing"
2222
"time"
2323

24+
"github.com/kubernetes-csi/external-snapshotter/v2/pkg/utils"
2425
v1 "k8s.io/api/core/v1"
2526
storagev1beta1 "k8s.io/api/storage/v1beta1"
2627
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -282,6 +283,59 @@ func TestSync(t *testing.T) {
282283
errors: noerrors,
283284
test: testSyncSnapshot,
284285
},
286+
{
287+
name: "5-1 - content missing finalizer is updated to have finalizer",
288+
initialContents: newContentArray("content5-1", "snapuid5-1", "snap5-1", "sid5-1", validSecretClass, "", "", deletionPolicy, nil, nil, false),
289+
expectedContents: newContentArray("content5-1", "snapuid5-1", "snap5-1", "sid5-1", validSecretClass, "", "", deletionPolicy, nil, nil, true),
290+
initialClaims: newClaimArray("claim5-1", "pvc-uid5-1", "1Gi", "volume5-1", v1.ClaimBound, &classEmpty),
291+
initialVolumes: newVolumeArray("volume5-1", "pv-uid5-1", "pv-handle5-1", "1Gi", "pvc-uid5-1", "claim5-1", v1.VolumeBound, v1.PersistentVolumeReclaimDelete, classEmpty),
292+
initialSecrets: []*v1.Secret{secret()},
293+
errors: noerrors,
294+
test: testSyncContent,
295+
},
296+
{
297+
name: "5-2 - content missing finalizer update attempt fails because of failed API call",
298+
initialContents: newContentArray("content5-2", "snapuid5-2", "snap5-2", "sid5-2", validSecretClass, "", "", deletionPolicy, nil, nil, false),
299+
expectedContents: newContentArray("content5-2", "snapuid5-2", "snap5-2", "sid5-2", validSecretClass, "", "", deletionPolicy, nil, nil, false),
300+
initialClaims: newClaimArray("claim5-2", "pvc-uid5-2", "1Gi", "volume5-2", v1.ClaimBound, &classEmpty),
301+
initialVolumes: newVolumeArray("volume5-2", "pv-uid5-2", "pv-handle5-2", "1Gi", "pvc-uid5-2", "claim5-2", v1.VolumeBound, v1.PersistentVolumeReclaimDelete, classEmpty),
302+
initialSecrets: []*v1.Secret{secret()},
303+
errors: []reactorError{
304+
// Inject error to the forth client.VolumesnapshotV1beta1().VolumeSnapshots().Update call.
305+
{"update", "volumesnapshotcontents", errors.New("mock update error")},
306+
},
307+
expectSuccess: false,
308+
test: testSyncContentError,
309+
},
310+
{
311+
name: "5-3 - snapshot deletion candidate marked for deletion",
312+
initialSnapshots: newSnapshotArray("snap5-3", "snapuid5-3", "claim5-3", "", validSecretClass, "content5-3", &False, nil, nil, nil, false, true, &timeNowMetav1),
313+
expectedSnapshots: newSnapshotArray("snap5-3", "snapuid5-3", "claim5-3", "", validSecretClass, "content5-3", &False, nil, nil, nil, false, true, &timeNowMetav1),
314+
initialContents: newContentArray("content5-3", "snapuid5-3", "snap5-3", "sid5-3", validSecretClass, "", "", deletionPolicy, nil, nil, true),
315+
expectedContents: withContentAnnotations(newContentArray("content5-3", "snapuid5-3", "snap5-3", "sid5-3", validSecretClass, "", "", deletionPolicy, nil, nil, true), map[string]string{utils.AnnVolumeSnapshotBeingDeleted: "yes"}),
316+
initialClaims: newClaimArray("claim5-3", "pvc-uid5-3", "1Gi", "volume5-3", v1.ClaimBound, &classEmpty),
317+
initialVolumes: newVolumeArray("volume5-3", "pv-uid5-3", "pv-handle5-3", "1Gi", "pvc-uid5-3", "claim5-3", v1.VolumeBound, v1.PersistentVolumeReclaimDelete, classEmpty),
318+
initialSecrets: []*v1.Secret{secret()},
319+
expectSuccess: true,
320+
test: testSyncContent,
321+
},
322+
{
323+
name: "5-4 - snapshot deletion candidate fail to mark for deletion due to failed API call",
324+
initialSnapshots: newSnapshotArray("snap5-4", "snapuid5-4", "claim5-4", "", validSecretClass, "content5-4", &False, nil, nil, nil, false, true, &timeNowMetav1),
325+
expectedSnapshots: newSnapshotArray("snap5-4", "snapuid5-4", "claim5-4", "", validSecretClass, "content5-4", &False, nil, nil, nil, false, true, &timeNowMetav1),
326+
initialContents: newContentArray("content5-4", "snapuid5-4", "snap5-4", "sid5-4", validSecretClass, "", "", deletionPolicy, nil, nil, true),
327+
// result of the test framework - annotation is still set in memory, but update call fails.
328+
expectedContents: withContentAnnotations(newContentArray("content5-4", "snapuid5-4", "snap5-4", "sid5-4", validSecretClass, "", "", deletionPolicy, nil, nil, true), map[string]string{utils.AnnVolumeSnapshotBeingDeleted: "yes"}),
329+
initialClaims: newClaimArray("claim5-4", "pvc-uid5-4", "1Gi", "volume5-4", v1.ClaimBound, &classEmpty),
330+
initialVolumes: newVolumeArray("volume5-4", "pv-uid5-4", "pv-handle5-4", "1Gi", "pvc-uid5-4", "claim5-4", v1.VolumeBound, v1.PersistentVolumeReclaimDelete, classEmpty),
331+
initialSecrets: []*v1.Secret{secret()},
332+
errors: []reactorError{
333+
// Inject error to the forth client.VolumesnapshotV1beta1().VolumeSnapshots().Update call.
334+
{"update", "volumesnapshotcontents", errors.New("mock update error")},
335+
},
336+
expectSuccess: false,
337+
test: testSyncContentError,
338+
},
285339
}
286340

287341
runSyncTests(t, tests, snapshotClasses)

0 commit comments

Comments
 (0)