Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
openapi3filter: validate non-string headers (#712)
Co-authored-by: Steve Lessard <steve.lessard@teradata.com>
- Loading branch information
Showing
5 changed files
with
271 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,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.Contains(t, err.Error(), 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 | ||
| } |