summaryrefslogtreecommitdiffstats
path: root/pkg/v1/remote/transport/retry_test.go
blob: ded0ce0932c96da88c8116fbde9be201b271e20d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
// Copyright 2018 Google LLC All Rights Reserved.
//
// 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 transport

import (
	"context"
	"errors"
	"io"
	"net/http"
	"net/http/httptest"
	"strings"
	"testing"
	"time"

	"github.com/google/go-containerregistry/internal/retry"
)

type mockTransport struct {
	errs  []error
	resps []*http.Response
	count int
}

func (t *mockTransport) RoundTrip(in *http.Request) (out *http.Response, err error) {
	defer func() { t.count++ }()
	if t.count < len(t.resps) {
		out = t.resps[t.count]
	}
	if t.count < len(t.errs) {
		err = t.errs[t.count]
	}
	return
}

type perm struct{}

func (e perm) Error() string {
	return "permanent error"
}

type temp struct{}

func (e temp) Error() string {
	return "temporary error"
}

func (e temp) Temporary() bool {
	return true
}

func resp(code int) *http.Response {
	return &http.Response{
		StatusCode: code,
		Body:       io.NopCloser(strings.NewReader("hi")),
	}
}

func TestRetryTransport(t *testing.T) {
	for _, test := range []struct {
		errs  []error
		resps []*http.Response
		ctx   context.Context
		count int
	}{{
		// Don't retry retry.Never.
		errs:  []error{temp{}},
		ctx:   retry.Never(context.Background()),
		count: 1,
	}, {
		// Don't retry permanent.
		errs:  []error{perm{}},
		count: 1,
	}, {
		// Do retry temp.
		errs:  []error{temp{}, perm{}},
		count: 2,
	}, {
		// Stop at some max.
		errs:  []error{temp{}, temp{}, temp{}, temp{}, temp{}},
		count: 3,
	}, {
		// Retry http errors.
		errs: []error{nil, nil, temp{}, temp{}, temp{}},
		resps: []*http.Response{
			resp(http.StatusRequestTimeout),
			resp(http.StatusInternalServerError),
			nil,
		},
		count: 3,
	}} {
		mt := mockTransport{
			errs:  test.errs,
			resps: test.resps,
		}

		tr := NewRetry(&mt,
			WithRetryBackoff(retry.Backoff{Steps: 3}),
			WithRetryPredicate(retry.IsTemporary),
			WithRetryStatusCodes(http.StatusRequestTimeout, http.StatusInternalServerError),
		)

		ctx := context.Background()
		if test.ctx != nil {
			ctx = test.ctx
		}
		req, err := http.NewRequestWithContext(ctx, "GET", "example.com", nil)
		if err != nil {
			t.Fatal(err)
		}
		tr.RoundTrip(req)
		if mt.count != test.count {
			t.Errorf("wrong count, wanted %d, got %d", test.count, mt.count)
		}
	}
}

func TestRetryDefaults(t *testing.T) {
	tr := NewRetry(http.DefaultTransport)
	rt, ok := tr.(*retryTransport)
	if !ok {
		t.Fatal("could not cast to retryTransport")
	}

	if rt.backoff != defaultBackoff {
		t.Fatalf("default backoff wrong: %v", rt.backoff)
	}

	if rt.predicate == nil {
		t.Fatal("default predicate not set")
	}
}

func TestTimeoutContext(t *testing.T) {
	tr := NewRetry(http.DefaultTransport)

	slowServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		// hanging request
		time.Sleep(time.Second * 1)
	}))
	defer func() { go func() { slowServer.Close() }() }()

	ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(time.Millisecond*20))
	defer cancel()
	req, err := http.NewRequest("GET", slowServer.URL, nil)
	if err != nil {
		t.Fatal(err)
	}
	req = req.WithContext(ctx)

	result := make(chan error)

	go func() {
		_, err := tr.RoundTrip(req)
		result <- err
	}()

	select {
	case err := <-result:
		if !errors.Is(err, context.DeadlineExceeded) {
			t.Fatalf("got: %v, want: %v", err, context.DeadlineExceeded)
		}
	case <-time.After(time.Millisecond * 100):
		t.Fatalf("deadline was not recognized by transport")
	}
}