-
Notifications
You must be signed in to change notification settings - Fork 150
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
pkg/sanity: track and delete volumes
When a test fails, any volume operations that I may have done should be reversed. To achieve this, tests can register volumes for cleanup. To avoid unnecessary operations, volumes also get unregistered after a successful removal inside the test itself. Whether ControllerUnpublishVolume has to be called also gets tracked. For the sake of simplicity, NodeUnpublishVolume and (if supported) NodeUnstageVolume always get called. This is okay because they have to be idempotent and won't fail when called unnecessarily. testFullWorkflowSuccess gets inlined because that's easier than passing yet another parameter. Fixes: #89.
- Loading branch information
Showing
3 changed files
with
315 additions
and
149 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| /* | ||
| Copyright 2018 Intel Corporation | ||
| 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 sanity | ||
|
|
||
| import ( | ||
| "context" | ||
| "log" | ||
|
|
||
| "github.com/container-storage-interface/spec/lib/go/csi/v0" | ||
|
|
||
| . "github.com/onsi/ginkgo" | ||
| ) | ||
|
|
||
| // VolumeInfo keeps track of the information needed to delete a volume. | ||
| type VolumeInfo struct { | ||
| // Node on which the volume was published, empty if none | ||
| // or publishing is not supported. | ||
| NodeID string | ||
|
|
||
| // Volume ID assigned by CreateVolume. | ||
| VolumeID string | ||
| } | ||
|
|
||
| // Cleanup keeps track of resources, in particular volumes, which need | ||
| // to be freed when testing is done. | ||
| type Cleanup struct { | ||
| Context *SanityContext | ||
| ControllerClient csi.ControllerClient | ||
| NodeClient csi.NodeClient | ||
| ControllerPublishSupported bool | ||
| NodeStageSupported bool | ||
|
|
||
| // Maps from volume name to the node ID for which the volume | ||
| // is published and the volume ID. | ||
| volumes map[string]VolumeInfo | ||
| } | ||
|
|
||
| // RegisterVolume adds or updates an entry for the volume with the | ||
| // given name. | ||
| func (cl *Cleanup) RegisterVolume(name string, info VolumeInfo) { | ||
| if cl.volumes == nil { | ||
| cl.volumes = make(map[string]VolumeInfo) | ||
| } | ||
| cl.volumes[name] = info | ||
| } | ||
|
|
||
| // UnregisterVolume removes the entry for the volume with the | ||
| // given name, thus preventing all cleanup operations for it. | ||
| func (cl *Cleanup) UnregisterVolume(name string) { | ||
| if cl.volumes != nil { | ||
| delete(cl.volumes, name) | ||
| } | ||
| } | ||
|
|
||
| // DeleteVolumes stops using the registered volumes and tries to delete all of them. | ||
| func (cl *Cleanup) DeleteVolumes() { | ||
| if cl.volumes == nil { | ||
| return | ||
| } | ||
| logger := log.New(GinkgoWriter, "cleanup: ", 0) | ||
| ctx := context.Background() | ||
|
|
||
| for name, info := range cl.volumes { | ||
| logger.Printf("deleting %s = %s", name, info.VolumeID) | ||
| if _, err := cl.NodeClient.NodeUnpublishVolume( | ||
| ctx, | ||
| &csi.NodeUnpublishVolumeRequest{ | ||
| VolumeId: info.VolumeID, | ||
| TargetPath: cl.Context.Config.TargetPath, | ||
| }, | ||
| ); err != nil { | ||
| logger.Printf("warning: NodeUnpublishVolume: %s", err) | ||
| } | ||
|
|
||
| if cl.NodeStageSupported { | ||
| if _, err := cl.NodeClient.NodeUnstageVolume( | ||
| ctx, | ||
| &csi.NodeUnstageVolumeRequest{ | ||
| VolumeId: info.VolumeID, | ||
| StagingTargetPath: cl.Context.Config.StagingPath, | ||
| }, | ||
| ); err != nil { | ||
| logger.Printf("warning: NodeUnstageVolume: %s", err) | ||
| } | ||
| } | ||
|
|
||
| if cl.ControllerPublishSupported && info.NodeID != "" { | ||
| if _, err := cl.ControllerClient.ControllerUnpublishVolume( | ||
| ctx, | ||
| &csi.ControllerUnpublishVolumeRequest{ | ||
| VolumeId: info.VolumeID, | ||
| NodeId: info.NodeID, | ||
| ControllerUnpublishSecrets: cl.Context.Secrets.ControllerUnpublishVolumeSecret, | ||
| }, | ||
| ); err != nil { | ||
| logger.Printf("warning: ControllerUnpublishVolume: %s", err) | ||
| } | ||
| } | ||
|
|
||
| if _, err := cl.ControllerClient.DeleteVolume( | ||
| ctx, | ||
| &csi.DeleteVolumeRequest{ | ||
| VolumeId: info.VolumeID, | ||
| ControllerDeleteSecrets: cl.Context.Secrets.DeleteVolumeSecret, | ||
| }, | ||
| ); err != nil { | ||
| logger.Printf("error: DeleteVolume: %s", err) | ||
| } | ||
|
|
||
| cl.UnregisterVolume(name) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.