File: yaml_test.go

package info (click to toggle)
golang-github-go-openapi-swag 1%3A0.23.1-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental, sid, trixie
  • size: 336 kB
  • sloc: makefile: 2
file content (689 lines) | stat: -rw-r--r-- 15,215 bytes parent folder | download
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
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
// Copyright 2015 go-swagger maintainers
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package swag

import (
	"encoding/json"
	"net/http"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	yaml "gopkg.in/yaml.v3"
)

func TestJSONToYAML(t *testing.T) {
	sd := `{"1":"the int key value","name":"a string value","y":"some value"}`
	var data JSONMapSlice
	require.NoError(t, json.Unmarshal([]byte(sd), &data))

	y, err := data.MarshalYAML()
	require.NoError(t, err)
	const expected = `"1": the int key value
name: a string value
y: some value
`
	assert.Equal(t, expected, string(y.([]byte)))

	nstd := `{"1":"the int key value","name":"a string value","y":"some value","tag":{"name":"tag name"}}`
	const nestpected = `"1": the int key value
name: a string value
y: some value
tag:
    name: tag name
`
	var ndata JSONMapSlice
	require.NoError(t, json.Unmarshal([]byte(nstd), &ndata))
	ny, err := ndata.MarshalYAML()
	require.NoError(t, err)
	assert.Equal(t, nestpected, string(ny.([]byte)))

	ydoc, err := BytesToYAMLDoc([]byte(fixtures2224))
	require.NoError(t, err)
	b, err := YAMLToJSON(ydoc)
	require.NoError(t, err)

	var bdata JSONMapSlice
	require.NoError(t, json.Unmarshal(b, &bdata))

}

func TestJSONToYAMLWithNull(t *testing.T) {
	const (
		jazon    = `{"1":"the int key value","name":null,"y":"some value"}`
		expected = `"1": the int key value
name: null
y: some value
`
	)
	var data JSONMapSlice
	require.NoError(t, json.Unmarshal([]byte(jazon), &data))
	ny, err := data.MarshalYAML()
	require.NoError(t, err)
	assert.Equal(t, expected, string(ny.([]byte)))
}

func TestMarshalYAML(t *testing.T) {
	t.Run("marshalYAML should be deterministic", func(t *testing.T) {
		const (
			jazon    = `{"1":"x","2":null,"3":{"a":1,"b":2,"c":3}}`
			expected = `"1": x
"2": null
"3":
    a: !!float 1
    b: !!float 2
    c: !!float 3
`
		)
		const iterations = 10
		for n := 0; n < iterations; n++ {
			var data JSONMapSlice
			require.NoError(t, json.Unmarshal([]byte(jazon), &data))
			ny, err := data.MarshalYAML()
			require.NoError(t, err)
			assert.Equal(t, expected, string(ny.([]byte)))
		}
	})
}

func TestYAMLToJSON(t *testing.T) {
	sd := `---
1: the int key value
name: a string value
'y': some value
`
	var data yaml.Node
	_ = yaml.Unmarshal([]byte(sd), &data)

	d, err := YAMLToJSON(data)
	require.NoError(t, err)
	require.NotNil(t, d)
	assert.JSONEq(t, `{"1":"the int key value","name":"a string value","y":"some value"}`, string(d))

	ns := []*yaml.Node{
		{
			Kind:  yaml.ScalarNode,
			Value: "true",
			Tag:   "!!bool",
		},
		{
			Kind:  yaml.ScalarNode,
			Value: "the bool value",
			Tag:   "!!str",
		},
	}
	data.Content[0].Content = append(data.Content[0].Content, ns...)
	d, err = YAMLToJSON(data)
	require.Error(t, err)
	require.Nil(t, d)

	data.Content[0].Content = data.Content[0].Content[:len(data.Content[0].Content)-2]

	tag := []*yaml.Node{
		{
			Kind:  yaml.ScalarNode,
			Value: "tag",
			Tag:   "!!str",
		},
		{
			Kind: yaml.MappingNode,
			Content: []*yaml.Node{
				{
					Kind:  yaml.ScalarNode,
					Value: "name",
					Tag:   "!!str",
				},
				{
					Kind:  yaml.ScalarNode,
					Value: "tag name",
					Tag:   "!!str",
				},
			},
		},
	}
	data.Content[0].Content = append(data.Content[0].Content, tag...)

	d, err = YAMLToJSON(data)
	require.NoError(t, err)
	assert.JSONEq(t, `{"1":"the int key value","name":"a string value","y":"some value","tag":{"name":"tag name"}}`, string(d))

	tag[1].Content = []*yaml.Node{
		{
			Kind:  yaml.ScalarNode,
			Value: "true",
			Tag:   "!!bool",
		},
		{
			Kind:  yaml.ScalarNode,
			Value: "the bool tag name",
			Tag:   "!!str",
		},
	}

	d, err = YAMLToJSON(data)
	require.Error(t, err)
	require.Nil(t, d)

	var lst []interface{}
	lst = append(lst, "hello")

	d, err = YAMLToJSON(lst)
	require.NoError(t, err)
	require.NotNil(t, d)
	assert.Equal(t, []byte(`["hello"]`), []byte(d))

	lst = append(lst, data)

	d, err = YAMLToJSON(lst)
	require.Error(t, err)
	require.Nil(t, d)

	_, err = BytesToYAMLDoc([]byte("- name: hello\n"))
	require.Error(t, err)

	dd, err := BytesToYAMLDoc([]byte("description: 'object created'\n"))
	require.NoError(t, err)

	d, err = YAMLToJSON(dd)
	require.NoError(t, err)
	assert.JSONEq(t, `{"description":"object created"}`, string(d))
}

