File: issue884_test.go

package info (click to toggle)
golang-github-getkin-kin-openapi 0.124.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,288 kB
  • sloc: sh: 344; makefile: 4
file content (113 lines) | stat: -rw-r--r-- 2,639 bytes parent folder | download | duplicates (3)
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
package openapi3filter

import (
	"net/http"
	"net/url"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"

	"github.com/getkin/kin-openapi/openapi3"
	"github.com/getkin/kin-openapi/routers/gorillamux"
)

func TestIssue884(t *testing.T) {
	loader := openapi3.NewLoader()
	ctx := loader.Context
	spec := `
  openapi: 3.0.0
  info:
    version: 1.0.0
    title: Sample API
  components:
    schemas:
      TaskSortEnum:
        enum:
          - createdAt
          - -createdAt
          - updatedAt
          - -updatedAt
  paths:
    /tasks:
      get:
        operationId: ListTask
        parameters:
          - in: query
            name: withDefault
            schema:
              allOf:
                - $ref: '#/components/schemas/TaskSortEnum'
                - default: -createdAt
          - in: query
            name: withoutDefault
            schema:
              allOf:
                - $ref: '#/components/schemas/TaskSortEnum'
          - in: query
            name: withManyDefaults
            schema:
              allOf:
                - default: -updatedAt
                - $ref: '#/components/schemas/TaskSortEnum'
                - default: -createdAt
        responses:
          '200':
            description: Successful response
  `[1:]

	doc, err := loader.LoadFromData([]byte(spec))
	require.NoError(t, err)

	err = doc.Validate(ctx)
	require.NoError(t, err)

	router, err := gorillamux.NewRouter(doc)
	require.NoError(t, err)

	tests := []struct {
		name          string
		options       *Options
		expectedQuery url.Values
	}{
		{
			name: "no defaults are added to requests",
			options: &Options{
				SkipSettingDefaults: true,
			},
			expectedQuery: url.Values{},
		},

		{
			name: "defaults are added to requests",
			expectedQuery: url.Values{
				"withDefault":      []string{"-createdAt"},
				"withManyDefaults": []string{"-updatedAt"}, // first default is win
			},
		},
	}

	for _, testcase := range tests {
		t.Run(testcase.name, func(t *testing.T) {
			httpReq, err := http.NewRequest(http.MethodGet, "/tasks", nil)
			require.NoError(t, err)
			httpReq.Header.Set("Content-Type", "application/json")
			require.NoError(t, err)

			route, pathParams, err := router.FindRoute(httpReq)
			require.NoError(t, err)

			requestValidationInput := &RequestValidationInput{
				Request:    httpReq,
				PathParams: pathParams,
				Route:      route,
				Options:    testcase.options,
			}
			err = ValidateRequest(ctx, requestValidationInput)
			require.NoError(t, err)

			q := httpReq.URL.Query()
			assert.Equal(t, testcase.expectedQuery, q)
		})
	}
}