File: errutil_test.go

package info (click to toggle)
golang-oras-oras-go 2.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental, forky, sid, trixie
  • size: 2,232 kB
  • sloc: makefile: 29
file content (239 lines) | stat: -rw-r--r-- 6,746 bytes parent folder | download
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
/*
Copyright The ORAS 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 errutil

import (
	"errors"
	"net/http"
	"net/http/httptest"
	"strings"
	"testing"

	"oras.land/oras-go/v2/registry/remote/errcode"
)

func Test_ParseErrorResponse(t *testing.T) {
	path := "/test"
	expectedErrs := errcode.Errors{
		{
			Code:    "UNAUTHORIZED",
			Message: "authentication required",
		},
		{
			Code:    "NAME_UNKNOWN",
			Message: "repository name not known to registry",
		},
	}
	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		switch r.URL.Path {
		case path:
			msg := `{ "errors": [ { "code": "UNAUTHORIZED", "message": "authentication required", "detail": [ { "Type": "repository", "Class": "", "Name": "library/hello-world", "Action": "pull" } ] }, { "code": "NAME_UNKNOWN", "message": "repository name not known to registry" } ] }`
			w.WriteHeader(http.StatusUnauthorized)
			if _, err := w.Write([]byte(msg)); err != nil {
				t.Errorf("failed to write %q: %v", r.URL, err)
			}
		default:
			t.Errorf("unexpected access: %s %s", r.Method, r.URL)
			w.WriteHeader(http.StatusNotFound)
		}

	}))
	defer ts.Close()

	resp, err := http.Get(ts.URL + path)
	if err != nil {
		t.Fatalf("failed to do request: %v", err)
	}
	err = ParseErrorResponse(resp)
	if err == nil {
		t.Errorf("ParseErrorResponse() error = %v, wantErr %v", err, true)
	}

	var errResp *errcode.ErrorResponse
	if ok := errors.As(err, &errResp); !ok {
		t.Errorf("errors.As(err, &UnexpectedStatusCodeError) = %v, want %v", ok, true)
	}
	if want := http.MethodGet; errResp.Method != want {
		t.Errorf("ParseErrorResponse() Method = %v, want Method %v", errResp.Method, want)
	}
	if want := http.StatusUnauthorized; errResp.StatusCode != want {
		t.Errorf("ParseErrorResponse() StatusCode = %v, want StatusCode %v", errResp.StatusCode, want)
	}
	if want := path; errResp.URL.Path != want {
		t.Errorf("ParseErrorResponse() URL = %v, want URL %v", errResp.URL.Path, want)
	}
	for i, e := range errResp.Errors {
		if want := expectedErrs[i].Code; e.Code != expectedErrs[i].Code {
			t.Errorf("ParseErrorResponse() Code = %v, want Code %v", e.Code, want)
		}
		if want := expectedErrs[i].Message; e.Message != want {
			t.Errorf("ParseErrorResponse() Message = %v, want Code %v", e.Code, want)
		}
	}

	errmsg := err.Error()
	if want := "401"; !strings.Contains(errmsg, want) {
		t.Errorf("ParseErrorResponse() error = %v, want err message %v", err, want)
	}
	// first error
	if want := "unauthorized"; !strings.Contains(errmsg, want) {
		t.Errorf("ParseErrorResponse() error = %v, want err message %v", err, want)
	}
	if want := "authentication required"; !strings.Contains(errmsg, want) {
		t.Errorf("ParseErrorResponse() error = %v, want err message %v", err, want)
	}
	// second error
	if want := "name unknown"; !strings.Contains(errmsg, want) {
		t.Errorf("ParseErrorResponse() error = %v, want err message %v", err, want)
	}
	if want := "repository name not known to registry"; !strings.Contains(errmsg, want) {
		t.Errorf("ParseErrorResponse() error = %v, want err message %v", err, want)
	}
}

func Test_ParseErrorResponse_plain(t *testing.T) {
	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusUnauthorized)
	}))
	defer ts.Close()

	resp, err := http.Get(ts.URL)
	if err != nil {
		t.Fatalf("failed to do request: %v", err)
	}
	err = ParseErrorResponse(resp)
	if err == nil {
		t.Errorf("ParseErrorResponse() error = %v, wantErr %v", err, true)
	}
	errmsg := err.Error()
	if want := "401"; !strings.Contains(errmsg, want) {
		t.Errorf("ParseErrorResponse() error = %v, want err message %v", err, want)
	}
	if want := http.StatusText(http.StatusUnauthorized); !strings.Contains(errmsg, want) {
		t.Errorf("ParseErrorResponse() error = %v, want err message %v", err, want)
	}
}

func TestIsErrorCode(t *testing.T) {
	tests := []struct {
		name string
		err  error
		code string
		want bool
	}{
		{
			name: "test errcode.Error, same code",
			err: errcode.Error{
				Code: errcode.ErrorCodeNameUnknown,
			},
			code: errcode.ErrorCodeNameUnknown,
			want: true,
		},
		{
			name: "test errcode.Error, different code",
			err: errcode.Error{
				Code: errcode.ErrorCodeUnauthorized,
			},
			code: errcode.ErrorCodeNameUnknown,
			want: false,
		},
		{
			name: "test errcode.Errors containing single error, same code",
			err: errcode.Errors{
				{
					Code: errcode.ErrorCodeNameUnknown,
				},
			},
			code: errcode.ErrorCodeNameUnknown,
			want: true,
		},
		{
			name: "test errcode.Errors containing single error, different code",
			err: errcode.Errors{
				{
					Code: errcode.ErrorCodeNameUnknown,
				},
			},
			code: errcode.ErrorCodeNameUnknown,
			want: true,
		},
		{
			name: "test errcode.Errors containing multiple errors, same code",
			err: errcode.Errors{
				{
					Code: errcode.ErrorCodeNameUnknown,
				},
				{
					Code: errcode.ErrorCodeUnauthorized,
				},
			},
			code: errcode.ErrorCodeNameUnknown,
			want: false,
		},
		{
			name: "test errcode.ErrorResponse containing single error, same code",
			err: &errcode.ErrorResponse{
				Errors: errcode.Errors{
					{
						Code: errcode.ErrorCodeNameUnknown,
					},
				},
			},
			code: errcode.ErrorCodeNameUnknown,
			want: true,
		},
		{
			name: "test errcode.ErrorResponse containing single error, different code",
			err: &errcode.ErrorResponse{
				Errors: errcode.Errors{
					{
						Code: errcode.ErrorCodeUnauthorized,
					},
				},
			},
			code: errcode.ErrorCodeNameUnknown,
			want: false,
		},
		{
			name: "test errcode.ErrorResponse containing multiple errors, same code",
			err: &errcode.ErrorResponse{
				Errors: errcode.Errors{
					{
						Code: errcode.ErrorCodeNameUnknown,
					},
					{
						Code: errcode.ErrorCodeUnauthorized,
					},
				},
			},
			code: errcode.ErrorCodeNameUnknown,
			want: false,
		},
		{
			name: "test unstructured error",
			err:  errors.New(errcode.ErrorCodeNameUnknown),
			code: errcode.ErrorCodeNameUnknown,
			want: false,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			if got := IsErrorCode(tt.err, tt.code); got != tt.want {
				t.Errorf("IsErrorCode() = %v, want %v", got, tt.want)
			}
		})
	}
}