320 lines
15 KiB
Go
320 lines
15 KiB
Go
/*
|
|
Copyright 2018 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package common_controller
|
|
|
|
import (
|
|
"errors"
|
|
"testing"
|
|
|
|
crdv1 "github.com/kubernetes-csi/external-snapshotter/v2/pkg/apis/volumesnapshot/v1beta1"
|
|
"github.com/kubernetes-csi/external-snapshotter/v2/pkg/utils"
|
|
v1 "k8s.io/api/core/v1"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
)
|
|
|
|
var class1Parameters = map[string]string{
|
|
"param1": "value1",
|
|
}
|
|
|
|
var class2Parameters = map[string]string{
|
|
"param2": "value2",
|
|
}
|
|
|
|
var class3Parameters = map[string]string{
|
|
"param3": "value3",
|
|
//utils.SnapshotterSecretNameKey: "name",
|
|
}
|
|
|
|
var class4Parameters = map[string]string{
|
|
//utils.SnapshotterSecretNameKey: "emptysecret",
|
|
//utils.SnapshotterSecretNamespaceKey: "default",
|
|
}
|
|
|
|
var class5Parameters = map[string]string{
|
|
//utils.SnapshotterSecretNameKey: "secret",
|
|
//utils.SnapshotterSecretNamespaceKey: "default",
|
|
}
|
|
|
|
var timeNowMetav1 = metav1.Now()
|
|
|
|
var content31 = "content3-1"
|
|
var claim31 = "claim3-1"
|
|
|
|
var snapshotClasses = []*crdv1.VolumeSnapshotClass{
|
|
{
|
|
TypeMeta: metav1.TypeMeta{
|
|
Kind: "VolumeSnapshotClass",
|
|
},
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: classGold,
|
|
},
|
|
Driver: mockDriverName,
|
|
Parameters: class1Parameters,
|
|
DeletionPolicy: crdv1.VolumeSnapshotContentDelete,
|
|
},
|
|
{
|
|
TypeMeta: metav1.TypeMeta{
|
|
Kind: "VolumeSnapshotClass",
|
|
},
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: classSilver,
|
|
},
|
|
Driver: mockDriverName,
|
|
Parameters: class2Parameters,
|
|
DeletionPolicy: crdv1.VolumeSnapshotContentDelete,
|
|
},
|
|
{
|
|
TypeMeta: metav1.TypeMeta{
|
|
Kind: "VolumeSnapshotClass",
|
|
},
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: emptySecretClass,
|
|
},
|
|
Driver: mockDriverName,
|
|
Parameters: class4Parameters,
|
|
DeletionPolicy: crdv1.VolumeSnapshotContentDelete,
|
|
},
|
|
{
|
|
TypeMeta: metav1.TypeMeta{
|
|
Kind: "VolumeSnapshotClass",
|
|
},
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: invalidSecretClass,
|
|
},
|
|
Driver: mockDriverName,
|
|
Parameters: class3Parameters,
|
|
DeletionPolicy: crdv1.VolumeSnapshotContentDelete,
|
|
},
|
|
{
|
|
TypeMeta: metav1.TypeMeta{
|
|
Kind: "VolumeSnapshotClass",
|
|
},
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: validSecretClass,
|
|
},
|
|
Driver: mockDriverName,
|
|
Parameters: class5Parameters,
|
|
DeletionPolicy: crdv1.VolumeSnapshotContentDelete,
|
|
},
|
|
{
|
|
TypeMeta: metav1.TypeMeta{
|
|
Kind: "VolumeSnapshotClass",
|
|
},
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: defaultClass,
|
|
Annotations: map[string]string{utils.IsDefaultSnapshotClassAnnotation: "true"},
|
|
},
|
|
Driver: mockDriverName,
|
|
DeletionPolicy: crdv1.VolumeSnapshotContentDelete,
|
|
},
|
|
}
|
|
|
|
// Test single call to syncContent, expecting deleting to happen.
|
|
// 1. Fill in the controller with initial data
|
|
// 2. Call the syncContent *once*.
|
|
// 3. Compare resulting contents with expected contents.
|
|
func TestDeleteSync(t *testing.T) {
|
|
tests := []controllerTest{
|
|
{
|
|
name: "1-1 - content with empty snapshot class is deleted if it is bound to a non-exist snapshot and also has a snapshot uid specified",
|
|
initialContents: newContentArray("content1-1", "snapuid1-1", "snap1-1", "sid1-1", classGold, "", "", deletionPolicy, nil, nil, true),
|
|
expectedContents: newContentArray("content1-1", "snapuid1-1", "snap1-1", "sid1-1", classGold, "", "", deletionPolicy, nil, nil, true),
|
|
initialSnapshots: nosnapshots,
|
|
expectedSnapshots: nosnapshots,
|
|
expectedEvents: noevents,
|
|
errors: noerrors,
|
|
//expectedDeleteCalls: []deleteCall{{"sid1-1", nil, nil}},
|
|
test: testSyncContent,
|
|
},
|
|
{
|
|
name: "2-1 - content with empty snapshot class will not be deleted if it is bound to a non-exist snapshot but it does not have a snapshot uid specified",
|
|
initialContents: newContentArray("content2-1", "", "snap2-1", "sid2-1", "", "", "", deletionPolicy, nil, nil, true),
|
|
expectedContents: newContentArray("content2-1", "", "snap2-1", "sid2-1", "", "", "", deletionPolicy, nil, nil, true),
|
|
initialSnapshots: nosnapshots,
|
|
expectedSnapshots: nosnapshots,
|
|
expectedEvents: noevents,
|
|
errors: noerrors,
|
|
//expectedDeleteCalls: []deleteCall{{"sid2-1", nil, nil}},
|
|
test: testSyncContent,
|
|
},
|
|
{
|
|
name: "1-2 - successful delete with snapshot class that has empty secret parameter",
|
|
initialContents: newContentArray("content1-2", "sid1-2", "snap1-2", "sid1-2", emptySecretClass, "", "", deletionPolicy, nil, nil, true),
|
|
expectedContents: newContentArray("content1-2", "sid1-2", "snap1-2", "sid1-2", emptySecretClass, "", "", deletionPolicy, nil, nil, true),
|
|
initialSnapshots: nosnapshots,
|
|
expectedSnapshots: nosnapshots,
|
|
initialSecrets: []*v1.Secret{emptySecret()},
|
|
expectedEvents: noevents,
|
|
errors: noerrors,
|
|
//expectedDeleteCalls: []deleteCall{{"sid1-2", map[string]string{}, nil}},
|
|
test: testSyncContent,
|
|
},
|
|
{
|
|
name: "1-3 - successful delete with snapshot class that has valid secret parameter",
|
|
initialContents: newContentArray("content1-3", "sid1-3", "snap1-3", "sid1-3", validSecretClass, "", "", deletionPolicy, nil, nil, true),
|
|
expectedContents: newContentArray("content1-3", "sid1-3", "snap1-3", "sid1-3", validSecretClass, "", "", deletionPolicy, nil, nil, true),
|
|
initialSnapshots: nosnapshots,
|
|
expectedSnapshots: nosnapshots,
|
|
expectedEvents: noevents,
|
|
errors: noerrors,
|
|
initialSecrets: []*v1.Secret{secret()},
|
|
//expectedDeleteCalls: []deleteCall{{"sid1-3", map[string]string{"foo": "bar"}, nil}},
|
|
test: testSyncContent,
|
|
},
|
|
{
|
|
// delete success - snapshot that the content was pointing to was deleted, and another
|
|
// with the same name created.
|
|
name: "1-7 - prebound content is deleted while the snapshot exists",
|
|
initialContents: newContentArray("content1-7", "sid1-7", "snap1-7", "sid1-7", emptySecretClass, "", "", deletionPolicy, nil, nil, true),
|
|
expectedContents: newContentArray("content1-7", "sid1-7", "snap1-7", "sid1-7", emptySecretClass, "", "", deletionPolicy, nil, nil, true),
|
|
initialSnapshots: newSnapshotArray("snap1-7", "snapuid1-7-x", "claim1-7", "", validSecretClass, "", &False, nil, nil, nil, false, true, nil),
|
|
expectedSnapshots: newSnapshotArray("snap1-7", "snapuid1-7-x", "claim1-7", "", validSecretClass, "", &False, nil, nil, nil, false, true, nil),
|
|
initialSecrets: []*v1.Secret{secret()},
|
|
//expectedDeleteCalls: []deleteCall{{"sid1-7", map[string]string{"foo": "bar"}, nil}},
|
|
expectedEvents: noevents,
|
|
errors: noerrors,
|
|
test: testSyncContent,
|
|
},
|
|
{
|
|
// delete success(?) - content is deleted before doDelete() starts
|
|
name: "1-8 - content is deleted before deleting",
|
|
initialContents: newContentArray("content1-8", "sid1-8", "snap1-8", "sid1-8", validSecretClass, "", "", deletionPolicy, nil, nil, true),
|
|
expectedContents: nocontents,
|
|
initialSnapshots: nosnapshots,
|
|
expectedSnapshots: nosnapshots,
|
|
initialSecrets: []*v1.Secret{secret()},
|
|
//expectedDeleteCalls: []deleteCall{{"sid1-8", map[string]string{"foo": "bar"}, nil}},
|
|
expectedEvents: noevents,
|
|
errors: noerrors,
|
|
test: wrapTestWithInjectedOperation(testSyncContent, func(ctrl *csiSnapshotCommonController, reactor *snapshotReactor) {
|
|
// Delete the volume before delete operation starts
|
|
reactor.lock.Lock()
|
|
delete(reactor.contents, "content1-8")
|
|
reactor.lock.Unlock()
|
|
}),
|
|
},
|
|
/*{
|
|
name: "1-9 - content will not be deleted if it is bound to a snapshot correctly, snapshot uid is specified",
|
|
initialContents: newContentArray("content1-9", "snapuid1-9", "snap1-9", "sid1-9", validSecretClass, "", "", deletionPolicy, nil, nil, true),
|
|
expectedContents: newContentArray("content1-9", "snapuid1-9", "snap1-9", "sid1-9", validSecretClass, "", "", deletionPolicy, nil, nil, true),
|
|
initialSnapshots: newSnapshotArray("snap1-9", "snapuid1-9", "claim1-9", "", validSecretClass, "content1-9", &False, nil, nil, nil),
|
|
expectedSnapshots: newSnapshotArray("snap1-9", "snapuid1-9", "claim1-9", "", validSecretClass, "content1-9", &True, nil, nil, nil),
|
|
expectedEvents: noevents,
|
|
initialSecrets: []*v1.Secret{secret()},
|
|
errors: noerrors,
|
|
test: testSyncContent,
|
|
},*/
|
|
{
|
|
name: "1-10 - will not delete content with retain policy set which is bound to a snapshot incorrectly",
|
|
initialContents: newContentArray("content1-10", "snapuid1-10-x", "snap1-10", "sid1-10", validSecretClass, "", "", retainPolicy, nil, nil, true),
|
|
expectedContents: newContentArray("content1-10", "snapuid1-10-x", "snap1-10", "sid1-10", validSecretClass, "", "", retainPolicy, nil, nil, true),
|
|
initialSnapshots: newSnapshotArray("snap1-10", "snapuid1-10", "claim1-10", "", validSecretClass, "content1-10", &False, nil, nil, nil, false, true, nil),
|
|
expectedSnapshots: newSnapshotArray("snap1-10", "snapuid1-10", "claim1-10", "", validSecretClass, "content1-10", &False, nil, nil, nil, false, true, nil),
|
|
expectedEvents: noevents,
|
|
initialSecrets: []*v1.Secret{secret()},
|
|
errors: noerrors,
|
|
test: testSyncContent,
|
|
},
|
|
{
|
|
name: "1-11 - content will not be deleted if it is bound to a snapshot correctly, snapsht uid is not specified",
|
|
initialContents: newContentArray("content1-11", "", "snap1-11", "sid1-11", validSecretClass, "", "", deletePolicy, nil, nil, true),
|
|
expectedContents: newContentArray("content1-11", "", "snap1-11", "sid1-11", validSecretClass, "", "", deletePolicy, nil, nil, true),
|
|
initialSnapshots: newSnapshotArray("snap1-11", "snapuid1-11", "claim1-11", "", validSecretClass, "content1-11", &False, nil, nil, nil, false, true, nil),
|
|
expectedSnapshots: newSnapshotArray("snap1-11", "snapuid1-11", "claim1-11", "", validSecretClass, "content1-11", &False, nil, nil, nil, false, true, nil),
|
|
expectedEvents: noevents,
|
|
initialSecrets: []*v1.Secret{secret()},
|
|
errors: noerrors,
|
|
test: testSyncContent,
|
|
},
|
|
{
|
|
name: "1-12 - content with retain policy will not be deleted if it is bound to a non-exist snapshot and also has a snapshot uid specified",
|
|
initialContents: newContentArray("content1-12", "sid1-12", "snap1-11", "sid1-11", validSecretClass, "", "", retainPolicy, nil, nil, true),
|
|
expectedContents: newContentArray("content1-12", "sid1-12", "snap1-11", "sid1-11", validSecretClass, "", "", retainPolicy, nil, nil, true),
|
|
initialSnapshots: nosnapshots,
|
|
expectedSnapshots: nosnapshots,
|
|
expectedEvents: noevents,
|
|
errors: noerrors,
|
|
test: testSyncContent,
|
|
},
|
|
{
|
|
name: "1-13 - content with empty snapshot class is not deleted when Deletion policy is not set even if it is bound to a non-exist snapshot and also has a snapshot uid specified",
|
|
initialContents: newContentArray("content1-13", "sid1-13", "snap1-13", "sid1-13", validSecretClass, "", "", retainPolicy, nil, nil, true),
|
|
expectedContents: newContentArray("content1-13", "sid1-13", "snap1-13", "sid1-13", validSecretClass, "", "", retainPolicy, nil, nil, true),
|
|
initialSnapshots: nosnapshots,
|
|
expectedSnapshots: nosnapshots,
|
|
expectedEvents: noevents,
|
|
errors: noerrors,
|
|
test: testSyncContent,
|
|
},
|
|
/*{
|
|
name: "1-14 - content will not be deleted if it is bound to a snapshot correctly, snapshot uid is specified",
|
|
initialContents: newContentArray("content1-14", "snapuid1-14", "snap1-14", "sid1-14", validSecretClass, "", "", retainPolicy, nil, nil, true),
|
|
expectedContents: newContentArray("content1-14", "snapuid1-14", "snap1-14", "sid1-14", validSecretClass, "", "", retainPolicy, nil, nil, true),
|
|
initialSnapshots: newSnapshotArray("snap1-14", "snapuid1-14", "claim1-14", "", validSecretClass, "content1-14", &False, nil, nil, nil),
|
|
expectedSnapshots: newSnapshotArray("snap1-14", "snapuid1-14", "claim1-14", "", validSecretClass, "content1-14", &True, nil, nil, nil),
|
|
expectedEvents: noevents,
|
|
initialSecrets: []*v1.Secret{secret()},
|
|
errors: noerrors,
|
|
test: testSyncContent,
|
|
},*/
|
|
{
|
|
name: "1-16 - continue delete with snapshot class that has nonexistent secret",
|
|
initialContents: newContentArray("content1-16", "sid1-16", "snap1-16", "sid1-16", emptySecretClass, "", "", deletePolicy, nil, nil, true),
|
|
expectedContents: newContentArray("content1-16", "sid1-16", "snap1-16", "sid1-16", emptySecretClass, "", "", deletePolicy, nil, nil, true),
|
|
initialSnapshots: nosnapshots,
|
|
expectedSnapshots: nosnapshots,
|
|
expectedEvents: noevents,
|
|
errors: noerrors,
|
|
initialSecrets: []*v1.Secret{}, // secret does not exist
|
|
//expectedDeleteCalls: []deleteCall{{"sid1-16", nil, nil}},
|
|
test: testSyncContent,
|
|
},
|
|
{
|
|
name: "3-1 - content will be deleted if snapshot deletion timestamp is set",
|
|
initialContents: newContentArray("content3-1", "", "snap3-1", "sid3-1", validSecretClass, "", "", deletePolicy, nil, nil, true),
|
|
expectedContents: nocontents,
|
|
initialSnapshots: newSnapshotArray("snap3-1", "snapuid3-1", "claim3-1", "", validSecretClass, "content3-1", &False, nil, nil, nil, false, true, &timeNowMetav1),
|
|
expectedSnapshots: withSnapshotFinalizers(newSnapshotArray("snap3-1", "snapuid3-1", "claim3-1", "", validSecretClass, "content3-1", &False, nil, nil, nil, false, false, &timeNowMetav1),
|
|
utils.VolumeSnapshotBoundFinalizer,
|
|
),
|
|
initialClaims: newClaimArray("claim3-1", "pvc-uid3-1", "1Gi", "volume3-1", v1.ClaimBound, &classEmpty),
|
|
expectedEvents: noevents,
|
|
initialSecrets: []*v1.Secret{secret()},
|
|
errors: noerrors,
|
|
test: testSyncSnapshot,
|
|
},
|
|
{
|
|
name: "3-2 - content will not be deleted if deletion API call fails",
|
|
initialContents: newContentArray("content3-2", "", "snap3-2", "sid3-2", validSecretClass, "", "", deletePolicy, nil, nil, true),
|
|
expectedContents: newContentArray("content3-2", "", "snap3-2", "sid3-2", validSecretClass, "", "", deletePolicy, nil, nil, true),
|
|
initialSnapshots: newSnapshotArray("snap3-2", "snapuid3-2", "claim3-2", "", validSecretClass, "content3-2", &False, nil, nil, nil, false, true, &timeNowMetav1),
|
|
expectedSnapshots: newSnapshotArray("snap3-2", "snapuid3-2", "claim3-2", "", validSecretClass, "content3-2", &False, nil, nil, nil, false, true, &timeNowMetav1),
|
|
initialClaims: newClaimArray("claim3-2", "pvc-uid3-2", "1Gi", "volume3-2", v1.ClaimBound, &classEmpty),
|
|
expectedEvents: []string{"Warning SnapshotContentObjectDeleteError"},
|
|
initialSecrets: []*v1.Secret{secret()},
|
|
errors: []reactorError{
|
|
// Inject error to the first client.VolumesnapshotV1beta1().VolumeSnapshotContents().Delete call.
|
|
// All other calls will succeed.
|
|
{"delete", "volumesnapshotcontents", errors.New("mock delete error")},
|
|
},
|
|
expectSuccess: false,
|
|
test: testSyncSnapshotError,
|
|
},
|
|
}
|
|
runSyncTests(t, tests, snapshotClasses)
|
|
}
|