-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Expand file tree
/
Copy pathprune_test.go
More file actions
432 lines (385 loc) · 10.6 KB
/
prune_test.go
File metadata and controls
432 lines (385 loc) · 10.6 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
package codegen
import (
"testing"
"github.com/getkin/kin-openapi/openapi3"
"github.com/stretchr/testify/assert"
)
func TestFindReferences(t *testing.T) {
t.Run("unfiltered", func(t *testing.T) {
swagger, err := openapi3.NewLoader().LoadFromData([]byte(pruneSpecTestFixture))
assert.NoError(t, err)
refs := findComponentRefs(swagger)
assert.Len(t, refs, 14)
})
t.Run("only cat", func(t *testing.T) {
swagger, err := openapi3.NewLoader().LoadFromData([]byte(pruneSpecTestFixture))
assert.NoError(t, err)
opts := Configuration{
OutputOptions: OutputOptions{
IncludeTags: []string{"cat"},
},
}
filterOperationsByTag(swagger, opts)
refs := findComponentRefs(swagger)
assert.Len(t, refs, 7)
})
t.Run("only dog", func(t *testing.T) {
swagger, err := openapi3.NewLoader().LoadFromData([]byte(pruneSpecTestFixture))
assert.NoError(t, err)
opts := Configuration{
OutputOptions: OutputOptions{
IncludeTags: []string{"dog"},
},
}
filterOperationsByTag(swagger, opts)
refs := findComponentRefs(swagger)
assert.Len(t, refs, 7)
})
}
func TestFilterOnlyCat(t *testing.T) {
// Get a spec from the test definition in this file:
swagger, err := openapi3.NewLoader().LoadFromData([]byte(pruneSpecTestFixture))
assert.NoError(t, err)
opts := Configuration{
OutputOptions: OutputOptions{
IncludeTags: []string{"cat"},
},
}
refs := findComponentRefs(swagger)
assert.Len(t, refs, 14)
assert.Len(t, swagger.Components.Schemas, 5)
filterOperationsByTag(swagger, opts)
refs = findComponentRefs(swagger)
assert.Len(t, refs, 7)
assert.NotEmpty(t, swagger.Paths.Value("/cat"), "/cat path should still be in spec")
assert.NotEmpty(t, swagger.Paths.Value("/cat").Get, "GET /cat operation should still be in spec")
assert.Empty(t, swagger.Paths.Value("/dog").Get, "GET /dog should have been removed from spec")
pruneUnusedComponents(swagger)
assert.Len(t, swagger.Components.Schemas, 3)
}
func TestFilterOnlyDog(t *testing.T) {
// Get a spec from the test definition in this file:
swagger, err := openapi3.NewLoader().LoadFromData([]byte(pruneSpecTestFixture))
assert.NoError(t, err)
opts := Configuration{
OutputOptions: OutputOptions{
IncludeTags: []string{"dog"},
},
}
refs := findComponentRefs(swagger)
assert.Len(t, refs, 14)
filterOperationsByTag(swagger, opts)
refs = findComponentRefs(swagger)
assert.Len(t, refs, 7)
assert.Len(t, swagger.Components.Schemas, 5)
assert.NotEmpty(t, swagger.Paths.Value("/dog"))
assert.NotEmpty(t, swagger.Paths.Value("/dog").Get)
assert.Empty(t, swagger.Paths.Value("/cat").Get)
pruneUnusedComponents(swagger)
assert.Len(t, swagger.Components.Schemas, 3)
}
func TestPruningUnusedComponents(t *testing.T) {
// Get a spec from the test definition in this file:
swagger, err := openapi3.NewLoader().LoadFromData([]byte(pruneComprehensiveTestFixture))
assert.NoError(t, err)
assert.Len(t, swagger.Components.Schemas, 8)
assert.Len(t, swagger.Components.Parameters, 1)
assert.Len(t, swagger.Components.SecuritySchemes, 2)
assert.Len(t, swagger.Components.RequestBodies, 1)
assert.Len(t, swagger.Components.Responses, 2)
assert.Len(t, swagger.Components.Headers, 3)
assert.Len(t, swagger.Components.Examples, 1)
assert.Len(t, swagger.Components.Links, 1)
assert.Len(t, swagger.Components.Callbacks, 1)
pruneUnusedComponents(swagger)
assert.Len(t, swagger.Components.Schemas, 0)
assert.Len(t, swagger.Components.Parameters, 0)
// securitySchemes are an exception. definitions in securitySchemes
// are referenced directly by name. and not by $ref
assert.Len(t, swagger.Components.SecuritySchemes, 2)
assert.Len(t, swagger.Components.RequestBodies, 0)
assert.Len(t, swagger.Components.Responses, 0)
assert.Len(t, swagger.Components.Headers, 0)
assert.Len(t, swagger.Components.Examples, 0)
assert.Len(t, swagger.Components.Links, 0)
assert.Len(t, swagger.Components.Callbacks, 0)
}
const pruneComprehensiveTestFixture = `
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:
get:
operationId: doesNothing
summary: does nothing
tags: [nothing]
responses:
default:
description: returns nothing
content:
application/json:
schema:
type: object
components:
schemas:
Object1:
type: object
properties:
object:
$ref: "#/components/schemas/Object2"
Object2:
type: object
properties:
object:
$ref: "#/components/schemas/Object3"
Object3:
type: object
properties:
object:
$ref: "#/components/schemas/Object4"
Object4:
type: object
properties:
object:
$ref: "#/components/schemas/Object5"
Object5:
type: object
properties:
object:
$ref: "#/components/schemas/Object6"
Object6:
type: object
Pet:
type: object
required:
- id
- name
properties:
id:
type: integer
format: int64
name:
type: string
tag:
type: string
Error:
required:
- code
- message
properties:
code:
type: integer
format: int32
description: Error code
message:
type: string
description: Error message
parameters:
offsetParam:
name: offset
in: query
description: Number of items to skip before returning the results.
required: false
schema:
type: integer
format: int32
minimum: 0
default: 0
securitySchemes:
BasicAuth:
type: http
scheme: basic
BearerAuth:
type: http
scheme: bearer
requestBodies:
PetBody:
description: A JSON object containing pet information
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Pet'
responses:
NotFound:
description: The specified resource was not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
headers:
X-RateLimit-Limit:
schema:
type: integer
description: Request limit per hour.
X-RateLimit-Remaining:
schema:
type: integer
description: The number of requests left for the time window.
X-RateLimit-Reset:
schema:
type: string
format: date-time
description: The UTC date/time at which the current rate limit window resets
examples:
objectExample:
value:
id: 1
name: new object
summary: A sample object
links:
GetUserByUserId:
description: >
The id value returned in the response can be used as
the userId parameter in GET /users/{userId}.
operationId: getUser
parameters:
userId: '$response.body#/id'
callbacks:
MyCallback:
'{$request.body#/callbackUrl}':
post:
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Some event happened
required:
- message
responses:
'200':
description: Your server returns this code if it accepts the callback
`
const pruneSpecTestFixture = `
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:
/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'
/dog:
get:
tags:
- dog
summary: Get dog status
operationId: getDogStatus
responses:
200:
description: Success
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/DogAlive'
- $ref: '#/components/schemas/DogDead'
application/xml:
schema:
anyOf:
- $ref: '#/components/schemas/DogAlive'
- $ref: '#/components/schemas/DogDead'
application/yaml:
schema:
allOf:
- $ref: '#/components/schemas/DogAlive'
- $ref: '#/components/schemas/DogDead'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
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]
DogAlive:
properties:
name:
type: string
alive_since:
type: string
format: date-time
DogDead:
properties:
name:
type: string
dead_since:
type: string
format: date-time
cause:
type: string
enum: [car, cat, oldage]
`