Skip to content
Navigation Menu
{{ message }}
-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Expand file tree
/
Copy pathcodegen_test.go
More file actions
465 lines (409 loc) · 14.4 KB
/
Copy pathcodegen_test.go
File metadata and controls
465 lines (409 loc) · 14.4 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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
package codegen
import (
_ "embed"
"go/format"
"testing"
"github.com/getkin/kin-openapi/openapi3"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/oapi-codegen/oapi-codegen/v2/pkg/util"
)
const (
remoteRefFile = `https://raw.githubusercontent.com/oapi-codegen/oapi-codegen/master/examples/petstore-expanded` +
`/petstore-expanded.yaml`
remoteRefImport = `github.com/oapi-codegen/oapi-codegen/v2/examples/petstore-expanded`
)
func TestExampleOpenAPICodeGeneration(t *testing.T) {
// Input vars for code generation:
packageName := "testswagger"
opts := Configuration{
PackageName: packageName,
Generate: GenerateOptions{
EchoServer: true,
Client: true,
Models: true,
EmbeddedSpec: true,
},
}
loader := openapi3.NewLoader()
loader.IsExternalRefsAllowed = true
// Get a spec from the test definition in this file:
swagger, err := loader.LoadFromData([]byte(testOpenAPIDefinition))
assert.NoError(t, err)
// Run our code generation:
code, err := Generate(swagger, 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 the response for an HTTP 200 `+"`application/json`"+` response
JSON200 *[]Test
// XML200 the response for an HTTP 200 `+"`application/xml`"+` response
XML200 *[]Test
// JSON422 the response for an HTTP 422 `+"`application/json`"+` response
JSON422 *[]interface{}
// XML422 the response for an HTTP 422 `+"`application/xml`"+` response
XML422 *[]interface{}
// JSONDefault the response for an HTTP default `+"`application/json`"+` response
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 `form:\"$top,omitempty\" 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, reqEditors ...RequestEditorFn) (*GetTestByNameResponse, error) {")
assert.Contains(t, code, "FavouriteBirds *[]*string `json:\"favourite_birds,omitempty\"`")
assert.Contains(t, code, "DetestedBirds *[]string `json:\"detested_birds,omitempty\"`")
assert.Contains(t, code, "SlicedBirds []string `json:\"sliced_birds\"`")
assert.Contains(t, code, "ForgettableBirds *map[string]*string `json:\"forgettable_birds,omitempty\"`")
assert.Contains(t, code, "MemorableBirds *map[string]string `json:\"memorable_birds,omitempty\"`")
assert.Contains(t, code, "VeryMemorableBirds map[string]string `json:\"very_memorable_birds\"`")
assert.Contains(t, code, "DeadSince *time.Time `json:\"dead_since,omitempty\" tag1:\"value1\" tag2:\"value2\"`")
assert.Contains(t, code, "VeryDeadSince time.Time `json:\"very_dead_since\"`")
assert.Contains(t, code, "type EnumTestNumerics int")
assert.Contains(t, code, "N2 EnumTestNumerics = 2")
assert.Contains(t, code, "type EnumTestEnumNames int")
assert.Contains(t, code, "Two EnumTestEnumNames = 2")
assert.Contains(t, code, "Double EnumTestEnumVarnames = 2")
}
func TestExtPropGoTypeSkipOptionalPointer(t *testing.T) {
packageName := "api"
opts := Configuration{
PackageName: packageName,
Generate: GenerateOptions{
EchoServer: true,
Models: true,
EmbeddedSpec: true,
Strict: true,
},
}
spec := "test_specs/x-go-type-skip-optional-pointer.yaml"
swagger, err := util.LoadSwagger(spec)
require.NoError(t, err)
// Run our code generation:
code, err := Generate(swagger, 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 optional pointer fields are skipped if requested
assert.Contains(t, code, "NullableFieldSkipFalse *string `json:\"nullableFieldSkipFalse,omitempty\"`")
assert.Contains(t, code, "NullableFieldSkipTrue string `json:\"nullableFieldSkipTrue,omitempty\"`")
assert.Contains(t, code, "OptionalField *string `json:\"optionalField,omitempty\"`")
assert.Contains(t, code, "OptionalFieldSkipFalse *string `json:\"optionalFieldSkipFalse,omitempty\"`")
assert.Contains(t, code, "OptionalFieldSkipTrue string `json:\"optionalFieldSkipTrue,omitempty\"`")
// Check that the extension applies on custom types as well
assert.Contains(t, code, "CustomTypeWithSkipTrue string `json:\"customTypeWithSkipTrue,omitempty\"`")
// Check that the extension has no effect on required fields
assert.Contains(t, code, "RequiredField string `json:\"requiredField\"`")
}
func TestGoTypeImport(t *testing.T) {
packageName := "api"
opts := Configuration{
PackageName: packageName,
Generate: GenerateOptions{
EchoServer: true,
Models: true,
EmbeddedSpec: true,
},
}
spec := "test_specs/x-go-type-import-pet.yaml"
swagger, err := util.LoadSwagger(spec)
require.NoError(t, err)
// Run our code generation:
code, err := Generate(swagger, 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)
imports := []string{
`github.com/CavernaTechnologies/pgext`, // schemas - direct object
`myuuid "github.com/google/uuid"`, // schemas - object
`github.com/lib/pq`, // schemas - array
`github.com/spf13/viper`, // responses - direct object
`golang.org/x/text`, // responses - complex object
`golang.org/x/email`, // requestBodies - in components
`github.com/fatih/color`, // parameters - query
`github.com/go-openapi/swag`, // parameters - path
`github.com/jackc/pgtype`, // direct parameters - path
`github.com/mailru/easyjson`, // direct parameters - query
`github.com/subosito/gotenv`, // direct request body
}
// Check import
for _, imp := range imports {
assert.Contains(t, code, imp)
}
}
func TestGoAllofTypeOverride(t *testing.T) {
packageName := "api"
opts := Configuration{
PackageName: packageName,
Generate: GenerateOptions{
EchoServer: true,
Models: true,
EmbeddedSpec: true,
},
}
spec := "test_specs/x-go-type-pet-allof.yaml"
swagger, err := util.LoadSwagger(spec)
require.NoError(t, err)
// Run our code generation:
code, err := Generate(swagger, 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)
for _, expected := range []string{
"type Cat = cat.Cat",
"type Dog = dog.Dog",
"type Pet = pet.Pet",
"github.com/somepetproject/pkg/cat",
"github.com/somepetproject/pkg/dog",
"github.com/somepetproject/pkg/pet",
} {
assert.Contains(t, code, expected)
}
}
func TestRemoteExternalReference(t *testing.T) {
if testing.Short() {
t.Skip("Skipping test that interacts with the network")
}
packageName := "api"
opts := Configuration{
PackageName: packageName,
Generate: GenerateOptions{
Models: true,
},
ImportMapping: map[string]string{
remoteRefFile: remoteRefImport,
},
}
spec := "test_specs/remote-external-reference.yaml"
swagger, err := util.LoadSwagger(spec)
require.NoError(t, err)
// Run our code generation:
code, err := Generate(swagger, 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 import
assert.Contains(t, code, `externalRef0 "github.com/oapi-codegen/oapi-codegen/v2/examples/petstore-expanded"`)
// Check generated oneOf structure:
assert.Contains(t, code, `
// ExampleSchema_Item defines model for ExampleSchema.Item.
type ExampleSchema_Item struct {
union json.RawMessage
}
`)
// Check generated oneOf structure As method:
assert.Contains(t, code, `
// AsExternalRef0NewPet returns the union data inside the ExampleSchema_Item as a externalRef0.NewPet
func (t ExampleSchema_Item) AsExternalRef0NewPet() (externalRef0.NewPet, error) {
`)
// Check generated oneOf structure From method:
assert.Contains(t, code, `
// FromExternalRef0NewPet overwrites any union data inside the ExampleSchema_Item as the provided externalRef0.NewPet
func (t *ExampleSchema_Item) FromExternalRef0NewPet(v externalRef0.NewPet) error {
`)
// Check generated oneOf structure Merge method:
assert.Contains(t, code, `
// FromExternalRef0NewPet overwrites any union data inside the ExampleSchema_Item as the provided externalRef0.NewPet
func (t *ExampleSchema_Item) FromExternalRef0NewPet(v externalRef0.NewPet) error {
`)
}
func TestDuplicatePathParameter(t *testing.T) {
// Regression test for https://github.com/oapi-codegen/oapi-codegen/issues/1574
// Some real-world specs (e.g. Keycloak) have paths where the same parameter
// appears more than once: /clients/{client-uuid}/.../clients/{client-uuid}
spec := `
openapi: "3.0.0"
info:
version: 1.0.0
title: Duplicate path param test
paths:
/admin/realms/{realm}/clients/{client-uuid}/roles/{role-name}/composites/clients/{client-uuid}:
get:
operationId: getCompositeRoles
parameters:
- name: realm
in: path
required: true
schema:
type: string
- name: client-uuid
in: path
required: true
schema:
type: string
- name: role-name
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
`
loader := openapi3.NewLoader()
swagger, err := loader.LoadFromData([]byte(spec))
require.NoError(t, err)
opts := Configuration{
PackageName: "api",
Generate: GenerateOptions{
EchoServer: true,
Client: true,
Models: true,
},
}
code, err := Generate(swagger, opts)
require.NoError(t, err)
assert.NotEmpty(t, code)
// Verify the generated code is valid Go.
_, err = format.Source([]byte(code))
require.NoError(t, err)
// The path params should appear exactly once in the function signature.
assert.Contains(t, code, "realm string")
assert.Contains(t, code, "clientUuid string")
assert.Contains(t, code, "roleName string")
}
// TestEnumConflictDetectionOrderIndependent checks that conflict detection
// doesn't miss overlaps because an enum was already marked for prefixing.
func TestEnumConflictDetectionOrderIndependent(t *testing.T) {
// AState+BState share "running" (both prefixed), AState+CState share "migrating".
// The bug: once AState was marked, GetValues() returned prefixed names that
// no longer matched CState's raw values, so CState's conflict was missed.
const spec = `
openapi: "3.0.0"
info:
version: 1.0.0
title: Test Enum Conflict Detection
paths: {}
components:
schemas:
AState:
type: string
enum:
- running
- migrating
BState:
type: string
enum:
- running
CState:
type: string
enum:
- migrating
`
loader := openapi3.NewLoader()
swagger, err := loader.LoadFromData([]byte(spec))
require.NoError(t, err)
opts := Configuration{
PackageName: "api",
Generate: GenerateOptions{
Models: true,
},
OutputOptions: OutputOptions{
SkipPrune: true,
},
}
code, err := Generate(swagger, opts)
require.NoError(t, err)
_, err = format.Source([]byte(code))
require.NoError(t, err)
// All three enums share values with at least one other enum; all must be prefixed.
assert.Contains(t, code, "AStateRunning")
assert.Contains(t, code, "AStateMigrating")
assert.Contains(t, code, "BStateRunning")
assert.Contains(t, code, "CStateMigrating")
}
// TestEnumConflictDetectionBothOrders verifies that enum conflict detection
// produces identical, fully-prefixed output regardless of the order the
// schemas appear in the spec.
func TestEnumConflictDetectionBothOrders(t *testing.T) {
specAFirst := `
openapi: "3.0.0"
info:
version: 1.0.0
title: Test
paths: {}
components:
schemas:
AState:
type: string
enum: [running, migrating]
BState:
type: string
enum: [running]
CState:
type: string
enum: [migrating]
`
specCFirst := `
openapi: "3.0.0"
info:
version: 1.0.0
title: Test
paths: {}
components:
schemas:
CState:
type: string
enum: [migrating]
BState:
type: string
enum: [running]
AState:
type: string
enum: [running, migrating]
`
opts := Configuration{
PackageName: "api",
Generate: GenerateOptions{Models: true},
OutputOptions: OutputOptions{
SkipPrune: true,
},
}
loader := openapi3.NewLoader()
swaggerA, err := loader.LoadFromData([]byte(specAFirst))
require.NoError(t, err)
codeA, err := Generate(swaggerA, opts)
require.NoError(t, err)
swaggerC, err := loader.LoadFromData([]byte(specCFirst))
require.NoError(t, err)
codeC, err := Generate(swaggerC, opts)
require.NoError(t, err)
// Both orderings must produce fully prefixed constants.
for _, code := range []string{codeA, codeC} {
assert.Contains(t, code, "AStateRunning")
assert.Contains(t, code, "AStateMigrating")
assert.Contains(t, code, "BStateRunning")
assert.Contains(t, code, "CStateMigrating")
// Unprefixed names must not appear as standalone constants.
assert.NotContains(t, code, "\tRunning ")
assert.NotContains(t, code, "\tMigrating ")
}
}
//go:embed test_spec.yaml
var testOpenAPIDefinition string
You can’t perform that action at this time.