feat: added partials to consumer-group plugins (#360)

* feat: added tls_sans property for service

* tests: added unit and integration tests for services with tls_sans

* tests: added dump tests for service tls sans

* feat: added partials to consumer-group plugins

* tests: added integration test for cg plugin with partial

Author: Prashansa-K

pkg/file/builder.go

@@ -254,7 +254,8 @@ func (b *stateBuilder) ingestConsumerGroupScopedPlugins(cg FConsumerGroupObject)
 				ConsumerGroup: &kong.ConsumerGroup{
 					ID: cg.ID,
 				},
-				Tags: plugin.Tags,
+				Partials: plugin.Partials,
+				Tags:     plugin.Tags,
 			},
 			ConfigSource: plugin.ConfigSource,
 		})

pkg/file/kong_json_schema.json

@@ -390,6 +390,12 @@
             "type": "string"
           },
           "type": "array"
+        },
+        "partials": {
+          "items": {
+            "type": "object"
+          },
+          "type": "array"
         }
       },
       "additionalProperties": false,

pkg/file/writer.go

@@ -878,10 +878,11 @@ func populateConsumerGroups(kongState *state.KongState, file *Content,
 					utils.ZeroOutID(plugin, plugin.Name, config.WithID)
 					utils.ZeroOutID(plugin.ConsumerGroup, plugin.ConsumerGroup.Name, config.WithID)
 					group.Plugins = append(group.Plugins, &kong.ConsumerGroupPlugin{
-						ID:     plugin.ID,
-						Name:   plugin.Name,
-						Config: plugin.Config,
-						Tags:   plugin.Tags,
+						ID:       plugin.ID,
+						Name:     plugin.Name,
+						Config:   plugin.Config,
+						Tags:     plugin.Tags,
+						Partials: plugin.Partials,
 					})
 				}
 			}

pkg/state/builder.go

@@ -138,6 +138,7 @@ func buildKong(kongState *KongState, raw *utils.KongRawState) error {
 						Config:        p.Config,
 						ConsumerGroup: cg.ConsumerGroup,
 						ConfigSource:  p.ConfigSource,
+						Partials:      p.Partials,
 						Tags:          p.Tags,
 					},
 				},

tests/integration/sync_test.go

@@ -8588,6 +8588,49 @@ func Test_Sync_Partials_Plugins(t *testing.T) {
 		require.Error(t, err)
 		assert.ErrorContains(t, err, "partial for plugin rate-limiting-advanced: missing required fields - name or id")
 	})
+
+	t.Run("partial linking with a consumer-group scoped plugin works fine", func(t *testing.T) {
+		mustResetKongState(ctx, t, client, dumpConfig)
+		currentState, err := fetchCurrentState(ctx, client, dumpConfig)
+		require.NoError(t, err)
+
+		targetState := stateFromFile(ctx, t, "testdata/sync/038-partials/cg-plugin-partial.yaml", client, dumpConfig)
+		syncer, err := deckDiff.NewSyncer(deckDiff.SyncerOpts{
+			CurrentState: currentState,
+			TargetState:  targetState,
+
+			KongClient: client,
+		})
+		require.NoError(t, err)
+
+		stats, errs, changes := syncer.Solve(ctx, 1, false, true)
+		require.Empty(t, errs, "Should have no errors in syncing")
+		logEntityChanges(t, stats, changes)
+
+		newState, err := fetchCurrentState(ctx, client, dumpConfig)
+		require.NoError(t, err)
+
+		// check for partial
+		partials, err := newState.Partials.GetAll()
+		require.NoError(t, err)
+		require.NotNil(t, partials)
+
+		require.Len(t, partials, 1)
+		assert.Equal(t, "my-redis-ee", *partials[0].Name)
+		assert.Equal(t, "redis-ee", *partials[0].Type)
+
+		// check for plugin
+		plugins, err := newState.Plugins.GetAll()
+		require.NoError(t, err)
+		require.NotNil(t, plugins)
+		require.Len(t, plugins, 1)
+		assert.Equal(t, "rate-limiting-advanced", *plugins[0].Name)
+		assert.IsType(t, []*kong.PartialLink{}, plugins[0].Partials)
+		require.Len(t, plugins[0].Partials, 1)
+		assert.Equal(t, *partials[0].ID, *plugins[0].Partials[0].ID)
+		assert.Equal(t, "config.redis", *plugins[0].Partials[0].Path)
+		assert.Equal(t, "foo", *plugins[0].ConsumerGroup.Name)
+	})
 }
 
 func Test_Sync_Partials(t *testing.T) {

tests/integration/testdata/sync/038-partials/cg-plugin-partial.yaml

@@ -0,0 +1,57 @@
+_format_version: "3.0"
+consumer_groups:
+- name: foo
+  plugins:
+  - config:
+      compound_identifier: null
+      consumer_groups: null
+      dictionary_name: kong_rate_limiting_counters
+      disable_penalty: false
+      enforce_consumer_groups: false
+      error_code: 429
+      error_message: API rate limit exceeded
+      header_name: null
+      hide_client_headers: false
+      identifier: consumer
+      limit:
+      - 10
+      lock_dictionary_name: kong_locks
+      namespace: w8YrKXnDFXNJGynDdUhmeyrZWa7p5B2P
+      path: null
+      retry_after_jitter_max: 0
+      strategy: redis
+      sync_rate: -1
+      window_size:
+      - 60
+      window_type: sliding
+    name: rate-limiting-advanced
+    partials:
+    - id: c252219a-ace0-4f35-9dc7-156ef259981f
+      name: my-redis-ee
+      path: config.redis
+partials:
+- config:
+    cluster_max_redirections: null
+    cluster_nodes: null
+    connect_timeout: 2000
+    connection_is_proxied: false
+    database: 0
+    host: 127.0.0.1
+    keepalive_backlog: 0
+    keepalive_pool_size: 256
+    password: null
+    port: 6000
+    read_timeout: 2000
+    send_timeout: 2000
+    sentinel_master: null
+    sentinel_nodes: null
+    sentinel_password: null
+    sentinel_role: null
+    sentinel_username: null
+    server_name: null
+    ssl: false
+    ssl_verify: false
+    username: null
+  id: c252219a-ace0-4f35-9dc7-156ef259981f
+  name: my-redis-ee
+  type: redis-ee