LukeParke/libopenapi
1
0
Fork 0
mirror of https://github.com/LukeHagar/libopenapi.git synced 2025-12-09 20:47:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: introduce extension change detection for info section

Browse Source 
This commit provides a fix for issue #184
This commit is contained in:
Sebastian Kunz
2023-10-13 11:41:24 +02:00
committed by quobix
parent 4dc693a3f5
commit 76dc865821
2 changed files with 114 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
what-changed/model/info.go
View File

@@ -13,6 +13,7 @@ type InfoChanges struct {
*PropertyChanges
ContactChanges *ContactChanges `json:"contact,omitempty" yaml:"contact,omitempty"`
LicenseChanges *LicenseChanges `json:"license,omitempty" yaml:"license,omitempty"`
ExtensionChanges *ExtensionChanges `json:"extensions,omitempty" yaml:"extensions,omitempty"`
}
// GetAllChanges returns a slice of all changes made between Info objects
@@ -25,6 +26,9 @@ func (i *InfoChanges) GetAllChanges() []*Change {
if i.LicenseChanges != nil {
changes = append(changes, i.LicenseChanges.GetAllChanges()...)
}
if i.ExtensionChanges != nil {
changes = append(changes, i.ExtensionChanges.GetAllChanges()...)
}
return changes
}
@@ -37,6 +41,9 @@ func (i *InfoChanges) TotalChanges() int {
if i.LicenseChanges != nil {
t += i.LicenseChanges.TotalChanges()
}
if i.ExtensionChanges != nil {
t += i.ExtensionChanges.TotalChanges()
}
return t
}
@@ -139,6 +146,10 @@ func CompareInfo(l, r *base.Info) *InfoChanges {
l.License.ValueNode, nil, false, r.License.Value, nil)
}
}
// check extensions.
i.ExtensionChanges = CompareExtensions(l.Extensions, r.Extensions)
i.PropertyChanges = NewPropertyChanges(changes)
if i.TotalChanges() <= 0 {
return nil

105
what-changed/model/info_test.go
View File

@@ -4,12 +4,13 @@
package model
import (
"testing"
"github.com/pb33f/libopenapi/datamodel/low"
"github.com/pb33f/libopenapi/datamodel/low/base"
"github.com/pb33f/libopenapi/datamodel/low/v3"
v3 "github.com/pb33f/libopenapi/datamodel/low/v3"
"github.com/stretchr/testify/assert"
"gopkg.in/yaml.v3"
"testing"
)
func TestCompareInfo_DescriptionAdded(t *testing.T) {
@@ -374,7 +375,8 @@ contact:
name: buckaroo
email: buckaroo@pb33f.io
license:
name: MIT`
name: MIT
x-extension: extension`
right := `title: a nice spec
termsOfService: https://pb33f.io/terms
@@ -383,7 +385,8 @@ contact:
name: buckaroo
email: buckaroo@pb33f.io
license:
name: MIT`
name: MIT
x-extension: extension`
var lNode, rNode yaml.Node
_ = yaml.Unmarshal([]byte(left), &lNode)
@@ -401,3 +404,97 @@ license:
extChanges := CompareInfo(&lDoc, &rDoc)
assert.Nil(t, extChanges)
}
func TestCompareInfo_ExtensionAdded(t *testing.T) {
left := `title: a nice spec
version: '1.2.3'
`
right := `title: a nice spec
version: '1.2.3'
x-extension: new extension
`
var lNode, rNode yaml.Node
_ = yaml.Unmarshal([]byte(left), &lNode)
_ = yaml.Unmarshal([]byte(right), &rNode)
// create low level objects
var lDoc base.Info
var rDoc base.Info
_ = low.BuildModel(lNode.Content[0], &lDoc)
_ = low.BuildModel(rNode.Content[0], &rDoc)
_ = lDoc.Build(nil, lNode.Content[0], nil)
_ = rDoc.Build(nil, rNode.Content[0], nil)
// compare.
extChanges := CompareInfo(&lDoc, &rDoc)
assert.Equal(t, 1, extChanges.TotalChanges())
assert.Len(t, extChanges.GetAllChanges(), 1)
assert.Equal(t, ObjectAdded, extChanges.ExtensionChanges.Changes[0].ChangeType)
assert.Equal(t, "x-extension", extChanges.ExtensionChanges.Changes[0].Property)
}
func TestCompareInfo_ExtensionRemoved(t *testing.T) {
left := `title: a nice spec
version: '1.2.3'
x-extension: extension
`
right := `title: a nice spec
version: '1.2.3'
`
var lNode, rNode yaml.Node
_ = yaml.Unmarshal([]byte(left), &lNode)
_ = yaml.Unmarshal([]byte(right), &rNode)
// create low level objects
var lDoc base.Info
var rDoc base.Info
_ = low.BuildModel(lNode.Content[0], &lDoc)
_ = low.BuildModel(rNode.Content[0], &rDoc)
_ = lDoc.Build(nil, lNode.Content[0], nil)
_ = rDoc.Build(nil, rNode.Content[0], nil)
// compare.
extChanges := CompareInfo(&lDoc, &rDoc)
assert.Equal(t, 1, extChanges.TotalChanges())
assert.Len(t, extChanges.GetAllChanges(), 1)
assert.Equal(t, ObjectRemoved, extChanges.ExtensionChanges.Changes[0].ChangeType)
assert.Equal(t, "x-extension", extChanges.ExtensionChanges.Changes[0].Property)
}
func TestCompareInfo_ExtensionModified(t *testing.T) {
left := `title: a nice spec
version: '1.2.3'
x-extension: original extension
`
right := `title: a nice spec
version: '1.2.3'
x-extension: new extension
`
var lNode, rNode yaml.Node
_ = yaml.Unmarshal([]byte(left), &lNode)
_ = yaml.Unmarshal([]byte(right), &rNode)
// create low level objects
var lDoc base.Info
var rDoc base.Info
_ = low.BuildModel(lNode.Content[0], &lDoc)
_ = low.BuildModel(rNode.Content[0], &rDoc)
_ = lDoc.Build(nil, lNode.Content[0], nil)
_ = rDoc.Build(nil, rNode.Content[0], nil)
// compare.
extChanges := CompareInfo(&lDoc, &rDoc)
assert.Equal(t, 1, extChanges.TotalChanges())
assert.Len(t, extChanges.GetAllChanges(), 1)
assert.Equal(t, Modified, extChanges.ExtensionChanges.Changes[0].ChangeType)
assert.Equal(t, "x-extension", extChanges.ExtensionChanges.Changes[0].Property)
}