var yamlPestoreServer = func(rw http.ResponseWriter, _ *http.Request) {
	rw.WriteHeader(http.StatusOK)
	_, _ = rw.Write([]byte(yamlPetStore))
}

func TestWithYKey(t *testing.T) {
	doc, err := BytesToYAMLDoc([]byte(withYKey))
	require.NoError(t, err)

	_, err = YAMLToJSON(doc)
	require.NoError(t, err)

	doc, err = BytesToYAMLDoc([]byte(withQuotedYKey))
	require.NoError(t, err)
	jsond, err := YAMLToJSON(doc)
	require.NoError(t, err)

	var yt struct {
		Definitions struct {
			Viewbox struct {
				Properties struct {
					Y struct {
						Type string `json:"type"`
					} `json:"y"`
				} `json:"properties"`
			} `json:"viewbox"`
		} `json:"definitions"`
	}
	require.NoError(t, json.Unmarshal(jsond, &yt))
	assert.Equal(t, "integer", yt.Definitions.Viewbox.Properties.Y.Type)
}

func TestMapKeyTypes(t *testing.T) {
	dm := map[interface{}]interface{}{
		12345:               "int",
		int8(1):             "int8",
		int16(12345):        "int16",
		int32(12345678):     "int32",
		int64(12345678910):  "int64",
		uint(12345):         "uint",
		uint8(1):            "uint8",
		uint16(12345):       "uint16",
		uint32(12345678):    "uint32",
		uint64(12345678910): "uint64",
	}
	_, err := YAMLToJSON(dm)
	require.NoError(t, err)
}

const fixtures2224 = `definitions:
  Time:
    type: string
    format: date-time
    x-go-type:
      import:
        package: time
      embedded: true
      type: Time
    x-nullable: true

  TimeAsObject:  # <- time.Time is actually a struct
    type: string
    format: date-time
    x-go-type:
      import:
        package: time
        hints:
          kind: object
      embedded: true
      type: Time
    x-nullable: true

  Raw:
    x-go-type:
      import:
        package: encoding/json
      hints:
        kind: primitive
      embedded: true
      type: RawMessage

  Request:
    x-go-type:
      import:
        package: net/http
      hints:
        kind: object
      embedded: true
      type: Request

  RequestPointer:
    x-go-type:
      import:
        package: net/http
      hints:
        kind: object
        nullable: true
      embedded: true
      type: Request

  OldStyleImport:
    type: object
    x-go-type:
      import:
        package: net/http
      type: Request
      hints:
        noValidation: true

  OldStyleRenamed:
    type: object
    x-go-type:
      import:
        package: net/http
      type: Request
      hints:
        noValidation: true
    x-go-name: OldRenamed

  ObjectWithEmbedded:
    type: object
    properties:
      a:
        $ref: '#/definitions/Time'
      b:
        $ref: '#/definitions/Request'
      c:
        $ref: '#/definitions/TimeAsObject'
      d:
        $ref: '#/definitions/Raw'
      e:
        $ref: '#/definitions/JSONObject'
      f:
        $ref: '#/definitions/JSONMessage'
      g:
        $ref: '#/definitions/JSONObjectWithAlias'

  ObjectWithExternals:
    type: object
    properties:
      a:
        $ref: '#/definitions/OldStyleImport'
      b:
        $ref: '#/definitions/OldStyleRenamed'

  Base:
    properties: &base
      id:
        type: integer
        format: uint64
        x-go-custom-tag: 'gorm:"primary_key"'
      FBID:
        type: integer
        format: uint64
        x-go-custom-tag: 'gorm:"index"'
      created_at:
        $ref: "#/definitions/Time"
      updated_at:
        $ref: "#/definitions/Time"
      version:
        type: integer
        format: uint64

  HotspotType:
    type: string
    enum:
      - A
      - B
      - C

  Hotspot:
    type: object
    allOf:
      - properties: *base
      - properties:
          access_points:
            type: array
            items:
              $ref: '#/definitions/AccessPoint'
          type:
            $ref: '#/definitions/HotspotType'
        required:
          - type

  AccessPoint:
    type: object
    allOf:
      - properties: *base
      - properties:
          mac_address:
            type: string
            x-go-custom-tag: 'gorm:"index;not null;unique"'
          hotspot_id:
            type: integer
            format: uint64
          hotspot:
            $ref: '#/definitions/Hotspot'

  JSONObject:
    type: object
    additionalProperties:
      type: array
      items:
        $ref: '#/definitions/Raw'

  JSONObjectWithAlias:
    type: object
    additionalProperties:
      type: object
      properties:
        message:
          $ref: '#/definitions/JSONMessage'

  JSONMessage:
    $ref: '#/definitions/Raw'

  Incorrect:
    x-go-type:
      import:
        package: net
        hints:
          kind: array
      embedded: true
      type: Buffers
    x-nullable: true
`

