Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improves unittest CC for azure_error and azure_retry #91439

Merged
merged 1 commit into from May 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -25,6 +25,7 @@ go_test(
],
embed = [":go_default_library"],
deps = [
"//vendor/github.com/Azure/go-autorest/autorest:go_default_library",
"//vendor/github.com/Azure/go-autorest/autorest/mocks:go_default_library",
"//vendor/github.com/stretchr/testify/assert:go_default_library",
],
Expand Down
Expand Up @@ -29,6 +29,40 @@ import (
"github.com/stretchr/testify/assert"
)

func TestNewError(t *testing.T) {
rawErr := fmt.Errorf("HTTP status code (404)")
newerr := NewError(true, rawErr)
assert.Equal(t, true, newerr.Retriable)
assert.Equal(t, rawErr, newerr.RawError)
}

func TestGetRetriableError(t *testing.T) {
rawErr := fmt.Errorf("HTTP status code (404)")
newerr := GetRetriableError(rawErr)
assert.Equal(t, true, newerr.Retriable)
assert.Equal(t, rawErr, newerr.RawError)
}

func TestGetRateLimitError(t *testing.T) {
opType := "write"
opName := "opNameTest"
rawErr := fmt.Errorf("azure cloud provider rate limited(%s) for operation %q", opType, opName)
newerr := GetRateLimitError(true, opName)
assert.Equal(t, true, newerr.Retriable)
assert.Equal(t, rawErr, newerr.RawError)
}

func TestGetThrottlingError(t *testing.T) {
operation := "operationtest"
reason := "reasontest"
rawErr := fmt.Errorf("azure cloud provider throttled for operation %s with reason %q", operation, reason)
onehourlater := time.Now().Add(time.Hour * 1)
newerr := GetThrottlingError(operation, reason, onehourlater)
assert.Equal(t, true, newerr.Retriable)
assert.Equal(t, rawErr, newerr.RawError)
assert.Equal(t, onehourlater, newerr.RetryAfter)
}

