Wiring up responses into what-changed feature

Building tests and hashing functions.

what-changed/model/response.go

@@ -65,6 +65,14 @@ func (r *ResponseChanges) TotalBreakingChanges() int {
 	return c
 }
 
+func CompareResponseV2(l, r *v2.Response) *ResponseChanges {
+	return CompareResponse(l, r)
+}
+
+func CompareResponseV3(l, r *v3.Response) *ResponseChanges {
+	return CompareResponse(l, r)
+}
+
 func CompareResponse(l, r any) *ResponseChanges {
 
 	var changes []*Change

what-changed/model/responses.go

@@ -0,0 +1,108 @@
+// 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/v2"
+	"github.com/pb33f/libopenapi/datamodel/low/v3"
+	"reflect"
+)
+
+type ResponsesChanges struct {
+	PropertyChanges
+	ResponseChanges  map[string]*ResponseChanges
+	DefaultChanges   *ResponseChanges
+	ExtensionChanges *ExtensionChanges
+}
+
+func (r *ResponsesChanges) TotalChanges() int {
+	c := r.PropertyChanges.TotalChanges()
+	for k := range r.ResponseChanges {
+		c += r.ResponseChanges[k].TotalChanges()
+	}
+	if r.ExtensionChanges != nil {
+		c += r.ExtensionChanges.TotalBreakingChanges()
+	}
+	return c
+}
+
+func (r *ResponsesChanges) TotalBreakingChanges() int {
+	c := r.PropertyChanges.TotalBreakingChanges()
+	for k := range r.ResponseChanges {
+		c += r.ResponseChanges[k].TotalChanges()
+	}
+	return c
+}
+
+func CompareResponses(l, r any) *ResponsesChanges {
+
+	var changes []*Change
+
+	rc := new(ResponsesChanges)
+
+	if reflect.TypeOf(&v2.Responses{}) == reflect.TypeOf(l) && reflect.TypeOf(&v2.Responses{}) == reflect.TypeOf(r) {
+
+		lResponses := l.(*v2.Responses)
+		rResponses := r.(*v2.Responses)
+
+		// perform hash check to avoid further processing
+		if low.AreEqual(lResponses, rResponses) {
+			return nil
+		}
+
+		if !lResponses.Default.IsEmpty() && !rResponses.Default.IsEmpty() {
+			rc.DefaultChanges = CompareResponse(lResponses.Default.Value, rResponses.Default.Value)
+		}
+		if !lResponses.Default.IsEmpty() && rResponses.Default.IsEmpty() {
+			CreateChange(&changes, ObjectRemoved, v3.DefaultLabel,
+				lResponses.Default.ValueNode, nil, true,
+				lResponses.Default.Value, nil)
+		}
+		if lResponses.Default.IsEmpty() && !rResponses.Default.IsEmpty() {
+			CreateChange(&changes, ObjectAdded, v3.DefaultLabel,
+				nil, rResponses.Default.ValueNode, false,
+				nil, lResponses.Default.Value)
+		}
+
+		rc.ResponseChanges = CheckMapForChanges(lResponses.Codes, rResponses.Codes,
+			&changes, v3.CodesLabel, CompareResponseV2)
+
+		rc.ExtensionChanges = CompareExtensions(lResponses.Extensions, rResponses.Extensions)
+	}
+
+	if reflect.TypeOf(&v3.Responses{}) == reflect.TypeOf(l) && reflect.TypeOf(&v3.Responses{}) == reflect.TypeOf(r) {
+
+		lResponses := l.(*v3.Responses)
+		rResponses := r.(*v3.Responses)
+
+		// perform hash check to avoid further processing
+		if low.AreEqual(lResponses, rResponses) {
+			return nil
+		}
+
+		if !lResponses.Default.IsEmpty() && !rResponses.Default.IsEmpty() {
+			rc.DefaultChanges = CompareResponse(lResponses.Default.Value, rResponses.Default.Value)
+		}
+		if !lResponses.Default.IsEmpty() && rResponses.Default.IsEmpty() {
+			CreateChange(&changes, ObjectRemoved, v3.DefaultLabel,
+				lResponses.Default.ValueNode, nil, true,
+				lResponses.Default.Value, nil)
+		}
+		if lResponses.Default.IsEmpty() && !rResponses.Default.IsEmpty() {
+			CreateChange(&changes, ObjectAdded, v3.DefaultLabel,
+				nil, rResponses.Default.ValueNode, false,
+				nil, lResponses.Default.Value)
+		}
+
+		rc.ResponseChanges = CheckMapForChanges(lResponses.Codes, rResponses.Codes,
+			&changes, v3.CodesLabel, CompareResponseV3)
+
+		rc.ExtensionChanges = CompareExtensions(lResponses.Extensions, rResponses.Extensions)
+
+	}
+
+	rc.Changes = changes
+	return rc
+}

