feat: gateway proxy plugin metadata (#69)

dspo · web-flow · commit f83fca968f1b · 2025-03-18T21:00:34.000+08:00
diff --git a/Makefile b/Makefile
@@ -261,6 +261,10 @@ $(GOLANGCI_LINT): $(LOCALBIN)
 
 gofmt: ## Apply go fmt
 	@gofmt -w -r 'interface{} -> any' .
+	@gofmt -w -r 'FIt -> It' test
+	@gofmt -w -r 'FContext -> Context' test
+	@gofmt -w -r 'FDescribe -> Describe' test
+	@gofmt -w -r 'FDescribeTable -> DescribeTable' test
 	@go fmt ./...
 .PHONY: gofmt
 
diff --git a/internal/provider/adc/adc.go b/internal/provider/adc/adc.go
@@ -46,18 +46,19 @@ func New() (provider.Provider, error) {
 
 func (d *adcClient) Update(ctx context.Context, tctx *provider.TranslateContext, obj client.Object) error {
 	log.Debugw("updating object", zap.Any("object", obj))
+	var (
+		result        *translator.TranslateResult
+		resourceTypes []string
+		err           error
+	)
 
-	var result *translator.TranslateResult
-	var resourceTypes []string
-	var err error
-
-	switch obj := obj.(type) {
+	switch t := obj.(type) {
 	case *gatewayv1.HTTPRoute:
-		result, err = d.translator.TranslateHTTPRoute(tctx, obj.DeepCopy())
+		result, err = d.translator.TranslateHTTPRoute(tctx, t.DeepCopy())
 		resourceTypes = append(resourceTypes, "service")
 	case *gatewayv1.Gateway:
-		result, err = d.translator.TranslateGateway(tctx, obj.DeepCopy())
-		resourceTypes = append(resourceTypes, "global_rule", "ssl")
+		result, err = d.translator.TranslateGateway(tctx, t.DeepCopy())
+		resourceTypes = append(resourceTypes, "global_rule", "ssl", "plugin_metadata")
 	}
 	if err != nil {
 		return err
@@ -70,9 +71,10 @@ func (d *adcClient) Update(ctx context.Context, tctx *provider.TranslateContext,
 		Name:   obj.GetName(),
 		Labels: label.GenLabel(obj),
 		Resources: types.Resources{
-			Services:    result.Services,
-			SSLs:        result.SSL,
-			GlobalRules: result.GlobalRules,
+			GlobalRules:    result.GlobalRules,
+			PluginMetadata: result.PluginMetadata,
+			Services:       result.Services,
+			SSLs:           result.SSL,
 		},
 		ResourceTypes: resourceTypes,
 	})
@@ -81,12 +83,12 @@ func (d *adcClient) Update(ctx context.Context, tctx *provider.TranslateContext,
 func (d *adcClient) Delete(ctx context.Context, obj client.Object) error {
 	log.Debugw("deleting object", zap.Any("object", obj))
 
-	resourceTypes := []string{}
+	var resourceTypes []string
 	switch obj.(type) {
 	case *gatewayv1.HTTPRoute:
 		resourceTypes = append(resourceTypes, "service")
 	case *gatewayv1.Gateway:
-		resourceTypes = append(resourceTypes, "global_rule", "ssl")
+		resourceTypes = append(resourceTypes, "global_rule", "ssl", "plugin_metadata")
 	}
 
 	return d.sync(Task{
diff --git a/internal/provider/adc/translator/gateway.go b/internal/provider/adc/translator/gateway.go
@@ -33,10 +33,15 @@ func (t *Translator) TranslateGateway(tctx *provider.TranslateContext, obj *gate
 		}
 	}
 	if tctx.GatewayProxy != nil {
-		globalRules := adctypes.Plugins{}
+		var (
+			globalRules    = adctypes.Plugins{}
+			pluginMetadata = adctypes.Plugins{}
+		)
 		// apply plugins from GatewayProxy to global rules
 		t.fillPluginsFromGatewayProxy(globalRules, tctx.GatewayProxy)
+		t.fillPluginMetadataFromGatewayProxy(pluginMetadata, tctx.GatewayProxy)
 		result.GlobalRules = globalRules
+		result.PluginMetadata = pluginMetadata
 	}
 	return result, nil
 }
@@ -192,3 +197,18 @@ func (t *Translator) fillPluginsFromGatewayProxy(plugins adctypes.Plugins, gatew
 		plugins[pluginName] = pluginConfig
 	}
 }
+
+func (t *Translator) fillPluginMetadataFromGatewayProxy(pluginMetadata adctypes.Plugins, gatewayProxy *v1alpha1.GatewayProxy) {
+	if gatewayProxy == nil {
+		return
+	}
+	for pluginName, plugin := range gatewayProxy.Spec.PluginMetadata {
+		var pluginConfig map[string]any
+		if err := json.Unmarshal(plugin.Raw, &pluginConfig); err != nil {
+			log.Errorw("gateway proxy plugin_metadata unmarshal failed", zap.Error(err), zap.Any("plugin", pluginName), zap.String("config", string(plugin.Raw)))
+			continue
+		}
+		log.Debugw("fill plugin_metadata for gateway proxy", zap.String("plugin", pluginName), zap.Any("config", pluginConfig))
+		pluginMetadata[pluginName] = pluginConfig
+	}
+}
diff --git a/internal/provider/adc/translator/translator.go b/internal/provider/adc/translator/translator.go
@@ -10,8 +10,9 @@ type Translator struct {
 	Log logr.Logger
 }
 type TranslateResult struct {
-	Routes      []*adctypes.Route
-	Services    []*adctypes.Service
-	SSL         []*adctypes.SSL
-	GlobalRules adctypes.Plugins
+	Routes         []*adctypes.Route
+	Services       []*adctypes.Service
+	SSL            []*adctypes.SSL
+	GlobalRules    adctypes.Plugins
+	PluginMetadata adctypes.Plugins
 }
diff --git a/test/e2e/framework/dashboard.go b/test/e2e/framework/dashboard.go
@@ -95,6 +95,7 @@ dashboard_configuration:
       host: "0.0.0.0"
     cron_spec: "@every 1s"
   plugins:
+    - error-page
     - real-ip
     #- ai
     - error-page
diff --git a/test/e2e/framework/manifests/dp.yaml b/test/e2e/framework/manifests/dp.yaml
@@ -39,6 +39,7 @@ data:
         allow_admin:
           - all
     plugins:
+      - error-page
       - real-ip
       - ai
       - client-control
diff --git a/test/e2e/gatewayapi/gatewayproxy.go b/test/e2e/gatewayapi/gatewayproxy.go
@@ -2,6 +2,7 @@ package gatewayapi
 
 import (
 	"fmt"
+	"net/http"
 	"time"
 
 	. "github.com/onsi/ginkgo/v2"
@@ -80,6 +81,46 @@ spec:
       headers:
         X-Proxy-Test: "disabled"
 `
+	var (
+		gatewayProxyWithPluginMetadata0 = `
+apiVersion: gateway.apisix.io/v1alpha1
+kind: GatewayProxy
+metadata:
+  name: api7-proxy-config
+spec:
+  plugins:
+  - name: error-page
+    enabled: true
+    config: {}
+  pluginMetadata:
+    error-page: {
+      "enable": true,
+      "error_404": {
+          "body": "404 from plugin metadata",
+          "content-type": "text/plain"
+      }
+    }
+`
+		gatewayProxyWithPluginMetadata1 = `
+apiVersion: gateway.apisix.io/v1alpha1
+kind: GatewayProxy
+metadata:
+  name: api7-proxy-config
+spec:
+  plugins:
+  - name: error-page
+    enabled: true
+    config: {}
+  pluginMetadata:
+    error-page: {
+      "enable": false,
+      "error_404": {
+          "body": "404 from plugin metadata",
+          "content-type": "text/plain"
+      }
+    }
+`
+	)
 
 	var httpRouteForTest = `
 apiVersion: gateway.networking.k8s.io/v1
@@ -101,15 +142,15 @@ spec:
       port: 80
 `
 
-	var ResourceApplied = func(resourceType, resourceName, resourceRaw string, observedGeneration int) {
+	var resourceApplied = func(resourceType, resourceName, resourceRaw string, observedGeneration int) {
 		Expect(s.CreateResourceFromString(resourceRaw)).
 			NotTo(HaveOccurred(), fmt.Sprintf("creating %s", resourceType))
 
 		Eventually(func() string {
 			hryaml, err := s.GetResourceYaml(resourceType, resourceName)
 			Expect(err).NotTo(HaveOccurred(), fmt.Sprintf("getting %s yaml", resourceType))
 			return hryaml
-		}, "8s", "2s").
+		}).WithTimeout(8*time.Second).ProbeEvery(2*time.Second).
 			Should(
 				SatisfyAll(
 					ContainSubstring(`status: "True"`),
@@ -163,7 +204,7 @@ spec:
 	Context("Test Gateway with enabled GatewayProxy plugin", func() {
 		It("Should apply plugin configuration when enabled", func() {
 			By("Create HTTPRoute for Gateway with GatewayProxy")
-			ResourceApplied("HTTPRoute", "test-route", fmt.Sprintf(httpRouteForTest, "api7"), 1)
+			resourceApplied("HTTPRoute", "test-route", fmt.Sprintf(httpRouteForTest, "api7"), 1)
 
 			By("Check if the plugin is applied")
 			resp := s.NewAPISIXClient().
@@ -180,7 +221,7 @@ spec:
 			time.Sleep(5 * time.Second)
 
 			By("Create HTTPRoute for Gateway with GatewayProxy")
-			ResourceApplied("HTTPRoute", "test-route", fmt.Sprintf(httpRouteForTest, "api7"), 1)
+			resourceApplied("HTTPRoute", "test-route", fmt.Sprintf(httpRouteForTest, "api7"), 1)
 
 			By("Check if the plugin is not applied")
 			resp = s.NewAPISIXClient().
@@ -194,7 +235,7 @@ spec:
 
 		It("Should work normally without GatewayProxy", func() {
 			By("Create HTTPRoute for Gateway with GatewayProxy")
-			ResourceApplied("HTTPRoute", "test-route", fmt.Sprintf(httpRouteForTest, "api7"), 1)
+			resourceApplied("HTTPRoute", "test-route", fmt.Sprintf(httpRouteForTest, "api7"), 1)
 
 			By("Check if the plugin is applied")
 			resp := s.NewAPISIXClient().
@@ -211,7 +252,7 @@ spec:
 			time.Sleep(5 * time.Second)
 
 			By("Create HTTPRoute for Gateway without GatewayProxy")
-			ResourceApplied("HTTPRoute", "test-route", fmt.Sprintf(httpRouteForTest, "api7"), 1)
+			resourceApplied("HTTPRoute", "test-route", fmt.Sprintf(httpRouteForTest, "api7"), 1)
 
 			By("Check if the route works without plugin")
 			resp = s.NewAPISIXClient().
@@ -224,4 +265,53 @@ spec:
 		})
 	})
 
+	Context("Test Gateway with PluginMetadata", func() {
+		var (
+			err error
+		)
+
+		It("Should work OK with error-page", func() {
+			By("Update GatewayProxy with PluginMetadata")
+			err = s.CreateResourceFromString(gatewayProxyWithPluginMetadata0)
+			Expect(err).ShouldNot(HaveOccurred())
+			time.Sleep(5 * time.Second)
+
+			By("Create HTTPRoute for Gateway with GatewayProxy")
+			resourceApplied("HTTPRoute", "test-route", fmt.Sprintf(httpRouteForTest, "api7"), 1)
+
+			By("Check PluginMetadata working")
+			s.NewAPISIXClient().
+				GET("/not-found").
+				WithHost("example.com").
+				Expect().
+				Status(http.StatusNotFound).
+				Body().Contains("404 from plugin metadata")
+
+			By("Update GatewayProxy with PluginMetadata")
+			err = s.CreateResourceFromString(gatewayProxyWithPluginMetadata1)
+			Expect(err).ShouldNot(HaveOccurred())
+			time.Sleep(5 * time.Second)
+
+			By("Check PluginMetadata working")
+			s.NewAPISIXClient().
+				GET("/not-found").
+				WithHost("example.com").
+				Expect().
+				Status(http.StatusNotFound).
+				Body().Contains(`{"error_msg":"404 Route Not Found"}`)
+
+			By("Delete GatewayProxy")
+			err = s.DeleteResourceFromString(gatewayProxyWithPluginMetadata0)
+			Expect(err).ShouldNot(HaveOccurred())
+			time.Sleep(5 * time.Second)
+
+			By("Check PluginMetadata is not working")
+			s.NewAPISIXClient().
+				GET("/not-found").
+				WithHost("example.com").
+				Expect().
+				Status(http.StatusNotFound).
+				Body().Contains(`{"error_msg":"404 Route Not Found"}`)
+		})
+	})
 })
diff --git a/test/e2e/scaffold/scaffold.go b/test/e2e/scaffold/scaffold.go
@@ -452,16 +452,10 @@ func (s *Scaffold) afterEach() {
 	s.DeleteGatewayGroup(s.gatewaygroupid)
 
 	if CurrentSpecReport().Failed() {
-		if os.Getenv("TSET_ENV") == "CI" {
+		if os.Getenv("TEST_ENV") == "CI" {
 			_, _ = fmt.Fprintln(GinkgoWriter, "Dumping namespace contents")
-			output, _ := k8s.RunKubectlAndGetOutputE(GinkgoT(), s.kubectlOptions, "get", "deploy,sts,svc,pods")
-			if output != "" {
-				_, _ = fmt.Fprintln(GinkgoWriter, output)
-			}
-			output, _ = k8s.RunKubectlAndGetOutputE(GinkgoT(), s.kubectlOptions, "describe", "pods")
-			if output != "" {
-				_, _ = fmt.Fprintln(GinkgoWriter, output)
-			}
+			_, _ = k8s.RunKubectlAndGetOutputE(GinkgoT(), s.kubectlOptions, "get", "deploy,sts,svc,pods,gatewayproxy")
+			_, _ = k8s.RunKubectlAndGetOutputE(GinkgoT(), s.kubectlOptions, "describe", "pods")
 		}
 
 		output := s.GetDeploymentLogs("api7-ingress-controller")

Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,9 @@ type Translator struct {`
`10`	`10`	`Log logr.Logger`
`11`	`11`	`}`
`12`	`12`	`type TranslateResult struct {`
`13`		`- Routes []*adctypes.Route`
`14`		`- Services []*adctypes.Service`
`15`		`- SSL []*adctypes.SSL`
`16`		`- GlobalRules adctypes.Plugins`
	`13`	`+ Routes []*adctypes.Route`
	`14`	`+ Services []*adctypes.Service`
	`15`	`+ SSL []*adctypes.SSL`
	`16`	`+ GlobalRules adctypes.Plugins`
	`17`	`+ PluginMetadata adctypes.Plugins`
`17`	`18`	`}`