add Empty check to jsonPatch (#520)

Co-authored-by: Reuven <rh@tufin.com>
Tufin · Apr 8, 2024 · c5dd33f · c5dd33f
1 parent 070b485
commit c5dd33f
Show file tree

Hide file tree

Showing 4 changed files with 114 additions and 1 deletion.
diff --git a/data/extensions/openapi-2.json b/data/extensions/openapi-2.json
@@ -0,0 +1,95 @@
+{
+  "openapi": "3.0.0",
+  "paths": {
+    "/v1alpha1/generic": {
+      "put": {
+        "operationId": "GenericController_request",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "resources": {
+                    "type": "array",
+                    "minItems": 1,
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "id": {
+                          "type": "string"
+                        },
+                        "kind": {
+                          "oneOf": [
+                            {
+                              "type": "string",
+                              "enum": [
+                                "foo",
+                                "bar",
+                                "fizz",
+                                "buzz"
+                              ],
+                              "x-enumNames": [
+                                "FOO",
+                                "BAR",
+                                "FIZZ",
+                                "BUZZ"
+                              ]
+                            },
+                            {
+                              "type": "string",
+                              "enum": [
+                                "self"
+                              ],
+                              "x-enumNames": [
+                                "SELF"
+                              ]
+                            }
+                          ]
+                        }
+                      },
+                      "required": [
+                        "id",
+                        "kind"
+                      ]
+                    }
+                  }
+                },
+                "required": [
+                  "resources"
+                ]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "number"
+                    }
+                  },
+                  "required": [
+                    "id"
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "tags": []
+      }
+    }
+  },
+  "tags": [],
+  "servers": [],
+  "components": {
+    "schemas": {}
+  }
+}
diff --git a/diff/diff_test.go b/diff/diff_test.go
@@ -915,3 +915,14 @@ func TestDiff_ExtensionsInvalidImplicit(t *testing.T) {
 	_, _, err = diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s1)
 	require.EqualError(t, err, "json: unsupported type: chan int")
 }
+
+func TestDiff_ExtensionsIssue519(t *testing.T) {
+	loader := openapi3.NewLoader()
+
+	s1, err := load.NewSpecInfo(loader, load.NewSource("../data/extensions/openapi-2.json"))
+	require.NoError(t, err)
+
+	d, _, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s1)
+	require.NoError(t, err)
+	require.Empty(t, d)
+}
diff --git a/diff/interface_map_diff.go b/diff/interface_map_diff.go
@@ -56,7 +56,9 @@ func getInterfaceMapDiffInternal(map1, map2 InterfaceMap) (*InterfaceMapDiff, er
 			if err != nil {
 				return nil, err
 			}
-			result.Modified[name1] = patch
+			if !patch.Empty() {
+				result.Modified[name1] = patch
+			}
 		} else {
 			result.Deleted = append(result.Deleted, name1)
 		}

diff --git a/diff/json_diff.go b/diff/json_diff.go
@@ -7,6 +7,11 @@ import (
 // jsonPatch is a wrapper to jsondiff.jsonPatch with proper serialization for json and yaml
 type jsonPatch []*jsonOperation
 
+// Empty indicates whether a change was found in this element
+func (p jsonPatch) Empty() bool {
+	return len(p) == 0
+}
+
 // jsonOperation is a wrapper to jsondiff.jsonOperation with proper serialization for json and yaml
 type jsonOperation struct {
 	OldValue interface{} `json:"oldValue" yaml:"oldValue"`