feat: add ExpectedErrorf

Convenient. Signed-off-by: Alexey Palazhchenko <[email protected]>
siderolabs · May 14, 2021 · 7885e16 · 7885e16
1 parent 3d83f61
commit 7885e16
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 15 deletions.
diff --git a/retry/constant_test.go b/retry/constant_test.go
@@ -42,7 +42,7 @@ func Test_constantRetryer_Retry(t *testing.T) {
 				f: func() error {
 					count++
 
-					return ExpectedError(fmt.Errorf("expected"))
+					return ExpectedErrorf("expected")
 				},
 			},
 			expectedCount: 3,
@@ -60,7 +60,7 @@ func Test_constantRetryer_Retry(t *testing.T) {
 				f: func() error {
 					count++
 
-					return ExpectedError(fmt.Errorf("expected"))
+					return ExpectedErrorf("expected")
 				},
 			},
 			expectedCount: 5,
@@ -99,7 +99,7 @@ func Test_constantRetryer_Retry(t *testing.T) {
 						return fmt.Errorf("unexpected")
 					}
 
-					return ExpectedError(fmt.Errorf("unexpected"))
+					return ExpectedErrorf("unexpected")
 				},
 			},
 			expectedCount: 2,
@@ -120,7 +120,7 @@ func Test_constantRetryer_Retry(t *testing.T) {
 						return nil
 					}
 
-					return ExpectedError(fmt.Errorf("unexpected"))
+					return ExpectedErrorf("unexpected")
 				},
 			},
 			expectedCount: 2,
@@ -154,7 +154,7 @@ func Test_constantRetryer_Retry(t *testing.T) {
 				f: func() error {
 					count++
 
-					return ExpectedError(fmt.Errorf("expected"))
+					return ExpectedErrorf("expected")
 				},
 			},
 			expectedCount: 1,

diff --git a/retry/exponential_test.go b/retry/exponential_test.go
@@ -42,7 +42,7 @@ func Test_exponentialRetryer_Retry(t *testing.T) {
 				f: func() error {
 					count++
 
-					return ExpectedError(fmt.Errorf("expected"))
+					return ExpectedErrorf("expected")
 				},
 			},
 			expectedCount: 4,
@@ -60,7 +60,7 @@ func Test_exponentialRetryer_Retry(t *testing.T) {
 				f: func() error {
 					count++
 
-					return ExpectedError(fmt.Errorf("expected"))
+					return ExpectedErrorf("expected")
 				},
 			},
 			expectedCount: 5,
@@ -99,7 +99,7 @@ func Test_exponentialRetryer_Retry(t *testing.T) {
 						return fmt.Errorf("unexpected")
 					}
 
-					return ExpectedError(fmt.Errorf("unexpected"))
+					return ExpectedErrorf("unexpected")
 				},
 			},
 			expectedCount: 2,
@@ -120,7 +120,7 @@ func Test_exponentialRetryer_Retry(t *testing.T) {
 						return nil
 					}
 
-					return ExpectedError(fmt.Errorf("unexpected"))
+					return ExpectedErrorf("unexpected")
 				},
 			},
 			expectedCount: 2,
@@ -154,7 +154,7 @@ func Test_exponentialRetryer_Retry(t *testing.T) {
 				f: func() error {
 					count++
 
-					return ExpectedError(fmt.Errorf("expected"))
+					return ExpectedErrorf("expected")
 				},
 			},
 			expectedCount: 2,

diff --git a/retry/linear_test.go b/retry/linear_test.go
@@ -42,7 +42,7 @@ func Test_linearRetryer_Retry(t *testing.T) {
 				f: func() error {
 					count++
 
-					return ExpectedError(fmt.Errorf("expected"))
+					return ExpectedErrorf("expected")
 				},
 			},
 			expectedCount: 5,
@@ -60,7 +60,7 @@ func Test_linearRetryer_Retry(t *testing.T) {
 				f: func() error {
 					count++
 
-					return ExpectedError(fmt.Errorf("expected"))
+					return ExpectedErrorf("expected")
 				},
 			},
 			expectedCount: 9,
@@ -99,7 +99,7 @@ func Test_linearRetryer_Retry(t *testing.T) {
 						return fmt.Errorf("unexpected")
 					}
 
-					return ExpectedError(fmt.Errorf("unexpected"))
+					return ExpectedErrorf("unexpected")
 				},
 			},
 			expectedCount: 1,
@@ -120,7 +120,7 @@ func Test_linearRetryer_Retry(t *testing.T) {
 						return nil
 					}
 
-					return ExpectedError(fmt.Errorf("unexpected"))
+					return ExpectedErrorf("unexpected")
 				},
 			},
 			expectedCount: 2,
@@ -154,7 +154,7 @@ func Test_linearRetryer_Retry(t *testing.T) {
 				f: func() error {
 					count++
 
-					return ExpectedError(fmt.Errorf("expected"))
+					return ExpectedErrorf("expected")
 				},
 			},
 			expectedCount: 1,

diff --git a/retry/retry.go b/retry/retry.go
@@ -159,6 +159,11 @@ func ExpectedError(err error) error {
 	return expectedError{err}
 }
 
+// ExpectedErrorf makes an expected error from given format and arguments.
+func ExpectedErrorf(format string, a ...interface{}) error {
+	return ExpectedError(fmt.Errorf(format, a...))
+}
+
 // UnexpectedError error represents an error that is unexpected by the retrying
 // function. This error is fatal.
 //