-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Expand file tree
/
Copy pathschema_test.go
More file actions
521 lines (491 loc) · 12.3 KB
/
schema_test.go
File metadata and controls
521 lines (491 loc) · 12.3 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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
package codegen
import (
"testing"
"github.com/getkin/kin-openapi/openapi3"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestProperty_GoTypeDef(t *testing.T) {
type fields struct {
GlobalStateDisableRequiredReadOnlyAsPointer bool
Schema Schema
Required bool
Nullable bool
ReadOnly bool
WriteOnly bool
}
tests := []struct {
name string
fields fields
want string
}{
{
// When pointer is skipped by setting flag SkipOptionalPointer, the
// flag will never be pointer irrespective of other flags.
name: "Set skip optional pointer type for go type",
fields: fields{
Schema: Schema{
SkipOptionalPointer: true,
RefType: "",
GoType: "int",
},
},
want: "int",
},
{
// if the field is optional, it will always be pointer irrespective of other
// flags, given that pointer type is not skipped by setting SkipOptionalPointer
// flag to true
name: "When the field is optional",
fields: fields{
Schema: Schema{
SkipOptionalPointer: false,
RefType: "",
GoType: "int",
},
Required: false,
},
want: "*int",
},
{
// if the field(custom-type) is optional, it will NOT be a pointer if
// SkipOptionalPointer flag is set to true
name: "Set skip optional pointer type for ref type",
fields: fields{
Schema: Schema{
SkipOptionalPointer: true,
RefType: "CustomType",
GoType: "int",
},
Required: false,
},
want: "CustomType",
},
// For the following test cases, SkipOptionalPointer flag is false.
{
name: "When field is required and not nullable",
fields: fields{
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
Required: true,
Nullable: false,
},
want: "int",
},
{
name: "When field is required and nullable",
fields: fields{
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
Required: true,
Nullable: true,
},
want: "*int",
},
{
name: "When field is optional and not nullable",
fields: fields{
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
Required: false,
Nullable: false,
},
want: "*int",
},
{
name: "When field is optional and nullable",
fields: fields{
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
Required: false,
Nullable: true,
},
want: "*int",
},
// Following tests cases for non-nullable and required; and skip pointer is not opted
{
name: "When field is readOnly it will always be pointer",
fields: fields{
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
ReadOnly: true,
Required: true,
},
want: "*int",
},
{
name: "When field is readOnly and read only pointer disabled",
fields: fields{
GlobalStateDisableRequiredReadOnlyAsPointer: true,
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
ReadOnly: true,
Required: true,
},
want: "int",
},
{
name: "When field is readOnly and optional",
fields: fields{
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
ReadOnly: true,
Required: false,
},
want: "*int",
},
{
name: "When field is readOnly and optional and read only pointer disabled",
fields: fields{
GlobalStateDisableRequiredReadOnlyAsPointer: true,
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
ReadOnly: true,
Required: false,
},
want: "*int",
},
// When field is write only, it will always be pointer unless pointer is
// skipped by setting SkipOptionalPointer flag
{
name: "When field is write only and read only pointer disabled",
fields: fields{
GlobalStateDisableRequiredReadOnlyAsPointer: true,
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
WriteOnly: true,
},
want: "*int",
},
{
name: "When field is write only and read only pointer enabled",
fields: fields{
GlobalStateDisableRequiredReadOnlyAsPointer: false,
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
WriteOnly: true,
},
want: "*int",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
globalState.options.Compatibility.DisableRequiredReadOnlyAsPointer = tt.fields.GlobalStateDisableRequiredReadOnlyAsPointer
p := Property{
Schema: tt.fields.Schema,
Required: tt.fields.Required,
Nullable: tt.fields.Nullable,
ReadOnly: tt.fields.ReadOnly,
WriteOnly: tt.fields.WriteOnly,
}
assert.Equal(t, tt.want, p.GoTypeDef())
})
}
}
func TestProperty_GoTypeDef_nullable(t *testing.T) {
type fields struct {
GlobalStateDisableRequiredReadOnlyAsPointer bool
GlobalStateNullableType bool
Schema Schema
Required bool
Nullable bool
ReadOnly bool
WriteOnly bool
}
tests := []struct {
name string
fields fields
want string
}{
{
// Field not nullable.
// When pointer is skipped by setting flag SkipOptionalPointer, the
// flag will never be pointer irrespective of other flags.
name: "Set skip optional pointer type for go type",
fields: fields{
GlobalStateNullableType: true,
Schema: Schema{
SkipOptionalPointer: true,
RefType: "",
GoType: "int",
},
},
want: "int",
},
{
// Field not nullable.
// if the field is optional, it will always be pointer irrespective of other
// flags, given that pointer type is not skipped by setting SkipOptionalPointer
// flag to true
name: "When the field is optional",
fields: fields{
GlobalStateNullableType: true,
Schema: Schema{
SkipOptionalPointer: false,
RefType: "",
GoType: "int",
},
Required: false,
},
want: "*int",
},
{
// Field not nullable.
// if the field(custom type) is optional, it will NOT be a pointer if
// SkipOptionalPointer flag is set to true
name: "Set skip optional pointer type for ref type",
fields: fields{
GlobalStateNullableType: true,
Schema: Schema{
SkipOptionalPointer: true,
RefType: "CustomType",
GoType: "int",
},
Required: false,
},
want: "CustomType",
},
// Field not nullable.
// For the following test case, SkipOptionalPointer flag is false.
{
name: "When field is required and not nullable",
fields: fields{
GlobalStateNullableType: true,
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
Required: true,
Nullable: false,
},
want: "int",
},
{
name: "When field is required and nullable",
fields: fields{
GlobalStateNullableType: true,
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
Required: true,
Nullable: true,
},
want: "nullable.Nullable[int]",
},
{
name: "When field is optional and not nullable",
fields: fields{
GlobalStateNullableType: true,
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
Required: false,
Nullable: false,
},
want: "*int",
},
{
name: "When field is optional and nullable",
fields: fields{
GlobalStateNullableType: true,
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
Required: false,
Nullable: true,
},
want: "nullable.Nullable[int]",
},
{
name: "When field is readOnly, non-nullable and required and skip pointer is not opted",
fields: fields{
GlobalStateNullableType: true,
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
ReadOnly: true,
Required: true,
},
want: "*int",
},
{
name: "When field is readOnly, required, non-nullable and read only pointer disabled",
fields: fields{
GlobalStateNullableType: true,
GlobalStateDisableRequiredReadOnlyAsPointer: true,
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
ReadOnly: true,
Required: true,
},
want: "int",
},
{
name: "When field is readOnly, optional and non nullable",
fields: fields{
GlobalStateNullableType: true,
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
ReadOnly: true,
Required: false,
},
want: "*int",
},
{
name: "When field is readOnly and optional and read only pointer disabled",
fields: fields{
GlobalStateNullableType: true,
GlobalStateDisableRequiredReadOnlyAsPointer: true,
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
ReadOnly: true,
Required: false,
},
want: "*int",
},
{
name: "When field is write only and non nullable",
fields: fields{
GlobalStateNullableType: true,
GlobalStateDisableRequiredReadOnlyAsPointer: true,
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
WriteOnly: true,
},
want: "*int",
},
{
name: "When field is write only and nullable",
fields: fields{
GlobalStateNullableType: true,
GlobalStateDisableRequiredReadOnlyAsPointer: true,
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
WriteOnly: true,
Nullable: true,
},
want: "nullable.Nullable[int]",
},
{
name: "When field is write only, nullable and read only pointer enabled",
fields: fields{
GlobalStateNullableType: true,
Schema: Schema{
SkipOptionalPointer: false,
GoType: "int",
},
WriteOnly: true,
Nullable: true,
},
want: "nullable.Nullable[int]",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
globalState.options.Compatibility.DisableRequiredReadOnlyAsPointer = tt.fields.GlobalStateDisableRequiredReadOnlyAsPointer
globalState.options.OutputOptions.NullableType = tt.fields.GlobalStateNullableType
p := Property{
Schema: tt.fields.Schema,
Required: tt.fields.Required,
Nullable: tt.fields.Nullable,
ReadOnly: tt.fields.ReadOnly,
WriteOnly: tt.fields.WriteOnly,
}
assert.Equal(t, tt.want, p.GoTypeDef())
})
}
}
func TestProperty_ZeroValueIsNil(t *testing.T) {
newType := func(typ string) *openapi3.Types {
return &openapi3.Types{typ}
}
tests := []struct {
name string
oapiSchema *openapi3.Schema
expectIsNil bool
}{
{
name: "when an array, returns true",
oapiSchema: &openapi3.Schema{Type: newType("array")},
expectIsNil: true,
},
{
name: "when an object, returns false",
oapiSchema: &openapi3.Schema{Type: newType("object")},
expectIsNil: false,
},
{
name: "when a string, returns false",
oapiSchema: &openapi3.Schema{Type: newType("string")},
expectIsNil: false,
},
{
name: "when an integer, returns false",
oapiSchema: &openapi3.Schema{Type: newType("integer")},
expectIsNil: false,
},
{
name: "when a number, returns false",
oapiSchema: &openapi3.Schema{Type: newType("number")},
expectIsNil: false,
},
{
name: "when OAPISchema is nil, returns false",
oapiSchema: nil,
expectIsNil: false,
},
{
name: "when OAPISchema is zero value, returns false",
oapiSchema: &openapi3.Schema{},
expectIsNil: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
prop := Property{
Schema: Schema{
OAPISchema: tt.oapiSchema,
},
}
if tt.expectIsNil {
require.True(t, prop.ZeroValueIsNil())
} else {
require.False(t, prop.ZeroValueIsNil())
}
})
}
}