forked from Tufin/oasdiff
-
Notifications
You must be signed in to change notification settings - Fork 0
/
headers_diff.go
125 lines (99 loc) · 2.89 KB
/
headers_diff.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
package diff
import (
"fmt"
"github.com/rjmohammad/kin-openapi/openapi3"
)
// HeadersDiff describes the changes between a pair of sets of header objects: https://swagger.io/specification/#header-object
type HeadersDiff struct {
Added StringList `json:"added,omitempty" yaml:"added,omitempty"`
Deleted StringList `json:"deleted,omitempty" yaml:"deleted,omitempty"`
Modified ModifiedHeaders `json:"modified,omitempty" yaml:"modified,omitempty"`
}
// Empty indicates whether a change was found in this element
func (headersDiff *HeadersDiff) Empty() bool {
if headersDiff == nil {
return true
}
return len(headersDiff.Added) == 0 &&
len(headersDiff.Deleted) == 0 &&
len(headersDiff.Modified) == 0
}
func (headersDiff *HeadersDiff) removeNonBreaking(state *state) {
if headersDiff.Empty() {
return
}
// TODO: handle sunset
switch state.direction {
case directionRequest:
// In request: deleting headers is non-breaking (for client)
headersDiff.Deleted = nil
case directionResponse:
// In response: adding headers is non-breaking (for client)
headersDiff.Added = nil
}
}
// ModifiedHeaders is map of header names to their respective diffs
type ModifiedHeaders map[string]*HeaderDiff
func newHeadersDiff() *HeadersDiff {
return &HeadersDiff{
Added: StringList{},
Deleted: StringList{},
Modified: ModifiedHeaders{},
}
}
func getHeadersDiff(config *Config, state *state, headers1, headers2 openapi3.Headers) (*HeadersDiff, error) {
diff, err := getHeadersDiffInternal(config, state, headers1, headers2)
if err != nil {
return nil, err
}
if config.BreakingOnly {
diff.removeNonBreaking(state)
}
if diff.Empty() {
return nil, nil
}
return diff, nil
}
func getHeadersDiffInternal(config *Config, state *state, headers1, headers2 openapi3.Headers) (*HeadersDiff, error) {
result := newHeadersDiff()
for headerName1, headerRef1 := range headers1 {
if headerRef2, ok := headers2[headerName1]; ok {
value1, err := derefHeader(headerRef1)
if err != nil {
return nil, err
}
value2, err := derefHeader(headerRef2)
if err != nil {
return nil, err
}
diff, err := getHeaderDiff(config, state, value1, value2)
if err != nil {
return nil, err
}
if !diff.Empty() {
result.Modified[headerName1] = diff
}
} else {
result.Deleted = append(result.Deleted, headerName1)
}
}
for headerValue2 := range headers2 {
if _, ok := headers1[headerValue2]; !ok {
result.Added = append(result.Added, headerValue2)
}
}
return result, nil
}
func derefHeader(ref *openapi3.HeaderRef) (*openapi3.Header, error) {
if ref == nil || ref.Value == nil {
return nil, fmt.Errorf("header reference is nil")
}
return ref.Value, nil
}
func (headersDiff *HeadersDiff) getSummary() *SummaryDetails {
return &SummaryDetails{
Added: len(headersDiff.Added),
Deleted: len(headersDiff.Deleted),
Modified: len(headersDiff.Modified),
}
}