add feature online plugins filter flag

Kong · Nov 28, 2024 · 6125315 · 6125315
1 parent 43eef06
commit 6125315
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 3 deletions.
diff --git a/cmd/gateway_validate.go b/cmd/gateway_validate.go
@@ -19,6 +19,7 @@ import (
 var (
 	validateCmdKongStateFile     []string
 	validateCmdRBACResourcesOnly bool
+	validateCmdCheckOnlinePluginsOnly bool
 	validateOnline               bool
 	validateWorkspace            string
 	validateParallelism          int
@@ -237,6 +238,8 @@ this command unless --online flag is used.
 
 	validateCmd.Flags().BoolVar(&validateCmdRBACResourcesOnly, "rbac-resources-only",
 		false, "indicate that the state file(s) contains RBAC resources only (Kong Enterprise only).")
+	validateCmd.Flags().BoolVar(&validateCmdCheckOnlinePluginsOnly, "check-online-plugins-only",
+		false, "indicate that the online validation will be done only on plugins.")
 	if deprecated {
 		validateCmd.Flags().StringSliceVarP(&validateCmdKongStateFile,
 			"state", "s", []string{"kong.yaml"}, "file(s) containing Kong's configuration.\n"+
@@ -284,6 +287,7 @@ func validateWithKong(
 		Client:            kongClient,
 		Parallelism:       validateParallelism,
 		RBACResourcesOnly: validateCmdRBACResourcesOnly,
+		CheckOnlinePluginsOnly: validateCmdCheckOnlinePluginsOnly,
 	}
 	validator := validate.NewValidator(opts)
 	return validator.Validate(parsedFormatVersion)

diff --git a/tests/integration/validate_test.go b/tests/integration/validate_test.go
@@ -133,6 +133,11 @@ func Test_Validate_File(t *testing.T) {
 			stateFile:      "testdata/validate/rbac-resources.yaml",
 			additionalArgs: []string{"--rbac-resources-only"},
 		},
+		{
+			name:           "file validate with --check-online-plugins-only",
+			stateFile:      "testdata/validate/kong3x.yaml",
+			additionalArgs: []string{"--check-online-plugins-only"},
+		},
 	}
 
 	for _, tc := range tests {

diff --git a/validate/validate.go b/validate/validate.go
@@ -21,6 +21,7 @@ type Validator struct {
 	client            *kong.Client
 	parallelism       int
 	rbacResourcesOnly bool
+	CheckOnlinePluginsOnly bool
 }
 
 type ValidatorOpts struct {
@@ -29,6 +30,7 @@ type ValidatorOpts struct {
 	Client            *kong.Client
 	Parallelism       int
 	RBACResourcesOnly bool
+	CheckOnlinePluginsOnly bool
 }
 
 func NewValidator(opt ValidatorOpts) *Validator {
@@ -38,6 +40,7 @@ func NewValidator(opt ValidatorOpts) *Validator {
 		client:            opt.Client,
 		parallelism:       opt.Parallelism,
 		rbacResourcesOnly: opt.RBACResourcesOnly,
+		CheckOnlinePluginsOnly: opt.CheckOnlinePluginsOnly,
 	}
 }
 
@@ -130,6 +133,14 @@ func (v *Validator) Validate(formatVersion semver.Version) []error {
 		return allErr
 	}
 
+	// validate Plugins resources then.
+	if err := v.entities(v.state.Plugins, "plugins"); err != nil {
+		allErr = append(allErr, err...)
+	}
+	if v.CheckOnlinePluginsOnly {
+		return allErr
+	}
+
 	if err := v.entities(v.state.Services, "services"); err != nil {
 		allErr = append(allErr, err...)
 	}
@@ -163,9 +174,6 @@ func (v *Validator) Validate(formatVersion semver.Version) []error {
 	if err := v.entities(v.state.Oauth2Creds, "oauth2_credentials"); err != nil {
 		allErr = append(allErr, err...)
 	}
-	if err := v.entities(v.state.Plugins, "plugins"); err != nil {
-		allErr = append(allErr, err...)
-	}
 	if err := v.entities(v.state.Routes, "routes"); err != nil {
 		allErr = append(allErr, err...)
 	}