mirror of
https://github.com/kubernetes/client-go.git
synced 2025-06-20 12:23:22 +00:00
The BackoffManager interface sleeps without considering the caller's context, i.e. cancellation is not supported. This alone is reason enough to deprecate it and to replace it with an interface that supports a context parameter. The other reason is that contextual logging needs that parameter. Kubernetes-commit: b15a1943d51adfb8c5e0185d58d25e038c3d6ade
119 lines
3.8 KiB
Go
119 lines
3.8 KiB
Go
/*
|
|
Copyright 2014 The Kubernetes Authors.
|
|
|
|
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 rest
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"net/url"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
"k8s.io/client-go/util/flowcontrol"
|
|
)
|
|
|
|
func parse(raw string) *url.URL {
|
|
theUrl, _ := url.Parse(raw)
|
|
return theUrl
|
|
}
|
|
|
|
func TestURLBackoffFunctionalityCollisions(t *testing.T) {
|
|
myBackoff := &URLBackoff{
|
|
Backoff: flowcontrol.NewBackOff(1*time.Second, 60*time.Second),
|
|
}
|
|
|
|
// Add some noise and make sure backoff for a clean URL is zero.
|
|
myBackoff.UpdateBackoff(parse("http://100.200.300.400:8080"), nil, 500)
|
|
|
|
myBackoff.UpdateBackoff(parse("http://1.2.3.4:8080"), nil, 500)
|
|
|
|
if myBackoff.CalculateBackoff(parse("http://1.2.3.4:100")) > 0 {
|
|
t.Errorf("URLs are colliding in the backoff map!")
|
|
}
|
|
}
|
|
|
|
// TestURLBackoffFunctionality generally tests the URLBackoff wrapper. We avoid duplicating tests from backoff and request.
|
|
func TestURLBackoffFunctionality(t *testing.T) {
|
|
myBackoff := &URLBackoff{
|
|
Backoff: flowcontrol.NewBackOff(1*time.Second, 60*time.Second),
|
|
}
|
|
|
|
// Now test that backoff increases, then recovers.
|
|
// 200 and 300 should both result in clearing the backoff.
|
|
// all others like 429 should result in increased backoff.
|
|
seconds := []int{0,
|
|
1, 2, 4, 8, 0,
|
|
1, 2}
|
|
returnCodes := []int{
|
|
429, 500, 501, 502, 300,
|
|
500, 501, 502,
|
|
}
|
|
|
|
if len(seconds) != len(returnCodes) {
|
|
t.Fatalf("responseCode to backoff arrays should be the same length... sanity check failed.")
|
|
}
|
|
|
|
for i, sec := range seconds {
|
|
backoffSec := myBackoff.CalculateBackoff(parse("http://1.2.3.4:100"))
|
|
if backoffSec < time.Duration(sec)*time.Second || backoffSec > time.Duration(sec+5)*time.Second {
|
|
t.Errorf("Backoff out of range %v: %v %v", i, sec, backoffSec)
|
|
}
|
|
myBackoff.UpdateBackoff(parse("http://1.2.3.4:100/responseCodeForFuncTest"), nil, returnCodes[i])
|
|
}
|
|
|
|
if myBackoff.CalculateBackoff(parse("http://1.2.3.4:100")) == 0 {
|
|
t.Errorf("The final return code %v should have resulted in a backoff ! ", returnCodes[7])
|
|
}
|
|
}
|
|
|
|
func TestBackoffManagerNopContext(t *testing.T) {
|
|
mock := NewMockBackoffManager(t)
|
|
|
|
sleepDuration := 42 * time.Second
|
|
mock.On("Sleep", sleepDuration).Return()
|
|
url := &url.URL{}
|
|
mock.On("CalculateBackoff", url).Return(time.Second)
|
|
err := errors.New("fake error")
|
|
responseCode := 404
|
|
mock.On("UpdateBackoff", url, err, responseCode).Return()
|
|
|
|
ctx := context.Background()
|
|
wrapper := backoffManagerNopContext{BackoffManager: mock}
|
|
wrapper.SleepWithContext(ctx, sleepDuration)
|
|
wrapper.CalculateBackoffWithContext(ctx, url)
|
|
wrapper.UpdateBackoffWithContext(ctx, url, err, responseCode)
|
|
}
|
|
|
|
func TestNoBackoff(t *testing.T) {
|
|
var backoff NoBackoff
|
|
assert.Equal(t, 0*time.Second, backoff.CalculateBackoff(nil))
|
|
assert.Equal(t, 0*time.Second, backoff.CalculateBackoffWithContext(context.Background(), nil))
|
|
|
|
start := time.Now()
|
|
backoff.Sleep(0 * time.Second)
|
|
assert.WithinDuration(t, start, time.Now(), time.Minute /* pretty generous, but we don't want to flake */, time.Since(start), "backoff.Sleep")
|
|
|
|
// Cancel right away to prevent sleeping.
|
|
ctx, cancel := context.WithCancel(context.Background())
|
|
cancel()
|
|
start = time.Now()
|
|
backoff.SleepWithContext(ctx, 10*time.Minute)
|
|
assert.WithinDuration(t, start, time.Now(), time.Minute /* pretty generous, but we don't want to flake */, time.Since(start), "backoff.SleepWithContext")
|
|
}
|