fix: plugin-relations fetched from intermediate state (#1627)

Author: Prashansa-K

go.mod

@@ -13,14 +13,14 @@ require (
 	github.com/fatih/color v1.18.0
 	github.com/google/go-cmp v0.7.0
 	github.com/kong/go-apiops v0.1.42
-	github.com/kong/go-database-reconciler v1.22.5
+	github.com/kong/go-database-reconciler v1.22.6
 	github.com/kong/go-kong v0.65.1
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/spf13/cobra v1.8.1
 	github.com/spf13/pflag v1.0.6
 	github.com/spf13/viper v1.19.0
 	github.com/stretchr/testify v1.10.0
-	golang.org/x/sync v0.12.0
+	golang.org/x/sync v0.14.0
 	k8s.io/api v0.32.1
 	k8s.io/apiextensions-apiserver v0.32.1
 	k8s.io/apimachinery v0.32.3

go.sum

@@ -246,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.42 h1:GF9KV1D06p/Ux2F5Dc4UJzGKFOeMzynpUWiAZwyEqxE=
 github.com/kong/go-apiops v0.1.42/go.mod h1:hKnHJ3UyeuG932SkI/yMpuT/PqSqGXNTS1zhno1lDqg=
-github.com/kong/go-database-reconciler v1.22.5 h1:QHfGnNgnn8WFb+k7m5sfr+1+YIEXogy1S7dSebHQBqw=
-github.com/kong/go-database-reconciler v1.22.5/go.mod h1:X8IjjS23H44Kzp9KjfCNM6WaQHnPhyeVYvntuI7fAkU=
+github.com/kong/go-database-reconciler v1.22.6 h1:G8rjG7057aVHem4q6tyyzEyJo3hH2weL0U9JAZk4H/0=
+github.com/kong/go-database-reconciler v1.22.6/go.mod h1:hLtPRsuxqTYv1rt6h/YrimjDQzkxlAFSIWoG1jEjWKE=
 github.com/kong/go-kong v0.65.1 h1:CM+8NlF+VbJckTxP2hGmSPKhA1GMliitXjQ7vJiPkaE=
 github.com/kong/go-kong v0.65.1/go.mod h1:sqdysTKrXIJ6mpxHwTwjgZhLW7jR1/puczTXHLUwJaE=
 github.com/kong/go-slugify v1.0.0 h1:vCFAyf2sdoSlBtLcrmDWUFn0ohlpKiKvQfXZkO5vSKY=
@@ -536,8 +536,8 @@ golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJ
 golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sync v0.12.0 h1:MHc5BpPuC30uJk597Ri8TV3CNZcTLu6B6z4lJy+g6Jw=
-golang.org/x/sync v0.12.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
+golang.org/x/sync v0.14.0 h1:woo0S4Yywslg6hp4eUFjTVOyKt0RookbpAHG4c1HmhQ=
+golang.org/x/sync v0.14.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
 golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=

tests/integration/sync_test.go

@@ -8217,3 +8217,76 @@ func Test_Sync_Plugins_Nested_Foreign_Keys_EE_3x(t *testing.T) {
 		})
 	}
 }
+
+// test scope:
+//
+// - >=2.8.0
+func Test_Sync_Scoped_Plugins_Check_Conflicts(t *testing.T) {
+	runWhenKongOrKonnect(t, ">=2.8.0")
+	setup(t)
+
+	ctx := context.Background()
+
+	stateFiles := []string{
+		"testdata/sync/042-scoped-plugins/plugins1.yaml",
+		"testdata/sync/042-scoped-plugins/plugins2.yaml",
+	}
+
+	tests := []struct {
+		name       string
+		multiSync  bool
+		emptyState bool
+	}{
+		{
+			name:       "sync plugin files one by one, existing state: empty",
+			multiSync:  false,
+			emptyState: true,
+		},
+		{
+			name:       "sync plugin files one by one, existing state: non-empty",
+			multiSync:  false,
+			emptyState: false,
+		},
+		{
+			name:       "sync plugin files together, existing state: empty",
+			multiSync:  true,
+			emptyState: true,
+		},
+		{
+			name:       "sync plugin files together, existing state: non-empty",
+			multiSync:  true,
+			emptyState: false,
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			reset(t)
+			if !tc.emptyState {
+				// syncing first state file to create initial state
+				err := sync(ctx, stateFiles[0])
+				require.NoError(t, err)
+			}
+
+			if tc.multiSync {
+				err := multiFileSync(ctx, stateFiles)
+				require.NoError(t, err)
+
+				// re-sync with no error
+				err = multiFileSync(ctx, stateFiles)
+				require.NoError(t, err)
+
+				return
+			}
+
+			for _, s := range stateFiles {
+				err := sync(ctx, s)
+				require.NoError(t, err)
+
+				// re-sync with no error
+				err = sync(ctx, s)
+				require.NoError(t, err)
+			}
+		})
+	}
+}

tests/integration/test_utils.go

@@ -323,6 +323,17 @@ func sync(ctx context.Context, kongFile string, opts ...string) error {
 	return deckCmd.ExecuteContext(ctx)
 }
 
+func multiFileSync(ctx context.Context, kongFiles []string, opts ...string) error {
+	deckCmd := cmd.NewRootCmd()
+	args := []string{"gateway", "sync"}
+	args = append(args, kongFiles...)
+	if len(opts) > 0 {
+		args = append(args, opts...)
+	}
+	deckCmd.SetArgs(args)
+	return deckCmd.ExecuteContext(ctx)
+}
+
 func diff(kongFile string, opts ...string) (string, error) {
 	deckCmd := cmd.NewRootCmd()
 	args := []string{"diff", "-s", kongFile}

tests/integration/testdata/sync/042-scoped-plugins/plugins1.yaml

@@ -0,0 +1,18 @@
+_format_version: "3.0"
+plugins:
+- config:
+    body: null
+    content_type: null
+    echo: false
+    message: null
+    status_code: 503
+    trigger: null
+  enabled: true
+  name: request-termination
+  protocols:
+  - grpc
+  - grpcs
+  - http
+  - https
+  tags:
+  - tag1

tests/integration/testdata/sync/042-scoped-plugins/plugins2.yaml

@@ -0,0 +1,28 @@
+_format_version: "3.0"
+services:
+- connect_timeout: 60000
+  enabled: true
+  host: httpbin.org
+  name: anything-tag2
+  path: /anything
+  plugins:
+  - config:
+      body: null
+      content_type: null
+      echo: true
+      message: null
+      status_code: 503
+      trigger: null
+    enabled: true
+    name: request-termination
+    protocols:
+    - grpc
+    - grpcs
+    - http
+    - https
+    tags:
+    - tag2
+  port: 80
+  protocol: http
+  read_timeout: 60000
+  retries: 5