handle nil OAuthFlows, fixes #53

Tufin · Nov 3, 2021 · 5684866 · 5684866
1 parent df5619c
commit 5684866
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 2 deletions.
diff --git a/data/openapi-test1.yaml b/data/openapi-test1.yaml
@@ -283,6 +283,9 @@ components:
       type: http
       scheme: bearer
       bearerFormat: JWT 
+    AccessToken:
+      type: http
+      scheme: bearer
     OAuth:
       x-extension-test: 
       type: oauth2

diff --git a/data/openapi-test5.yaml b/data/openapi-test5.yaml
@@ -170,4 +170,12 @@ components:
       type: http
       scheme: bearer
       bearerFormat: JWT 
+    AccessToken:
+      type: oauth2
+      flows:
+        implicit:
+          authorizationUrl: https://example.com/api/oauth/dialog
+          scopes:
+            write:pets: modify pets in your account
+            read:pets": read your pets
 
diff --git a/diff/diff_test.go b/diff/diff_test.go
@@ -484,7 +484,7 @@ func TestSummary(t *testing.T) {
 	require.Equal(t, diff.SummaryDetails{0, 3, 0}, d.GetSummaryDetails(diff.HeadersDetail))
 	require.Equal(t, diff.SummaryDetails{0, 1, 0}, d.GetSummaryDetails(diff.RequestBodiesDetail))
 	require.Equal(t, diff.SummaryDetails{0, 1, 0}, d.GetSummaryDetails(diff.ResponsesDetail))
-	require.Equal(t, diff.SummaryDetails{0, 2, 0}, d.GetSummaryDetails(diff.SecuritySchemesDetail))
+	require.Equal(t, diff.SummaryDetails{0, 3, 0}, d.GetSummaryDetails(diff.SecuritySchemesDetail))
 	require.Equal(t, diff.SummaryDetails{}, d.GetSummaryDetails(diff.ExamplesDetail))
 	require.Equal(t, diff.SummaryDetails{}, d.GetSummaryDetails(diff.LinksDetail))
 	require.Equal(t, diff.SummaryDetails{}, d.GetSummaryDetails(diff.CallbacksDetail))
@@ -503,7 +503,7 @@ func TestSummary2(t *testing.T) {
 	require.Equal(t, diff.SummaryDetails{0, 3, 0}, d.GetSummaryDetails(diff.HeadersDetail))
 	require.Equal(t, diff.SummaryDetails{0, 0, 1}, d.GetSummaryDetails(diff.RequestBodiesDetail))
 	require.Equal(t, diff.SummaryDetails{0, 1, 0}, d.GetSummaryDetails(diff.ResponsesDetail))
-	require.Equal(t, diff.SummaryDetails{0, 1, 1}, d.GetSummaryDetails(diff.SecuritySchemesDetail))
+	require.Equal(t, diff.SummaryDetails{0, 2, 1}, d.GetSummaryDetails(diff.SecuritySchemesDetail))
 	require.Equal(t, diff.SummaryDetails{1, 0, 0}, d.GetSummaryDetails(diff.ExamplesDetail))
 	require.Equal(t, diff.SummaryDetails{1, 0, 0}, d.GetSummaryDetails(diff.LinksDetail))
 	require.Equal(t, diff.SummaryDetails{1, 0, 0}, d.GetSummaryDetails(diff.CallbacksDetail))
@@ -537,6 +537,11 @@ func TestModifiedSecurityRequirement(t *testing.T) {
 		"write:pets")
 }
 
+func TestAddedSecurityOAuthFlows(t *testing.T) {
+	require.True(t,
+		d(t, diff.NewConfig(), 1, 5).ComponentsDiff.SecuritySchemesDiff.Modified["AccessToken"].OAuthFlowsDiff.Added)
+}
+
 func TestOAS31(t *testing.T) {
 	loader := openapi3.NewLoader()
 

diff --git a/diff/oauth_flows.go b/diff/oauth_flows.go
@@ -4,6 +4,8 @@ import "github.com/getkin/kin-openapi/openapi3"
 
 // OAuthFlowsDiff describes the changes between a pair of oauth flows objects: https://swagger.io/specification/#oauth-flows-object
 type OAuthFlowsDiff struct {
+	Added                 bool            `json:"added,omitempty" yaml:"added,omitempty"`
+	Deleted               bool            `json:"deleted,omitempty" yaml:"deleted,omitempty"`
 	ExtensionsDiff        *ExtensionsDiff `json:"extensions,omitempty" yaml:"extensions,omitempty"`
 	ImplicitDiff          *OAuthFlowDiff  `json:"implicit,omitempty" yaml:"implicit,omitempty"`
 	PasswordDiff          *OAuthFlowDiff  `json:"password,omitempty" yaml:"password,omitempty"`
@@ -30,6 +32,18 @@ func getOAuthFlowsDiffInternal(config *Config, flows1, flows2 *openapi3.OAuthFlo
 		return nil
 	}
 
+	if flows1 == nil && flows2 != nil {
+		return &OAuthFlowsDiff{
+			Added: true,
+		}
+	}
+
+	if flows1 != nil && flows2 == nil {
+		return &OAuthFlowsDiff{
+			Deleted: true,
+		}
+	}
+
 	result := OAuthFlowsDiff{}
 
 	result.ExtensionsDiff = getExtensionsDiff(config, flows1.ExtensionProps, flows2.ExtensionProps)