mirror of
https://github.com/LukeHagar/libopenapi.git
synced 2025-12-07 20:47:45 +00:00
468 lines
14 KiB
Go
468 lines
14 KiB
Go
// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
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"
|
|
"gopkg.in/yaml.v3"
|
|
"reflect"
|
|
"sort"
|
|
"strings"
|
|
)
|
|
|
|
type OperationChanges struct {
|
|
PropertyChanges
|
|
ExternalDocChanges *ExternalDocChanges
|
|
ParameterChanges []*ParameterChanges
|
|
ResponsesChanges *ResponsesChanges
|
|
|
|
// SecurityRequirementChanges are defined differently between v2 and v3. Both are defined
|
|
// as the same data type, however the objects are structured differently. A slice is the cleanest
|
|
// way to compose both models.
|
|
SecurityRequirementChanges []*SecurityRequirementChanges
|
|
|
|
// v3
|
|
RequestBodyChanges *RequestBodyChanges
|
|
ServerChanges []*ServerChanges
|
|
ExtensionChanges *ExtensionChanges
|
|
// todo: callbacks need implementing.
|
|
//CallbackChanges map[string]*CallbackChanges
|
|
}
|
|
|
|
func (o *OperationChanges) TotalChanges() int {
|
|
c := o.PropertyChanges.TotalChanges()
|
|
if o.ExternalDocChanges != nil {
|
|
c += o.ExternalDocChanges.TotalChanges()
|
|
}
|
|
for k := range o.ParameterChanges {
|
|
c += o.ParameterChanges[k].TotalChanges()
|
|
}
|
|
if o.ResponsesChanges != nil {
|
|
c += o.ResponsesChanges.TotalChanges()
|
|
}
|
|
for k := range o.SecurityRequirementChanges {
|
|
c += o.SecurityRequirementChanges[k].TotalChanges()
|
|
}
|
|
if o.RequestBodyChanges != nil {
|
|
c += o.RequestBodyChanges.TotalChanges()
|
|
}
|
|
for k := range o.ServerChanges {
|
|
c += o.ServerChanges[k].TotalChanges()
|
|
}
|
|
// todo: add callbacks in here.
|
|
if o.ExtensionChanges != nil {
|
|
c += o.ExtensionChanges.TotalChanges()
|
|
}
|
|
return c
|
|
}
|
|
|
|
func (o *OperationChanges) TotalBreakingChanges() int {
|
|
c := o.PropertyChanges.TotalBreakingChanges()
|
|
if o.ExternalDocChanges != nil {
|
|
c += o.ExternalDocChanges.TotalBreakingChanges()
|
|
}
|
|
for k := range o.ParameterChanges {
|
|
c += o.ParameterChanges[k].TotalBreakingChanges()
|
|
}
|
|
if o.ResponsesChanges != nil {
|
|
c += o.ResponsesChanges.TotalBreakingChanges()
|
|
}
|
|
for k := range o.SecurityRequirementChanges {
|
|
c += o.SecurityRequirementChanges[k].TotalBreakingChanges()
|
|
}
|
|
if o.RequestBodyChanges != nil {
|
|
c += o.RequestBodyChanges.TotalBreakingChanges()
|
|
}
|
|
for k := range o.ServerChanges {
|
|
c += o.ServerChanges[k].TotalBreakingChanges()
|
|
}
|
|
// todo: add callbacks in here.
|
|
return c
|
|
}
|
|
|
|
func addSharedOperationProperties(left, right low.SharedOperations, changes *[]*Change) []*PropertyCheck {
|
|
var props []*PropertyCheck
|
|
|
|
// tags
|
|
if len(left.GetTags().Value) > 0 || len(right.GetTags().Value) > 0 {
|
|
ExtractStringValueSliceChanges(left.GetTags().Value, right.GetTags().Value,
|
|
changes, v3.TagsLabel, false)
|
|
}
|
|
|
|
// summary
|
|
addPropertyCheck(&props, left.GetSummary().ValueNode, right.GetSummary().ValueNode,
|
|
left.GetSummary(), right.GetSummary(), changes, v3.SummaryLabel, false)
|
|
|
|
// description
|
|
addPropertyCheck(&props, left.GetDescription().ValueNode, right.GetDescription().ValueNode,
|
|
left.GetDescription(), right.GetDescription(), changes, v3.DescriptionLabel, false)
|
|
|
|
// deprecated
|
|
addPropertyCheck(&props, left.GetDeprecated().ValueNode, right.GetDeprecated().ValueNode,
|
|
left.GetDeprecated(), right.GetDeprecated(), changes, v3.DeprecatedLabel, false)
|
|
|
|
return props
|
|
}
|
|
|
|
func compareSharedOperationObjects(l, r low.SharedOperations, changes *[]*Change, opChanges *OperationChanges) {
|
|
|
|
// external docs
|
|
if !l.GetExternalDocs().IsEmpty() && !r.GetExternalDocs().IsEmpty() {
|
|
lExtDoc := l.GetExternalDocs().Value.(*base.ExternalDoc)
|
|
rExtDoc := r.GetExternalDocs().Value.(*base.ExternalDoc)
|
|
if !low.AreEqual(lExtDoc, rExtDoc) {
|
|
opChanges.ExternalDocChanges = CompareExternalDocs(lExtDoc, rExtDoc)
|
|
}
|
|
}
|
|
if l.GetExternalDocs().IsEmpty() && !r.GetExternalDocs().IsEmpty() {
|
|
CreateChange(changes, PropertyAdded, v3.ExternalDocsLabel,
|
|
nil, r.GetExternalDocs().ValueNode, false, nil,
|
|
r.GetExternalDocs().Value)
|
|
}
|
|
if !l.GetExternalDocs().IsEmpty() && r.GetExternalDocs().IsEmpty() {
|
|
CreateChange(changes, PropertyRemoved, v3.ExternalDocsLabel,
|
|
l.GetExternalDocs().ValueNode, nil, false, l.GetExternalDocs().Value,
|
|
nil)
|
|
}
|
|
|
|
// responses
|
|
if !l.GetResponses().IsEmpty() && !r.GetResponses().IsEmpty() {
|
|
opChanges.ResponsesChanges = CompareResponses(l.GetResponses().Value, r.GetResponses().Value)
|
|
}
|
|
if l.GetResponses().IsEmpty() && !r.GetResponses().IsEmpty() {
|
|
CreateChange(changes, PropertyAdded, v3.ResponsesLabel,
|
|
nil, r.GetResponses().ValueNode, false, nil,
|
|
r.GetResponses().Value)
|
|
}
|
|
if !l.GetResponses().IsEmpty() && r.GetResponses().IsEmpty() {
|
|
CreateChange(changes, PropertyRemoved, v3.ResponsesLabel,
|
|
l.GetResponses().ValueNode, nil, true, l.GetResponses().Value,
|
|
nil)
|
|
}
|
|
|
|
}
|
|
|
|
func CompareOperations(l, r any) *OperationChanges {
|
|
|
|
var changes []*Change
|
|
var props []*PropertyCheck
|
|
|
|
oc := new(OperationChanges)
|
|
|
|
// Swagger
|
|
if reflect.TypeOf(&v2.Operation{}) == reflect.TypeOf(l) &&
|
|
reflect.TypeOf(&v2.Operation{}) == reflect.TypeOf(r) {
|
|
|
|
lOperation := l.(*v2.Operation)
|
|
rOperation := r.(*v2.Operation)
|
|
|
|
// perform hash check to avoid further processing
|
|
if low.AreEqual(lOperation, rOperation) {
|
|
return nil
|
|
}
|
|
|
|
props = append(props, addSharedOperationProperties(lOperation, rOperation, &changes)...)
|
|
|
|
compareSharedOperationObjects(lOperation, rOperation, &changes, oc)
|
|
|
|
// parameters
|
|
lParamsUntyped := lOperation.GetParameters()
|
|
rParamsUntyped := rOperation.GetParameters()
|
|
if !lParamsUntyped.IsEmpty() && !rParamsUntyped.IsEmpty() {
|
|
lParams := lParamsUntyped.Value.([]low.ValueReference[*v2.Parameter])
|
|
rParams := rParamsUntyped.Value.([]low.ValueReference[*v2.Parameter])
|
|
|
|
lv := make(map[string]*v2.Parameter, len(lParams))
|
|
rv := make(map[string]*v2.Parameter, len(rParams))
|
|
|
|
for i := range lParams {
|
|
s := lParams[i].Value.Name.Value
|
|
lv[s] = lParams[i].Value
|
|
}
|
|
for i := range rParams {
|
|
s := rParams[i].Value.Name.Value
|
|
rv[s] = rParams[i].Value
|
|
}
|
|
|
|
var paramChanges []*ParameterChanges
|
|
for n := range lv {
|
|
if _, ok := rv[n]; ok {
|
|
if !low.AreEqual(lv[n], rv[n]) {
|
|
ch := CompareParameters(lv[n], rv[n])
|
|
if ch != nil {
|
|
paramChanges = append(paramChanges, ch)
|
|
}
|
|
}
|
|
continue
|
|
}
|
|
CreateChange(&changes, ObjectRemoved, v3.ParametersLabel,
|
|
lv[n].Name.ValueNode, nil, true, lv[n].Name.Value,
|
|
nil)
|
|
|
|
}
|
|
for n := range rv {
|
|
if _, ok := lv[n]; !ok {
|
|
CreateChange(&changes, ObjectAdded, v3.ParametersLabel,
|
|
nil, rv[n].Name.ValueNode, true, nil,
|
|
rv[n].Name.Value)
|
|
}
|
|
}
|
|
oc.ParameterChanges = paramChanges
|
|
}
|
|
if !lParamsUntyped.IsEmpty() && rParamsUntyped.IsEmpty() {
|
|
CreateChange(&changes, PropertyRemoved, v3.ParametersLabel,
|
|
lParamsUntyped.ValueNode, nil, true, lParamsUntyped.Value,
|
|
nil)
|
|
}
|
|
if lParamsUntyped.IsEmpty() && !rParamsUntyped.IsEmpty() {
|
|
CreateChange(&changes, PropertyAdded, v3.ParametersLabel,
|
|
nil, rParamsUntyped.ValueNode, true, nil,
|
|
rParamsUntyped.Value)
|
|
}
|
|
|
|
// security
|
|
if !lOperation.Security.IsEmpty() && !lOperation.Security.IsEmpty() {
|
|
checkSecurity(lOperation.Security, rOperation.Security, &changes, oc)
|
|
}
|
|
|
|
// produces
|
|
if len(lOperation.Produces.Value) > 0 || len(rOperation.Produces.Value) > 0 {
|
|
ExtractStringValueSliceChanges(lOperation.Produces.Value, rOperation.Produces.Value,
|
|
&changes, v3.ProducesLabel, false)
|
|
}
|
|
|
|
// consumes
|
|
if len(lOperation.Consumes.Value) > 0 || len(rOperation.Consumes.Value) > 0 {
|
|
ExtractStringValueSliceChanges(lOperation.Consumes.Value, rOperation.Consumes.Value,
|
|
&changes, v3.ConsumesLabel, false)
|
|
}
|
|
|
|
// schemes
|
|
if len(lOperation.Schemes.Value) > 0 || len(rOperation.Schemes.Value) > 0 {
|
|
ExtractStringValueSliceChanges(lOperation.Schemes.Value, rOperation.Schemes.Value,
|
|
&changes, v3.SchemesLabel, true)
|
|
}
|
|
|
|
oc.ExtensionChanges = CompareExtensions(lOperation.Extensions, rOperation.Extensions)
|
|
}
|
|
|
|
// OpenAPI
|
|
if reflect.TypeOf(&v3.Operation{}) == reflect.TypeOf(l) &&
|
|
reflect.TypeOf(&v3.Operation{}) == reflect.TypeOf(r) {
|
|
|
|
lOperation := l.(*v3.Operation)
|
|
rOperation := r.(*v3.Operation)
|
|
|
|
// perform hash check to avoid further processing
|
|
if low.AreEqual(lOperation, rOperation) {
|
|
return nil
|
|
}
|
|
|
|
props = append(props, addSharedOperationProperties(lOperation, rOperation, &changes)...)
|
|
compareSharedOperationObjects(lOperation, rOperation, &changes, oc)
|
|
|
|
// parameters
|
|
lParamsUntyped := lOperation.GetParameters()
|
|
rParamsUntyped := rOperation.GetParameters()
|
|
if !lParamsUntyped.IsEmpty() && !rParamsUntyped.IsEmpty() {
|
|
lParams := lParamsUntyped.Value.([]low.ValueReference[*v3.Parameter])
|
|
rParams := rParamsUntyped.Value.([]low.ValueReference[*v3.Parameter])
|
|
|
|
lv := make(map[string]*v3.Parameter, len(lParams))
|
|
rv := make(map[string]*v3.Parameter, len(rParams))
|
|
|
|
for i := range lParams {
|
|
s := lParams[i].Value.Name.Value
|
|
lv[s] = lParams[i].Value
|
|
}
|
|
for i := range rParams {
|
|
s := rParams[i].Value.Name.Value
|
|
rv[s] = rParams[i].Value
|
|
}
|
|
|
|
var paramChanges []*ParameterChanges
|
|
for n := range lv {
|
|
if _, ok := rv[n]; ok {
|
|
if !low.AreEqual(lv[n], rv[n]) {
|
|
ch := CompareParameters(lv[n], rv[n])
|
|
if ch != nil {
|
|
paramChanges = append(paramChanges, ch)
|
|
}
|
|
}
|
|
continue
|
|
}
|
|
CreateChange(&changes, ObjectRemoved, v3.ParametersLabel,
|
|
lv[n].Name.ValueNode, nil, true, lv[n].Name.Value,
|
|
nil)
|
|
|
|
}
|
|
for n := range rv {
|
|
if _, ok := lv[n]; !ok {
|
|
CreateChange(&changes, ObjectAdded, v3.ParametersLabel,
|
|
nil, rv[n].Name.ValueNode, true, nil,
|
|
rv[n].Name.Value)
|
|
}
|
|
}
|
|
oc.ParameterChanges = paramChanges
|
|
}
|
|
if !lParamsUntyped.IsEmpty() && rParamsUntyped.IsEmpty() {
|
|
CreateChange(&changes, PropertyRemoved, v3.ParametersLabel,
|
|
lParamsUntyped.ValueNode, nil, true, lParamsUntyped.Value,
|
|
nil)
|
|
}
|
|
if lParamsUntyped.IsEmpty() && !rParamsUntyped.IsEmpty() {
|
|
CreateChange(&changes, PropertyAdded, v3.ParametersLabel,
|
|
nil, rParamsUntyped.ValueNode, true, nil,
|
|
rParamsUntyped.Value)
|
|
}
|
|
|
|
// security
|
|
if !lOperation.Security.IsEmpty() && !lOperation.Security.IsEmpty() {
|
|
checkSecurity(lOperation.Security, rOperation.Security, &changes, oc)
|
|
}
|
|
|
|
// request body
|
|
if !lOperation.RequestBody.IsEmpty() && !rOperation.RequestBody.IsEmpty() {
|
|
if !low.AreEqual(lOperation.RequestBody.Value, rOperation.RequestBody.Value) {
|
|
oc.RequestBodyChanges = CompareRequestBodies(lOperation.RequestBody.Value, rOperation.RequestBody.Value)
|
|
}
|
|
}
|
|
if !lOperation.RequestBody.IsEmpty() && rOperation.RequestBody.IsEmpty() {
|
|
CreateChange(&changes, PropertyRemoved, v3.RequestBodyLabel,
|
|
lOperation.RequestBody.ValueNode, nil, true, lOperation.RequestBody.Value,
|
|
nil)
|
|
}
|
|
if lOperation.RequestBody.IsEmpty() && !rOperation.RequestBody.IsEmpty() {
|
|
CreateChange(&changes, PropertyAdded, v3.RequestBodyLabel,
|
|
nil, rOperation.RequestBody.ValueNode, true, nil,
|
|
rOperation.RequestBody.Value)
|
|
}
|
|
|
|
// servers
|
|
oc.ServerChanges = checkServers(lOperation.Servers, rOperation.Servers, &changes)
|
|
oc.ExtensionChanges = CompareExtensions(lOperation.Extensions, rOperation.Extensions)
|
|
|
|
// todo: callbacks
|
|
}
|
|
CheckProperties(props)
|
|
oc.Changes = changes
|
|
return oc
|
|
}
|
|
|
|
func checkServers(lServers, rServers low.NodeReference[[]low.ValueReference[*v3.Server]],
|
|
changes *[]*Change) []*ServerChanges {
|
|
|
|
var serverChanges []*ServerChanges
|
|
|
|
if !lServers.IsEmpty() && !rServers.IsEmpty() {
|
|
|
|
lv := make(map[string]low.ValueReference[*v3.Server], len(lServers.Value))
|
|
rv := make(map[string]low.ValueReference[*v3.Server], len(rServers.Value))
|
|
|
|
for i := range lServers.Value {
|
|
var s string
|
|
if !lServers.Value[i].Value.URL.IsEmpty() {
|
|
s = lServers.Value[i].Value.URL.Value
|
|
} else {
|
|
s = low.GenerateHashString(lServers.Value[i].Value)
|
|
}
|
|
lv[s] = lServers.Value[i]
|
|
}
|
|
for i := range rServers.Value {
|
|
var s string
|
|
if !rServers.Value[i].Value.URL.IsEmpty() {
|
|
s = rServers.Value[i].Value.URL.Value
|
|
} else {
|
|
s = low.GenerateHashString(rServers.Value[i].Value)
|
|
}
|
|
rv[s] = rServers.Value[i]
|
|
}
|
|
|
|
for k := range lv {
|
|
if _, ok := rv[k]; ok {
|
|
if !low.AreEqual(lv[k].Value, rv[k].Value) {
|
|
serverChanges = append(serverChanges, CompareServers(lv[k].Value, rv[k].Value))
|
|
}
|
|
continue
|
|
}
|
|
CreateChange(changes, ObjectRemoved, v3.ServersLabel,
|
|
lv[k].ValueNode, nil, true, lv[k].Value.URL.Value,
|
|
nil)
|
|
}
|
|
for k := range rv {
|
|
if _, ok := lv[k]; !ok {
|
|
CreateChange(changes, ObjectAdded, v3.ServersLabel,
|
|
rv[k].ValueNode, nil, false, rv[k].Value.URL.Value,
|
|
nil)
|
|
}
|
|
}
|
|
}
|
|
if !lServers.IsEmpty() && rServers.IsEmpty() {
|
|
CreateChange(changes, PropertyRemoved, v3.ServersLabel,
|
|
lServers.ValueNode, nil, true, lServers.ValueNode,
|
|
nil)
|
|
}
|
|
if lServers.IsEmpty() && !rServers.IsEmpty() {
|
|
CreateChange(changes, PropertyAdded, v3.ServersLabel,
|
|
nil, rServers.ValueNode, false, nil,
|
|
rServers.Value)
|
|
}
|
|
return serverChanges
|
|
}
|
|
|
|
func checkSecurity(lSecurity, rSecurity low.NodeReference[[]low.ValueReference[*base.SecurityRequirement]],
|
|
changes *[]*Change, oc *OperationChanges) {
|
|
|
|
lv := make(map[string]*base.SecurityRequirement, len(lSecurity.Value))
|
|
rv := make(map[string]*base.SecurityRequirement, len(rSecurity.Value))
|
|
lvn := make(map[string]*yaml.Node, len(lSecurity.Value))
|
|
rvn := make(map[string]*yaml.Node, len(rSecurity.Value))
|
|
|
|
for i := range lSecurity.Value {
|
|
keys := lSecurity.Value[i].Value.GetKeys()
|
|
sort.Strings(keys)
|
|
s := strings.Join(keys, "|")
|
|
lv[s] = lSecurity.Value[i].Value
|
|
lvn[s] = lSecurity.Value[i].ValueNode
|
|
|
|
}
|
|
for i := range rSecurity.Value {
|
|
keys := rSecurity.Value[i].Value.GetKeys()
|
|
sort.Strings(keys)
|
|
s := strings.Join(keys, "|")
|
|
rv[s] = rSecurity.Value[i].Value
|
|
rvn[s] = rSecurity.Value[i].ValueNode
|
|
}
|
|
|
|
var secChanges []*SecurityRequirementChanges
|
|
for n := range lv {
|
|
if _, ok := rv[n]; ok {
|
|
if !low.AreEqual(lv[n], rv[n]) {
|
|
ch := CompareSecurityRequirement(lv[n], rv[n])
|
|
if ch != nil {
|
|
secChanges = append(secChanges, ch)
|
|
}
|
|
}
|
|
continue
|
|
}
|
|
lvn[n].Value = strings.Join(lv[n].GetKeys(), ", ")
|
|
CreateChange(changes, ObjectRemoved, v3.SecurityLabel,
|
|
lvn[n], nil, true, lv[n],
|
|
nil)
|
|
|
|
}
|
|
for n := range rv {
|
|
if _, ok := lv[n]; !ok {
|
|
rvn[n].Value = strings.Join(rv[n].GetKeys(), ", ")
|
|
CreateChange(changes, ObjectAdded, v3.SecurityLabel,
|
|
nil, rvn[n], false, nil,
|
|
rv[n])
|
|
}
|
|
}
|
|
oc.SecurityRequirementChanges = secChanges
|
|
}
|