-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
tests(logging): Minimized risk of flaky metrics/sinks tests by adding…
… retries (#11331) * tests(logging): Minimized likelihood of metrics/sinks tests failing by adding retries * Made variables private in internal/testing/retry.go * Added comment to Iterator * Updated the version of cloud.google.com/go to v0.117.0 for r.Fatalf
- Loading branch information
1 parent
156f02c
commit 946c3e8
Showing
6 changed files
with
222 additions
and
99 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
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
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,110 @@ | ||
| /* | ||
| Copyright 2024 Google LLC | ||
| 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 testing | ||
|
|
||
| import ( | ||
| "testing" | ||
| "time" | ||
|
|
||
| "cloud.google.com/go/internal/testutil" | ||
| "google.golang.org/api/iterator" | ||
| "google.golang.org/grpc/codes" | ||
| "google.golang.org/grpc/status" | ||
| ) | ||
|
|
||
| var defaultMaxAttempts = 10 | ||
| var defaultSleep = 10 * time.Second | ||
| var defaultRetryableCodes = map[codes.Code]bool{ | ||
| codes.Unavailable: true, | ||
| } | ||
|
|
||
| // Iterator is a wrapper interface type for iterators in the logadmin | ||
| // library that have a Next function that gets the next item/error, or returns | ||
| // nil/iterator.Done if the object has no next item. | ||
| type Iterator[T any] interface { | ||
| Next() (*T, error) | ||
| } | ||
|
|
||
| // handleError handles the given error for the retry attempt. | ||
| func handleError(r *testutil.R, err error) { | ||
| if err != nil { | ||
| s, ok := status.FromError(err) | ||
|
|
||
| // Throw a fatal error if the error is not retryable or if it cannot be converted into | ||
| // a status object. | ||
| if ok && !defaultRetryableCodes[s.Code()] { | ||
| r.Fatalf("%+v\n", err) | ||
| } else if ok { | ||
| r.Errorf("%+v\n", err) | ||
| } else { | ||
| r.Fatalf("%+v\n", err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Retry is a wrapper around testutil.Retry that retries the test function on Unavailable errors, otherwise, Fatalfs. | ||
| func Retry(t *testing.T, f func(r *testutil.R) error) bool { | ||
| retryFunc := func(r *testutil.R) { | ||
| err := f(r) | ||
| handleError(r, err) | ||
| } | ||
| return testutil.Retry(t, defaultMaxAttempts, defaultSleep, retryFunc) | ||
| } | ||
|
|
||
| // RetryAndExpectError retries the test function on Unavailable errors, otherwise passes | ||
| // if a different error was thrown. If no non-retryable error is returned, fails. | ||
| func RetryAndExpectError(t *testing.T, f func(r *testutil.R) error) bool { | ||
| retryFunc := func(r *testutil.R) { | ||
| err := f(r) | ||
|
|
||
| if err != nil { | ||
| s, ok := status.FromError(err) | ||
|
|
||
| // Only retry on retryable errors, otherwise pass. | ||
| if ok && defaultRetryableCodes[s.Code()] { | ||
| r.Errorf("%+v\n", err) | ||
| } | ||
| } else { | ||
| r.Fatalf("got no error, expected one") | ||
| } | ||
| } | ||
|
|
||
| return testutil.Retry(t, defaultMaxAttempts, defaultSleep, retryFunc) | ||
| } | ||
|
|
||
| // RetryIteratorNext is a wrapper around testutil.Retry that retries the given iterator's Next function | ||
| // and returns the next object, retrying if a retryable error is found. If a non-retryable error is found, fail | ||
| // the test. | ||
| func RetryIteratorNext[T any](t *testing.T, it Iterator[T]) (*T, bool) { | ||
| var next *T | ||
| var err error | ||
| retryFunc := func(r *testutil.R) { | ||
| next, err = it.Next() | ||
| if err != nil { | ||
| if err == iterator.Done { | ||
| return | ||
| } | ||
|
|
||
| handleError(r, err) | ||
| } | ||
| } | ||
| testutil.Retry(t, defaultMaxAttempts, defaultSleep, retryFunc) | ||
| if err == iterator.Done { | ||
| return nil, true | ||
| } | ||
| return next, false | ||
| } |
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.