v2 and v3 security scheme is now in place for what changed

full converage for security, with confidence.
2025-12-10 04:20:24 +00:00 · 2022-10-24 11:33:06 -04:00
parent c78cbd5cd0
commit 9c3c935530
6 changed files with 1044 additions and 1 deletions
--- a/what-changed/model/security_scheme.go
+++ b/what-changed/model/security_scheme.go
@@ -0,0 +1,148 @@
+// 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 SecuritySchemeChanges struct {
+	PropertyChanges
+	ExtensionChanges *ExtensionChanges
+	// v3
+	OAuthFlowChanges *OAuthFlowsChanges
+	// v2
+	ScopesChanges *ScopesChanges
+}
+
+func (ss *SecuritySchemeChanges) TotalChanges() int {
+	c := ss.PropertyChanges.TotalChanges()
+	if ss.OAuthFlowChanges != nil {
+		c += ss.OAuthFlowChanges.TotalChanges()
+	}
+	if ss.ScopesChanges != nil {
+		c += ss.ScopesChanges.TotalChanges()
+	}
+	if ss.ExtensionChanges != nil {
+		c += ss.ExtensionChanges.TotalChanges()
+	}
+	return c
+}
+
+func (ss *SecuritySchemeChanges) TotalBreakingChanges() int {
+	c := ss.PropertyChanges.TotalBreakingChanges()
+	if ss.OAuthFlowChanges != nil {
+		c += ss.OAuthFlowChanges.TotalBreakingChanges()
+	}
+	if ss.ScopesChanges != nil {
+		c += ss.ScopesChanges.TotalBreakingChanges()
+	}
+	return c
+}
+
+func CompareSecuritySchemes(l, r any) *SecuritySchemeChanges {
+
+	var props []*PropertyCheck
+	var changes []*Change
+
+	sc := new(SecuritySchemeChanges)
+	if reflect.TypeOf(&v2.SecurityScheme{}) == reflect.TypeOf(l) &&
+		reflect.TypeOf(&v2.SecurityScheme{}) == reflect.TypeOf(r) {
+
+		lSS := l.(*v2.SecurityScheme)
+		rSS := r.(*v2.SecurityScheme)
+
+		if low.AreEqual(lSS, rSS) {
+			return nil
+		}
+		addPropertyCheck(&props, lSS.Type.ValueNode, rSS.Type.ValueNode,
+			lSS.Type.Value, rSS.Type.Value, &changes, v3.TypeLabel, true)
+
+		addPropertyCheck(&props, lSS.Description.ValueNode, rSS.Description.ValueNode,
+			lSS.Description.Value, rSS.Description.Value, &changes, v3.DescriptionLabel, false)
+
+		addPropertyCheck(&props, lSS.Name.ValueNode, rSS.Name.ValueNode,
+			lSS.Name.Value, rSS.Name.Value, &changes, v3.NameLabel, true)
+
+		addPropertyCheck(&props, lSS.In.ValueNode, rSS.In.ValueNode,
+			lSS.In.Value, rSS.In.Value, &changes, v3.InLabel, true)
+
+		addPropertyCheck(&props, lSS.Flow.ValueNode, rSS.Flow.ValueNode,
+			lSS.Flow.Value, rSS.Flow.Value, &changes, v3.FlowLabel, true)
+
+		addPropertyCheck(&props, lSS.AuthorizationUrl.ValueNode, rSS.AuthorizationUrl.ValueNode,
+			lSS.AuthorizationUrl.Value, rSS.AuthorizationUrl.Value, &changes, v3.AuthorizationUrlLabel, true)
+
+		addPropertyCheck(&props, lSS.TokenUrl.ValueNode, rSS.TokenUrl.ValueNode,
+			lSS.TokenUrl.Value, rSS.TokenUrl.Value, &changes, v3.TokenUrlLabel, true)
+
+		if !lSS.Scopes.IsEmpty() && !rSS.Scopes.IsEmpty() {
+			if !low.AreEqual(lSS.Scopes.Value, rSS.Scopes.Value) {
+				sc.ScopesChanges = CompareScopes(lSS.Scopes.Value, rSS.Scopes.Value)
+			}
+		}
+		if lSS.Scopes.IsEmpty() && !rSS.Scopes.IsEmpty() {
+			CreateChange(&changes, ObjectAdded, v3.ScopesLabel,
+				nil, rSS.Scopes.ValueNode, false, nil, rSS.Scopes.Value)
+		}
+		if !lSS.Scopes.IsEmpty() && rSS.Scopes.IsEmpty() {
+			CreateChange(&changes, ObjectRemoved, v3.ScopesLabel,
+				lSS.Scopes.ValueNode, nil, true, lSS.Scopes.Value, nil)
+		}
+
+		sc.ExtensionChanges = CompareExtensions(lSS.Extensions, rSS.Extensions)
+	}
+
+	if reflect.TypeOf(&v3.SecurityScheme{}) == reflect.TypeOf(l) &&
+		reflect.TypeOf(&v3.SecurityScheme{}) == reflect.TypeOf(r) {
+
+		lSS := l.(*v3.SecurityScheme)
+		rSS := r.(*v3.SecurityScheme)
+
+		if low.AreEqual(lSS, rSS) {
+			return nil
+		}
+		addPropertyCheck(&props, lSS.Type.ValueNode, rSS.Type.ValueNode,
+			lSS.Type.Value, rSS.Type.Value, &changes, v3.TypeLabel, true)
+
+		addPropertyCheck(&props, lSS.Description.ValueNode, rSS.Description.ValueNode,
+			lSS.Description.Value, rSS.Description.Value, &changes, v3.DescriptionLabel, false)
+
+		addPropertyCheck(&props, lSS.Name.ValueNode, rSS.Name.ValueNode,
+			lSS.Name.Value, rSS.Name.Value, &changes, v3.NameLabel, true)
+
+		addPropertyCheck(&props, lSS.In.ValueNode, rSS.In.ValueNode,
+			lSS.In.Value, rSS.In.Value, &changes, v3.InLabel, true)
+
+		addPropertyCheck(&props, lSS.Scheme.ValueNode, rSS.Scheme.ValueNode,
+			lSS.Scheme.Value, rSS.Scheme.Value, &changes, v3.SchemeLabel, true)
+
+		addPropertyCheck(&props, lSS.BearerFormat.ValueNode, rSS.BearerFormat.ValueNode,
+			lSS.BearerFormat.Value, rSS.BearerFormat.Value, &changes, v3.SchemeLabel, false)
+
+		addPropertyCheck(&props, lSS.OpenIdConnectUrl.ValueNode, rSS.OpenIdConnectUrl.ValueNode,
+			lSS.OpenIdConnectUrl.Value, rSS.OpenIdConnectUrl.Value, &changes, v3.OpenIdConnectUrlLabel, false)
+
+		if !lSS.Flows.IsEmpty() && !rSS.Flows.IsEmpty() {
+			if !low.AreEqual(lSS.Flows.Value, rSS.Flows.Value) {
+				sc.OAuthFlowChanges = CompareOAuthFlows(lSS.Flows.Value, rSS.Flows.Value)
+			}
+		}
+		if lSS.Flows.IsEmpty() && !rSS.Flows.IsEmpty() {
+			CreateChange(&changes, ObjectAdded, v3.FlowsLabel,
+				nil, rSS.Flows.ValueNode, false, nil, rSS.Flows.Value)
+		}
+		if !lSS.Flows.IsEmpty() && rSS.Flows.IsEmpty() {
+			CreateChange(&changes, ObjectRemoved, v3.ScopesLabel,
+				lSS.Flows.ValueNode, nil, true, lSS.Flows.Value, nil)
+		}
+		sc.ExtensionChanges = CompareExtensions(lSS.Extensions, rSS.Extensions)
+	}
+	CheckProperties(props)
+	sc.Changes = changes
+	return sc
+}