what-changed/model/responses_test.go

@@ -0,0 +1,221 @@
+// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
+// SPDX-License-Identifier: MIT
+
+package model
+
+import (
+	"github.com/pb33f/libopenapi/datamodel/low"
+	v2 "github.com/pb33f/libopenapi/datamodel/low/v2"
+	"github.com/stretchr/testify/assert"
+	"gopkg.in/yaml.v3"
+	"testing"
+)
+
+func TestCompareResponses_V2(t *testing.T) {
+
+	left := `default:
+  schema:
+    type: string
+200:
+  description: OK response
+  schema:
+    type: string
+404:
+  description: not found response
+  schema:
+    type: string`
+
+	right := left
+
+	var lNode, rNode yaml.Node
+	_ = yaml.Unmarshal([]byte(left), &lNode)
+	_ = yaml.Unmarshal([]byte(right), &rNode)
+
+	// create low level objects
+	var lDoc v2.Responses
+	var rDoc v2.Responses
+	_ = low.BuildModel(&lNode, &lDoc)
+	_ = low.BuildModel(&rNode, &rDoc)
+	_ = lDoc.Build(lNode.Content[0], nil)
+	_ = rDoc.Build(rNode.Content[0], nil)
+
+	extChanges := CompareResponses(&lDoc, &rDoc)
+	assert.Nil(t, extChanges)
+}
+
+func TestCompareResponses_V2_ModifyCode(t *testing.T) {
+
+	left := `200:
+  description: OK response
+  schema:
+    type: int
+404:
+  description: not found response
+  schema:
+    type: int
+x-ting: tang`
+
+	right := `200:
+  description: OK response
+  schema:
+    type: string
+404:
+  description: not found response
+  schema:
+    type: string
+x-ting: tang`
+
+	var lNode, rNode yaml.Node
+	_ = yaml.Unmarshal([]byte(left), &lNode)
+	_ = yaml.Unmarshal([]byte(right), &rNode)
+
+	// create low level objects
+	var lDoc v2.Responses
+	var rDoc v2.Responses
+	_ = low.BuildModel(&lNode, &lDoc)
+	_ = low.BuildModel(&rNode, &rDoc)
+	_ = lDoc.Build(lNode.Content[0], nil)
+	_ = rDoc.Build(rNode.Content[0], nil)
+
+	extChanges := CompareResponses(&lDoc, &rDoc)
+	assert.Equal(t, 2, extChanges.TotalChanges())
+	assert.Equal(t, 2, extChanges.TotalBreakingChanges())
+	assert.Equal(t, Modified, extChanges.ResponseChanges["404"].SchemaChanges.Changes[0].ChangeType)
+	assert.Equal(t, Modified, extChanges.ResponseChanges["200"].SchemaChanges.Changes[0].ChangeType)
+}
+
+func TestCompareResponses_V2_AddSchema(t *testing.T) {
+	left := `200:
+  description: OK response
+  schema:
+    type: int
+404:
+  description: not found response
+  schema:
+    type: int`
+
+	right := `200:
+  description: OK response
+404:
+  description: not found response
+  schema:
+    type: int`
+
+	var lNode, rNode yaml.Node
+	_ = yaml.Unmarshal([]byte(left), &lNode)
+	_ = yaml.Unmarshal([]byte(right), &rNode)
+
+	// create low level objects
+	var lDoc v2.Responses
+	var rDoc v2.Responses
+	_ = low.BuildModel(&lNode, &lDoc)
+	_ = low.BuildModel(&rNode, &rDoc)
+	_ = lDoc.Build(lNode.Content[0], nil)
+	_ = rDoc.Build(rNode.Content[0], nil)
+
+	extChanges := CompareResponses(&rDoc, &lDoc)
+	assert.Equal(t, 1, extChanges.TotalChanges())
+	assert.Equal(t, 1, extChanges.TotalBreakingChanges())
+	assert.Equal(t, ObjectAdded, extChanges.ResponseChanges["200"].Changes[0].ChangeType)
+}
+
+func TestCompareResponses_V2_RemoveSchema(t *testing.T) {
+	left := `200:
+  description: OK response
+  schema:
+    type: int
+404:
+  description: not found response
+  schema:
+    type: int`
+
+	right := `200:
+  description: OK response
+404:
+  description: not found response
+  schema:
+    type: int`
+
+	var lNode, rNode yaml.Node
+	_ = yaml.Unmarshal([]byte(left), &lNode)
+	_ = yaml.Unmarshal([]byte(right), &rNode)
+
+	// create low level objects
+	var lDoc v2.Responses
+	var rDoc v2.Responses
+	_ = low.BuildModel(&lNode, &lDoc)
+	_ = low.BuildModel(&rNode, &rDoc)
+	_ = lDoc.Build(lNode.Content[0], nil)
+	_ = rDoc.Build(rNode.Content[0], nil)
+
+	extChanges := CompareResponses(&lDoc, &rDoc)
+	assert.Equal(t, 1, extChanges.TotalChanges())
+	assert.Equal(t, 1, extChanges.TotalBreakingChanges())
+	assert.Equal(t, ObjectRemoved, extChanges.ResponseChanges["200"].Changes[0].ChangeType)
+}
+
+func TestCompareResponses_V2_AddDefault(t *testing.T) {
+	left := `200:
+  description: OK response
+  schema:
+    type: int`
+
+	right := `200:
+  description: OK response
+  schema:
+    type: int
+default:
+  description: not found response
+  schema:
+    type: int`
+
+	var lNode, rNode yaml.Node
+	_ = yaml.Unmarshal([]byte(left), &lNode)
+	_ = yaml.Unmarshal([]byte(right), &rNode)
+
+	// create low level objects
+	var lDoc v2.Responses
+	var rDoc v2.Responses
+	_ = low.BuildModel(&lNode, &lDoc)
+	_ = low.BuildModel(&rNode, &rDoc)
+	_ = lDoc.Build(lNode.Content[0], nil)
+	_ = rDoc.Build(rNode.Content[0], nil)
+
+	extChanges := CompareResponses(&lDoc, &rDoc)
+	assert.Equal(t, 1, extChanges.TotalChanges())
+	assert.Equal(t, 0, extChanges.TotalBreakingChanges())
+	assert.Equal(t, ObjectAdded, extChanges.Changes[0].ChangeType)
+}
+
+func TestCompareResponses_V2_RemoveDefault(t *testing.T) {
+	left := `200:
+  description: OK response
+  schema:
+    type: int`
+
+	right := `200:
+  description: OK response
+  schema:
+    type: int
+default:
+  description: not found response
+  schema:
+    type: int`
+
+	var lNode, rNode yaml.Node
+	_ = yaml.Unmarshal([]byte(left), &lNode)
+	_ = yaml.Unmarshal([]byte(right), &rNode)
+
+	// create low level objects
+	var lDoc v2.Responses
+	var rDoc v2.Responses
+	_ = low.BuildModel(&lNode, &lDoc)
+	_ = low.BuildModel(&rNode, &rDoc)
+	_ = lDoc.Build(lNode.Content[0], nil)
+	_ = rDoc.Build(rNode.Content[0], nil)
+
+	extChanges := CompareResponses(&rDoc, &lDoc)
+	assert.Equal(t, 1, extChanges.TotalChanges())
+	assert.Equal(t, 1, extChanges.TotalBreakingChanges())
+	assert.Equal(t, ObjectRemoved, extChanges.Changes[0].ChangeType)
+}