fix: added fix for creation errors in consumer_group_consumers while using mismatched lookup tags (#1576)

Prashansa-K · web-flow · commit a45678ea22ce · 2025-03-27T15:51:11.000+05:30
* tests: added partial-plugin tests for konnect

* tests: reduced test duplication for konnect by setting CP in utils func

* style: removed stray code

* fix: added fix for creation errors in consumer_group_consumers while using lookup tags

* tests: added integration tests

* chore: added verbose flag in docker run command to check for container errors

* fix: added -v flag to kong health command

* ci: added continue_on_error condition for gateway-dev:latest image
The setup stage is failing due to some reason
diff --git a/.github/workflows/integration-enterprise.yaml b/.github/workflows/integration-enterprise.yaml
@@ -52,6 +52,7 @@ jobs:
         env:
           KONG_LICENSE_DATA: ${{ steps.license.outputs.license }}
         run: make setup-kong-ee
+        continue-on-error: ${{ matrix.kong_image == 'kong/kong-gateway-dev:latest' }}
       - name: Run integration tests
         env:
           KONG_LICENSE_DATA: ${{ steps.license.outputs.license }}
diff --git a/cmd/common.go b/cmd/common.go
@@ -284,7 +284,8 @@ func syncMain(ctx context.Context, filenames []string, dry bool, parallelism,
 	}
 
 	if dumpConfig.LookUpSelectorTagsConsumerGroups != nil {
-		consumerGroupsGlobal, err := dump.GetAllConsumerGroups(ctx, kongClient, dumpConfig.LookUpSelectorTagsConsumerGroups)
+		consumerGroupsGlobal, err := dump.GetAllConsumerGroups(ctx, kongClient, dumpConfig.LookUpSelectorTagsConsumerGroups,
+			dump.DefaultLookupTag)
 		if err != nil {
 			return fmt.Errorf("error retrieving global consumer groups via lookup selector tags: %w", err)
 		}
diff --git a/cmd/gateway_validate.go b/cmd/gateway_validate.go
@@ -56,7 +56,8 @@ func executeValidate(cmd *cobra.Command, _ []string) error {
 		}
 
 		if lookUpSelectorTagsConsumerGroups != nil {
-			consumerGroupsGlobal, err := dump.GetAllConsumerGroups(ctx, kongClient, lookUpSelectorTagsConsumerGroups)
+			consumerGroupsGlobal, err := dump.GetAllConsumerGroups(ctx, kongClient, lookUpSelectorTagsConsumerGroups,
+				dump.DefaultLookupTag)
 			if err != nil {
 				return fmt.Errorf("error retrieving global consumer groups via lookup selector tags: %w", err)
 			}
diff --git a/go.mod b/go.mod
@@ -13,7 +13,7 @@ require (
 	github.com/fatih/color v1.18.0
 	github.com/google/go-cmp v0.7.0
 	github.com/kong/go-apiops v0.1.41
-	github.com/kong/go-database-reconciler v1.21.0
+	github.com/kong/go-database-reconciler v1.22.0
 	github.com/kong/go-kong v0.64.1
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/spf13/cobra v1.8.1
@@ -58,7 +58,7 @@ require (
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/gorilla/websocket v1.5.1 // indirect
 	github.com/gregjones/httpcache v0.0.0-20190611155906-901d90724c79 // indirect
-	github.com/hashicorp/go-memdb v1.3.4 // indirect
+	github.com/hashicorp/go-memdb v1.3.5 // indirect
 	github.com/hashicorp/go-retryablehttp v0.7.7 // indirect
 	github.com/hashicorp/go-uuid v1.0.3 // indirect
 	github.com/hexops/gotextdiff v1.0.3 // indirect
diff --git a/go.sum b/go.sum
@@ -209,11 +209,10 @@ github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9n
 github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48=
 github.com/hashicorp/go-hclog v1.6.3 h1:Qr2kF+eVWjTiYmU7Y31tYlP1h0q/X3Nl3tPGdaB11/k=
 github.com/hashicorp/go-hclog v1.6.3/go.mod h1:W4Qnvbt70Wk/zYJryRzDRU/4r0kIg0PVHBcfoyhpF5M=
-github.com/hashicorp/go-immutable-radix v1.3.0/go.mod h1:0y9vanUI8NX6FsYoO3zeMjhV/C5i9g4Q3DwcSNZ4P60=
 github.com/hashicorp/go-immutable-radix v1.3.1 h1:DKHmCUm2hRBK510BaiZlwvpD40f8bJFeZnpfm2KLowc=
 github.com/hashicorp/go-immutable-radix v1.3.1/go.mod h1:0y9vanUI8NX6FsYoO3zeMjhV/C5i9g4Q3DwcSNZ4P60=
-github.com/hashicorp/go-memdb v1.3.4 h1:XSL3NR682X/cVk2IeV0d70N4DZ9ljI885xAEU8IoK3c=
-github.com/hashicorp/go-memdb v1.3.4/go.mod h1:uBTr1oQbtuMgd1SSGoR8YV27eT3sBHbYiNm53bMpgSg=
+github.com/hashicorp/go-memdb v1.3.5 h1:b3taDMxCBCBVgyRrS1AZVHO14ubMYZB++QpNhBg+Nyo=
+github.com/hashicorp/go-memdb v1.3.5/go.mod h1:8IVKKBkVe+fxFgdFOYxzQQNjz+sWCyHCdIC/+5+Vy1Y=
 github.com/hashicorp/go-retryablehttp v0.7.7 h1:C8hUCYzor8PIfXHa4UrZkU4VvK8o9ISHxT2Q8+VepXU=
 github.com/hashicorp/go-retryablehttp v0.7.7/go.mod h1:pkQpWZeYWskR+D1tR2O5OcBFOxfA7DoAO6xtkuQnHTk=
 github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro=
@@ -247,8 +246,8 @@ github.com/klauspost/cpuid/v2 v2.2.5 h1:0E5MSMDEoAulmXNFquVs//DdoomxaoTY1kUhbc/q
 github.com/klauspost/cpuid/v2 v2.2.5/go.mod h1:Lcz8mBdAVJIBVzewtcLocK12l3Y+JytZYpaMropDUws=
 github.com/kong/go-apiops v0.1.41 h1:1KXbQqyhO2E4nEnXJNqUDmHZU/LQ1U7Zoi+MAlcM2P0=
 github.com/kong/go-apiops v0.1.41/go.mod h1:sATq9Tz+ivzHKZU+tDXkRtEZnf64xroU3lgv3yXqP4I=
-github.com/kong/go-database-reconciler v1.21.0 h1:KoO63asW0uk/si+JvIpa/GHoov5vHwx4i7d+Eazc2hY=
-github.com/kong/go-database-reconciler v1.21.0/go.mod h1:AmYOR/Og7CHT8bB9zpbQCINpTT+C+WVNDjqfVxQT5V0=
+github.com/kong/go-database-reconciler v1.22.0 h1:xkcGFqjk1QattePNXHI2PYtQ4qh6Ibhkj+8aMBPQLZs=
+github.com/kong/go-database-reconciler v1.22.0/go.mod h1:emf04E6FSd5y9OKCMB+kNQ0NCTauSaEeCUNRCUgymSY=
 github.com/kong/go-kong v0.64.1 h1:HQssErFchbyYoDVQL7kR8x2naaY9mFgmDu/dXF0NZSo=
 github.com/kong/go-kong v0.64.1/go.mod h1:sqdysTKrXIJ6mpxHwTwjgZhLW7jR1/puczTXHLUwJaE=
 github.com/kong/go-slugify v1.0.0 h1:vCFAyf2sdoSlBtLcrmDWUFn0ohlpKiKvQfXZkO5vSKY=
diff --git a/tests/integration/sync_test.go b/tests/integration/sync_test.go
@@ -7875,3 +7875,45 @@ func Test_Sync_Partials(t *testing.T) {
 		require.NoError(t, err)
 	})
 }
+
+func Test_Sync_Consumers_Default_Lookup_Tag(t *testing.T) {
+	runWhenEnterpriseOrKonnect(t, ">=2.8.0")
+
+	ctx := context.Background()
+
+	t.Run("no errors occur in case of subsequent syncs with distributed config and defaultLookupTags for consumer-group",
+		func(t *testing.T) {
+			// sync consumer-group file first
+			err := sync(ctx, "testdata/sync/015-consumer-groups/kong-cg.yaml")
+			t.Cleanup(func() {
+				reset(t)
+			})
+			require.NoError(t, err)
+
+			// sync consumers file
+			err = sync(ctx, "testdata/sync/015-consumer-groups/kong-consumers.yaml")
+			require.NoError(t, err)
+
+			// sync again
+			err = sync(ctx, "testdata/sync/015-consumer-groups/kong-consumers.yaml")
+			require.NoError(t, err)
+		})
+
+	t.Run("no errors occur in case of with distributed config when consumer is not tagged but consumer-group is",
+		func(t *testing.T) {
+			// sync consumer-group file first
+			err := sync(ctx, "testdata/sync/015-consumer-groups/kong-cg.yaml")
+			t.Cleanup(func() {
+				reset(t)
+			})
+			require.NoError(t, err)
+
+			// sync consumers file
+			err = sync(ctx, "testdata/sync/015-consumer-groups/kong-consumers-no-tag.yaml")
+			require.NoError(t, err)
+
+			// sync again
+			err = sync(ctx, "testdata/sync/015-consumer-groups/kong-consumers-no-tag.yaml")
+			require.NoError(t, err)
+		})
+}
diff --git a/tests/integration/testdata/sync/015-consumer-groups/kong-cg.yaml b/tests/integration/testdata/sync/015-consumer-groups/kong-cg.yaml
@@ -0,0 +1,5 @@
+_format_version: "3.0"
+consumer_groups:
+  - name: foo-group
+    tags:
+      - group-tag
diff --git a/tests/integration/testdata/sync/015-consumer-groups/kong-consumers-no-tag.yaml b/tests/integration/testdata/sync/015-consumer-groups/kong-consumers-no-tag.yaml
@@ -0,0 +1,11 @@
+_format_version: "3.0"
+_info:
+  defaults: {}
+  default_lookup_tags:
+    consumer_groups:
+      - group-tag
+
+consumers:
+  - username: user-1
+    groups:
+      - name: foo-group
diff --git a/tests/integration/testdata/sync/015-consumer-groups/kong-consumers.yaml b/tests/integration/testdata/sync/015-consumer-groups/kong-consumers.yaml
@@ -0,0 +1,15 @@
+_format_version: "3.0"
+_info:
+  defaults: {}
+  select_tags:
+    -  user-tag
+  default_lookup_tags:
+    consumer_groups:
+      - group-tag
+
+consumers:
+  - username: user-1
+    groups:
+      - name: foo-group
+    tags:
+    - user-tag

Original file line number	Diff line number	Diff line change
`@@ -284,7 +284,8 @@ func syncMain(ctx context.Context, filenames []string, dry bool, parallelism,`
`284`	`284`	`}`
`285`	`285`
`286`	`286`	`if dumpConfig.LookUpSelectorTagsConsumerGroups != nil {`
`287`		`- consumerGroupsGlobal, err := dump.GetAllConsumerGroups(ctx, kongClient, dumpConfig.LookUpSelectorTagsConsumerGroups)`
	`287`	`+ consumerGroupsGlobal, err := dump.GetAllConsumerGroups(ctx, kongClient, dumpConfig.LookUpSelectorTagsConsumerGroups,`
	`288`	`+ dump.DefaultLookupTag)`
`288`	`289`	`if err != nil {`
`289`	`290`	`return fmt.Errorf("error retrieving global consumer groups via lookup selector tags: %w", err)`
`290`	`291`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,8 @@ func executeValidate(cmd *cobra.Command, _ []string) error {`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`if lookUpSelectorTagsConsumerGroups != nil {`
`59`		`- consumerGroupsGlobal, err := dump.GetAllConsumerGroups(ctx, kongClient, lookUpSelectorTagsConsumerGroups)`
	`59`	`+ consumerGroupsGlobal, err := dump.GetAllConsumerGroups(ctx, kongClient, lookUpSelectorTagsConsumerGroups,`
	`60`	`+ dump.DefaultLookupTag)`
`60`	`61`	`if err != nil {`
`61`	`62`	`return fmt.Errorf("error retrieving global consumer groups via lookup selector tags: %w", err)`
`62`	`63`	`}`