mirror of
https://github.com/LukeHagar/libopenapi.git
synced 2025-12-10 04:20:24 +00:00
Change indentation to tabs
This commit is contained in:
Hugo Stijns
committed by
Dave Shanley
Dave Shanley
parent
d6031b5440
commit
b395518a5e
@@ -4,11 +4,12 @@
|
||||
package model
|
||||
|
||||
import (
|
||||
"github.com/pb33f/libopenapi/datamodel/low"
|
||||
"github.com/pb33f/libopenapi/datamodel/low/base"
|
||||
"github.com/pb33f/libopenapi/datamodel/low/v2"
|
||||
"github.com/pb33f/libopenapi/datamodel/low/v3"
|
||||
"reflect"
|
||||
"reflect"
|
||||
|
||||
"github.com/pb33f/libopenapi/datamodel/low"
|
||||
"github.com/pb33f/libopenapi/datamodel/low/base"
|
||||
v2 "github.com/pb33f/libopenapi/datamodel/low/v2"
|
||||
v3 "github.com/pb33f/libopenapi/datamodel/low/v3"
|
||||
)
|
||||
|
||||
// ComponentsChanges represents changes made to both OpenAPI and Swagger documents. This model is based on OpenAPI 3
|
||||
@@ -35,228 +36,228 @@ import (
|
||||
// modifications are not checked, these checks occur in-place by implementing objects as they are autp-resolved
|
||||
// when the model is built.
|
||||
type ComponentsChanges struct {
|
||||
*PropertyChanges
|
||||
SchemaChanges map[string]*SchemaChanges `json:"schemas,omitempty" yaml:"schemas,omitempty"`
|
||||
SecuritySchemeChanges map[string]*SecuritySchemeChanges `json:"securitySchemes,omitempty" yaml:"securitySchemes,omitempty"`
|
||||
ExtensionChanges *ExtensionChanges `json:"extensions,omitempty" yaml:"extensions,omitempty"`
|
||||
*PropertyChanges
|
||||
SchemaChanges map[string]*SchemaChanges `json:"schemas,omitempty" yaml:"schemas,omitempty"`
|
||||
SecuritySchemeChanges map[string]*SecuritySchemeChanges `json:"securitySchemes,omitempty" yaml:"securitySchemes,omitempty"`
|
||||
ExtensionChanges *ExtensionChanges `json:"extensions,omitempty" yaml:"extensions,omitempty"`
|
||||
}
|
||||
|
||||
// CompareComponents will compare OpenAPI components for any changes. Accepts Swagger Definition objects
|
||||
// like ParameterDefinitions or Definitions etc.
|
||||
func CompareComponents(l, r any) *ComponentsChanges {
|
||||
|
||||
var changes []*Change
|
||||
var changes []*Change
|
||||
|
||||
cc := new(ComponentsChanges)
|
||||
cc := new(ComponentsChanges)
|
||||
|
||||
// Swagger Parameters
|
||||
if reflect.TypeOf(&v2.ParameterDefinitions{}) == reflect.TypeOf(l) &&
|
||||
reflect.TypeOf(&v2.ParameterDefinitions{}) == reflect.TypeOf(r) {
|
||||
lDef := l.(*v2.ParameterDefinitions)
|
||||
rDef := r.(*v2.ParameterDefinitions)
|
||||
var a, b map[low.KeyReference[string]]low.ValueReference[*v2.Parameter]
|
||||
if lDef != nil {
|
||||
a = lDef.Definitions
|
||||
}
|
||||
if rDef != nil {
|
||||
b = rDef.Definitions
|
||||
}
|
||||
CheckMapForAdditionRemoval(a, b, &changes, v3.ParametersLabel)
|
||||
}
|
||||
// Swagger Parameters
|
||||
if reflect.TypeOf(&v2.ParameterDefinitions{}) == reflect.TypeOf(l) &&
|
||||
reflect.TypeOf(&v2.ParameterDefinitions{}) == reflect.TypeOf(r) {
|
||||
lDef := l.(*v2.ParameterDefinitions)
|
||||
rDef := r.(*v2.ParameterDefinitions)
|
||||
var a, b map[low.KeyReference[string]]low.ValueReference[*v2.Parameter]
|
||||
if lDef != nil {
|
||||
a = lDef.Definitions
|
||||
}
|
||||
if rDef != nil {
|
||||
b = rDef.Definitions
|
||||
}
|
||||
CheckMapForAdditionRemoval(a, b, &changes, v3.ParametersLabel)
|
||||
}
|
||||
|
||||
// Swagger Responses
|
||||
if reflect.TypeOf(&v2.ResponsesDefinitions{}) == reflect.TypeOf(l) &&
|
||||
reflect.TypeOf(&v2.ResponsesDefinitions{}) == reflect.TypeOf(r) {
|
||||
lDef := l.(*v2.ResponsesDefinitions)
|
||||
rDef := r.(*v2.ResponsesDefinitions)
|
||||
var a, b map[low.KeyReference[string]]low.ValueReference[*v2.Response]
|
||||
if lDef != nil {
|
||||
a = lDef.Definitions
|
||||
}
|
||||
if rDef != nil {
|
||||
b = rDef.Definitions
|
||||
}
|
||||
CheckMapForAdditionRemoval(a, b, &changes, v3.ResponsesLabel)
|
||||
}
|
||||
// Swagger Responses
|
||||
if reflect.TypeOf(&v2.ResponsesDefinitions{}) == reflect.TypeOf(l) &&
|
||||
reflect.TypeOf(&v2.ResponsesDefinitions{}) == reflect.TypeOf(r) {
|
||||
lDef := l.(*v2.ResponsesDefinitions)
|
||||
rDef := r.(*v2.ResponsesDefinitions)
|
||||
var a, b map[low.KeyReference[string]]low.ValueReference[*v2.Response]
|
||||
if lDef != nil {
|
||||
a = lDef.Definitions
|
||||
}
|
||||
if rDef != nil {
|
||||
b = rDef.Definitions
|
||||
}
|
||||
CheckMapForAdditionRemoval(a, b, &changes, v3.ResponsesLabel)
|
||||
}
|
||||
|
||||
// Swagger Schemas
|
||||
if reflect.TypeOf(&v2.Definitions{}) == reflect.TypeOf(l) &&
|
||||
reflect.TypeOf(&v2.Definitions{}) == reflect.TypeOf(r) {
|
||||
lDef := l.(*v2.Definitions)
|
||||
rDef := r.(*v2.Definitions)
|
||||
var a, b map[low.KeyReference[string]]low.ValueReference[*base.SchemaProxy]
|
||||
if lDef != nil {
|
||||
a = lDef.Schemas
|
||||
}
|
||||
if rDef != nil {
|
||||
b = rDef.Schemas
|
||||
}
|
||||
cc.SchemaChanges = CheckMapForChanges(a, b, &changes, v2.DefinitionsLabel, CompareSchemas)
|
||||
}
|
||||
// Swagger Schemas
|
||||
if reflect.TypeOf(&v2.Definitions{}) == reflect.TypeOf(l) &&
|
||||
reflect.TypeOf(&v2.Definitions{}) == reflect.TypeOf(r) {
|
||||
lDef := l.(*v2.Definitions)
|
||||
rDef := r.(*v2.Definitions)
|
||||
var a, b map[low.KeyReference[string]]low.ValueReference[*base.SchemaProxy]
|
||||
if lDef != nil {
|
||||
a = lDef.Schemas
|
||||
}
|
||||
if rDef != nil {
|
||||
b = rDef.Schemas
|
||||
}
|
||||
cc.SchemaChanges = CheckMapForChanges(a, b, &changes, v2.DefinitionsLabel, CompareSchemas)
|
||||
}
|
||||
|
||||
// Swagger Security Definitions
|
||||
if reflect.TypeOf(&v2.SecurityDefinitions{}) == reflect.TypeOf(l) &&
|
||||
reflect.TypeOf(&v2.SecurityDefinitions{}) == reflect.TypeOf(r) {
|
||||
lDef := l.(*v2.SecurityDefinitions)
|
||||
rDef := r.(*v2.SecurityDefinitions)
|
||||
var a, b map[low.KeyReference[string]]low.ValueReference[*v2.SecurityScheme]
|
||||
if lDef != nil {
|
||||
a = lDef.Definitions
|
||||
}
|
||||
if rDef != nil {
|
||||
b = rDef.Definitions
|
||||
}
|
||||
cc.SecuritySchemeChanges = CheckMapForChanges(a, b, &changes,
|
||||
v3.SecurityDefinitionLabel, CompareSecuritySchemesV2)
|
||||
}
|
||||
// Swagger Security Definitions
|
||||
if reflect.TypeOf(&v2.SecurityDefinitions{}) == reflect.TypeOf(l) &&
|
||||
reflect.TypeOf(&v2.SecurityDefinitions{}) == reflect.TypeOf(r) {
|
||||
lDef := l.(*v2.SecurityDefinitions)
|
||||
rDef := r.(*v2.SecurityDefinitions)
|
||||
var a, b map[low.KeyReference[string]]low.ValueReference[*v2.SecurityScheme]
|
||||
if lDef != nil {
|
||||
a = lDef.Definitions
|
||||
}
|
||||
if rDef != nil {
|
||||
b = rDef.Definitions
|
||||
}
|
||||
cc.SecuritySchemeChanges = CheckMapForChanges(a, b, &changes,
|
||||
v3.SecurityDefinitionLabel, CompareSecuritySchemesV2)
|
||||
}
|
||||
|
||||
// OpenAPI Components
|
||||
if reflect.TypeOf(&v3.Components{}) == reflect.TypeOf(l) &&
|
||||
reflect.TypeOf(&v3.Components{}) == reflect.TypeOf(r) {
|
||||
// OpenAPI Components
|
||||
if reflect.TypeOf(&v3.Components{}) == reflect.TypeOf(l) &&
|
||||
reflect.TypeOf(&v3.Components{}) == reflect.TypeOf(r) {
|
||||
|
||||
lComponents := l.(*v3.Components)
|
||||
rComponents := r.(*v3.Components)
|
||||
lComponents := l.(*v3.Components)
|
||||
rComponents := r.(*v3.Components)
|
||||
|
||||
//if low.AreEqual(lComponents, rComponents) {
|
||||
// return nil
|
||||
//}
|
||||
//if low.AreEqual(lComponents, rComponents) {
|
||||
// return nil
|
||||
//}
|
||||
|
||||
doneChan := make(chan componentComparison)
|
||||
comparisons := 0
|
||||
doneChan := make(chan componentComparison)
|
||||
comparisons := 0
|
||||
|
||||
// run as fast as we can, thread all the things.
|
||||
if !lComponents.Schemas.IsEmpty() || !rComponents.Schemas.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.Schemas.Value, rComponents.Schemas.Value,
|
||||
&changes, v3.SchemasLabel, CompareSchemas, doneChan)
|
||||
}
|
||||
// run as fast as we can, thread all the things.
|
||||
if !lComponents.Schemas.IsEmpty() || !rComponents.Schemas.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.Schemas.Value, rComponents.Schemas.Value,
|
||||
&changes, v3.SchemasLabel, CompareSchemas, doneChan)
|
||||
}
|
||||
|
||||
if !lComponents.Responses.IsEmpty() || !rComponents.Responses.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.Responses.Value, rComponents.Responses.Value,
|
||||
&changes, v3.ResponsesLabel, CompareResponseV3, doneChan)
|
||||
}
|
||||
if !lComponents.Responses.IsEmpty() || !rComponents.Responses.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.Responses.Value, rComponents.Responses.Value,
|
||||
&changes, v3.ResponsesLabel, CompareResponseV3, doneChan)
|
||||
}
|
||||
|
||||
if !lComponents.Parameters.IsEmpty() || !rComponents.Parameters.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.Parameters.Value, rComponents.Parameters.Value,
|
||||
&changes, v3.ParametersLabel, CompareParametersV3, doneChan)
|
||||
}
|
||||
if !lComponents.Parameters.IsEmpty() || !rComponents.Parameters.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.Parameters.Value, rComponents.Parameters.Value,
|
||||
&changes, v3.ParametersLabel, CompareParametersV3, doneChan)
|
||||
}
|
||||
|
||||
if !lComponents.Examples.IsEmpty() || !rComponents.Examples.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.Examples.Value, rComponents.Examples.Value,
|
||||
&changes, v3.ExamplesLabel, CompareExamples, doneChan)
|
||||
}
|
||||
if !lComponents.Examples.IsEmpty() || !rComponents.Examples.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.Examples.Value, rComponents.Examples.Value,
|
||||
&changes, v3.ExamplesLabel, CompareExamples, doneChan)
|
||||
}
|
||||
|
||||
if !lComponents.RequestBodies.IsEmpty() || !rComponents.RequestBodies.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.RequestBodies.Value, rComponents.RequestBodies.Value,
|
||||
&changes, v3.RequestBodiesLabel, CompareRequestBodies, doneChan)
|
||||
}
|
||||
if !lComponents.RequestBodies.IsEmpty() || !rComponents.RequestBodies.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.RequestBodies.Value, rComponents.RequestBodies.Value,
|
||||
&changes, v3.RequestBodiesLabel, CompareRequestBodies, doneChan)
|
||||
}
|
||||
|
||||
if !lComponents.Headers.IsEmpty() || !rComponents.Headers.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.Headers.Value, rComponents.Headers.Value,
|
||||
&changes, v3.HeadersLabel, CompareHeadersV3, doneChan)
|
||||
}
|
||||
if !lComponents.Headers.IsEmpty() || !rComponents.Headers.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.Headers.Value, rComponents.Headers.Value,
|
||||
&changes, v3.HeadersLabel, CompareHeadersV3, doneChan)
|
||||
}
|
||||
|
||||
if !lComponents.SecuritySchemes.IsEmpty() || !rComponents.SecuritySchemes.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.SecuritySchemes.Value, rComponents.SecuritySchemes.Value,
|
||||
&changes, v3.SecuritySchemesLabel, CompareSecuritySchemesV3, doneChan)
|
||||
}
|
||||
if !lComponents.SecuritySchemes.IsEmpty() || !rComponents.SecuritySchemes.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.SecuritySchemes.Value, rComponents.SecuritySchemes.Value,
|
||||
&changes, v3.SecuritySchemesLabel, CompareSecuritySchemesV3, doneChan)
|
||||
}
|
||||
|
||||
if !lComponents.Links.IsEmpty() || !rComponents.Links.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.Links.Value, rComponents.Links.Value,
|
||||
&changes, v3.LinksLabel, CompareLinks, doneChan)
|
||||
}
|
||||
if !lComponents.Links.IsEmpty() || !rComponents.Links.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.Links.Value, rComponents.Links.Value,
|
||||
&changes, v3.LinksLabel, CompareLinks, doneChan)
|
||||
}
|
||||
|
||||
if !lComponents.Callbacks.IsEmpty() || !rComponents.Callbacks.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.Callbacks.Value, rComponents.Callbacks.Value,
|
||||
&changes, v3.CallbacksLabel, CompareCallback, doneChan)
|
||||
}
|
||||
if !lComponents.Callbacks.IsEmpty() || !rComponents.Callbacks.IsEmpty() {
|
||||
comparisons++
|
||||
go runComparison(lComponents.Callbacks.Value, rComponents.Callbacks.Value,
|
||||
&changes, v3.CallbacksLabel, CompareCallback, doneChan)
|
||||
}
|
||||
|
||||
cc.ExtensionChanges = CompareExtensions(lComponents.Extensions, rComponents.Extensions)
|
||||
cc.ExtensionChanges = CompareExtensions(lComponents.Extensions, rComponents.Extensions)
|
||||
|
||||
completedComponents := 0
|
||||
for completedComponents < comparisons {
|
||||
select {
|
||||
case res := <-doneChan:
|
||||
switch res.prop {
|
||||
case v3.SchemasLabel:
|
||||
completedComponents++
|
||||
cc.SchemaChanges = res.result.(map[string]*SchemaChanges)
|
||||
break
|
||||
case v3.SecuritySchemesLabel:
|
||||
completedComponents++
|
||||
cc.SecuritySchemeChanges = res.result.(map[string]*SecuritySchemeChanges)
|
||||
break
|
||||
case v3.ResponsesLabel, v3.ParametersLabel, v3.ExamplesLabel, v3.RequestBodiesLabel, v3.HeadersLabel,
|
||||
v3.LinksLabel, v3.CallbacksLabel:
|
||||
completedComponents++
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
completedComponents := 0
|
||||
for completedComponents < comparisons {
|
||||
select {
|
||||
case res := <-doneChan:
|
||||
switch res.prop {
|
||||
case v3.SchemasLabel:
|
||||
completedComponents++
|
||||
cc.SchemaChanges = res.result.(map[string]*SchemaChanges)
|
||||
break
|
||||
case v3.SecuritySchemesLabel:
|
||||
completedComponents++
|
||||
cc.SecuritySchemeChanges = res.result.(map[string]*SecuritySchemeChanges)
|
||||
break
|
||||
case v3.ResponsesLabel, v3.ParametersLabel, v3.ExamplesLabel, v3.RequestBodiesLabel, v3.HeadersLabel,
|
||||
v3.LinksLabel, v3.CallbacksLabel:
|
||||
completedComponents++
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
cc.PropertyChanges = NewPropertyChanges(changes)
|
||||
if cc.TotalChanges() <= 0 {
|
||||
return nil
|
||||
}
|
||||
return cc
|
||||
cc.PropertyChanges = NewPropertyChanges(changes)
|
||||
if cc.TotalChanges() <= 0 {
|
||||
return nil
|
||||
}
|
||||
return cc
|
||||
}
|
||||
|
||||
type componentComparison struct {
|
||||
prop string
|
||||
result any
|
||||
prop string
|
||||
result any
|
||||
}
|
||||
|
||||
// run a generic comparison in a thread which in turn splits checks into further threads.
|
||||
func runComparison[T any, R any](l, r map[low.KeyReference[string]]low.ValueReference[T],
|
||||
changes *[]*Change, label string, compareFunc func(l, r T) R, doneChan chan componentComparison) {
|
||||
changes *[]*Change, label string, compareFunc func(l, r T) R, doneChan chan componentComparison) {
|
||||
|
||||
// for schemas
|
||||
if label == v3.SchemasLabel || label == v2.DefinitionsLabel || label == v3.SecuritySchemesLabel {
|
||||
doneChan <- componentComparison{
|
||||
prop: label,
|
||||
result: CheckMapForChanges(l, r, changes, label, compareFunc),
|
||||
}
|
||||
return
|
||||
} else {
|
||||
doneChan <- componentComparison{
|
||||
prop: label,
|
||||
result: CheckMapForAdditionRemoval(l, r, changes, label),
|
||||
}
|
||||
}
|
||||
// for schemas
|
||||
if label == v3.SchemasLabel || label == v2.DefinitionsLabel || label == v3.SecuritySchemesLabel {
|
||||
doneChan <- componentComparison{
|
||||
prop: label,
|
||||
result: CheckMapForChanges(l, r, changes, label, compareFunc),
|
||||
}
|
||||
return
|
||||
} else {
|
||||
doneChan <- componentComparison{
|
||||
prop: label,
|
||||
result: CheckMapForAdditionRemoval(l, r, changes, label),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TotalChanges returns total changes for all Components and Definitions
|
||||
func (c *ComponentsChanges) TotalChanges() int {
|
||||
v := c.PropertyChanges.TotalChanges()
|
||||
for k := range c.SchemaChanges {
|
||||
v += c.SchemaChanges[k].TotalChanges()
|
||||
}
|
||||
for k := range c.SecuritySchemeChanges {
|
||||
v += c.SecuritySchemeChanges[k].TotalChanges()
|
||||
}
|
||||
if c.ExtensionChanges != nil {
|
||||
v += c.ExtensionChanges.TotalChanges()
|
||||
}
|
||||
return v
|
||||
v := c.PropertyChanges.TotalChanges()
|
||||
for k := range c.SchemaChanges {
|
||||
v += c.SchemaChanges[k].TotalChanges()
|
||||
}
|
||||
for k := range c.SecuritySchemeChanges {
|
||||
v += c.SecuritySchemeChanges[k].TotalChanges()
|
||||
}
|
||||
if c.ExtensionChanges != nil {
|
||||
v += c.ExtensionChanges.TotalChanges()
|
||||
}
|
||||
return v
|
||||
}
|
||||
|
||||
// TotalBreakingChanges returns all breaking changes found for all Components and Definitions
|
||||
func (c *ComponentsChanges) TotalBreakingChanges() int {
|
||||
v := c.PropertyChanges.TotalBreakingChanges()
|
||||
for k := range c.SchemaChanges {
|
||||
v += c.SchemaChanges[k].TotalBreakingChanges()
|
||||
}
|
||||
for k := range c.SecuritySchemeChanges {
|
||||
v += c.SecuritySchemeChanges[k].TotalBreakingChanges()
|
||||
}
|
||||
return v
|
||||
v := c.PropertyChanges.TotalBreakingChanges()
|
||||
for k := range c.SchemaChanges {
|
||||
v += c.SchemaChanges[k].TotalBreakingChanges()
|
||||
}
|
||||
for k := range c.SecuritySchemeChanges {
|
||||
v += c.SecuritySchemeChanges[k].TotalBreakingChanges()
|
||||
}
|
||||
return v
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user