Skip to content

Make sure delete-access-point should not delete entire EFS #1696

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

Closed
Phaow wants to merge 1 commit into from
Closed

Make sure delete-access-point should not delete entire EFS #1696

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
23 changes: 14 additions & 9 deletions pkg/driver/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -524,16 +524,21 @@ func (d *Driver) DeleteVolume(ctx context.Context, req *csi.DeleteVolumeRequest)

// Before removing, ensure the removal path exists and is a directory
apRootPath := fsRoot + accessPoint.AccessPointRootDir
if pathInfo, err := d.mounter.Stat(apRootPath); err == nil && !os.IsNotExist(err) && pathInfo.IsDir() {
err = os.RemoveAll(apRootPath)
}
if err != nil {
return nil, status.Errorf(codes.Internal, "Could not delete access point root directory %q: %v", accessPoint.AccessPointRootDir, err)
}
err = d.mounter.Unmount(fsRoot)
if err != nil {
return nil, status.Errorf(codes.Internal, "Could not unmount %q: %v", fsRoot, err)
pathInfo, err := d.mounter.Stat(apRootPath)
if err == nil && pathInfo.IsDir() {
// Prevent accidental deletion of the entire staging path when AP root is "/"
if accessPoint.AccessPointRootDir == "/" {
klog.Warningf("Skipping cleanup of root directory %q for access point %s",
accessPoint.AccessPointRootDir, accessPointId)
return nil, status.Errorf(codes.Internal, "Could not delete efs root dir '/'")
}
if err = os.RemoveAll(apRootPath); err != nil {
return nil, status.Errorf(codes.Internal, "Could not delete access point root directory %q: %v", accessPoint.AccessPointRootDir, err)
}
} else if err != nil && !os.IsNotExist(err) {
return nil, status.Errorf(codes.Internal, "Could not stat access point root directory %q: %v", accessPoint.AccessPointRootDir, err)
}

err = os.Remove(fsRoot)
if err != nil && !os.IsNotExist(err) {
return nil, status.Errorf(codes.Internal, "Could not delete %q: %v", fsRoot, err)
Expand Down
77 changes: 64 additions & 13 deletions pkg/driver/controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3435,10 +3435,9 @@ func TestDeleteVolume(t *testing.T) {

ctx := context.Background()
mockMounter.EXPECT().MakeDir(gomock.Any()).Return(nil)
mockMounter.EXPECT().IsLikelyNotMountPoint(gomock.Any()).Return(true, nil)
mockMounter.EXPECT().Mount(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(nil)
mockMounter.EXPECT().Unmount(gomock.Any()).Return(nil)
mockMounter.EXPECT().Stat(gomock.Any()).Return(dirPresent, nil)
mockMounter.EXPECT().IsLikelyNotMountPoint(gomock.Any()).Return(true, nil)
mockCloud.EXPECT().DescribeAccessPoint(gomock.Eq(ctx), gomock.Eq(apId)).Return(accessPoint, nil)
mockCloud.EXPECT().DeleteAccessPoint(gomock.Eq(ctx), gomock.Eq(apId)).Return(nil)
_, err := driver.DeleteVolume(ctx, req)
Expand Down Expand Up @@ -3488,12 +3487,12 @@ func TestDeleteVolume(t *testing.T) {
ctx := context.Background()
// Expect the deletion scenario to only happen once
mockMounter.EXPECT().MakeDir(gomock.Any()).Return(nil).Times(1)
mockMounter.EXPECT().IsLikelyNotMountPoint(gomock.Any()).Return(true, nil).Times(1)
mockMounter.EXPECT().Mount(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(nil).Times(1)
mockMounter.EXPECT().Unmount(gomock.Any()).Return(nil).Times(1)
mockMounter.EXPECT().Stat(gomock.Any()).Return(dirPresent, nil).Times(1)
mockCloud.EXPECT().DeleteAccessPoint(gomock.Eq(ctx), gomock.Eq(apId)).Return(nil).Times(1)

mockMounter.EXPECT().IsLikelyNotMountPoint(gomock.Any()).Return(true, nil).Times(numGoRoutines)
mockMounter.EXPECT().IsLikelyNotMountPoint(gomock.Any()).Return(true, nil).Times(numGoRoutines - 1)

// Expect the first describe call to see the access point, then subsequent calls to see it as deleted
var describeCallCount int32 = 0
Expand Down Expand Up @@ -3603,13 +3602,13 @@ func TestDeleteVolume(t *testing.T) {
ctx := context.Background()
// Expect the deletion scenario to only happen once per access point
mockMounter.EXPECT().MakeDir(gomock.Any()).Return(nil).Times(2)
mockMounter.EXPECT().IsLikelyNotMountPoint(gomock.Any()).Return(true, nil).Times(2)
mockMounter.EXPECT().Mount(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(nil).Times(2)
mockMounter.EXPECT().Unmount(gomock.Any()).Return(nil).Times(2)
mockMounter.EXPECT().Stat(gomock.Any()).Return(dirPresent, nil).Times(2)
mockCloud.EXPECT().DeleteAccessPoint(gomock.Eq(ctx), gomock.Eq(apId)).Return(nil).Times(1)
mockCloud.EXPECT().DeleteAccessPoint(gomock.Eq(ctx), gomock.Eq(apId2)).Return(nil).Times(1)

mockMounter.EXPECT().IsLikelyNotMountPoint(gomock.Any()).Return(true, nil).Times(2 * numGoRoutines)
mockMounter.EXPECT().IsLikelyNotMountPoint(gomock.Any()).Return(true, nil).Times(2*numGoRoutines - 2)

// Expect the first describe call to see the access point, then subsequent calls to see it as deleted
describeCallCountAp1 := 0
Expand Down Expand Up @@ -3960,11 +3959,14 @@ func TestDeleteVolume(t *testing.T) {

ctx := context.Background()
mockMounter.EXPECT().MakeDir(gomock.Any()).Return(nil)
mockMounter.EXPECT().IsLikelyNotMountPoint(gomock.Any()).Return(true, nil)
mockMounter.EXPECT().Mount(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(nil)
mockMounter.EXPECT().Unmount(gomock.Any()).Return(errors.New("Failed to unmount"))
mockMounter.EXPECT().Stat(gomock.Any()).Return(dirPresent, nil).Times(1)
mockMounter.EXPECT().IsLikelyNotMountPoint(gomock.Any()).Return(true, nil).Times(2)
mockCloud.EXPECT().DescribeAccessPoint(gomock.Eq(ctx), gomock.Eq(apId)).Return(accessPoint, nil)
mockCloud.EXPECT().DeleteAccessPoint(gomock.Eq(ctx), gomock.Eq(apId)).Return(errors.New("Failed to delete access point"))
// Deferred cleanup function may try to check and unmount when deletion fails
mockMounter.EXPECT().IsLikelyNotMountPoint(gomock.Any()).Return(false, nil).AnyTimes()
mockMounter.EXPECT().Unmount(gomock.Any()).Return(errors.New("Failed to unmount")).AnyTimes()
_, err := driver.DeleteVolume(ctx, req)
if err == nil {
t.Fatal("DeleteVolume did not fail")
Expand Down Expand Up @@ -4108,6 +4110,58 @@ func TestDeleteVolume(t *testing.T) {
mockCtl.Finish()
},
},
{
name: "Fail: Access point root directory is '/'",
testFunc: func(t *testing.T) {
mockCtl := gomock.NewController(t)
mockCloud := mocks.NewMockCloud(mockCtl)
mockMounter := mocks.NewMockMounter(mockCtl)

driver := &Driver{
endpoint: endpoint,
cloud: mockCloud,
mounter: mockMounter,
gidAllocator: NewGidAllocator(),
deleteAccessPointRootDir: true,
}

req := &csi.DeleteVolumeRequest{
VolumeId: volumeId,
}

accessPoint := &cloud.AccessPoint{
AccessPointId: apId,
FileSystemId: fsId,
AccessPointRootDir: "/",
CapacityGiB: 0,
}

fsRoot := TempMountPathPrefix + "/" + apId

ctx := context.Background()
mockCloud.EXPECT().DescribeAccessPoint(gomock.Eq(ctx), gomock.Eq(apId)).Return(accessPoint, nil)
mockMounter.EXPECT().MakeDir(fsRoot).Return(nil)
mockMounter.EXPECT().IsLikelyNotMountPoint(fsRoot).Return(true, nil)
mockMounter.EXPECT().Mount(fsId, fsRoot, "efs", gomock.Any()).Return(nil)
dirPresent := mocks.NewMockFileInfo(
"testFile",
0,
0755,
time.Now(),
true,
nil,
)
mockMounter.EXPECT().Stat(fsRoot+"/").Return(dirPresent, nil)
// Additional call from deferred cleanup function when deletion fails
mockMounter.EXPECT().IsLikelyNotMountPoint(fsRoot).Return(true, nil)

_, err := driver.DeleteVolume(ctx, req)
if err == nil {
t.Fatalf("DeleteVolume did not fail")
}
mockCtl.Finish()
},
},
}

for _, tc := range testCases {
Expand Down Expand Up @@ -4207,13 +4261,11 @@ func TestCreateDeleteVolumeRace(t *testing.T) {

// Expected delete function calls
mockMounter.EXPECT().MakeDir(gomock.Any()).Return(nil).Times(1)
mockMounter.EXPECT().IsLikelyNotMountPoint(gomock.Any()).Return(true, nil).Times(1)
mockMounter.EXPECT().Mount(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(nil).Times(1)
mockMounter.EXPECT().Unmount(gomock.Any()).Return(nil).Times(1)
mockMounter.EXPECT().Stat(gomock.Any()).Return(dirPresent, nil).Times(1)
mockCloud.EXPECT().DeleteAccessPoint(gomock.Eq(ctx), gomock.Eq(apId)).Return(nil).Times(1)

mockMounter.EXPECT().IsLikelyNotMountPoint(gomock.Any()).Return(true, nil).Times(1)

// Lock the volume mutex to hold threads until they are all scheduled
driver.lockManager.lockMutex(apId)

Expand Down Expand Up @@ -4360,10 +4412,9 @@ func TestCreateDeleteVolumeRace(t *testing.T) {

// Expected delete function calls
mockMounter.EXPECT().MakeDir(gomock.Any()).Return(nil).Times(1)
mockMounter.EXPECT().IsLikelyNotMountPoint(gomock.Any()).Return(true, nil).Times(1)
mockMounter.EXPECT().Mount(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(nil).Times(1)
mockMounter.EXPECT().Unmount(gomock.Any()).Return(nil).Times(1)
mockMounter.EXPECT().Stat(gomock.Any()).Return(dirPresent, nil).Times(1)
mockMounter.EXPECT().IsLikelyNotMountPoint(gomock.Any()).Return(true, nil).Times(1)
mockCloud.EXPECT().DeleteAccessPoint(gomock.Eq(ctx), gomock.Eq(apId)).Return(nil).Times(1)

// Lock the volume mutex to hold threads until they are all scheduled
Expand Down
Loading