add ctx to Set function (#2405)

Signed-off-by: Adam Krpan <[email protected]>
libopenstorage · Feb 13, 2024 · 967cfd8 · 967cfd8
1 parent 87df45b
commit 967cfd8
Show file tree

Hide file tree

Showing 17 changed files with 42 additions and 44 deletions.
diff --git a/api/client/volume/client.go b/api/client/volume/client.go
@@ -452,8 +452,7 @@ func (v *volumeClient) Unmount(ctx context.Context, volumeID string, mountPath s
 }
 
 // Update volume
-func (v *volumeClient) Set(volumeID string, locator *api.VolumeLocator,
- spec *api.VolumeSpec) error {
+func (v *volumeClient) Set(ctx context.Context, volumeID string, locator *api.VolumeLocator, spec *api.VolumeSpec) error {
  return v.doVolumeSet(correlation.TODO(),
  volumeID,
  &api.VolumeSetRequest{

diff --git a/api/server/middleware_auth.go b/api/server/middleware_auth.go
@@ -205,7 +205,7 @@ func (a *authMiddleware) setWithAuth(w http.ResponseWriter, r *http.Request, nex
 
  if req.Spec != nil && req.Spec.Size > 0 {
  isOpDone = true
- err = d.Set(volumeID, req.Locator, req.Spec)
+ err = d.Set(ctx, volumeID, req.Locator, req.Spec)
  }
 
  for err == nil && req.Action != nil {

diff --git a/api/server/sdk/volume_ops.go b/api/server/sdk/volume_ops.go
@@ -729,7 +729,7 @@ func (s *VolumeServer) Update(
  maskUnModified(updatedSpec, req.GetSpec())
 
  // Send to driver
- if err := s.driver(ctx).Set(req.GetVolumeId(), locator, updatedSpec); err != nil {
+ if err := s.driver(ctx).Set(ctx, req.GetVolumeId(), locator, updatedSpec); err != nil {
  return nil, status.Errorf(codes.Internal, "Failed to update volume: %v", err)
  }
 

diff --git a/api/server/sdk/volume_ops_test.go b/api/server/sdk/volume_ops_test.go
@@ -647,7 +647,7 @@ func TestSdkVolumeUpdate(t *testing.T) {
  AnyTimes()
  s.MockDriver().
  EXPECT().
- Set(id, &api.VolumeLocator{VolumeLabels: newlabels}, &api.VolumeSpec{SnapshotInterval: math.MaxUint32}).
+ Set(gomock.Any(), id, &api.VolumeLocator{VolumeLabels: newlabels}, &api.VolumeSpec{SnapshotInterval: math.MaxUint32}).
  Return(nil).
  Times(1)
 
@@ -668,7 +668,7 @@ func TestSdkVolumeUpdate(t *testing.T) {
 
  s.MockDriver().
  EXPECT().
- Set(id, nil, &api.VolumeSpec{Size: 1234, SnapshotInterval: math.MaxUint32}).
+ Set(gomock.Any(), id, nil, &api.VolumeSpec{Size: 1234, SnapshotInterval: math.MaxUint32}).
  Return(nil).
  Times(1)
  _, err = c.Update(context.Background(), req)
@@ -687,7 +687,7 @@ func TestSdkVolumeUpdate(t *testing.T) {
 
  s.MockDriver().
  EXPECT().
- Set(
+ Set(gomock.Any(),
  id,
  &api.VolumeLocator{VolumeLabels: newlabels},
  &api.VolumeSpec{Size: 1234, SnapshotInterval: math.MaxUint32},
@@ -1156,7 +1156,7 @@ func TestSdkCloneOwnership(t *testing.T) {
  Times(1),
  mv.
  EXPECT().
- Set(id, nil, &api.VolumeSpec{
+ Set(gomock.Any(), id, nil, &api.VolumeSpec{
  Size: 1234,
  Ownership: &api.Ownership{
  Owner: user2,
@@ -1283,7 +1283,7 @@ func TestSdkCloneOwnership(t *testing.T) {
  Times(1),
  mv.
  EXPECT().
- Set(id, nil, &api.VolumeSpec{
+ Set(gomock.Any(), id, nil, &api.VolumeSpec{
  Size: 1234,
  Ownership: &api.Ownership{
  Owner: user2,
@@ -1803,7 +1803,7 @@ func TestSdkVolumeUpdatePolicyOwnership(t *testing.T) {
  AnyTimes()
  mv.
  EXPECT().
- Set(id, nil, volPolSpec).
+ Set(gomock.Any(), id, nil, volPolSpec).
  Return(nil).
  Times(1)
 

diff --git a/api/server/sdk/volume_snapshot_test.go b/api/server/sdk/volume_snapshot_test.go
@@ -6,7 +6,7 @@ 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
+ 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,
@@ -18,6 +18,7 @@ package sdk
 
 import (
  "context"
+ "github.com/golang/mock/gomock"
  "math"
  "testing"
 
@@ -311,7 +312,7 @@ func TestSdkVolumeSnapshotScheduleUpdate(t *testing.T) {
  Times(1)
  s.MockDriver().
  EXPECT().
- Set(volid, nil, &api.VolumeSpec{
+ Set(gomock.Any(), volid, nil, &api.VolumeSpec{
  SnapshotSchedule: "policy=mypolicy",
  SnapshotInterval: math.MaxUint32,
  }).
@@ -348,7 +349,7 @@ func TestSdkVolumeSnapshotScheduleUpdateDelete(t *testing.T) {
  AnyTimes()
  s.MockDriver().
  EXPECT().
- Set(volid, nil, &api.VolumeSpec{
+ Set(gomock.Any(), volid, nil, &api.VolumeSpec{
  SnapshotSchedule: "",
  SnapshotInterval: math.MaxUint32,
  }).

diff --git a/api/server/volume_test.go b/api/server/volume_test.go
@@ -123,7 +123,7 @@ func TestVolumeNoAuth(t *testing.T) {
 
  newspec := req.GetSpec()
  newspec.Size = newsize
- resp := driverclient.Set(id, req.GetLocator(), newspec)
+ resp := driverclient.Set(context.TODO(), id, req.GetLocator(), newspec)
  assert.Nil(t, resp)
 
  // INSPECT
@@ -792,7 +792,7 @@ func TestVolumeSetSuccess(t *testing.T) {
  Spec: &api.VolumeSpec{Size: newsize},
  }
 
- res := driverclient.Set(id, req.GetLocator(), req2.GetSpec())
+ res := driverclient.Set(context.TODO(), id, req.GetLocator(), req2.GetSpec())
  assert.Nil(t, res)
 
  // Assert volume information is correct
@@ -807,13 +807,11 @@ func TestVolumeSetSuccess(t *testing.T) {
  assert.Equal(t, newsize, r.GetVolume().GetSpec().GetSize())
 
  // Send HA request
- res = driverclient.Set(id,
- nil,
- &api.VolumeSpec{
- HaLevel: 2,
- ReplicaSet: &api.ReplicaSet{Nodes: []string{}},
- SnapshotInterval: math.MaxUint32,
- })
+ res = driverclient.Set(context.TODO(), id, nil, &api.VolumeSpec{
+ HaLevel: 2,
+ ReplicaSet: &api.ReplicaSet{Nodes: []string{}},
+ SnapshotInterval: math.MaxUint32,
+ })
  assert.Nil(t, res, fmt.Sprintf("Error: %v", res))
 
  // Assert volume information is correct
@@ -883,7 +881,7 @@ func TestVolumeSetFailed(t *testing.T) {
  Spec: &api.VolumeSpec{Size: size, HaLevel: halevel},
  }
  // Cannot get this to fail....
- err = driverclient.Set("doesnotexist", req2.GetLocator(), req2.GetSpec())
+ err = driverclient.Set(context.TODO(), "doesnotexist", req2.GetLocator(), req2.GetSpec())
  // assert.NotNil(t, err)
 
  // Assert volume information is correct
@@ -928,7 +926,7 @@ func TestMiddlewareVolumeSetSizeSuccess(t *testing.T) {
 
  // Not setting mock secrets
 
- err = driverclient.Set(id, nil, req.GetSpec())
+ err = driverclient.Set(context.TODO(), id, nil, req.GetSpec())
  assert.NoError(t, err, "Unexpected error on Set")
 
  // Assert volume information is correct
@@ -975,7 +973,7 @@ func TestMiddlewareVolumeSetFailure(t *testing.T) {
 
  // Not setting mock secrets
 
- err = driverclient.Set(id, &api.VolumeLocator{Name: "myvol"}, req.GetSpec())
+ err = driverclient.Set(context.TODO(), id, &api.VolumeLocator{Name: "myvol"}, req.GetSpec())
  assert.Error(t, err, "Unexpected error on Set")
 
 }

diff --git a/csi/controller_test.go b/csi/controller_test.go
@@ -1947,7 +1947,7 @@ func TestControllerCreateVolumeFromSnapshot(t *testing.T) {
 
  s.MockDriver().
  EXPECT().
- Set(gomock.Any(), gomock.Any(), gomock.Any()).
+ Set(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).
  Return(nil).
  Times(1),
 
@@ -2084,7 +2084,7 @@ func TestControllerCreateVolumeSnapshotThroughParameters(t *testing.T) {
  Times(1),
  s.MockDriver().
  EXPECT().
- Set(gomock.Any(), gomock.Any(), gomock.Any()).
+ Set(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).
  Return(nil).
  Times(1),
  // final inspect
@@ -2742,7 +2742,7 @@ func TestControllerExpandVolume(t *testing.T) {
  AnyTimes(),
  s.MockDriver().
  EXPECT().
- Set(gomock.Any(), gomock.Any(), &api.VolumeSpec{
+ Set(gomock.Any(), gomock.Any(), gomock.Any(), &api.VolumeSpec{
  Size: 46 * units.GiB, // Round up from 45.5 to 46
  SnapshotInterval: math.MaxUint32,
  }).

diff --git a/pkg/sanity/volume.go b/pkg/sanity/volume.go
@@ -617,7 +617,7 @@ var _ = Describe("Volume [Volume Tests]", func() {
  },
  }
 
- err = volumedriver.Set(volumeID, set.GetLocator(), set.GetSpec())
+ err = volumedriver.Set(context.TODO(), volumeID, set.GetLocator(), set.GetSpec())
  Expect(err).NotTo(HaveOccurred())
 
  By("Inspecting the volume for new updates")
@@ -679,7 +679,7 @@ var _ = Describe("Volume [Volume Tests]", func() {
  },
  }
 
- err = volumedriver.Set(volumeID, set.Locator, set.Spec)
+ err = volumedriver.Set(context.TODO(), volumeID, set.Locator, set.Spec)
  Expect(err).NotTo(HaveOccurred())
 
  By("Inspecting the volume for new updates")

diff --git a/volume/drivers/buse/buse.go b/volume/drivers/buse/buse.go
@@ -360,7 +360,7 @@ func (d *driver) SnapshotGroup(groupID string, labels map[string]string, volumeI
  return nil, volume.ErrNotSupported
 }
 
-func (d *driver) Set(volumeID string, locator *api.VolumeLocator, spec *api.VolumeSpec) error {
+func (d *driver) Set(ctx context.Context, volumeID string, locator *api.VolumeLocator, spec *api.VolumeSpec) error {
  if spec != nil {
  return volume.ErrNotSupported
  }

diff --git a/volume/drivers/fake/fake.go b/volume/drivers/fake/fake.go
@@ -335,7 +335,7 @@ func (d *driver) CloudMigrateStatus(request *api.CloudMigrateStatusRequest) (*ap
  }, nil
 }
 
-func (d *driver) Set(volumeID string, locator *api.VolumeLocator, spec *api.VolumeSpec) error {
+func (d *driver) Set(ctx context.Context, volumeID string, locator *api.VolumeLocator, spec *api.VolumeSpec) error {
  v, err := d.GetVol(volumeID)
  if err != nil {
  return err

diff --git a/volume/drivers/fake/fake_test.go b/volume/drivers/fake/fake_test.go
@@ -715,7 +715,7 @@ func TestFakeSet(t *testing.T) {
  assert.NotEmpty(t, volid)
 
  // Set values
- err = d.Set(volid, &api.VolumeLocator{
+ err = d.Set(context.TODO(), volid, &api.VolumeLocator{
  Name: "newname",
  VolumeLabels: map[string]string{
  "hello": "world",

diff --git a/volume/drivers/fuse/volume_driver.go b/volume/drivers/fuse/volume_driver.go
@@ -178,7 +178,7 @@ func (v *volumeDriver) Unmount(ctx context.Context, volumeID string, mountpath s
  return v.UpdateVol(volume)
 }
 
-func (v *volumeDriver) Set(volumeID string, locator *api.VolumeLocator, spec *api.VolumeSpec) error {
+func (v *volumeDriver) Set(ctx context.Context, volumeID string, locator *api.VolumeLocator, spec *api.VolumeSpec) error {
  return volume.ErrNotSupported
 
 }

diff --git a/volume/drivers/mock/driver.mock.go b/volume/drivers/mock/driver.mock.go
diff --git a/volume/drivers/nfs/nfs.go b/volume/drivers/nfs/nfs.go
@@ -787,7 +787,7 @@ func (d *driver) Detach(ctx context.Context, volumeID string, options map[string
  return nil
 }
 
-func (d *driver) Set(volumeID string, locator *api.VolumeLocator, spec *api.VolumeSpec) error {
+func (d *driver) Set(ctx context.Context, volumeID string, locator *api.VolumeLocator, spec *api.VolumeSpec) error {
  if spec != nil {
  return volume.ErrNotSupported
  }

diff --git a/volume/drivers/test/driver.go b/volume/drivers/test/driver.go
@@ -149,7 +149,7 @@ func set(t *testing.T, ctx *Context) {
  require.Equal(t, vols[0].Id, ctx.volID, "Expect volID %v actual %v", ctx.volID, vols[0].Id)
 
  vols[0].Locator.VolumeLabels["UpdateTest"] = "Success"
- err = ctx.Set(ctx.volID, vols[0].Locator, nil)
+ err = ctx.Set(correlation.TODO(), ctx.volID, vols[0].Locator, nil)
  if err != volume.ErrNotSupported {
  require.NoError(t, err, "Failed in Update")
  vols, err = ctx.Inspect(correlation.TODO(), []string{ctx.volID})

diff --git a/volume/drivers/vfs/vfs.go b/volume/drivers/vfs/vfs.go
@@ -169,7 +169,7 @@ func (d *driver) Unmount(ctx context.Context, volumeID string, mountpath string,
  return d.UpdateVol(v)
 }
 
-func (d *driver) Set(volumeID string, locator *api.VolumeLocator, spec *api.VolumeSpec) error {
+func (d *driver) Set(ctx context.Context, volumeID string, locator *api.VolumeLocator, spec *api.VolumeSpec) error {
  if spec != nil {
  return volume.ErrNotSupported
  }

diff --git a/volume/volume.go b/volume/volume.go
@@ -282,7 +282,7 @@ type ProtoDriver interface {
  Unmount(ctx context.Context, volumeID string, mountPath string, options map[string]string) error
  // Update not all fields of the spec are supported, ErrNotSupported will be thrown for unsupported
  // updates.
- Set(volumeID string, locator *api.VolumeLocator, spec *api.VolumeSpec) error
+ Set(ctx context.Context, volumeID string, locator *api.VolumeLocator, spec *api.VolumeSpec) error
  // Status returns a set of key-value pairs which give low
  // level diagnostic status about this driver.
  Status() [][2]string