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 240 241 242 243 244 245 246 247 248 249 250 251 252
|
// 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 errors
import (
"fmt"
"net/http"
"net/http/httptest"
"strings"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
type customError struct {
apiError
}
func TestServeError(t *testing.T) {
// method not allowed wins
// err abides by the Error interface
err := MethodNotAllowed("GET", []string{"POST", "PUT"})
recorder := httptest.NewRecorder()
ServeError(recorder, nil, err)
assert.Equal(t, http.StatusMethodNotAllowed, recorder.Code)
assert.Equal(t, "POST,PUT", recorder.Header().Get("Allow"))
// assert.Equal(t, "application/json", recorder.Header().Get("content-type"))
assert.Equal(t, `{"code":405,"message":"method GET is not allowed, but [POST,PUT] are"}`, recorder.Body.String())
// renders status code from error when present
err = NotFound("")
recorder = httptest.NewRecorder()
ServeError(recorder, nil, err)
assert.Equal(t, http.StatusNotFound, recorder.Code)
// assert.Equal(t, "application/json", recorder.Header().Get("content-type"))
assert.Equal(t, `{"code":404,"message":"Not found"}`, recorder.Body.String())
// renders mapped status code from error when present
err = InvalidTypeName("someType")
recorder = httptest.NewRecorder()
ServeError(recorder, nil, err)
assert.Equal(t, http.StatusUnprocessableEntity, recorder.Code)
// assert.Equal(t, "application/json", recorder.Header().Get("content-type"))
assert.Equal(t, `{"code":601,"message":"someType is an invalid type name"}`, recorder.Body.String())
// same, but override DefaultHTTPCode
func() {
oldDefaultHTTPCode := DefaultHTTPCode
defer func() { DefaultHTTPCode = oldDefaultHTTPCode }()
DefaultHTTPCode = http.StatusBadRequest
err = InvalidTypeName("someType")
recorder = httptest.NewRecorder()
ServeError(recorder, nil, err)
assert.Equal(t, http.StatusBadRequest, recorder.Code)
// assert.Equal(t, "application/json", recorder.Header().Get("content-type"))
assert.Equal(t, `{"code":601,"message":"someType is an invalid type name"}`, recorder.Body.String())
}()
// defaults to internal server error
simpleErr := fmt.Errorf("some error")
recorder = httptest.NewRecorder()
ServeError(recorder, nil, simpleErr)
assert.Equal(t, http.StatusInternalServerError, recorder.Code)
// assert.Equal(t, "application/json", recorder.Header().Get("content-type"))
assert.Equal(t, `{"code":500,"message":"some error"}`, recorder.Body.String())
// composite errors
// unrecognized: return internal error with first error only - the second error is ignored
compositeErr := &CompositeError{
Errors: []error{
fmt.Errorf("firstError"),
fmt.Errorf("anotherError"),
},
}
recorder = httptest.NewRecorder()
ServeError(recorder, nil, compositeErr)
assert.Equal(t, http.StatusInternalServerError, recorder.Code)
assert.Equal(t, `{"code":500,"message":"firstError"}`, recorder.Body.String())
// recognized: return internal error with first error only - the second error is ignored
compositeErr = &CompositeError{
Errors: []error{
New(600, "myApiError"),
New(601, "myOtherApiError"),
},
}
recorder = httptest.NewRecorder()
ServeError(recorder, nil, compositeErr)
assert.Equal(t, CompositeErrorCode, recorder.Code)
assert.Equal(t, `{"code":600,"message":"myApiError"}`, recorder.Body.String())
// recognized API Error, flattened
compositeErr = &CompositeError{
Errors: []error{
&CompositeError{
Errors: []error{
New(600, "myApiError"),
New(601, "myOtherApiError"),
},
},
},
}
recorder = httptest.NewRecorder()
ServeError(recorder, nil, compositeErr)
assert.Equal(t, CompositeErrorCode, recorder.Code)
assert.Equal(t, `{"code":600,"message":"myApiError"}`, recorder.Body.String())
// check guard against empty CompositeError (e.g. nil Error interface)
compositeErr = &CompositeError{
Errors: []error{
&CompositeError{
Errors: []error{},
},
},
}
recorder = httptest.NewRecorder()
ServeError(recorder, nil, compositeErr)
assert.Equal(t, http.StatusInternalServerError, recorder.Code)
assert.Equal(t, `{"code":500,"message":"Unknown error"}`, recorder.Body.String())
// check guard against nil type
recorder = httptest.NewRecorder()
ServeError(recorder, nil, nil)
assert.Equal(t, http.StatusInternalServerError, recorder.Code)
assert.Equal(t, `{"code":500,"message":"Unknown error"}`, recorder.Body.String())
recorder = httptest.NewRecorder()
var z *customError
ServeError(recorder, nil, z)
assert.Equal(t, http.StatusInternalServerError, recorder.Code)
assert.Equal(t, `{"code":500,"message":"Unknown error"}`, recorder.Body.String())
}
func TestAPIErrors(t *testing.T) {
err := New(402, "this failed %s", "yada")
assert.Error(t, err)
assert.EqualValues(t, 402, err.Code())
assert.EqualValues(t, "this failed yada", err.Error())
err = NotFound("this failed %d", 1)
assert.Error(t, err)
assert.EqualValues(t, http.StatusNotFound, err.Code())
assert.EqualValues(t, "this failed 1", err.Error())
err = NotFound("")
assert.Error(t, err)
assert.EqualValues(t, http.StatusNotFound, err.Code())
assert.EqualValues(t, "Not found", err.Error())
err = NotImplemented("not implemented")
assert.Error(t, err)
assert.EqualValues(t, http.StatusNotImplemented, err.Code())
assert.EqualValues(t, "not implemented", err.Error())
err = MethodNotAllowed("GET", []string{"POST", "PUT"})
assert.Error(t, err)
assert.EqualValues(t, http.StatusMethodNotAllowed, err.Code())
assert.EqualValues(t, "method GET is not allowed, but [POST,PUT] are", err.Error())
err = InvalidContentType("application/saml", []string{"application/json", "application/x-yaml"})
assert.Error(t, err)
assert.EqualValues(t, http.StatusUnsupportedMediaType, err.Code())
assert.EqualValues(t, "unsupported media type \"application/saml\", only [application/json application/x-yaml] are allowed", err.Error())
err = InvalidResponseFormat("application/saml", []string{"application/json", "application/x-yaml"})
assert.Error(t, err)
assert.EqualValues(t, http.StatusNotAcceptable, err.Code())
assert.EqualValues(t, "unsupported media type requested, only [application/json application/x-yaml] are available", err.Error())
}
func TestValidateName(t *testing.T) {
v := &Validation{Name: "myValidation", message: "myMessage"}
// unchanged
vv := v.ValidateName("")
assert.EqualValues(t, "myValidation", vv.Name)
assert.EqualValues(t, "myMessage", vv.message)
// forced
vv = v.ValidateName("myNewName")
assert.EqualValues(t, "myNewName.myValidation", vv.Name)
assert.EqualValues(t, "myNewName.myMessage", vv.message)
v.Name = ""
v.message = "myMessage"
// unchanged
vv = v.ValidateName("")
assert.EqualValues(t, "", vv.Name)
assert.EqualValues(t, "myMessage", vv.message)
// forced
vv = v.ValidateName("myNewName")
assert.EqualValues(t, "myNewName", vv.Name)
assert.EqualValues(t, "myNewNamemyMessage", vv.message)
}
func TestMarshalJSON(t *testing.T) {
const (
expectedCode = http.StatusUnsupportedMediaType
value = "myValue"
)
list := []string{"a", "b"}
e := InvalidContentType(value, list)
jazon, err := e.MarshalJSON()
require.NoError(t, err)
expectedMessage := strings.ReplaceAll(fmt.Sprintf(contentTypeFail, value, list), `"`, `\"`)
expectedJSON := fmt.Sprintf(
`{"code":%d,"message":"%s","name":"Content-Type","in":"header","value":"%s","values":["a","b"]}`,
expectedCode, expectedMessage, value,
)
assert.JSONEq(t, expectedJSON, string(jazon))
a := apiError{code: 1, message: "a"}
jazon, err = a.MarshalJSON()
require.NoError(t, err)
assert.JSONEq(t, `{"code":1,"message":"a"}`, string(jazon))
m := MethodNotAllowedError{code: 1, message: "a", Allowed: []string{"POST"}}
jazon, err = m.MarshalJSON()
require.NoError(t, err)
assert.JSONEq(t, `{"code":1,"message":"a","allowed":["POST"]}`, string(jazon))
c := CompositeError{Errors: []error{e}, code: 1, message: "a"}
jazon, err = c.MarshalJSON()
require.NoError(t, err)
assert.JSONEq(t, fmt.Sprintf(`{"code":1,"message":"a","errors":[%s]}`, expectedJSON), string(jazon))
p := ParseError{code: 1, message: "x", Name: "a", In: "b", Value: "c", Reason: fmt.Errorf("d")}
jazon, err = p.MarshalJSON()
require.NoError(t, err)
assert.JSONEq(t, `{"code":1,"message":"x","name":"a","in":"b","value":"c","reason":"d"}`, string(jazon))
}
|