-
Notifications
You must be signed in to change notification settings - Fork 77
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CLOUDP-251510: test/helper/retry: add helper for get+mutate+update re…
…tries (#1625) * test/helper/retry: add helper for get+mutate+update retries * address import name
- Loading branch information
1 parent
81988e5
commit 37f229e
Showing
3 changed files
with
156 additions
and
28 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,28 @@ | ||
| package retry | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "k8s.io/client-go/util/retry" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| ) | ||
|
|
||
| // RetryUpdateOnConflict is a wrapper around client-go/util/retry.RetryOnConflict, | ||
| // adding the following often repeated actions: | ||
| // | ||
| // 1. client.Get a resource for the given key | ||
| // 2. mutate the retrieved object using the given mutator function. | ||
| // 3. client.Update the updated resource and retry on conflict | ||
| // using the client-go/util/retry.DefaultRetry strategy. | ||
| func RetryUpdateOnConflict[T any](ctx context.Context, k8s client.Client, key client.ObjectKey, mutator func(*T)) (*T, error) { | ||
| var obj T | ||
| clientObj := any(&obj).(client.Object) | ||
| err := retry.RetryOnConflict(retry.DefaultRetry, func() error { | ||
| if err := k8s.Get(ctx, key, clientObj); err != nil { | ||
| return err | ||
| } | ||
| mutator(&obj) | ||
| return k8s.Update(ctx, clientObj) | ||
| }) | ||
| return &obj, err | ||
| } |
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,113 @@ | ||
| package retry | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "reflect" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| apierrors "k8s.io/apimachinery/pkg/api/errors" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| "sigs.k8s.io/controller-runtime/pkg/client/fake" | ||
| "sigs.k8s.io/controller-runtime/pkg/client/interceptor" | ||
|
|
||
| akov2 "github.com/mongodb/mongodb-atlas-kubernetes/v2/pkg/api/v1" | ||
| ) | ||
|
|
||
| func TestRetryUpdateOnConflict(t *testing.T) { | ||
| for _, tc := range []struct { | ||
| name string | ||
| key client.ObjectKey | ||
| objects []client.Object | ||
| interceptorFuncs interceptor.Funcs | ||
|
|
||
| want *akov2.AtlasProject | ||
| wantErr string | ||
| }{ | ||
| { | ||
| name: "fail immediately if not found", | ||
| key: types.NamespacedName{ | ||
| Name: "foo", | ||
| Namespace: "bar", | ||
| }, | ||
| want: &akov2.AtlasProject{}, | ||
| wantErr: "atlasprojects.atlas.mongodb.com \"foo\" not found", | ||
| }, | ||
| { | ||
| name: "succeed if found", | ||
| key: types.NamespacedName{ | ||
| Name: "foo", | ||
| Namespace: "bar", | ||
| }, | ||
| objects: []client.Object{ | ||
| &akov2.AtlasProject{ObjectMeta: metav1.ObjectMeta{Name: "foo", Namespace: "bar"}}, | ||
| }, | ||
| want: &akov2.AtlasProject{ObjectMeta: metav1.ObjectMeta{Name: "foo", Namespace: "bar"}}, | ||
| }, | ||
| { | ||
| name: "exhaust on conflict", | ||
| key: types.NamespacedName{ | ||
| Name: "foo", | ||
| Namespace: "bar", | ||
| }, | ||
| objects: []client.Object{ | ||
| &akov2.AtlasProject{ObjectMeta: metav1.ObjectMeta{Name: "foo", Namespace: "bar"}}, | ||
| }, | ||
| interceptorFuncs: interceptor.Funcs{ | ||
| Update: func(context.Context, client.WithWatch, client.Object, ...client.UpdateOption) error { | ||
| return &apierrors.StatusError{ErrStatus: metav1.Status{Reason: metav1.StatusReasonConflict, Message: "conflict"}} | ||
| }, | ||
| }, | ||
| want: &akov2.AtlasProject{ObjectMeta: metav1.ObjectMeta{Name: "foo", Namespace: "bar"}}, | ||
| wantErr: "conflict", | ||
| }, | ||
| { | ||
| name: "fail on any other update error", | ||
| key: types.NamespacedName{ | ||
| Name: "foo", | ||
| Namespace: "bar", | ||
| }, | ||
| objects: []client.Object{ | ||
| &akov2.AtlasProject{ObjectMeta: metav1.ObjectMeta{Name: "foo", Namespace: "bar"}}, | ||
| }, | ||
| interceptorFuncs: interceptor.Funcs{ | ||
| Update: func(context.Context, client.WithWatch, client.Object, ...client.UpdateOption) error { | ||
| return errors.New("boom") | ||
| }, | ||
| }, | ||
| want: &akov2.AtlasProject{ObjectMeta: metav1.ObjectMeta{Name: "foo", Namespace: "bar"}}, | ||
| wantErr: "boom", | ||
| }, | ||
| } { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| testScheme := runtime.NewScheme() | ||
| assert.NoError(t, akov2.AddToScheme(testScheme)) | ||
| k8sClient := fake.NewClientBuilder(). | ||
| WithScheme(testScheme). | ||
| WithObjects(tc.objects...). | ||
| WithInterceptorFuncs(tc.interceptorFuncs). | ||
| Build() | ||
|
|
||
| got, err := RetryUpdateOnConflict(context.Background(), k8sClient, tc.key, func(*akov2.AtlasProject) {}) | ||
| gotErr := "" | ||
| if err != nil { | ||
| gotErr = err.Error() | ||
| } | ||
|
|
||
| if gotErr != tc.wantErr { | ||
| t.Errorf("want error %q, got %q", tc.wantErr, gotErr) | ||
| } | ||
|
|
||
| // ignore unnecessary fields | ||
| got.ResourceVersion = "" | ||
|
|
||
| if !reflect.DeepEqual(got, tc.want) { | ||
| t.Errorf("want AtlasProject %+v, got %+v", tc.want, got) | ||
| } | ||
| }) | ||
| } | ||
| } |
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