-
Notifications
You must be signed in to change notification settings - Fork 28
/
merge.go
388 lines (365 loc) · 12.6 KB
/
merge.go
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
package openapi3
import (
"errors"
"fmt"
"os"
"reflect"
"regexp"
"sort"
"strings"
oas3 "github.com/getkin/kin-openapi/openapi3"
"github.com/grokify/gocharts/v2/data/table"
"github.com/grokify/mogo/errors/errorsutil"
"github.com/grokify/mogo/os/osutil"
)
var jsonFileRx = regexp.MustCompile(`(?i)\.(json|yaml|yml)\s*$`)
func MergeDirectory(dir string, mergeOpts *MergeOptions) (*Spec, int, error) {
var filenames []string
var err error
if mergeOpts != nil && mergeOpts.FileRx != nil {
entries, err := osutil.ReadDirMore(dir, mergeOpts.FileRx, false, true, false)
if err != nil {
filenames = entries.Names(dir)
}
} else {
entries, err := osutil.ReadDirMore(dir, jsonFileRx, false, true, false)
if err != nil {
filenames = entries.Names(dir)
}
}
if err != nil {
return nil, len(filenames), err
}
spec, err := MergeFiles(filenames, mergeOpts)
return spec, len(filenames), err
}
func MergeFiles(filepaths []string, mergeOpts *MergeOptions) (*Spec, error) {
sort.Strings(filepaths)
validateEach := false
validateFinal := true
if mergeOpts != nil {
validateEach = mergeOpts.ValidateEach
validateFinal = mergeOpts.ValidateFinal
}
var specMaster *Spec
for i, fpath := range filepaths {
thisSpec, err := ReadFile(fpath, validateEach)
if err != nil {
return specMaster, errorsutil.Wrap(err, fmt.Sprintf("ReadSpecError [%v] ValidateEach [%v]", fpath, validateEach))
}
if i == 0 {
specMaster = thisSpec
} else {
specMaster, err = Merge(specMaster, thisSpec, fpath, mergeOpts)
if err != nil {
return nil, errorsutil.Wrap(err, fmt.Sprintf("Merging [%v]", fpath))
}
}
}
if validateFinal {
bytes, err := specMaster.MarshalJSON()
if err != nil {
return specMaster, err
}
newSpec, err := oas3.NewLoader().LoadFromData(bytes)
if err != nil {
return newSpec, errorsutil.Wrap(err, "Loader.LoadSwaggerFromData (MergeFiles().ValidateFinal)")
}
return newSpec, nil
}
return specMaster, nil
}
func Merge(specMaster, specExtra *Spec, specExtraNote string, mergeOpts *MergeOptions) (*Spec, error) {
specMaster = MergeTags(specMaster, specExtra)
specMaster, err := MergeParameters(specMaster, specExtra, specExtraNote, mergeOpts)
if err != nil {
return specMaster, err
}
specMaster, err = MergeSchemas(specMaster, specExtra, specExtraNote, mergeOpts)
if err != nil {
return specMaster, err
}
specMaster, err = MergePaths(specMaster, specExtra)
if err != nil {
return specMaster, err
}
specMaster, err = MergeResponses(specMaster, specExtra, specExtraNote, mergeOpts)
if err != nil {
return specMaster, err
}
return MergeRequestBodies(specMaster, specExtra, specExtraNote)
}
func MergeTags(specMaster, specExtra *Spec) *Spec {
tagsMap := map[string]int{}
for _, tag := range specMaster.Tags {
tagsMap[tag.Name] = 1
}
for _, tag := range specExtra.Tags {
tag.Name = strings.TrimSpace(tag.Name)
if _, ok := tagsMap[tag.Name]; !ok {
specMaster.Tags = append(specMaster.Tags, tag)
}
}
return specMaster
}
// MergeWithTables performs a spec merge and returns comparison
// tables. This is useful to combine with github.com/grokify/gocharts/v2/data/table
// WriteXLSX() to write out comparison tables for debugging.
func MergeWithTables(spec1, spec2 *Spec, specExtraNote string, mergeOpts *MergeOptions) (*Spec, []*table.Table, error) {
tbls := []*table.Table{}
sm1 := SpecMore{Spec: spec1}
sm2 := SpecMore{Spec: spec2}
tbls1, err := sm1.OperationsTable(mergeOpts.TableColumns, mergeOpts.TableOpFilterFunc, mergeOpts.TableAddlColFormatFuncs)
if err != nil {
return nil, nil, err
}
tbls = append(tbls, tbls1)
tbls[0].Name = "Spec1"
tbls2, err := sm2.OperationsTable(mergeOpts.TableColumns, mergeOpts.TableOpFilterFunc, mergeOpts.TableAddlColFormatFuncs)
if err != nil {
return nil, nil, err
}
tbls = append(tbls, tbls2)
tbls[1].Name = "Spec2"
specf, err := Merge(spec1, spec2, specExtraNote, mergeOpts)
if err != nil {
return specf, tbls, err
}
smf := SpecMore{Spec: specf}
tblsf, err := smf.OperationsTable(mergeOpts.TableColumns, mergeOpts.TableOpFilterFunc, mergeOpts.TableAddlColFormatFuncs)
if err != nil {
return nil, nil, err
}
tbls = append(tbls, tblsf)
tbls[2].Name = "SpecFinal"
return specf, tbls, nil
}
func MergePaths(specMaster, specExtra *Spec) (*Spec, error) {
// getkin v0.121.0 to v0.122.0 - new version
if specExtra == nil {
return specMaster, errors.New("spec extra cannot be nil")
}
addPathMap := specExtra.Paths.Map()
for addPathKey, addPathItem := range addPathMap {
if addPathItem == nil {
continue
}
srcPathItem := specMaster.Paths.Find(addPathKey)
if srcPathItem == nil {
specMaster.Paths.Set(addPathKey, addPathItem)
continue
}
srcPathItemMore := PathItemMore{PathItem: srcPathItem}
err := srcPathItemMore.AddPathItemOperations(addPathItem, false)
if err != nil {
return specMaster, err
}
specMaster.Paths.Set(addPathKey, srcPathItemMore.PathItem)
}
return specMaster, nil
}
/*
func MergePathsOld(specMaster, specExtra *Spec) (*Spec, error) {
pathsMapExtra := specExtra.Paths.Map()
pathsMapMaster := specMaster.Paths.Map()
// for url, pathItem := range pathsMapExtra {
for url, pathItem := range pathsMapExtra {
if pathInfoMaster, ok := pathsMapMaster[url]; !ok || pathInfoMaster == nil {
// specMaster.Paths[url] = &oas3.PathItem{}
specMaster.Paths.Set(url, &oas3.PathItem{})
}
if pathItem.Connect != nil {
if specMaster.Paths[url].Connect == nil {
specMaster.Paths[url].Connect = pathItem.Connect
} else if !reflect.DeepEqual(pathItem.Connect, specMaster.Paths[url].Connect) {
return specMaster, fmt.Errorf("E_OPERATION_COLLISION_CONNECT [%v]", pathItem.Connect.OperationID)
}
}
if pathItem.Delete != nil {
if specMaster.Paths[url].Delete == nil {
specMaster.Paths[url].Delete = pathItem.Delete
} else if !reflect.DeepEqual(pathItem.Delete, specMaster.Paths[url].Delete) {
return specMaster, fmt.Errorf("E_OPERATION_COLLISION_DELETE [%v]", pathItem.Delete.OperationID)
}
}
if pathItem.Get != nil {
if specMaster.Paths[url].Get == nil {
specMaster.Paths[url].Get = pathItem.Get
} else if !reflect.DeepEqual(pathItem.Get, specMaster.Paths[url].Get) {
return specMaster, fmt.Errorf("E_OPERATION_COLLISION_GET [%v]", pathItem.Get.OperationID)
}
}
if pathItem.Head != nil {
if specMaster.Paths[url].Head == nil {
specMaster.Paths[url].Head = pathItem.Head
} else if !reflect.DeepEqual(pathItem.Head, specMaster.Paths[url].Head) {
return specMaster, fmt.Errorf("E_OPERATION_COLLISION_HEAD [%v]", pathItem.Head.OperationID)
}
}
if pathItem.Options != nil {
if specMaster.Paths[url].Options == nil {
specMaster.Paths[url].Options = pathItem.Options
} else if !reflect.DeepEqual(pathItem.Options, specMaster.Paths[url].Options) {
return specMaster, fmt.Errorf("E_OPERATION_COLLISION_OPTIONS [%v]", pathItem.Options.OperationID)
}
}
if pathItem.Patch != nil {
if specMaster.Paths[url].Patch == nil {
specMaster.Paths[url].Patch = pathItem.Patch
} else if !reflect.DeepEqual(pathItem.Patch, specMaster.Paths[url].Patch) {
return specMaster, fmt.Errorf("E_OPERATION_COLLISION_PATCH [%v]", pathItem.Patch.OperationID)
}
}
if pathItem.Post != nil {
if specMaster.Paths[url].Post == nil {
specMaster.Paths[url].Post = pathItem.Post
} else if !reflect.DeepEqual(pathItem.Post, specMaster.Paths[url].Post) {
return specMaster, fmt.Errorf("E_OPERATION_COLLISION_POST [%v]", pathItem.Post.OperationID)
}
}
if pathItem.Put != nil {
if specMaster.Paths[url].Put == nil {
specMaster.Paths[url].Put = pathItem.Put
} else if !reflect.DeepEqual(pathItem.Put, specMaster.Paths[url].Put) {
return specMaster, fmt.Errorf("E_OPERATION_COLLISION_PUT [%v]", pathItem.Put.OperationID)
}
}
if pathItem.Trace != nil {
if specMaster.Paths[url].Trace == nil {
specMaster.Paths[url].Trace = pathItem.Trace
} else if !reflect.DeepEqual(pathItem.Trace, specMaster.Paths[url].Trace) {
return specMaster, fmt.Errorf("E_OPERATION_COLLISION_TRACE [%v]", pathItem.Trace.OperationID)
}
}
}
return specMaster, nil
}
*/
func MergeParameters(specMaster, specExtra *Spec, specExtraNote string, mergeOpts *MergeOptions) (*Spec, error) {
if specMaster.Components.Parameters == nil {
specMaster.Components.Parameters = map[string]*oas3.ParameterRef{}
}
for pName, pExtra := range specExtra.Components.Parameters {
if pExtra == nil {
continue
} else if pMaster, ok := specMaster.Components.Parameters[pName]; ok {
if pMaster == nil {
specMaster.Components.Parameters[pName] = pExtra
} else {
if mergeOpts == nil {
mergeOpts = &MergeOptions{}
}
if mergeOpts.CollisionCheckResult == CollisionCheckSkip {
continue
} else if reflect.DeepEqual(pExtra, pMaster) {
continue
} else if mergeOpts.CollisionCheckResult == CollisionCheckOverwrite {
specExtra.Components.Parameters[pName] = pExtra
} else {
return nil, fmt.Errorf("E_SCHEMA_COLLISION [%v] EXTRA_COMPONENTS_PARAMETER [%s]", specExtraNote, pName)
}
}
} else {
specMaster.Components.Parameters[pName] = pExtra
}
}
return specMaster, nil
}
func MergeResponses(specMaster, specExtra *Spec, specExtraNote string, mergeOpts *MergeOptions) (*Spec, error) {
if specMaster.Components.Responses == nil {
specMaster.Components.Responses = map[string]*oas3.ResponseRef{}
}
for rName, rExtra := range specExtra.Components.Responses {
if rExtra == nil {
continue
} else if rMaster, ok := specMaster.Components.Responses[rName]; ok {
if rMaster == nil {
specMaster.Components.Responses[rName] = rExtra
} else {
if mergeOpts == nil {
mergeOpts = &MergeOptions{}
}
if mergeOpts.CollisionCheckResult == CollisionCheckSkip {
continue
} else if reflect.DeepEqual(rExtra, rMaster) {
continue
} else {
return nil, fmt.Errorf("E_SCHEMA_COLLISION [%v] EXTRA_COMPONENTS_RESPONSE [%s]", specExtraNote, rName)
}
}
} else {
specMaster.Components.Responses[rName] = rExtra
}
}
return specMaster, nil
}
func MergeSchemas(specMaster, specExtra *Spec, specExtraNote string, mergeOpts *MergeOptions) (*Spec, error) {
for schemaName, schemaExtra := range specExtra.Components.Schemas {
if schemaExtra == nil {
continue
} else if schemaMaster, ok := specMaster.Components.Schemas[schemaName]; ok {
if schemaMaster == nil {
specMaster.Components.Schemas[schemaName] = schemaExtra
} else {
if mergeOpts == nil {
mergeOpts = &MergeOptions{}
}
checkCollisionResult := mergeOpts.CheckSchemaCollision(schemaName, schemaMaster, schemaExtra, specExtraNote)
if checkCollisionResult != CollisionCheckSame &&
mergeOpts.CollisionCheckResult != CollisionCheckSkip {
if mergeOpts.CollisionCheckResult == CollisionCheckOverwrite {
delete(specMaster.Components.Schemas, schemaName)
specMaster.Components.Schemas[schemaName] = schemaExtra
} else if mergeOpts.CollisionCheckResult == CollisionCheckError {
return nil, fmt.Errorf("E_SCHEMA_COLLISION [%v] EXTRA_SPEC [%s]", schemaName, specExtraNote)
}
}
/*
if !reflect.DeepEqual(schemaMaster, schemaExtra) {
return nil, fmt.Errorf("E_SCHEMA_COLLISION [%v] EXTRA_SPEC [%s]", schemaName, specExtraNote)
}*/
continue
}
} else {
specMaster.Components.Schemas[schemaName] = schemaExtra
}
}
return specMaster, nil
}
func MergeRequestBodies(specMaster, specExtra *Spec, specExtraNote string) (*Spec, error) {
for rbName, rbExtra := range specExtra.Components.RequestBodies {
if rbExtra == nil {
continue
} else if rbMaster, ok := specMaster.Components.RequestBodies[rbName]; ok {
if rbMaster == nil {
if specMaster.Components.RequestBodies == nil {
specMaster.Components.RequestBodies = map[string]*oas3.RequestBodyRef{}
}
specMaster.Components.RequestBodies[rbName] = rbExtra
} else if !reflect.DeepEqual(rbMaster, rbExtra) {
return nil, fmt.Errorf("E_SCHEMA_COLLISION [%v] EXTRA_SPEC [%s]", rbName, specExtraNote)
}
} else {
if specMaster.Components.RequestBodies == nil {
specMaster.Components.RequestBodies = map[string]*oas3.RequestBodyRef{}
}
specMaster.Components.RequestBodies[rbName] = rbExtra
}
}
return specMaster, nil
}
func WriteFileDirMerge(outfile, inputDir string, perm os.FileMode, mergeOpts *MergeOptions) (int, error) {
spec, num, err := MergeDirectory(inputDir, mergeOpts)
if err != nil {
return num, errorsutil.Wrap(err, "E_OPENAPI3_MERGE_DIRECTORY_FAILED")
}
bytes, err := spec.MarshalJSON()
if err != nil {
return num, errorsutil.Wrap(err, "E_SWAGGER2_JSON_ENCODING_FAILED")
}
err = os.WriteFile(outfile, bytes, perm)
if err != nil {
return num, errorsutil.Wrap(err, "E_SWAGGER2_WRITE_FAILED")
}
return num, nil
}