forked from Tufin/oasdiff
-
Notifications
You must be signed in to change notification settings - Fork 0
/
request_body_diff.go
117 lines (92 loc) · 3.23 KB
/
request_body_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
package diff
import (
"fmt"
"github.com/rjmohammad/kin-openapi/openapi3"
)
// RequestBodyDiff describes the changes between a pair of request body objects: https://swagger.io/specification/#request-body-object
type RequestBodyDiff struct {
Added bool `json:"added,omitempty" yaml:"added,omitempty"`
Deleted bool `json:"deleted,omitempty" yaml:"deleted,omitempty"`
ExtensionsDiff *ExtensionsDiff `json:"extensions,omitempty" yaml:"extensions,omitempty"`
DescriptionDiff *ValueDiff `json:"description,omitempty" yaml:"description,omitempty"`
RequiredDiff *ValueDiff `json:"required,omitempty" yaml:"required,omitempty"`
ContentDiff *ContentDiff `json:"content,omitempty" yaml:"content,omitempty"`
}
// Empty indicates whether a change was found in this element
func (diff *RequestBodyDiff) Empty() bool {
if diff == nil {
return true
}
return *diff == RequestBodyDiff{}
}
func (diff *RequestBodyDiff) removeNonBreaking(requestBodyRef2 *openapi3.RequestBodyRef) {
if diff.Empty() {
return
}
// remove added but not required
if diff.Added {
if requestBodyRef2 != nil &&
requestBodyRef2.Value != nil &&
!requestBodyRef2.Value.Required {
diff.Added = false
}
}
diff.ExtensionsDiff = nil
diff.DescriptionDiff = nil
// remove 'required disabled' (only required enabled is breaking)
if !diff.RequiredDiff.CompareWithDefault(false, true, false) {
diff.RequiredDiff = nil
}
}
func newRequestBodyDiff() *RequestBodyDiff {
return &RequestBodyDiff{}
}
func getRequestBodyDiff(config *Config, state *state, requestBodyRef1, requestBodyRef2 *openapi3.RequestBodyRef) (*RequestBodyDiff, error) {
diff, err := getRequestBodyDiffInternal(config, state, requestBodyRef1, requestBodyRef2)
if err != nil {
return nil, err
}
if config.BreakingOnly {
diff.removeNonBreaking(requestBodyRef2)
}
if diff.Empty() {
return nil, nil
}
return diff, nil
}
func getRequestBodyDiffInternal(config *Config, state *state, requestBodyRef1, requestBodyRef2 *openapi3.RequestBodyRef) (*RequestBodyDiff, error) {
if requestBodyRef1 == nil && requestBodyRef2 == nil {
return nil, nil
}
result := newRequestBodyDiff()
if requestBodyRef1 == nil && requestBodyRef2 != nil {
result.Added = true
return result, nil
}
if requestBodyRef1 != nil && requestBodyRef2 == nil {
result.Deleted = true
return result, nil
}
requestBody1, err := derefRequestBody(requestBodyRef1)
if err != nil {
return nil, err
}
requestBody2, err := derefRequestBody(requestBodyRef2)
if err != nil {
return nil, err
}
result.ExtensionsDiff = getExtensionsDiff(config, state, requestBody1.ExtensionProps, requestBody2.ExtensionProps)
result.DescriptionDiff = getValueDiffConditional(config.ExcludeDescription, requestBody1.Description, requestBody2.Description)
result.RequiredDiff = getValueDiff(requestBody1.Required, requestBody2.Required)
result.ContentDiff, err = getContentDiff(config, state, requestBody1.Content, requestBody2.Content)
if err != nil {
return nil, err
}
return result, nil
}
func derefRequestBody(ref *openapi3.RequestBodyRef) (*openapi3.RequestBody, error) {
if ref == nil || ref.Value == nil {
return nil, fmt.Errorf("request body reference is nil")
}
return ref.Value, nil
}