-
-
Notifications
You must be signed in to change notification settings - Fork 100
Expand file tree
/
Copy pathoverlay_test.go
More file actions
534 lines (443 loc) · 13.3 KB
/
overlay_test.go
File metadata and controls
534 lines (443 loc) · 13.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
522
523
524
525
526
527
528
529
530
531
532
533
534
// Copyright 2022-2025 Princess B33f Heavy Industries / Dave Shanley
// SPDX-License-Identifier: MIT
package libopenapi
import (
"testing"
"github.com/pb33f/libopenapi/datamodel"
v2 "github.com/pb33f/libopenapi/datamodel/high/v2"
v3 "github.com/pb33f/libopenapi/datamodel/high/v3"
"github.com/pb33f/libopenapi/index"
"github.com/pb33f/libopenapi/overlay"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestNewOverlayDocument(t *testing.T) {
overlayYAML := `overlay: 1.0.0
info:
title: Test Overlay
version: 1.0.0
actions:
- target: $.info
update:
title: Updated Title`
ov, err := NewOverlayDocument([]byte(overlayYAML))
require.NoError(t, err)
assert.NotNil(t, ov)
assert.Equal(t, "1.0.0", ov.Overlay)
assert.Equal(t, "Test Overlay", ov.Info.Title)
assert.Len(t, ov.Actions, 1)
}
func TestNewOverlayDocument_InvalidYAML(t *testing.T) {
ov, err := NewOverlayDocument([]byte(`invalid: yaml: content:`))
assert.Error(t, err)
assert.Nil(t, ov)
}
func TestNewOverlayDocument_EmptyDocument(t *testing.T) {
ov, err := NewOverlayDocument([]byte(``))
assert.ErrorIs(t, err, overlay.ErrInvalidOverlay)
assert.Nil(t, ov)
}
func TestNewOverlayDocument_InvalidOverlay(t *testing.T) {
// Missing required fields
overlayYAML := `foo: bar`
ov, err := NewOverlayDocument([]byte(overlayYAML))
// BuildModel should succeed but Build should return an error
// Actually, lowoverlay.Build returns nil for missing fields,
// and validation happens in overlay.Apply
require.NoError(t, err)
assert.NotNil(t, ov)
}
func TestNewOverlayDocument_SequenceRoot(t *testing.T) {
// Sequence at root - BuildModel is lenient and returns empty overlay
overlayYAML := `- item1
- item2`
ov, err := NewOverlayDocument([]byte(overlayYAML))
// BuildModel is lenient and doesn't fail, but the overlay will be empty
require.NoError(t, err)
assert.NotNil(t, ov)
assert.Empty(t, ov.Overlay)
}
func TestNewOverlayDocument_WithExtensions(t *testing.T) {
overlayYAML := `overlay: 1.0.0
info:
title: Test Overlay
version: 1.0.0
x-custom: custom value
actions:
- target: $.info
update:
title: Updated`
ov, err := NewOverlayDocument([]byte(overlayYAML))
require.NoError(t, err)
assert.NotNil(t, ov)
assert.Equal(t, "1.0.0", ov.Overlay)
assert.NotNil(t, ov.Extensions)
}
// Tests for ApplyOverlay (Document, Overlay)
func TestApplyOverlay(t *testing.T) {
targetYAML := `openapi: 3.0.0
info:
title: Original Title
version: 1.0.0
paths: {}`
overlayYAML := `overlay: 1.0.0
info:
title: Test Overlay
version: 1.0.0
actions:
- target: $.info
update:
title: Updated Title`
doc, err := NewDocument([]byte(targetYAML))
require.NoError(t, err)
ov, err := NewOverlayDocument([]byte(overlayYAML))
require.NoError(t, err)
result, err := ApplyOverlay(doc, ov)
require.NoError(t, err)
assert.NotNil(t, result)
assert.Contains(t, string(result.Bytes), "Updated Title")
assert.Len(t, result.Warnings, 0)
// Verify OverlayDocument is populated and ready to use
assert.NotNil(t, result.OverlayDocument)
assert.Equal(t, "3.0.0", result.OverlayDocument.GetVersion())
}
func TestApplyOverlay_PreservesConfiguration(t *testing.T) {
targetYAML := `openapi: 3.0.0
info:
title: Original Title
version: 1.0.0
paths: {}`
overlayYAML := `overlay: 1.0.0
info:
title: Test Overlay
version: 1.0.0
actions:
- target: $.info
update:
title: Updated Title`
// Create document with custom configuration
config := &datamodel.DocumentConfiguration{
AllowFileReferences: true,
AllowRemoteReferences: false,
}
doc, err := NewDocumentWithConfiguration([]byte(targetYAML), config)
require.NoError(t, err)
ov, err := NewOverlayDocument([]byte(overlayYAML))
require.NoError(t, err)
result, err := ApplyOverlay(doc, ov)
require.NoError(t, err)
// Verify configuration is preserved in the resulting document
resultConfig := result.OverlayDocument.GetConfiguration()
assert.NotNil(t, resultConfig)
assert.True(t, resultConfig.AllowFileReferences)
assert.False(t, resultConfig.AllowRemoteReferences)
}
func TestApplyOverlay_WithWarnings(t *testing.T) {
targetYAML := `openapi: 3.0.0
info:
title: Test
version: 1.0.0`
overlayYAML := `overlay: 1.0.0
info:
title: Test Overlay
version: 1.0.0
actions:
- target: $.nonexistent
update:
value: test`
doc, err := NewDocument([]byte(targetYAML))
require.NoError(t, err)
ov, err := NewOverlayDocument([]byte(overlayYAML))
require.NoError(t, err)
result, err := ApplyOverlay(doc, ov)
require.NoError(t, err)
assert.Len(t, result.Warnings, 1)
assert.Contains(t, result.Warnings[0].Message, "zero nodes")
// OverlayDocument should still be populated
assert.NotNil(t, result.OverlayDocument)
}
func TestApplyOverlay_NilOverlay(t *testing.T) {
targetYAML := `openapi: 3.0.0
info:
title: Test
version: 1.0.0`
doc, err := NewDocument([]byte(targetYAML))
require.NoError(t, err)
result, err := ApplyOverlay(doc, nil)
assert.ErrorIs(t, err, overlay.ErrInvalidOverlay)
assert.Nil(t, result)
}
// Tests for ApplyOverlayFromBytes (Document, overlayBytes)
func TestApplyOverlayFromBytes(t *testing.T) {
targetYAML := `openapi: 3.0.0
info:
title: Original Title
version: 1.0.0
paths: {}`
overlayYAML := `overlay: 1.0.0
info:
title: Test Overlay
version: 1.0.0
actions:
- target: $.info
update:
title: Updated Title`
doc, err := NewDocument([]byte(targetYAML))
require.NoError(t, err)
result, err := ApplyOverlayFromBytes(doc, []byte(overlayYAML))
require.NoError(t, err)
assert.NotNil(t, result)
assert.Contains(t, string(result.Bytes), "Updated Title")
// Verify OverlayDocument is populated
assert.NotNil(t, result.OverlayDocument)
assert.Equal(t, "3.0.0", result.OverlayDocument.GetVersion())
}
func TestApplyOverlayFromBytes_InvalidOverlay(t *testing.T) {
targetYAML := `openapi: 3.0.0
info:
title: Test
version: 1.0.0`
doc, err := NewDocument([]byte(targetYAML))
require.NoError(t, err)
result, err := ApplyOverlayFromBytes(doc, []byte(`invalid: yaml: content:`))
assert.Error(t, err)
assert.Nil(t, result)
}
// Tests for ApplyOverlayToSpecBytes (docBytes, Overlay)
func TestApplyOverlayToSpecBytes(t *testing.T) {
targetYAML := `openapi: 3.0.0
info:
title: Original Title
version: 1.0.0
paths: {}`
overlayYAML := `overlay: 1.0.0
info:
title: Test Overlay
version: 1.0.0
actions:
- target: $.info
update:
title: Updated Title`
ov, err := NewOverlayDocument([]byte(overlayYAML))
require.NoError(t, err)
result, err := ApplyOverlayToSpecBytes([]byte(targetYAML), ov)
require.NoError(t, err)
assert.NotNil(t, result)
assert.Contains(t, string(result.Bytes), "Updated Title")
// Verify OverlayDocument is populated (with default config)
assert.NotNil(t, result.OverlayDocument)
assert.Equal(t, "3.0.0", result.OverlayDocument.GetVersion())
}
func TestApplyOverlayToSpecBytes_NilOverlay(t *testing.T) {
result, err := ApplyOverlayToSpecBytes([]byte(`openapi: 3.0.0`), nil)
assert.ErrorIs(t, err, overlay.ErrInvalidOverlay)
assert.Nil(t, result)
}
func TestApplyOverlayToSpecBytes_InvalidTarget(t *testing.T) {
targetYAML := `invalid: yaml: content:`
overlayYAML := `overlay: 1.0.0
info:
title: Test Overlay
version: 1.0.0
actions:
- target: $.info
update:
title: Updated`
ov, err := NewOverlayDocument([]byte(overlayYAML))
require.NoError(t, err)
result, err := ApplyOverlayToSpecBytes([]byte(targetYAML), ov)
assert.Error(t, err)
assert.Nil(t, result)
}
// Tests for ApplyOverlayFromBytesToSpecBytes (docBytes, overlayBytes)
func TestApplyOverlayFromBytesToSpecBytes(t *testing.T) {
targetYAML := `openapi: 3.0.0
info:
title: Original Title
version: 1.0.0
paths: {}`
overlayYAML := `overlay: 1.0.0
info:
title: Test Overlay
version: 1.0.0
actions:
- target: $.info
update:
title: Updated Title`
result, err := ApplyOverlayFromBytesToSpecBytes([]byte(targetYAML), []byte(overlayYAML))
require.NoError(t, err)
assert.NotNil(t, result)
assert.Contains(t, string(result.Bytes), "Updated Title")
// Verify OverlayDocument is populated (with default config)
assert.NotNil(t, result.OverlayDocument)
assert.Equal(t, "3.0.0", result.OverlayDocument.GetVersion())
}
func TestApplyOverlayFromBytesToSpecBytes_InvalidOverlay(t *testing.T) {
targetYAML := `openapi: 3.0.0`
overlayYAML := `invalid: yaml: content:`
result, err := ApplyOverlayFromBytesToSpecBytes([]byte(targetYAML), []byte(overlayYAML))
assert.Error(t, err)
assert.Nil(t, result)
}
func TestApplyOverlayFromBytesToSpecBytes_InvalidTarget(t *testing.T) {
targetYAML := `invalid: yaml: content:`
overlayYAML := `overlay: 1.0.0
info:
title: Test
version: 1.0.0
actions:
- target: $.info
update:
title: Updated`
result, err := ApplyOverlayFromBytesToSpecBytes([]byte(targetYAML), []byte(overlayYAML))
assert.Error(t, err)
assert.Nil(t, result)
}
func TestApplyOverlayFromBytesToSpecBytes_ComplexOverlay(t *testing.T) {
targetYAML := `openapi: 3.0.0
info:
title: Original
version: 1.0.0
description: Remove me
tags:
- name: existing
paths: {}`
overlayYAML := `overlay: 1.0.0
info:
title: Complex Overlay
version: 1.0.0
actions:
- target: $.info
update:
title: Updated
- target: $.info.description
remove: true
- target: $.tags
update:
- name: new-tag`
result, err := ApplyOverlayFromBytesToSpecBytes([]byte(targetYAML), []byte(overlayYAML))
require.NoError(t, err)
assert.Contains(t, string(result.Bytes), "Updated")
assert.NotContains(t, string(result.Bytes), "Remove me")
assert.Contains(t, string(result.Bytes), "existing")
assert.Contains(t, string(result.Bytes), "new-tag")
// Verify OverlayDocument is populated
assert.NotNil(t, result.OverlayDocument)
}
func TestApplyOverlay_CanBuildModel(t *testing.T) {
targetYAML := `openapi: 3.0.0
info:
title: Original Title
version: 1.0.0
paths:
/test:
get:
summary: Test endpoint`
overlayYAML := `overlay: 1.0.0
info:
title: Test Overlay
version: 1.0.0
actions:
- target: $.info
update:
title: Updated Title`
doc, err := NewDocument([]byte(targetYAML))
require.NoError(t, err)
ov, err := NewOverlayDocument([]byte(overlayYAML))
require.NoError(t, err)
result, err := ApplyOverlay(doc, ov)
require.NoError(t, err)
// Verify we can build a model from the OverlayDocument
model, errs := result.OverlayDocument.BuildV3Model()
require.Empty(t, errs)
assert.NotNil(t, model)
assert.Equal(t, "Updated Title", model.Model.Info.Title)
}
// mockDocument is a minimal Document implementation for testing edge cases
type mockDocument struct {
specBytes *[]byte
config *datamodel.DocumentConfiguration
version string
}
func (m *mockDocument) GetSpecInfo() *datamodel.SpecInfo {
return &datamodel.SpecInfo{SpecBytes: m.specBytes}
}
func (m *mockDocument) GetConfiguration() *datamodel.DocumentConfiguration {
return m.config
}
func (m *mockDocument) GetVersion() string { return m.version }
func (m *mockDocument) GetRolodex() *index.Rolodex { return nil }
func (m *mockDocument) SetConfiguration(*datamodel.DocumentConfiguration) {}
func (m *mockDocument) Render() ([]byte, error) { return nil, nil }
func (m *mockDocument) BuildV2Model() (*DocumentModel[v2.Swagger], error) { return nil, nil }
func (m *mockDocument) BuildV3Model() (*DocumentModel[v3.Document], error) {
return nil, nil
}
func (m *mockDocument) Serialize() ([]byte, error) { return nil, nil }
func (m *mockDocument) RenderAndReload() ([]byte, Document, *DocumentModel[v3.Document], error) {
return nil, nil, nil, nil
}
func (m *mockDocument) Release() {}
func TestApplyOverlay_NilSpecBytes(t *testing.T) {
// Test line 63: specBytes == nil
doc := &mockDocument{
specBytes: nil,
config: nil,
}
overlayYAML := `overlay: 1.0.0
info:
title: Test Overlay
version: 1.0.0
actions:
- target: $.info
update:
title: Updated`
ov, err := NewOverlayDocument([]byte(overlayYAML))
require.NoError(t, err)
result, err := ApplyOverlay(doc, ov)
assert.ErrorIs(t, err, overlay.ErrNoTargetDocument)
assert.Nil(t, result)
}
func TestApplyOverlay_InvalidResultDocument(t *testing.T) {
// Test line 73: NewDocumentWithConfiguration fails
// Create an overlay that removes the openapi version, making the result invalid
targetYAML := `openapi: 3.0.0
info:
title: Test
version: 1.0.0`
overlayYAML := `overlay: 1.0.0
info:
title: Test Overlay
version: 1.0.0
actions:
- target: $.openapi
remove: true`
doc, err := NewDocument([]byte(targetYAML))
require.NoError(t, err)
ov, err := NewOverlayDocument([]byte(overlayYAML))
require.NoError(t, err)
result, err := ApplyOverlay(doc, ov)
// Should fail because resulting document has no openapi version
assert.Error(t, err)
assert.Nil(t, result)
}
func TestApplyOverlayToSpecBytes_InvalidResultDocument(t *testing.T) {
// Test line 126: NewDocumentWithConfiguration fails in applyOverlayToBytesWithConfig
targetYAML := `openapi: 3.0.0
info:
title: Test
version: 1.0.0`
overlayYAML := `overlay: 1.0.0
info:
title: Test Overlay
version: 1.0.0
actions:
- target: $.openapi
remove: true`
ov, err := NewOverlayDocument([]byte(overlayYAML))
require.NoError(t, err)
result, err := ApplyOverlayToSpecBytes([]byte(targetYAML), ov)
// Should fail because resulting document has no openapi version
assert.Error(t, err)
assert.Nil(t, result)
}