func TestGetError(t *testing.T) {
now = func() time.Time {
return time.Time{}
Expand Down Expand Up @@ -104,6 +138,19 @@ func TestGetError(t *testing.T) {
}
}

func TestGetErrorNil(t *testing.T) {
rerr := GetError(nil, nil)
assert.Nil(t, rerr)

// null body
resp := &http.Response{
StatusCode: http.StatusBadRequest,
Body: nil,
}
rerr = GetError(resp, nil)
assert.Equal(t, fmt.Errorf("empty HTTP response"), rerr.RawError)
}

func TestGetStatusNotFoundAndForbiddenIgnoredError(t *testing.T) {
now = func() time.Time {
return time.Time{}
Expand Down Expand Up @@ -256,6 +303,11 @@ func TestIsSuccessResponse(t *testing.T) {
}
}

func TestIsSuccessResponseNil(t *testing.T) {
res := isSuccessHTTPResponse(nil)
assert.Equal(t, false, res)
}

func TestIsThrottled(t *testing.T) {
tests := []struct {
err *Error
Expand Down Expand Up @@ -290,3 +342,13 @@ func TestIsThrottled(t *testing.T) {
assert.Equal(t, test.expected, real)
}
}

func TestIsErrorRetriable(t *testing.T) {
// flase case
result := IsErrorRetriable(nil)
assert.Equal(t, false, result)

// true case
result = IsErrorRetriable(fmt.Errorf("Retriable: true"))
assert.Equal(t, true, result)
}
Expand Up @@ -26,10 +26,85 @@ import (
"testing"
"time"

"github.com/Azure/go-autorest/autorest"
"github.com/Azure/go-autorest/autorest/mocks"
"github.com/stretchr/testify/assert"
)

func TestNewBackoff(t *testing.T) {
expected := &Backoff{Duration: time.Second, Factor: 2, Steps: 0, Cap: 3 * time.Second, Jitter: 0.5}
result := NewBackoff(time.Second, 2, 0.5, 0, 3*time.Second)
assert.Equal(t, expected, result)
}

func TestWithNonRetriableErrors(t *testing.T) {
bo := &Backoff{Duration: time.Second, Factor: 2, Steps: 0, Cap: 3 * time.Second, Jitter: 0.5}
errs := []string{"error1", "error2"}
expected := bo
expected.NonRetriableErrors = errs
result := bo.WithNonRetriableErrors(errs)
assert.Equal(t, expected, result)
}

func TestWithRetriableHTTPStatusCodes(t *testing.T) {
bo := &Backoff{Duration: time.Second, Factor: 2, Steps: 0, Cap: 3 * time.Second, Jitter: 0.5}
httpStatusCodes := []int{http.StatusOK, http.StatusTooManyRequests}
expected := bo
expected.RetriableHTTPStatusCodes = httpStatusCodes
result := bo.WithRetriableHTTPStatusCodes(httpStatusCodes)
assert.Equal(t, expected, result)
}

func TestIsNonRetriableError(t *testing.T) {
// false case
bo := &Backoff{Factor: 1.0, Steps: 3}
ret := bo.isNonRetriableError(nil)
assert.Equal(t, false, ret)

// true case
errs := []string{"error1", "error2"}
bo2 := bo
bo2.NonRetriableErrors = errs
rerr := &Error{
Retriable: false,
HTTPStatusCode: 429,
RawError: fmt.Errorf("error1"),
}

ret = bo2.isNonRetriableError(rerr)
assert.Equal(t, true, ret)
}

func TestJitterWithNegativeMaxFactor(t *testing.T) {
// jitter := duration + time.Duration(rand.Float64()*maxFactor*float64(duration))
// If maxFactor is 0.0 or less than 0.0, a suggested default value will be chosen.
// rand.Float64() returns, as a float64, a pseudo-random number in [0.0,1.0).
duration := time.Duration(time.Second)
maxFactor := float64(-3.0)
res := jitter(duration, maxFactor)
defaultMaxFactor := float64(1.0)
expected := jitter(duration, defaultMaxFactor)
assert.Equal(t, expected-res >= time.Duration(0.0*float64(duration)), true)
assert.Equal(t, expected-res < time.Duration(1.0*float64(duration)), true)
}

func TestDoExponentialBackoffRetry(t *testing.T) {
client := mocks.NewSender()
bo := &Backoff{Duration: time.Second, Factor: 2, Steps: 0, Cap: 3 * time.Second, Jitter: 0.5}
sender := autorest.DecorateSender(
client,
DoExponentialBackoffRetry(bo),
)

req := &http.Request{
Method: "GET",
}

result, err := sender.Do(req)
assert.Nil(t, result)
assert.Nil(t, err)
}

func TestStep(t *testing.T) {
tests := []struct {
initial *Backoff
Expand Down Expand Up @@ -97,6 +172,34 @@ func TestDoBackoffRetry(t *testing.T) {
assert.Equal(t, expectedErr.Error(), err)
assert.Equal(t, 3, client.Attempts())

// retries with 0 steps
respSteps0, errSteps0 := doBackoffRetry(client, fakeRequest, &Backoff{Factor: 1.0, Steps: 0})
assert.Nil(t, respSteps0)
assert.Nil(t, errSteps0)

// backoff with NonRetriableErrors and RetriableHTTPStatusCodes
r = mocks.NewResponseWithStatus("404 StatusNotFound", http.StatusNotFound)
client = mocks.NewSender()
client.AppendAndRepeatResponseWithDelay(r, time.Second, 1)
client.AppendError(fmt.Errorf("HTTP status code (404)"))
bo := &Backoff{Factor: 1.0, Steps: 3}
bo.NonRetriableErrors = []string{"404 StatusNotFound"}
bo.RetriableHTTPStatusCodes = []int{http.StatusNotFound}
expectedResp := &http.Response{
Status: "200 OK",
StatusCode: 200,
Proto: "HTTP/1.0",
ProtoMajor: 1,
ProtoMinor: 0,
Body: mocks.NewBody(""),
Request: fakeRequest,
}

resp, err = doBackoffRetry(client, fakeRequest, bo)
assert.Nil(t, err)
assert.Equal(t, 3, client.Attempts())
assert.Equal(t, expectedResp, resp)

// returns immediately on succeed
r = mocks.NewResponseWithStatus("200 OK", http.StatusOK)
client = mocks.NewSender()
Expand Down