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
|
package openapi3filter
import (
"io"
"net/http"
"strings"
"testing"
"github.com/stretchr/testify/require"
"github.com/getkin/kin-openapi/openapi3"
)
func Test_validateResponseHeader(t *testing.T) {
type args struct {
headerName string
headerRef *openapi3.HeaderRef
}
tests := []struct {
name string
args args
isHeaderPresent bool
headerVals []string
wantErr bool
wantErrMsg string
}{
{
name: "test required string header with single string value",
args: args{
headerName: "X-Blab",
headerRef: newHeaderRef(openapi3.NewStringSchema(), true),
},
isHeaderPresent: true,
headerVals: []string{"blab"},
wantErr: false,
},
{
name: "test required string header with single, empty string value",
args: args{
headerName: "X-Blab",
headerRef: newHeaderRef(openapi3.NewStringSchema(), true),
},
isHeaderPresent: true,
headerVals: []string{""},
wantErr: true,
wantErrMsg: `response header "X-Blab" doesn't match schema: Value is not nullable`,
},
{
name: "test optional string header with single string value",
args: args{
headerName: "X-Blab",
headerRef: newHeaderRef(openapi3.NewStringSchema(), false),
},
isHeaderPresent: false,
headerVals: []string{"blab"},
wantErr: false,
},
{
name: "test required, but missing string header",
args: args{
headerName: "X-Blab",
headerRef: newHeaderRef(openapi3.NewStringSchema(), true),
},
isHeaderPresent: false,
headerVals: nil,
wantErr: true,
wantErrMsg: `response header "X-Blab" missing`,
},
{
name: "test integer header with single integer value",
args: args{
headerName: "X-Blab",
headerRef: newHeaderRef(openapi3.NewIntegerSchema(), true),
},
isHeaderPresent: true,
headerVals: []string{"88"},
wantErr: false,
},
{
name: "test integer header with single string value",
args: args{
headerName: "X-Blab",
headerRef: newHeaderRef(openapi3.NewIntegerSchema(), true),
},
isHeaderPresent: true,
headerVals: []string{"blab"},
wantErr: true,
wantErrMsg: `unable to decode header "X-Blab" value: value blab: an invalid integer: invalid syntax`,
},
{
name: "test int64 header with single int64 value",
args: args{
headerName: "X-Blab",
headerRef: newHeaderRef(openapi3.NewInt64Schema(), true),
},
isHeaderPresent: true,
headerVals: []string{"88"},
wantErr: false,
},
{
name: "test int32 header with single int32 value",
args: args{
headerName: "X-Blab",
headerRef: newHeaderRef(openapi3.NewInt32Schema(), true),
},
isHeaderPresent: true,
headerVals: []string{"88"},
wantErr: false,
},
{
name: "test float64 header with single float64 value",
args: args{
headerName: "X-Blab",
headerRef: newHeaderRef(openapi3.NewFloat64Schema(), true),
},
isHeaderPresent: true,
headerVals: []string{"88.87"},
wantErr: false,
},
{
name: "test integer header with multiple csv integer values",
args: args{
headerName: "X-blab",
headerRef: newHeaderRef(newArraySchema(openapi3.NewIntegerSchema()), true),
},
isHeaderPresent: true,
headerVals: []string{"87,88"},
wantErr: false,
},
{
name: "test integer header with multiple integer values",
args: args{
headerName: "X-blab",
headerRef: newHeaderRef(newArraySchema(openapi3.NewIntegerSchema()), true),
},
isHeaderPresent: true,
headerVals: []string{"87", "88"},
wantErr: false,
},
{
name: "test non-typed, nullable header with single string value",
args: args{
headerName: "X-blab",
headerRef: newHeaderRef(&openapi3.Schema{Nullable: true}, true),
},
isHeaderPresent: true,
headerVals: []string{"blab"},
wantErr: false,
},
{
name: "test required non-typed, nullable header not present",
args: args{
headerName: "X-blab",
headerRef: newHeaderRef(&openapi3.Schema{Nullable: true}, true),
},
isHeaderPresent: false,
headerVals: []string{"blab"},
wantErr: true,
wantErrMsg: `response header "X-blab" missing`,
},
{
name: "test non-typed, non-nullable header with single string value",
args: args{
headerName: "X-blab",
headerRef: newHeaderRef(&openapi3.Schema{Nullable: false}, true),
},
isHeaderPresent: true,
headerVals: []string{"blab"},
wantErr: true,
wantErrMsg: `response header "X-blab" doesn't match schema: Value is not nullable`,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
input := newInputDefault()
opts := []openapi3.SchemaValidationOption(nil)
if tt.isHeaderPresent {
input.Header = map[string][]string{http.CanonicalHeaderKey(tt.args.headerName): tt.headerVals}
}
err := validateResponseHeader(tt.args.headerName, tt.args.headerRef, input, opts)
if tt.wantErr {
require.NotEmpty(t, tt.wantErrMsg, "wanted error message is not populated")
require.Error(t, err)
require.ErrorContains(t, err, tt.wantErrMsg)
} else {
require.NoError(t, err)
}
})
}
}
func newInputDefault() *ResponseValidationInput {
return &ResponseValidationInput{
RequestValidationInput: &RequestValidationInput{
Request: nil,
PathParams: nil,
Route: nil,
},
Status: 200,
Header: nil,
Body: io.NopCloser(strings.NewReader(`{}`)),
}
}
func newHeaderRef(schema *openapi3.Schema, required bool) *openapi3.HeaderRef {
return &openapi3.HeaderRef{Value: &openapi3.Header{Parameter: openapi3.Parameter{Schema: &openapi3.SchemaRef{Value: schema}, Required: required}}}
}
func newArraySchema(schema *openapi3.Schema) *openapi3.Schema {
arraySchema := openapi3.NewArraySchema()
arraySchema.Items = openapi3.NewSchemaRef("", schema)
return arraySchema
}
|