Skip to content

Update VolumeAttachment.Finalizers as separate subresource in markAsDetatched #227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
k8s-ci-robot merged 1 commit into from
Apr 24, 2020
Merged

Update VolumeAttachment.Finalizers as separate subresource in markAsDetatched #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 75 additions & 21 deletions pkg/controller/csi_handler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -919,8 +919,11 @@ func TestCSIHandler(t *testing.T) {
addedVA: deleted(va(true, fin, ann)),
expectedActions: []core.Action{
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(va(true, fin, ann)),
types.MergePatchType, patch(deleted(va(true, "", ann)),
deleted(va(false /*attached*/, "", ann))), "status"),
core.NewPatchAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(va(false, fin, ann)),
deleted(va(false /*attached*/, "", ann)))),
},
expectedCSICalls: []csiCall{
{"detach", testVolumeHandle, testNodeID, noAttrs, noSecrets, readWrite, success, ignored, noMetadata, 0},
Expand All @@ -932,8 +935,11 @@ func TestCSIHandler(t *testing.T) {
addedVA: deleted(vaWithInlineSpec(va(true, fin, ann))),
expectedActions: []core.Action{
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(vaWithInlineSpec(va(true, fin, ann))),
types.MergePatchType, patch(deleted(vaWithInlineSpec(va(true, "", ann))),
deleted(vaWithInlineSpec(va(false /*attached*/, "", ann)))), "status"),
core.NewPatchAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(vaWithInlineSpec(va(false, fin, ann))),
deleted(vaWithInlineSpec(va(false /*attached*/, "", ann))))),
},
expectedCSICalls: []csiCall{
{"detach", testVolumeHandle, testNodeID, noAttrs, noSecrets, readWrite, success, ignored, noMetadata, 0},
Expand All @@ -946,8 +952,11 @@ func TestCSIHandler(t *testing.T) {
expectedActions: []core.Action{
core.NewGetAction(secretGroupResourceVersion, "default", "secret"),
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(va(true, fin, ann)),
types.MergePatchType, patch(deleted(va(true, "", ann)),
deleted(va(false /*attached*/, "", ann))), "status"),
core.NewPatchAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(vaWithInlineSpec(va(false, fin, ann))),
deleted(vaWithInlineSpec(va(false /*attached*/, "", ann))))),
},
expectedCSICalls: []csiCall{
{"detach", testVolumeHandle, testNodeID, noAttrs, map[string]string{"foo": "bar"}, readWrite, success, ignored, noMetadata, 0},
Expand All @@ -960,9 +969,14 @@ func TestCSIHandler(t *testing.T) {
expectedActions: []core.Action{
core.NewGetAction(secretGroupResourceVersion, "default", "secret"),
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(vaInlineSpecWithSecret(vaWithInlineSpec(va(true, fin, ann)), "secret")),
types.MergePatchType, patch(deleted(vaInlineSpecWithSecret(vaWithInlineSpec(va(true, "", ann)), "secret")),
deleted(vaInlineSpecWithSecret(vaWithInlineSpec(va(false /*attached*/, "", ann)),
"secret"))), "status")},
"secret"))), "status"),
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(vaInlineSpecWithSecret(vaWithInlineSpec(va(false, fin, ann)), "secret")),
deleted(vaInlineSpecWithSecret(vaWithInlineSpec(va(false /*attached*/, "", ann)),
"secret"))), ""),
},
expectedCSICalls: []csiCall{
{"detach", testVolumeHandle, testNodeID, noAttrs, map[string]string{"foo": "bar"}, readWrite, success, ignored, noMetadata, 0},
},
Expand All @@ -974,8 +988,11 @@ func TestCSIHandler(t *testing.T) {
expectedActions: []core.Action{
core.NewGetAction(secretGroupResourceVersion, "default", "emptySecret"),
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(va(true, fin, ann)),
types.MergePatchType, patch(deleted(va(true, "", ann)),
deleted(va(false /*attached*/, "", ann))), "status"),
core.NewPatchAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(va(false, fin, ann)),
deleted(va(false /*attached*/, "", ann)))),
},
expectedCSICalls: []csiCall{
{"detach", testVolumeHandle, testNodeID, noAttrs, map[string]string{}, readWrite, success, ignored, noMetadata, 0},
Expand All @@ -989,9 +1006,14 @@ func TestCSIHandler(t *testing.T) {
core.NewGetAction(secretGroupResourceVersion, "default", "emptySecret"),
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone,
testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(vaInlineSpecWithSecret(vaWithInlineSpec(va(true, fin, ann)), "emptySecret")),
types.MergePatchType, patch(deleted(vaInlineSpecWithSecret(vaWithInlineSpec(va(true, "", ann)), "emptySecret")),
deleted(vaInlineSpecWithSecret(vaWithInlineSpec(va(false /*attached*/, "", ann)),
"emptySecret"))), "status"),
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone,
testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(vaInlineSpecWithSecret(vaWithInlineSpec(va(false, fin, ann)), "emptySecret")),
deleted(vaInlineSpecWithSecret(vaWithInlineSpec(va(false /*attached*/, "", ann)),
"emptySecret"))), ""),
},
expectedCSICalls: []csiCall{
{"detach", testVolumeHandle, testNodeID, noAttrs, map[string]string{}, readWrite, success, ignored, noMetadata, 0},
Expand Down Expand Up @@ -1019,11 +1041,14 @@ func TestCSIHandler(t *testing.T) {
expectedActions: []core.Action{
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone,
testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(va(true, fin, ann)),
deleted(vaWithDetachError(va(true, fin, ann), "mock error"))), "status"),
types.MergePatchType, patch(deleted(va(true, "", ann)),
deleted(vaWithDetachError(va(true, "", ann), "mock error"))), "status"),
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(va(true, fin, ann)),
types.MergePatchType, patch(deleted(va(true, "", ann)),
deleted(va(false, "", ann))), "status"),
core.NewPatchAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(va(false, fin, ann)),
deleted(va(false, "", ann)))),
},
expectedCSICalls: []csiCall{
{"detach", testVolumeHandle, testNodeID, noAttrs, noSecrets, readWrite, fmt.Errorf("mock error"), ignored, noMetadata, 0},
Expand All @@ -1036,8 +1061,11 @@ func TestCSIHandler(t *testing.T) {
addedVA: deleted(va(true, fin, ann)),
expectedActions: []core.Action{
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(va(true, fin, ann)),
types.MergePatchType, patch(deleted(va(true, "", ann)),
deleted(va(false /*attached*/, "", ann))), "status"),
core.NewPatchAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(va(false, fin, ann)),
deleted(va(false /*attached*/, "", ann)))),
},
expectedCSICalls: []csiCall{
{"detach", testVolumeHandle, testNodeID, noAttrs, noSecrets, readWrite, success, ignored, noMetadata, 500 * time.Millisecond},
Expand All @@ -1058,8 +1086,13 @@ func TestCSIHandler(t *testing.T) {
expectedActions: []core.Action{
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone,
testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(va(true, fin, ann)),
deleted(vaWithDetachError(va(true, fin, ann), "persistentvolume \"pv1\" not found"))),
types.MergePatchType, patch(deleted(va(true, "", ann)),
deleted(vaWithDetachError(va(true, "", ann), "persistentvolume \"pv1\" not found"))),
"status"),
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone,
testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(va(false, "", ann)),
deleted(vaWithDetachError(va(false, "", ann), "persistentvolume \"pv1\" not found"))),
"status"),
},
},
Expand All @@ -1069,7 +1102,7 @@ func TestCSIHandler(t *testing.T) {
addedVA: deleted(va(true, fin, ann)),
reactors: []reaction{
{
verb: "update",
verb: "patch",
resource: "volumeattachments",
reactor: func(t *testing.T) core.ReactionFunc {
i := 0
Expand All @@ -1085,6 +1118,10 @@ func TestCSIHandler(t *testing.T) {
},
},
},
// The handler will perform the same patch regardless of whether the error save was successful or not. The only
// difference is in the errors logged (which are not checked here).
// Because the detach never succeeds, the test will loop as long as there are expected actions remaining.
// 4 such loops are tested below: two when the error save fails, and then two when the error succeeds.
expectedActions: []core.Action{
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(va(true, fin, ann)),
Expand All @@ -1098,6 +1135,10 @@ func TestCSIHandler(t *testing.T) {
types.MergePatchType, patch(deleted(va(true, fin, ann)),
deleted(vaWithDetachError(va(true, fin, ann), "persistentvolume \"pv1\" not found"))),
"status"),
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(deleted(va(true, fin, ann)),
deleted(vaWithDetachError(va(true, fin, ann), "persistentvolume \"pv1\" not found"))),
"status"),
},
},
{
Expand Down Expand Up @@ -1143,9 +1184,14 @@ func TestCSIHandler(t *testing.T) {
expectedActions: []core.Action{
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(
deleted(va(true, fin, map[string]string{vaNodeIDAnnotation: "annotatedNodeID"})),
deleted(va(true, "", map[string]string{vaNodeIDAnnotation: "annotatedNodeID"})),
deleted(va(false /*attached*/, "",
map[string]string{vaNodeIDAnnotation: "annotatedNodeID"}))), "status"),
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(
deleted(va(false, fin, map[string]string{vaNodeIDAnnotation: "annotatedNodeID"})),
deleted(va(false /*attached*/, "",
map[string]string{vaNodeIDAnnotation: "annotatedNodeID"}))), ""),
},
expectedCSICalls: []csiCall{
{"detach", testVolumeHandle, "annotatedNodeID", noAttrs, noSecrets, readWrite, success, detached, noMetadata, 0},
Expand Down Expand Up @@ -1176,21 +1222,25 @@ func TestCSIHandler(t *testing.T) {
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone,
testPVName+"-"+testNodeName,
types.MergePatchType, patch(
deleted(va(false, fin, ann)),
deleted(va(false, "", ann)),
deleted(va(false, "", ann))), "status"),
// Saving error succeeds
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone,
testPVName+"-"+testNodeName,
types.MergePatchType, patch(
deleted(va(false, fin, ann)),
vaWithDetachError(deleted(va(false, fin, ann)),
deleted(va(false, "", ann)),
vaWithDetachError(deleted(va(false, "", ann)),
"could not mark as detached: volumeattachments.storage.k8s."+
"io \"pv1-node1\" is forbidden: mock error")), "status"),
// Second save of attached=false succeeds
// Second save of attached=false succeeds and the finalizer is subsequently deleted.
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(
deleted(va(false, fin, ann)),
deleted(va(false, "", ann)),
deleted(va(false, "", ann))), "status"),
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(
deleted(va(false, fin, ann)),
deleted(va(false, "", ann))), ""),
},
expectedCSICalls: []csiCall{
{"detach", testVolumeHandle, testNodeID, noAttrs, noSecrets, readWrite, success, detached, noMetadata, 0},
Expand All @@ -1205,8 +1255,12 @@ func TestCSIHandler(t *testing.T) {
// Finalizer is saved first
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(
deleted(va(true, fin, ann)),
deleted(va(true, "", ann)),
deleted(va(false /*attached*/, "", ann))), "status"),
core.NewPatchSubresourceAction(vaGroupResourceVersion, metav1.NamespaceNone, testPVName+"-"+testNodeName,
types.MergePatchType, patch(
deleted(va(false, fin, ann)),
deleted(va(false /*attached*/, "", ann))), ""),
},
expectedCSICalls: []csiCall{
{"detach", "projects/UNSPECIFIED/zones/testZone/disks/testpd", testNodeID,
Expand Down
13 changes: 12 additions & 1 deletion pkg/controller/util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@ func markAsDetached(client kubernetes.Interface, va *storage.VolumeAttachment) (

klog.V(4).Infof("Marking as detached %q", va.Name)
clone := va.DeepCopy()
clone.Finalizers = newFinalizers
clone.Status.Attached = false
clone.Status.DetachError = nil
clone.Status.AttachmentMetadata = nil
Expand All @@ -92,6 +91,18 @@ func markAsDetached(client kubernetes.Interface, va *storage.VolumeAttachment) (
if err != nil {
return va, err
}

// As Finalizers is not in the status subresource it must be patched separately. It is removed after the status update so the resource is not prematurely deleted.
clone = newVA.DeepCopy()
clone.Finalizers = newFinalizers
patch, err = createMergePatch(newVA, clone)
if err != nil {
return newVA, err
}
newVA, err = client.StorageV1().VolumeAttachments().Patch(context.TODO(), newVA.Name, types.MergePatchType, patch, metav1.PatchOptions{}, "")
if err != nil {
return newVA, err
}
klog.V(4).Infof("Finalizer removed from %q", va.Name)
return newVA, nil
}
Expand Down