forked from oapi-codegen/oapi-codegen
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcodegen_test.go
More file actions
310 lines (265 loc) · 8.38 KB
/
codegen_test.go
File metadata and controls
310 lines (265 loc) · 8.38 KB
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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
package codegen
import (
"bytes"
"go/format"
"io/ioutil"
"net/http"
"testing"
examplePetstoreClient "github.com/deepmap/oapi-codegen/examples/petstore-expanded"
examplePetstore "github.com/deepmap/oapi-codegen/examples/petstore-expanded/echo/api"
"github.com/getkin/kin-openapi/openapi3"
"github.com/golangci/lint-1"
"github.com/stretchr/testify/assert"
)
func TestExamplePetStoreCodeGeneration(t *testing.T) {
// Input vars for code generation:
packageName := "api"
opts := Options{
GenerateClient: true,
GenerateEchoServer: true,
GenerateTypes: true,
EmbedSpec: true,
}
// Get a spec from the example PetStore definition:
swagger, err := examplePetstore.GetSwagger()
assert.NoError(t, err)
// Run our code generation:
code, err := Generate(swagger, packageName, opts)
assert.NoError(t, err)
assert.NotEmpty(t, code)
// Check that we have valid (formattable) code:
_, err = format.Source([]byte(code))
assert.NoError(t, err)
// Check that we have a package:
assert.Contains(t, code, "package api")
// Check that the client method signatures return response structs:
assert.Contains(t, code, "func (c *Client) FindPetById(ctx context.Context, id int64, reqEditors ...RequestEditorFn) (*http.Response, error) {")
// Check that the property comments were generated
assert.Contains(t, code, "// Unique id of the pet")
// Check that the summary comment contains newlines
assert.Contains(t, code, `// Deletes a pet by ID
// (DELETE /pets/{id})
`)
// Make sure the generated code is valid:
linter := new(lint.Linter)
problems, err := linter.Lint("test.gen.go", []byte(code))
assert.NoError(t, err)
assert.Len(t, problems, 0)
}
func TestExamplePetStoreCodeGenerationWithUserTemplates(t *testing.T) {
userTemplates := map[string]string{"typedef.tmpl": "//blah"}
// Input vars for code generation:
packageName := "api"
opts := Options{
GenerateTypes: true,
UserTemplates: userTemplates,
}
// Get a spec from the example PetStore definition:
swagger, err := examplePetstore.GetSwagger()
assert.NoError(t, err)
// Run our code generation:
code, err := Generate(swagger, packageName, opts)
assert.NoError(t, err)
assert.NotEmpty(t, code)
// Check that we have valid (formattable) code:
_, err = format.Source([]byte(code))
assert.NoError(t, err)
// Check that we have a package:
assert.Contains(t, code, "package api")
// Check that the built-in template has been overriden
assert.Contains(t, code, "//blah")
}
func TestExamplePetStoreParseFunction(t *testing.T) {
bodyBytes := []byte(`{"id": 5, "name": "testpet", "tag": "cat"}`)
cannedResponse := &http.Response{
StatusCode: 200,
Body: ioutil.NopCloser(bytes.NewReader(bodyBytes)),
Header: http.Header{},
}
cannedResponse.Header.Add("Content-type", "application/json")
findPetByIDResponse, err := examplePetstoreClient.ParseFindPetByIdResponse(cannedResponse)
assert.NoError(t, err)
assert.NotNil(t, findPetByIDResponse.JSON200)
assert.Equal(t, int64(5), findPetByIDResponse.JSON200.Id)
assert.Equal(t, "testpet", findPetByIDResponse.JSON200.Name)
assert.NotNil(t, findPetByIDResponse.JSON200.Tag)
assert.Equal(t, "cat", *findPetByIDResponse.JSON200.Tag)
}
func TestExampleOpenAPICodeGeneration(t *testing.T) {
// Input vars for code generation:
packageName := "testswagger"
opts := Options{
GenerateClient: true,
GenerateEchoServer: true,
GenerateTypes: true,
EmbedSpec: true,
}
// Get a spec from the test definition in this file:
swagger, err := openapi3.NewSwaggerLoader().LoadSwaggerFromData([]byte(testOpenAPIDefinition))
assert.NoError(t, err)
// Run our code generation:
code, err := Generate(swagger, packageName, opts)
assert.NoError(t, err)
assert.NotEmpty(t, code)
// Check that we have valid (formattable) code:
_, err = format.Source([]byte(code))
assert.NoError(t, err)
// Check that we have a package:
assert.Contains(t, code, "package testswagger")
// Check that response structs are generated correctly:
assert.Contains(t, code, "type GetTestByNameResponse struct {")
// Check that response structs contains fallbacks to interface for invalid types:
// Here an invalid array with no items.
assert.Contains(t, code, `
type GetTestByNameResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *[]Test
XML200 *[]Test
JSON422 *[]interface{}
XML422 *[]interface{}
JSONDefault *Error
}`)
// Check that the helper methods are generated correctly:
assert.Contains(t, code, "func (r GetTestByNameResponse) Status() string {")
assert.Contains(t, code, "func (r GetTestByNameResponse) StatusCode() int {")
assert.Contains(t, code, "func ParseGetTestByNameResponse(rsp *http.Response) (*GetTestByNameResponse, error) {")
// Check the client method signatures:
assert.Contains(t, code, "type GetTestByNameParams struct {")
assert.Contains(t, code, "Top *int `json:\"$top,omitempty\"`")
assert.Contains(t, code, "func (c *Client) GetTestByName(ctx context.Context, name string, params *GetTestByNameParams, reqEditors ...RequestEditorFn) (*http.Response, error) {")
assert.Contains(t, code, "func (c *ClientWithResponses) GetTestByNameWithResponse(ctx context.Context, name string, params *GetTestByNameParams) (*GetTestByNameResponse, error) {")
// Make sure the generated code is valid:
linter := new(lint.Linter)
problems, err := linter.Lint("test.gen.go", []byte(code))
assert.NoError(t, err)
assert.Len(t, problems, 0)
}
const testOpenAPIDefinition = `
openapi: 3.0.1
info:
title: OpenAPI-CodeGen Test
description: 'This is a test OpenAPI Spec'
version: 1.0.0
servers:
- url: https://test.oapi-codegen.com/v2
- url: http://test.oapi-codegen.com/v2
paths:
/test/{name}:
get:
tags:
- test
summary: Get test
operationId: getTestByName
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: $top
in: query
required: false
schema:
type: integer
responses:
200:
description: Success
content:
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/Test'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Test'
422:
description: InvalidArray
content:
application/xml:
schema:
type: array
application/json:
schema:
type: array
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/cat:
get:
tags:
- cat
summary: Get cat status
operationId: getCatStatus
responses:
200:
description: Success
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/CatAlive'
- $ref: '#/components/schemas/CatDead'
application/xml:
schema:
anyOf:
- $ref: '#/components/schemas/CatAlive'
- $ref: '#/components/schemas/CatDead'
application/yaml:
schema:
allOf:
- $ref: '#/components/schemas/CatAlive'
- $ref: '#/components/schemas/CatDead'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Test:
properties:
name:
type: string
cases:
type: array
items:
$ref: '#/components/schemas/TestCase'
TestCase:
properties:
name:
type: string
command:
type: string
Error:
properties:
code:
type: integer
format: int32
message:
type: string
CatAlive:
properties:
name:
type: string
alive_since:
type: string
format: date-time
CatDead:
properties:
name:
type: string
dead_since:
type: string
format: date-time
cause:
type: string
enum: [car, dog, oldage]
`