mirrors/velero
1
0
Fork 0
mirror of https://github.com/vmware-tanzu/velero.git synced 2026-08-20 22:26:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Refactor: Replace context.TODO() with properly plumbed contexts in CSI actions (#10247)

Browse Source 
Signed-off-by: opbot_xd <awasthikrishna23052005@gmail.com>
This commit is contained in:
Krishna Awasthi
2026-08-14 16:17:29 +08:00
committed by GitHub
parent 798e34054b
commit 41b95b5919
7 changed files with 44 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/util/csi/volume_snapshot.go
+17 -9
View File
@@ -112,6 +112,7 @@ func WaitVolumeSnapshotReady(
// GetVolumeSnapshotContentForVolumeSnapshot returns the VolumeSnapshotContent
// object associated with the VolumeSnapshot.
func GetVolumeSnapshotContentForVolumeSnapshot(
ctx context.Context,
volSnap *snapshotv1api.VolumeSnapshot,
snapshotClient snapshotter.SnapshotV1Interface,
) (*snapshotv1api.VolumeSnapshotContent, error) {
@@ -120,7 +121,7 @@ func GetVolumeSnapshotContentForVolumeSnapshot(
}
vsc, err := snapshotClient.VolumeSnapshotContents().Get(
context.TODO(),
ctx,
*volSnap.Status.BoundVolumeSnapshotContentName,
metav1.GetOptions{},
)
@@ -309,6 +310,7 @@ func patchVSC(
}
func GetVolumeSnapshotClass(
ctx context.Context,
provisioner string,
backup *velerov1api.Backup,
pvc *corev1api.PersistentVolumeClaim,
@@ -317,7 +319,7 @@ func GetVolumeSnapshotClass(
policySnapshotClass string,
) (*snapshotv1api.VolumeSnapshotClass, error) {
snapshotClasses := new(snapshotv1api.VolumeSnapshotClassList)
err := crClient.List(context.TODO(), snapshotClasses)
err := crClient.List(ctx, snapshotClasses)
if err != nil {
return nil, errors.Wrap(err, "error listing VolumeSnapshotClass")
}
@@ -517,13 +519,14 @@ func IsVolumeSnapshotContentHasDeleteSecret(vsc *snapshotv1api.VolumeSnapshotCon
// IsVolumeSnapshotExists returns whether a specific volumesnapshot object exists.
func IsVolumeSnapshotExists(
ctx context.Context,
ns,
name string,
crClient crclient.Client,
) bool {
vs := new(snapshotv1api.VolumeSnapshot)
err := crClient.Get(
context.TODO(),
ctx,
crclient.ObjectKey{Namespace: ns, Name: name},
vs,
)
@@ -532,24 +535,26 @@ func IsVolumeSnapshotExists(
}
func SetVolumeSnapshotContentDeletionPolicy(
ctx context.Context,
vscName string,
crClient crclient.Client,
policy snapshotv1api.DeletionPolicy,
) (*snapshotv1api.VolumeSnapshotContent, error) {
vsc := new(snapshotv1api.VolumeSnapshotContent)
if err := crClient.Get(context.TODO(), crclient.ObjectKey{Name: vscName}, vsc); err != nil {
if err := crClient.Get(ctx, crclient.ObjectKey{Name: vscName}, vsc); err != nil {
return nil, err
}
originVSC := vsc.DeepCopy()
vsc.Spec.DeletionPolicy = policy
return vsc, crClient.Patch(context.TODO(), vsc, crclient.MergeFrom(originVSC))
return vsc, crClient.Patch(ctx, vsc, crclient.MergeFrom(originVSC))
}
// CleanupVolumeSnapshot deletes the VolumeSnapshot and the associated VolumeSnapshotContent. It will make sure the
// physical snapshot is also deleted.
func CleanupVolumeSnapshot(
ctx context.Context,
volSnap *snapshotv1api.VolumeSnapshot,
crClient crclient.Client,
log logrus.FieldLogger,
@@ -557,7 +562,7 @@ func CleanupVolumeSnapshot(
log.Infof("Deleting Volumesnapshot %s/%s", volSnap.Namespace, volSnap.Name)
vs := new(snapshotv1api.VolumeSnapshot)
err := crClient.Get(
context.TODO(),
ctx,
crclient.ObjectKey{Name: volSnap.Name, Namespace: volSnap.Namespace},
vs,
)
@@ -570,6 +575,7 @@ func CleanupVolumeSnapshot(
// we patch the DeletionPolicy of the VolumeSnapshotContent to set it to Delete.
// This ensures that the volume snapshot in the storage provider is also deleted.
_, err := SetVolumeSnapshotContentDeletionPolicy(
ctx,
*vs.Status.BoundVolumeSnapshotContentName,
crClient,
snapshotv1api.VolumeSnapshotContentDelete,
@@ -579,7 +585,7 @@ func CleanupVolumeSnapshot(
vs.Namespace, vs.Name)
}
}
err = crClient.Delete(context.TODO(), vs)
err = crClient.Delete(ctx, vs)
if err != nil {
log.Debugf("Failed to delete volumesnapshot %s/%s: %v", vs.Namespace, vs.Name, err)
} else {
@@ -589,6 +595,7 @@ func CleanupVolumeSnapshot(
}
func DeleteReadyVolumeSnapshot(
ctx context.Context,
vs snapshotv1api.VolumeSnapshot,
client crclient.Client,
logger logrus.FieldLogger,
@@ -610,6 +617,7 @@ func DeleteReadyVolumeSnapshot(
// Patch the DeletionPolicy of the VolumeSnapshotContent to set it to Retain.
// This ensures that the volume snapshot in the storage provider is kept.
if vsc, err = SetVolumeSnapshotContentDeletionPolicy(
ctx,
*vs.Status.BoundVolumeSnapshotContentName,
client,
snapshotv1api.VolumeSnapshotContentRetain,
@@ -619,11 +627,11 @@ func DeleteReadyVolumeSnapshot(
return
}
if err := client.Delete(context.TODO(), vsc); err != nil {
if err := client.Delete(ctx, vsc); err != nil {
logger.WithError(err).Warnf("Failed to delete the VolumeSnapshotContent %s", vsc.Name)
}
}
if err := client.Delete(context.TODO(), &vs); err != nil {
if err := client.Delete(ctx, &vs); err != nil {
logger.WithError(err).Warnf("Failed to delete VolumeSnapshot %s", vs.Namespace+"/"+vs.Name)
} else {
logger.Infof("Deleted VolumeSnapshot %s and VolumeSnapshotContent %s",
pkg/util/csi/volume_snapshot_test.go
+6 -4
View File
@@ -17,6 +17,7 @@ limitations under the License.
package csi
import (
"context"
"errors"
"testing"
"time"
@@ -286,7 +287,7 @@ func TestGetVolumeSnapshotContentForVolumeSnapshot(t *testing.T) {
t.Run(test.name, func(t *testing.T) {
fakeClient := snapshotFake.NewSimpleClientset(test.clientObj...)
vs, err := GetVolumeSnapshotContentForVolumeSnapshot(test.snapshotObj, fakeClient.SnapshotV1())
vs, err := GetVolumeSnapshotContentForVolumeSnapshot(context.TODO(), test.snapshotObj, fakeClient.SnapshotV1())
if err != nil {
require.EqualError(t, err, test.err)
} else {
@@ -1032,6 +1033,7 @@ func TestGetVolumeSnapshotClass(t *testing.T) {
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
actualSnapshotClass, actualError := GetVolumeSnapshotClass(
context.TODO(),
tc.driverName, tc.backup, tc.pvc, logrus.New(), fakeClient, "")
if tc.expectError {
require.Error(t, actualError)
@@ -1458,7 +1460,7 @@ func TestIsVolumeSnapshotExists(t *testing.T) {
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
actual := IsVolumeSnapshotExists(tc.vs.Namespace, tc.vs.Name, fakeClient)
actual := IsVolumeSnapshotExists(context.TODO(), tc.vs.Namespace, tc.vs.Name, fakeClient)
assert.Equal(t, tc.expected, actual)
})
}
@@ -1529,7 +1531,7 @@ func TestSetVolumeSnapshotContentDeletionPolicy(t *testing.T) {
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
fakeClient := velerotest.NewFakeControllerRuntimeClient(t, tc.objs...)
_, err := SetVolumeSnapshotContentDeletionPolicy(tc.inputVSCName, fakeClient, tc.policy)
_, err := SetVolumeSnapshotContentDeletionPolicy(context.TODO(), tc.inputVSCName, fakeClient, tc.policy)
if tc.expectError {
assert.Error(t, err)
} else {
@@ -1586,7 +1588,7 @@ func TestDeleteVolumeSnapshots(t *testing.T) {
)
logger := logging.DefaultLogger(logrus.DebugLevel, logging.FormatText)
DeleteReadyVolumeSnapshot(tc.vs, client, logger)
DeleteReadyVolumeSnapshot(context.TODO(), tc.vs, client, logger)
vsList := new(snapshotv1api.VolumeSnapshotList)
err := client.List(