-
Notifications
You must be signed in to change notification settings - Fork 93
Expand file tree
/
Copy pathsecurity_requirements_diff.go
More file actions
111 lines (91 loc) · 3.58 KB
/
security_requirements_diff.go
File metadata and controls
111 lines (91 loc) · 3.58 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
package diff
import (
"maps"
"slices"
"strings"
"github.com/getkin/kin-openapi/openapi3"
"github.com/oasdiff/oasdiff/utils"
)
// SecurityRequirementsDiff describes the changes between a pair of sets of security requirement objects: https://swagger.io/specification/#security-requirement-object
type SecurityRequirementsDiff struct {
Added []string `json:"added,omitempty" yaml:"added,omitempty"`
Deleted []string `json:"deleted,omitempty" yaml:"deleted,omitempty"`
Modified ModifiedSecurityRequirements `json:"modified,omitempty" yaml:"modified,omitempty"`
}
// Empty indicates whether a change was found in this element
func (diff *SecurityRequirementsDiff) Empty() bool {
if diff == nil {
return true
}
return len(diff.Added) == 0 &&
len(diff.Deleted) == 0 &&
len(diff.Modified) == 0
}
// ModifiedSecurityRequirements is map of security requirements to their respective diffs
type ModifiedSecurityRequirements map[string]SecurityScopesDiff
func newSecurityRequirementsDiff() *SecurityRequirementsDiff {
return &SecurityRequirementsDiff{
Added: []string{},
Deleted: []string{},
Modified: ModifiedSecurityRequirements{},
}
}
func getSecurityRequirementsDiff(securityRequirements1, securityRequirements2 *openapi3.SecurityRequirements) *SecurityRequirementsDiff {
diff := getSecurityRequirementsDiffInternal(securityRequirements1, securityRequirements2)
if diff.Empty() {
return nil
}
return diff
}
func getSecurityRequirementsDiffInternal(securityRequirements1, securityRequirements2 *openapi3.SecurityRequirements) *SecurityRequirementsDiff {
result := newSecurityRequirementsDiff()
if securityRequirements1 != nil {
for _, securityRequirement1 := range *securityRequirements1 {
if securityRequirement2 := findSecurityRequirement(securityRequirement1, securityRequirements2); securityRequirement2 != nil {
if securityScopesDiff := getSecurityScopesDiff(securityRequirement1, securityRequirement2); !securityScopesDiff.Empty() {
result.Modified[getSecurityRequirementID(securityRequirement1)] = securityScopesDiff
}
} else {
result.Deleted = append(result.Deleted, getSecurityRequirementID(securityRequirement1))
}
}
}
if securityRequirements2 != nil {
for _, securityRequirement2 := range *securityRequirements2 {
if securityRequirements1 := findSecurityRequirement(securityRequirement2, securityRequirements1); securityRequirements1 == nil {
result.Added = append(result.Added, getSecurityRequirementID(securityRequirement2))
}
}
}
return result
}
func findSecurityRequirement(securityRequirement1 openapi3.SecurityRequirement, securityRequirements2 *openapi3.SecurityRequirements) openapi3.SecurityRequirement {
if securityRequirements2 == nil {
return nil
}
securitySchemes1 := getSecuritySchemes(securityRequirement1)
for _, securityRequirement2 := range *securityRequirements2 {
securitySchemes2 := getSecuritySchemes(securityRequirement2)
if securitySchemes1.Equals(securitySchemes2) {
return securityRequirement2
}
}
return nil
}
func getSecuritySchemes(securityRequirement openapi3.SecurityRequirement) utils.StringSet {
result := utils.StringSet{}
for name := range securityRequirement {
result.Add(name)
}
return result
}
func getSecurityRequirementID(securityRequirement openapi3.SecurityRequirement) string {
return strings.Join(slices.Collect(maps.Keys(securityRequirement)), " AND ")
}
func (diff *SecurityRequirementsDiff) getSummary() *SummaryDetails {
return &SummaryDetails{
Added: len(diff.Added),
Deleted: len(diff.Deleted),
Modified: len(diff.Modified),
}
}