const withQuotedYKey = `consumes:
- application/json
definitions:
  viewBox:
    type: object
    properties:
      x:
        type: integer
        format: int16
      # y -> types don't match: expect map key string or int get: bool
      "y":
        type: integer
        format: int16
      width:
        type: integer
        format: int16
      height:
        type: integer
        format: int16
info:
  description: Test RESTful APIs
  title: Test Server
  version: 1.0.0
basePath: /api
paths:
  /test:
    get:
      operationId: findAll
      parameters:
        - name: since
          in: query
          type: integer
          format: int64
        - name: limit
          in: query
          type: integer
          format: int32
          default: 20
      responses:
        200:
          description: Array[Trigger]
          schema:
            type: array
            items:
              $ref: "#/definitions/viewBox"
produces:
- application/json
schemes:
- https
swagger: "2.0"
`

const withYKey = `consumes:
- application/json
definitions:
  viewBox:
    type: object
    properties:
      x:
        type: integer
        format: int16
      # y -> types don't match: expect map key string or int get: bool
      y:
        type: integer
        format: int16
      width:
        type: integer
        format: int16
      height:
        type: integer
        format: int16
info:
  description: Test RESTful APIs
  title: Test Server
  version: 1.0.0
basePath: /api
paths:
  /test:
    get:
      operationId: findAll
      parameters:
        - name: since
          in: query
          type: integer
          format: int64
        - name: limit
          in: query
          type: integer
          format: int32
          default: 20
      responses:
        200:
          description: Array[Trigger]
          schema:
            type: array
            items:
              $ref: "#/definitions/viewBox"
produces:
- application/json
schemes:
- https
swagger: "2.0"
`

const yamlPetStore = `swagger: '2.0'
info:
  version: '1.0.0'
  title: Swagger Petstore
  description: A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification
  termsOfService: http://helloreverb.com/terms/
  contact:
    name: Swagger API team
    email: foo@example.com
    url: http://swagger.io
  license:
    name: MIT
    url: http://opensource.org/licenses/MIT
host: petstore.swagger.wordnik.com
basePath: /api
schemes:
  - http
consumes:
  - application/json
produces:
  - application/json
paths:
  /pets:
    get:
      description: Returns all pets from the system that the user has access to
      operationId: findPets
      produces:
        - application/json
        - application/xml
        - text/xml
        - text/html
      parameters:
        - name: tags
          in: query
          description: tags to filter by
          required: false
          type: array
          items:
            type: string
          collectionFormat: csv
        - name: limit
          in: query
          description: maximum number of results to return
          required: false
          type: integer
          format: int32
      responses:
        '200':
          description: pet response
          schema:
            type: array
            items:
              $ref: '#/definitions/pet'
        default:
          description: unexpected error
          schema:
            $ref: '#/definitions/errorModel'
    post:
      description: Creates a new pet in the store.  Duplicates are allowed
      operationId: addPet
      produces:
        - application/json
      parameters:
        - name: pet
          in: body
          description: Pet to add to the store
          required: true
          schema:
            $ref: '#/definitions/newPet'
      responses:
        '200':
          description: pet response
          schema:
            $ref: '#/definitions/pet'
        default:
          description: unexpected error
          schema:
            $ref: '#/definitions/errorModel'
  /pets/{id}:
    get:
      description: Returns a user based on a single ID, if the user does not have access to the pet
      operationId: findPetById
      produces:
        - application/json
        - application/xml
        - text/xml
        - text/html
      parameters:
        - name: id
          in: path
          description: ID of pet to fetch
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: pet response
          schema:
            $ref: '#/definitions/pet'
        default:
          description: unexpected error
          schema:
            $ref: '#/definitions/errorModel'
    delete:
      description: deletes a single pet based on the ID supplied
      operationId: deletePet
      parameters:
        - name: id
          in: path
          description: ID of pet to delete
          required: true
          type: integer
          format: int64
      responses:
        '204':
          description: pet deleted
        default:
          description: unexpected error
          schema:
            $ref: '#/definitions/errorModel'
definitions:
  pet:
    required:
      - id
      - name
    properties:
      id:
        type: integer
        format: int64
      name:
        type: string
      tag:
        type: string
  newPet:
    allOf:
      - $ref: '#/definitions/pet'
      - required:
          - name
        properties:
          id:
            type: integer
            format: int64
          name:
            type: string
  errorModel:
    required:
      - code
      - message
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string
`