Fleshing out what-changed functionality.

Starting at the bottom again with low levels and sketching out how to consume it.

what-changed/external_docs_test.go

@@ -0,0 +1,154 @@
+// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
+// SPDX-License-Identifier: MIT
+
+package what_changed
+
+import (
+	"github.com/pb33f/libopenapi/datamodel/low"
+	lowbase "github.com/pb33f/libopenapi/datamodel/low/base"
+	lowv3 "github.com/pb33f/libopenapi/datamodel/low/v3"
+	"github.com/stretchr/testify/assert"
+	"gopkg.in/yaml.v3"
+	"testing"
+)
+
+func TestCompareExternalDocs(t *testing.T) {
+
+	left := `url: https://pb33f.io
+description: this is a test
+x-testing: hello`
+
+	right := `url: https://quobix.com
+description: this is another test
+x-testing: hiya!`
+
+	var lNode, rNode yaml.Node
+	_ = yaml.Unmarshal([]byte(left), &lNode)
+	_ = yaml.Unmarshal([]byte(right), &rNode)
+
+	// create low level objects
+	var lDoc lowbase.ExternalDoc
+	var rDoc lowbase.ExternalDoc
+	_ = low.BuildModel(&lNode, &lDoc)
+	_ = low.BuildModel(&rNode, &rDoc)
+	_ = lDoc.Build(lNode.Content[0], nil)
+	_ = rDoc.Build(rNode.Content[0], nil)
+
+	// compare.
+	extChanges := CompareExternalDocs(&lDoc, &rDoc)
+	assert.Len(t, extChanges.ExtensionChanges.Changes, 1)
+	assert.Len(t, extChanges.Changes, 2)
+
+	// validate property changes
+	urlChange := extChanges.Changes[0]
+	assert.Equal(t, Modified, urlChange.ChangeType)
+	assert.False(t, urlChange.Context.HasChanged())
+	assert.Equal(t, "https://pb33f.io", urlChange.Original)
+	assert.Equal(t, "https://quobix.com", urlChange.New)
+	assert.Equal(t, 1, urlChange.Context.OrigLine)
+	assert.Equal(t, lowv3.URLLabel, urlChange.Property)
+
+	descChange := extChanges.Changes[1]
+	assert.Equal(t, Modified, descChange.ChangeType)
+	assert.False(t, descChange.Context.HasChanged())
+	assert.Equal(t, "this is another test", descChange.New)
+	assert.Equal(t, "this is a test", descChange.Original)
+	assert.Equal(t, 2, descChange.Context.OrigLine)
+	assert.Equal(t, 14, descChange.Context.OrigCol)
+
+	// validate extensions
+	extChange := extChanges.ExtensionChanges.Changes[0]
+	assert.Equal(t, Modified, extChange.ChangeType)
+	assert.False(t, extChange.Context.HasChanged())
+	assert.Equal(t, "hiya!", extChange.New)
+	assert.Equal(t, "hello", extChange.Original)
+	assert.Equal(t, 3, extChange.Context.OrigLine)
+	assert.Equal(t, 12, extChange.Context.OrigCol)
+
+}
+
+func TestCompareExternalDocs_Moved(t *testing.T) {
+
+	left := `url: https://pb33f.io
+description: this is a test
+x-testing: hello`
+
+	right := `description: this is another test
+x-testing: hiya!
+url: https://quobix.com`
+
+	var lNode, rNode yaml.Node
+	_ = yaml.Unmarshal([]byte(left), &lNode)
+	_ = yaml.Unmarshal([]byte(right), &rNode)
+
+	// create low level objects
+	var lDoc lowbase.ExternalDoc
+	var rDoc lowbase.ExternalDoc
+	_ = low.BuildModel(&lNode, &lDoc)
+	_ = low.BuildModel(&rNode, &rDoc)
+	_ = lDoc.Build(lNode.Content[0], nil)
+	_ = rDoc.Build(rNode.Content[0], nil)
+
+	// compare.
+	extChanges := CompareExternalDocs(&lDoc, &rDoc)
+	assert.Len(t, extChanges.ExtensionChanges.Changes, 1)
+	assert.Len(t, extChanges.Changes, 2)
+
+	// validate property changes
+	urlChange := extChanges.Changes[0]
+	assert.Equal(t, ModifiedAndMoved, urlChange.ChangeType)
+	assert.True(t, urlChange.Context.HasChanged())
+	assert.Equal(t, "https://pb33f.io", urlChange.Original)
+	assert.Equal(t, "https://quobix.com", urlChange.New)
+	assert.Equal(t, 1, urlChange.Context.OrigLine)
+	assert.Equal(t, 3, urlChange.Context.NewLine)
+	assert.Equal(t, lowv3.URLLabel, urlChange.Property)
+
+	descChange := extChanges.Changes[1]
+	assert.Equal(t, ModifiedAndMoved, descChange.ChangeType)
+	assert.True(t, descChange.Context.HasChanged())
+	assert.Equal(t, "this is another test", descChange.New)
+	assert.Equal(t, "this is a test", descChange.Original)
+	assert.Equal(t, 2, descChange.Context.OrigLine)
+	assert.Equal(t, 14, descChange.Context.OrigCol)
+	assert.Equal(t, 1, descChange.Context.NewLine)
+	assert.Equal(t, 14, descChange.Context.NewCol)
+
+	// validate extensions
+	extChange := extChanges.ExtensionChanges.Changes[0]
+	assert.Equal(t, ModifiedAndMoved, extChange.ChangeType)
+	assert.True(t, extChange.Context.HasChanged())
+	assert.Equal(t, "hiya!", extChange.New)
+	assert.Equal(t, "hello", extChange.Original)
+	assert.Equal(t, 3, extChange.Context.OrigLine)
+	assert.Equal(t, 12, extChange.Context.OrigCol)
+	assert.Equal(t, 2, extChange.Context.NewLine)
+	assert.Equal(t, 12, extChange.Context.NewCol)
+}
+
+func TestCompareExternalDocs_Identical(t *testing.T) {
+
+	left := `url: https://pb33f.io
+description: this is a test
+x-testing: hello`
+
+	right := `url: https://pb33f.io
+description: this is a test
+x-testing: hello`
+
+	var lNode, rNode yaml.Node
+	_ = yaml.Unmarshal([]byte(left), &lNode)
+	_ = yaml.Unmarshal([]byte(right), &rNode)
+
+	// create low level objects
+	var lDoc lowbase.ExternalDoc
+	var rDoc lowbase.ExternalDoc
+	_ = low.BuildModel(&lNode, &lDoc)
+	_ = low.BuildModel(&rNode, &rDoc)
+	_ = lDoc.Build(lNode.Content[0], nil)
+	_ = rDoc.Build(rNode.Content[0], nil)
+
+	// compare.
+	extChanges := CompareExternalDocs(&lDoc, &rDoc)
+	assert.Nil(t, extChanges)
+}