mirror of
https://github.com/LukeHagar/libopenapi.git
synced 2025-12-10 04:20:24 +00:00
4b30fe3622
Self induced pain on some of this by changing the design between v2 and v3 (not sure why split one into a slice and not the other). Too many herbs, oh well. Perhaps a refactor down the road will help. The v2 model is inaccurate, not the v3, so... well, who cares. Death to swagger!
536 lines
12 KiB
Go
536 lines
12 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/v2"
|
|
"github.com/pb33f/libopenapi/datamodel/low/v3"
|
|
"github.com/stretchr/testify/assert"
|
|
"gopkg.in/yaml.v3"
|
|
"testing"
|
|
)
|
|
|
|
func TestCompareSecurityRequirement_V2(t *testing.T) {
|
|
|
|
left := `auth:
|
|
- pizza
|
|
- pie`
|
|
|
|
right := `auth:
|
|
- pie
|
|
- pizza`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v2.SecurityRequirement
|
|
var rDoc v2.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV2(&lDoc, &rDoc)
|
|
assert.Nil(t, extChanges)
|
|
}
|
|
|
|
func TestCompareSecurityRequirement_NewReq_V2(t *testing.T) {
|
|
|
|
left := `tip:
|
|
- tap
|
|
auth:
|
|
- pizza
|
|
- pie`
|
|
|
|
right := `auth:
|
|
- pie
|
|
- pizza
|
|
tip:
|
|
- tap
|
|
biscuit:
|
|
- digestive`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v2.SecurityRequirement
|
|
var rDoc v2.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV2(&lDoc, &rDoc)
|
|
assert.Equal(t, 1, extChanges.TotalChanges())
|
|
assert.Equal(t, 0, extChanges.TotalBreakingChanges())
|
|
assert.Equal(t, ObjectAdded, extChanges.Changes[0].ChangeType)
|
|
assert.Equal(t, "biscuit", extChanges.Changes[0].NewObject)
|
|
}
|
|
|
|
func TestCompareSecurityRequirement_RemoveReq_V2(t *testing.T) {
|
|
|
|
left := `auth:
|
|
- pizza
|
|
- pie`
|
|
|
|
right := `auth:
|
|
- pie
|
|
- pizza
|
|
biscuit:
|
|
- digestive`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v2.SecurityRequirement
|
|
var rDoc v2.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV2(&rDoc, &lDoc)
|
|
assert.Equal(t, 1, extChanges.TotalChanges())
|
|
assert.Equal(t, 1, extChanges.TotalBreakingChanges())
|
|
}
|
|
|
|
func TestCompareSecurityRequirement_SwapOut_V2(t *testing.T) {
|
|
|
|
left := `cheese:
|
|
- pizza
|
|
- pie
|
|
biscuit:
|
|
- digestive`
|
|
|
|
right := `bread:
|
|
- pie
|
|
- pizza
|
|
milk:
|
|
- digestive`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v2.SecurityRequirement
|
|
var rDoc v2.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV2(&lDoc, &rDoc)
|
|
assert.Equal(t, 4, extChanges.TotalChanges())
|
|
assert.Equal(t, 2, extChanges.TotalBreakingChanges())
|
|
assert.Equal(t, ObjectRemoved, extChanges.Changes[0].ChangeType)
|
|
assert.Equal(t, ObjectRemoved, extChanges.Changes[1].ChangeType)
|
|
assert.Equal(t, ObjectAdded, extChanges.Changes[2].ChangeType)
|
|
assert.Equal(t, ObjectAdded, extChanges.Changes[3].ChangeType)
|
|
}
|
|
|
|
func TestCompareSecurityRequirement_SwapLeft_V2(t *testing.T) {
|
|
|
|
left := `cheese:
|
|
- pizza
|
|
- pie
|
|
biscuit:
|
|
- digestive`
|
|
|
|
right := `cheese:
|
|
- pie
|
|
- pizza
|
|
milk:
|
|
- digestive`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v2.SecurityRequirement
|
|
var rDoc v2.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV2(&lDoc, &rDoc)
|
|
assert.Equal(t, 2, extChanges.TotalChanges())
|
|
assert.Equal(t, 1, extChanges.TotalBreakingChanges())
|
|
assert.Equal(t, ObjectRemoved, extChanges.Changes[0].ChangeType)
|
|
assert.Equal(t, ObjectAdded, extChanges.Changes[1].ChangeType)
|
|
}
|
|
|
|
func TestCompareSecurityRequirement_AddedRole_V2(t *testing.T) {
|
|
|
|
left := `cheese:
|
|
- pizza
|
|
- pie
|
|
biscuit:
|
|
- digestive`
|
|
|
|
right := `cheese:
|
|
- pizza
|
|
- pie
|
|
biscuit:
|
|
- digestive
|
|
- rich tea`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v2.SecurityRequirement
|
|
var rDoc v2.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV2(&lDoc, &rDoc)
|
|
assert.Equal(t, 1, extChanges.TotalChanges())
|
|
assert.Equal(t, 0, extChanges.TotalBreakingChanges())
|
|
assert.Equal(t, ObjectAdded, extChanges.Changes[0].ChangeType)
|
|
assert.Equal(t, "rich tea", extChanges.Changes[0].New)
|
|
}
|
|
|
|
func TestCompareSecurityRequirement_AddedMultiple_V2(t *testing.T) {
|
|
|
|
left := `cheese:
|
|
- pizza
|
|
- pie
|
|
biscuit:
|
|
- digestive`
|
|
|
|
right := `cheese:
|
|
- pizza
|
|
- pie
|
|
cake:
|
|
- vanilla
|
|
- choccy
|
|
biscuit:
|
|
- digestive
|
|
- rich tea`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v2.SecurityRequirement
|
|
var rDoc v2.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV2(&lDoc, &rDoc)
|
|
assert.Equal(t, 2, extChanges.TotalChanges())
|
|
assert.Equal(t, 0, extChanges.TotalBreakingChanges())
|
|
assert.Equal(t, ObjectAdded, extChanges.Changes[0].ChangeType)
|
|
}
|
|
|
|
func TestCompareSecurityRequirement_ReplaceRole_V2(t *testing.T) {
|
|
|
|
left := `cheese:
|
|
- pizza
|
|
- pie
|
|
biscuit:
|
|
- digestive`
|
|
|
|
right := `cheese:
|
|
- pizza
|
|
- pie
|
|
biscuit:
|
|
- biscotti
|
|
- rich tea`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v2.SecurityRequirement
|
|
var rDoc v2.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV2(&lDoc, &rDoc)
|
|
assert.Equal(t, 3, extChanges.TotalChanges())
|
|
assert.Equal(t, 1, extChanges.TotalBreakingChanges())
|
|
}
|
|
|
|
func TestCompareSecurityRequirement_Identical_V2(t *testing.T) {
|
|
|
|
left := `cheese:
|
|
- pizza
|
|
- pie
|
|
biscuit:
|
|
- biscotti
|
|
- rich tea`
|
|
|
|
right := `cheese:
|
|
- pizza
|
|
- pie
|
|
biscuit:
|
|
- biscotti
|
|
- rich tea`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v2.SecurityRequirement
|
|
var rDoc v2.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV2(&lDoc, &rDoc)
|
|
assert.Nil(t, extChanges)
|
|
}
|
|
|
|
func TestCompareSecurityRequirement_RemovedRole_V2(t *testing.T) {
|
|
|
|
left := `cheese:
|
|
- pizza
|
|
- pie
|
|
biscuit:
|
|
- digestive`
|
|
|
|
right := `cheese:
|
|
- pizza
|
|
- pie
|
|
biscuit:
|
|
- digestive
|
|
- rich tea`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v2.SecurityRequirement
|
|
var rDoc v2.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV2(&rDoc, &lDoc)
|
|
assert.Equal(t, 1, extChanges.TotalChanges())
|
|
assert.Equal(t, 1, extChanges.TotalBreakingChanges())
|
|
assert.Equal(t, ObjectRemoved, extChanges.Changes[0].ChangeType)
|
|
assert.Equal(t, "rich tea", extChanges.Changes[0].Original)
|
|
}
|
|
|
|
func TestCompareSecurityRequirement_Add_V2(t *testing.T) {
|
|
|
|
left := `
|
|
biscuit:
|
|
- biscotti
|
|
- rich tea`
|
|
|
|
right := `punch:
|
|
- nice
|
|
cheese:
|
|
- pizza
|
|
- pie
|
|
biscuit:
|
|
- biscotti
|
|
- rich tea`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v2.SecurityRequirement
|
|
var rDoc v2.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV2(&lDoc, &rDoc)
|
|
assert.Equal(t, 2, extChanges.TotalChanges())
|
|
assert.Equal(t, 0, extChanges.TotalBreakingChanges())
|
|
assert.Equal(t, ObjectAdded, extChanges.Changes[0].ChangeType)
|
|
}
|
|
|
|
func TestCompareSecurityRequirement_V3(t *testing.T) {
|
|
|
|
left := `- auth:
|
|
- pizza
|
|
- pie`
|
|
|
|
right := `- auth:
|
|
- pie
|
|
- pizza`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v3.SecurityRequirement
|
|
var rDoc v3.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV3(&lDoc, &rDoc)
|
|
assert.Nil(t, extChanges)
|
|
}
|
|
|
|
func TestCompareSecurityRequirement_V3_AddARole(t *testing.T) {
|
|
|
|
left := `- auth:
|
|
- pizza
|
|
- pie`
|
|
|
|
right := `- auth:
|
|
- pie
|
|
- pizza
|
|
- beer`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v3.SecurityRequirement
|
|
var rDoc v3.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV3(&lDoc, &rDoc)
|
|
assert.Equal(t, 1, extChanges.TotalChanges())
|
|
assert.Equal(t, 0, extChanges.TotalBreakingChanges())
|
|
assert.Equal(t, ObjectAdded, extChanges.Changes[0].ChangeType)
|
|
}
|
|
|
|
func TestCompareSecurityRequirement_V3_RemoveRole(t *testing.T) {
|
|
|
|
left := `- auth:
|
|
- pizza
|
|
- pie`
|
|
|
|
right := `- auth:
|
|
- pie
|
|
- pizza
|
|
- beer`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v3.SecurityRequirement
|
|
var rDoc v3.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV3(&rDoc, &lDoc)
|
|
assert.Equal(t, 1, extChanges.TotalChanges())
|
|
assert.Equal(t, 1, extChanges.TotalBreakingChanges())
|
|
assert.Equal(t, ObjectRemoved, extChanges.Changes[0].ChangeType)
|
|
}
|
|
|
|
func TestCompareSecurityRequirement_V3_AddAReq(t *testing.T) {
|
|
|
|
left := `- auth:
|
|
- pizza
|
|
- pie`
|
|
|
|
right := `- auth:
|
|
- pie
|
|
- pizza
|
|
- coffee:
|
|
- filter
|
|
- espresso`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v3.SecurityRequirement
|
|
var rDoc v3.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV3(&lDoc, &rDoc)
|
|
assert.Equal(t, 1, extChanges.TotalChanges())
|
|
assert.Equal(t, 0, extChanges.TotalBreakingChanges())
|
|
assert.Equal(t, ObjectAdded, extChanges.Changes[0].ChangeType)
|
|
}
|
|
|
|
func TestCompareSecurityRequirement_V3_RemoveAReq(t *testing.T) {
|
|
|
|
left := `- coffee:
|
|
- filter
|
|
- espresso`
|
|
|
|
right := `- coffee:
|
|
- filter
|
|
- espresso
|
|
- auth:
|
|
- pizza
|
|
- pie`
|
|
|
|
var lNode, rNode yaml.Node
|
|
_ = yaml.Unmarshal([]byte(left), &lNode)
|
|
_ = yaml.Unmarshal([]byte(right), &rNode)
|
|
|
|
// create low level objects
|
|
var lDoc v3.SecurityRequirement
|
|
var rDoc v3.SecurityRequirement
|
|
_ = low.BuildModel(&lNode, &lDoc)
|
|
_ = low.BuildModel(&rNode, &rDoc)
|
|
_ = lDoc.Build(lNode.Content[0], nil)
|
|
_ = rDoc.Build(rNode.Content[0], nil)
|
|
|
|
// compare
|
|
extChanges := CompareSecurityRequirementV3(&rDoc, &lDoc)
|
|
assert.Equal(t, 1, extChanges.TotalChanges())
|
|
assert.Equal(t, 1, extChanges.TotalBreakingChanges())
|
|
assert.Equal(t, ObjectRemoved, extChanges.Changes[0].ChangeType)
|
|
}
|