fix(plugins): properly compare against foreign keys

Kong · Jul 6, 2023 · 2fee027 · 2fee027
1 parent 2e1aa14
commit 2fee027
Show file tree

Hide file tree

Showing 2 changed files with 114 additions and 2 deletions.
diff --git a/plugins/plugins.go b/plugins/plugins.go
@@ -106,7 +106,7 @@ func (ts *Plugger) SetSelectors(selectors []string) error {
 	ts.selectors = compiledSelectors
 	ts.pluginOwners = nil // clear previous JSONpointer search results
 	ts.pluginMain = nil
-	logbasics.Debug("successfully compiled JSONpaths")
+	logbasics.Debug("successfully compiled JSONpaths", selectors)
 	return nil
 }
 
@@ -220,6 +220,9 @@ func (ts *Plugger) addPluginToOwners(newPlugin *yaml.Node, overwrite bool) error
 		nameNode := yamlbasics.GetFieldValue(newPlugin, "name")
 		if nameNode != nil && nameNode.Kind == yaml.ScalarNode {
 			pluginName = nameNode.Value
+			logbasics.Info("adding plugin", "name", pluginName)
+		} else {
+			logbasics.Info("plugin has no name", "plugin", newPlugin)
 		}
 	}
 
@@ -272,7 +275,7 @@ func (ts *Plugger) addPluginToOwners(newPlugin *yaml.Node, overwrite bool) error
 
 		// findPlugin the plugin in the owner
 		var findPlugin yamlbasics.YamlArrayIterator
-		if owner == ts.pluginMain {
+		if ownerPluginArray == ts.pluginMain {
 			findPlugin = yamlbasics.Search(ownerPluginArray, mainSearcher)
 		} else {
 			findPlugin = yamlbasics.Search(ownerPluginArray, genericSearcher)

diff --git a/plugins/plugins_test.go b/plugins/plugins_test.go
@@ -228,6 +228,115 @@ var _ = Describe("plugins", func() {
 			}`))
 		})
 
+		It("adds plugin with non-matching foreign keys in the main array", func() {
+			dataInput := []byte(`
+				{ "services": [
+					{ "name": "service1" }
+				],
+				"plugins": [
+					{
+						"name": "plugin1",
+						"service": "service1",
+						"route": "route1",
+						"consumer": "consumer1",
+						"consumer_group": "consumer_group1"
+					}
+				]
+			}`)
+
+			plugger := plugins.Plugger{}
+			plugger.SetData(filebasics.MustDeserialize(&dataInput))
+			plugger.SetSelectors([]string{
+				"$",
+			})
+			err := plugger.AddPlugin(map[string]interface{}{
+				"name":           "plugin1",
+				"service":        "service2", // this one is different
+				"route":          "route1",
+				"consumer":       "consumer1",
+				"consumer_group": "consumer_group1",
+			}, true)
+			Expect(err).ToNot(HaveOccurred())
+
+			result := *(filebasics.MustSerialize(plugger.GetData(), filebasics.OutputFormatJSON))
+			Expect(result).To(MatchJSON(`
+				{
+					"services": [
+						{
+							"name": "service1"
+						}
+					],
+					"plugins": [
+						{
+							"name": "plugin1",
+							"service": "service1",
+							"route": "route1",
+							"consumer": "consumer1",
+							"consumer_group": "consumer_group1"
+						},
+						{
+							"name": "plugin1",
+							"service": "service2",
+							"route": "route1",
+							"consumer": "consumer1",
+							"consumer_group": "consumer_group1"
+						}
+					]
+			}`))
+		})
+
+		It("overwrites plugin with matching foreign keys in the main array", func() {
+			dataInput := []byte(`
+				{ "services": [
+					{ "name": "service1" }
+				],
+				"plugins": [
+					{
+						"name": "plugin1",
+						"service": "service1",
+						"route": "route1",
+						"consumer": "consumer1",
+						"consumer_group": "consumer_group1"
+					}
+				]
+			}`)
+
+			plugger := plugins.Plugger{}
+			plugger.SetData(filebasics.MustDeserialize(&dataInput))
+			plugger.SetSelectors([]string{
+				"$",
+			})
+			err := plugger.AddPlugin(map[string]interface{}{
+				"name":           "plugin1",
+				"service":        "service1",
+				"route":          "route1",
+				"consumer":       "consumer1",
+				"consumer_group": "consumer_group1",
+				"plugin":         "was overwritten",
+			}, true)
+			Expect(err).ToNot(HaveOccurred())
+
+			result := *(filebasics.MustSerialize(plugger.GetData(), filebasics.OutputFormatJSON))
+			Expect(result).To(MatchJSON(`
+				{
+					"services": [
+						{
+							"name": "service1"
+						}
+					],
+					"plugins": [
+						{
+							"name": "plugin1",
+							"service": "service1",
+							"route": "route1",
+							"consumer": "consumer1",
+							"consumer_group": "consumer_group1",
+							"plugin": "was overwritten"
+						}
+					]
+			}`))
+		})
+
 		It("fails to add plugin to nested array with service foreign key", func() {
 			dataInput := []byte(`
 				{ "services": [