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
|
// Copyright 2015 go-swagger maintainers
//
// 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 swag
import (
"context"
"net/http"
"net/http/httptest"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestLoadFromHTTP(t *testing.T) {
// Check backward-compatible global config.
// More comprehensive testing is carried out in package loading.
t.Run("with remote basic auth", func(t *testing.T) {
const (
validUsername = "fake-user"
validPassword = "correct-password"
invalidPassword = "incorrect-password"
)
ts := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
u, p, ok := r.BasicAuth()
if ok && u == validUsername && p == validPassword {
rw.WriteHeader(http.StatusOK)
return
}
rw.WriteHeader(http.StatusForbidden)
}))
defer ts.Close()
t.Run("using global config", func(t *testing.T) {
t.Cleanup(func() {
LoadHTTPBasicAuthUsername = ""
LoadHTTPBasicAuthPassword = ""
})
t.Run("should load from remote URL with basic auth", func(t *testing.T) {
// basic auth, valid credentials
LoadHTTPBasicAuthUsername = validUsername
LoadHTTPBasicAuthPassword = validPassword
_, err := LoadFromFileOrHTTP(ts.URL)
require.NoError(t, err)
})
})
})
t.Run("with remote API key auth", func(t *testing.T) {
const (
sharedHeaderKey = "X-Myapp"
sharedHeaderValue = "MySecretKey"
)
ts := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
myHeaders := r.Header[sharedHeaderKey]
ok := false
for _, v := range myHeaders {
if v == sharedHeaderValue {
ok = true
break
}
}
if ok {
rw.WriteHeader(http.StatusOK)
} else {
rw.WriteHeader(http.StatusForbidden)
}
}))
defer ts.Close()
t.Run("using global config", func(t *testing.T) {
t.Cleanup(func() {
LoadHTTPCustomHeaders = map[string]string{}
})
t.Run("should load from remote URL with API key header", func(t *testing.T) {
LoadHTTPCustomHeaders[sharedHeaderKey] = sharedHeaderValue
_, err := LoadFromFileOrHTTP(ts.URL)
require.NoError(t, err)
})
})
})
t.Run("should not load when timeout", func(t *testing.T) {
const (
delay = 30 * time.Millisecond
wait = delay / 2
)
ts := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
time.Sleep(delay)
rw.WriteHeader(http.StatusOK)
}))
defer ts.Close()
t.Run("using global configuration", func(t *testing.T) {
original := LoadHTTPTimeout
t.Cleanup(func() {
LoadHTTPTimeout = original
})
LoadHTTPTimeout = wait
_, err := LoadFromFileOrHTTP(ts.URL)
require.Error(t, err)
require.ErrorIs(t, err, context.DeadlineExceeded)
})
t.Run("using deprecated method", func(t *testing.T) {
_, err := LoadFromFileOrHTTPWithTimeout(ts.URL, wait)
require.Error(t, err)
require.ErrorIs(t, err, context.DeadlineExceeded)
})
t.Run("should serve local strategy", func(t *testing.T) {
loader := func(_ string) ([]byte, error) {
return []byte("local"), nil
}
remLoader := func(_ string) ([]byte, error) {
return []byte("remote"), nil
}
ldr := LoadStrategy("not_http", loader, remLoader)
b, _ := ldr("")
assert.Equal(t, "local", string(b))
})
})
}
func TestYAMLDoc(t *testing.T) {
t.Run("deprecated loading YAML functions should work", func(t *testing.T) {
require.True(t, YAMLMatcher("a.yml"))
ts := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
rw.WriteHeader(http.StatusOK)
const ydoc = "x:\n a: one\n b: two\n"
_, _ = rw.Write([]byte(ydoc))
}))
defer ts.Close()
b, err := YAMLDoc(ts.URL)
require.NoError(t, err)
require.NotEmpty(t, b)
doc, err := YAMLData(ts.URL)
require.NoError(t, err)
require.NotEmpty(t, doc)
})
}
|
