feat: add E2E test case labeling and enhance test framework

dspo · dspo · commit 68e56be97ed7 · 2025-06-25T14:40:32.000+08:00
- Introduced Ginkgo labels for categorizing E2E test cases based on apisix resource type and networking components.
- Updated Makefile and GitHub Actions workflow to include label-based test execution.
- Improved ADC output handling and extended backend mode validation logic.
diff --git a/.github/workflows/apisix-e2e-test.yml b/.github/workflows/apisix-e2e-test.yml
@@ -40,6 +40,9 @@ jobs:
         provider_type:
         - apisix-standalone
         - apisix
+        cases_subset:
+        - apisix
+        - networking
     runs-on: buildjet-2vcpu-ubuntu-2204
     steps:
       - name: Checkout
@@ -89,5 +92,6 @@ jobs:
         env:
           TEST_DIR: "./test/e2e/apisix/"
           PROVIDER_TYPE: ${{ matrix.provider_type }}
+          TEST_LABEL: ${{ matrix.cases_subset }}
         run: |
           make e2e-test
diff --git a/Makefile b/Makefile
@@ -111,7 +111,7 @@ kind-e2e-test: kind-up build-image kind-load-images e2e-test
 .PHONY: e2e-test
 e2e-test:
 	@kind get kubeconfig --name $(KIND_NAME) > $$KUBECONFIG
-	DASHBOARD_VERSION=$(DASHBOARD_VERSION) go test $(TEST_DIR) -test.timeout=$(TEST_TIMEOUT) -v -ginkgo.v -ginkgo.focus="$(TEST_FOCUS)"
+	DASHBOARD_VERSION=$(DASHBOARD_VERSION) go test $(TEST_DIR) -test.timeout=$(TEST_TIMEOUT) -v -ginkgo.v -ginkgo.focus="$(TEST_FOCUS)" -ginkgo.label-filter="$(TEST_LABEL)"
 
 .PHONY: download-api7ee3-chart
 download-api7ee3-chart:
diff --git a/internal/provider/adc/adc.go b/internal/provider/adc/adc.go
@@ -189,8 +189,18 @@ func (d *adcClient) Update(ctx context.Context, tctx *provider.TranslateContext,
 	// This mode is full synchronization,
 	// which only needs to be saved in cache
 	// and triggered by a timer for synchronization
-	if d.BackendMode == BackendModeAPISIXStandalone || d.BackendMode == BackendModeAPISIX || apiv2.Is(obj) {
+	switch d.BackendMode {
+	case BackendModeAPI7EE:
+		if apiv2.Is(obj) {
+			return nil
+		}
+	case BackendModeAPISIX:
+		// do nothing
+	case BackendModeAPISIXStandalone:
 		return nil
+	default:
+		return errors.Errorf("unknown backend mode: %s", d.BackendMode)
+
 	}
 
 	return d.sync(ctx, Task{
diff --git a/internal/provider/adc/executor.go b/internal/provider/adc/executor.go
@@ -112,6 +112,10 @@ func (e *DefaultADCExecutor) buildCmdError(runErr error, stdout, stderr []byte)
 
 func (e *DefaultADCExecutor) handleOutput(output []byte) error {
 	var result adctypes.SyncResult
+	if index := strings.IndexByte(string(output), '{'); index > 0 {
+		log.Warnf("extra output: %s", string(output[:index]))
+		output = output[index:]
+	}
 	if err := json.Unmarshal(output, &result); err != nil {
 		log.Errorw("failed to unmarshal adc output",
 			zap.Error(err),
diff --git a/test/e2e/apisix/basic.go b/test/e2e/apisix/basic.go
@@ -19,7 +19,7 @@ import (
 	"github.com/apache/apisix-ingress-controller/test/e2e/scaffold"
 )
 
-var _ = Describe("APISIX Standalone Basic Tests", func() {
+var _ = Describe("APISIX Standalone Basic Tests", Label("apisix", "v2", "basic"), func() {
 	s := scaffold.NewScaffold(&scaffold.Options{
 		ControllerName: "apisix.apache.org/apisix-ingress-controller",
 	})
diff --git a/test/e2e/apisix/consumer.go b/test/e2e/apisix/consumer.go
@@ -28,7 +28,7 @@ import (
 
 type Headers map[string]string
 
-var _ = Describe("Test ApisixConsumer", func() {
+var _ = Describe("Test ApisixConsumer", Label("apisix", "v2", "apisixconsumer"), func() {
 	var (
 		s = scaffold.NewScaffold(&scaffold.Options{
 			ControllerName: "apisix.apache.org/apisix-ingress-controller",
diff --git a/test/e2e/apisix/globalrule.go b/test/e2e/apisix/globalrule.go
@@ -56,7 +56,7 @@ spec:
     scope: "Namespace"
 `
 
-var _ = Describe("Test GlobalRule", func() {
+var _ = Describe("Test GlobalRule", Label("apisix", "v2", "apisixglobalrule"), func() {
 	s := scaffold.NewScaffold(&scaffold.Options{
 		ControllerName: "apisix.apache.org/apisix-ingress-controller",
 	})
diff --git a/test/e2e/apisix/pluginconfig.go b/test/e2e/apisix/pluginconfig.go
@@ -59,7 +59,7 @@ spec:
     scope: "Namespace"
 `
 
-var _ = Describe("Test ApisixPluginConfig", func() {
+var _ = Describe("Test ApisixPluginConfig", Label("apisix", "v2", "apisixpluginconfig"), func() {
 	var (
 		s = scaffold.NewScaffold(&scaffold.Options{
 			ControllerName: "apisix.apache.org/apisix-ingress-controller",
diff --git a/test/e2e/apisix/route.go b/test/e2e/apisix/route.go
@@ -27,7 +27,7 @@ import (
 	"github.com/apache/apisix-ingress-controller/test/e2e/scaffold"
 )
 
-var _ = Describe("Test ApisixRoute", func() {
+var _ = Describe("Test ApisixRoute", Label("apisix", "v2", "apisixroute"), func() {
 	var (
 		s = scaffold.NewScaffold(&scaffold.Options{
 			ControllerName: "apisix.apache.org/apisix-ingress-controller",
diff --git a/test/e2e/apisix/tls.go b/test/e2e/apisix/tls.go
@@ -85,7 +85,7 @@ var Cert = strings.TrimSpace(framework.TestServerCert)
 
 var Key = strings.TrimSpace(framework.TestServerKey)
 
-var _ = Describe("Test ApisixTls", func() {
+var _ = Describe("Test ApisixTls", Label("apisix", "v2", "apisixtls"), func() {
 	var (
 		s = scaffold.NewScaffold(&scaffold.Options{
 			ControllerName: "apisix.apache.org/apisix-ingress-controller",
diff --git a/test/e2e/crds/backendtrafficpolicy.go b/test/e2e/crds/backendtrafficpolicy.go
@@ -22,7 +22,7 @@ import (
 	"github.com/apache/apisix-ingress-controller/test/e2e/scaffold"
 )
 
-var _ = Describe("Test BackendTrafficPolicy base on HTTPRoute", func() {
+var _ = Describe("Test BackendTrafficPolicy base on HTTPRoute", Label("apisix", "v1alpha1", "backendtrafficpolicy"), func() {
 	s := scaffold.NewDefaultScaffold()
 
 	var defaultGatewayProxy = `
diff --git a/test/e2e/crds/consumer.go b/test/e2e/crds/consumer.go
@@ -23,7 +23,7 @@ import (
 	"github.com/apache/apisix-ingress-controller/test/e2e/scaffold"
 )
 
-var _ = Describe("Test Consumer", func() {
+var _ = Describe("Test Consumer", Label("apisix", "v1alpha1", "consumer"), func() {
 	s := scaffold.NewDefaultScaffold()
 
 	var defaultGatewayProxy = `
diff --git a/test/e2e/framework/assertion.go b/test/e2e/framework/assertion.go
@@ -111,7 +111,7 @@ func APIv2MustHaveCondition(t testing.TestingT, cli client.Client, timeout time.
 	}
 	err := PollUntilAPIv2MustHaveStatus(cli, timeout, nn, obj, f)
 
-	require.NoError(t, err, "error waiting status to have a Condition matching %+v", nn, cond)
+	require.NoError(t, err, "error waiting %s status to have a Condition matching %+v", nn, cond)
 }
 
 func PollUntilAPIv2MustHaveStatus(cli client.Client, timeout time.Duration, nn types.NamespacedName, obj client.Object, f func(client.Object) bool) error {
diff --git a/test/e2e/gatewayapi/controller.go b/test/e2e/gatewayapi/controller.go
@@ -23,7 +23,7 @@ import (
 	"github.com/apache/apisix-ingress-controller/test/e2e/scaffold"
 )
 
-var _ = Describe("Check if controller cache gets synced with correct resources", func() {
+var _ = Describe("Check if controller cache gets synced with correct resources", Label("networking", "basic"), func() {
 
 	var gatewayProxyYaml = `
 apiVersion: apisix.apache.org/v1alpha1
diff --git a/test/e2e/gatewayapi/gateway.go b/test/e2e/gatewayapi/gateway.go
@@ -37,7 +37,7 @@ func createSecret(s *scaffold.Scaffold, secretName string) {
 	assert.Nil(GinkgoT(), err, "create secret error")
 }
 
-var _ = Describe("Test Gateway", func() {
+var _ = Describe("Test Gateway", Label("networking", "gateway"), func() {
 	s := scaffold.NewScaffold(&scaffold.Options{
 		ControllerName: "apisix.apache.org/apisix-ingress-controller",
 	})
diff --git a/test/e2e/gatewayapi/gatewayclass.go b/test/e2e/gatewayapi/gatewayclass.go
@@ -21,7 +21,7 @@ import (
 	"github.com/apache/apisix-ingress-controller/test/e2e/scaffold"
 )
 
-var _ = Describe("Test GatewayClass", func() {
+var _ = Describe("Test GatewayClass", Label("networking", "gatewayclass"), func() {
 	s := scaffold.NewScaffold(&scaffold.Options{
 		ControllerName: "apisix.apache.org/apisix-ingress-controller",
 	})
diff --git a/test/e2e/gatewayapi/gatewayproxy.go b/test/e2e/gatewayapi/gatewayproxy.go
@@ -23,7 +23,7 @@ import (
 	"github.com/apache/apisix-ingress-controller/test/e2e/scaffold"
 )
 
-var _ = Describe("Test GatewayProxy", func() {
+var _ = Describe("Test GatewayProxy", Label("apisix", "v1alpha1", "gatewayproxy"), func() {
 	s := scaffold.NewDefaultScaffold()
 
 	var defaultGatewayClass = `
diff --git a/test/e2e/gatewayapi/httproute.go b/test/e2e/gatewayapi/httproute.go
@@ -33,7 +33,7 @@ import (
 	"github.com/apache/apisix-ingress-controller/test/e2e/scaffold"
 )
 
-var _ = Describe("Test HTTPRoute", func() {
+var _ = Describe("Test HTTPRoute", Label("networking", "httproute"), func() {
 	s := scaffold.NewDefaultScaffold()
 
 	var gatewayProxyYaml = `
diff --git a/test/e2e/ingress/ingress.go b/test/e2e/ingress/ingress.go
@@ -41,7 +41,7 @@ func createSecret(s *scaffold.Scaffold, secretName string) {
 	assert.Nil(GinkgoT(), err, "create secret error")
 }
 
-var _ = Describe("Test Ingress", func() {
+var _ = Describe("Test Ingress", Label("networking", "ingress"), func() {
 	s := scaffold.NewScaffold(&scaffold.Options{
 		ControllerName: "apisix.apache.org/apisix-ingress-controller",
 	})
diff --git a/test/e2e/scaffold/apisix_deployer.go b/test/e2e/scaffold/apisix_deployer.go
@@ -195,8 +195,9 @@ func (s *APISIXDeployer) deployDataplane(opts *APISIXDeployOptions) *corev1.Serv
 	kubectlOpts := k8s.NewKubectlOptions("", "", opts.Namespace)
 
 	if os.Getenv(framework.EnvKeyProviderType) == adc.BackendModeAPISIX {
-		// deploy etcd
+		opts.ServiceName = "apisix"
 		opts.ConfigProvider = "etcd"
+		// deploy etcd
 		k8s.KubectlApplyFromString(s.GinkgoT, kubectlOpts, framework.EtcdSpec)
 		err := framework.WaitPodsAvailable(s.GinkgoT, kubectlOpts, metav1.ListOptions{
 			LabelSelector: "app=etcd",

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ import (`
`19`	`19`	`"github.com/apache/apisix-ingress-controller/test/e2e/scaffold"`
`20`	`20`	`)`
`21`	`21`
`22`		`-var _ = Describe("APISIX Standalone Basic Tests", func() {`
	`22`	`+var _ = Describe("APISIX Standalone Basic Tests", Label("apisix", "v2", "basic"), func() {`
`23`	`23`	`s := scaffold.NewScaffold(&scaffold.Options{`
`24`	`24`	`ControllerName: "apisix.apache.org/apisix-ingress-controller",`
`25`	`25`	`})`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ spec:`
`56`	`56`	`scope: "Namespace"`
`57`	`57`	`
`58`	`58`
`59`		`-var _ = Describe("Test GlobalRule", func() {`
	`59`	`+var _ = Describe("Test GlobalRule", Label("apisix", "v2", "apisixglobalrule"), func() {`
`60`	`60`	`s := scaffold.NewScaffold(&scaffold.Options{`
`61`	`61`	`ControllerName: "apisix.apache.org/apisix-ingress-controller",`
`62`	`62`	`})`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ spec:`
`59`	`59`	`scope: "Namespace"`
`60`	`60`	`
`61`	`61`
`62`		`-var _ = Describe("Test ApisixPluginConfig", func() {`
	`62`	`+var _ = Describe("Test ApisixPluginConfig", Label("apisix", "v2", "apisixpluginconfig"), func() {`
`63`	`63`	`var (`
`64`	`64`	`s = scaffold.NewScaffold(&scaffold.Options{`
`65`	`65`	`ControllerName: "apisix.apache.org/apisix-ingress-controller",`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ import (`
`27`	`27`	`"github.com/apache/apisix-ingress-controller/test/e2e/scaffold"`
`28`	`28`	`)`
`29`	`29`
`30`		`-var _ = Describe("Test ApisixRoute", func() {`
	`30`	`+var _ = Describe("Test ApisixRoute", Label("apisix", "v2", "apisixroute"), func() {`
`31`	`31`	`var (`
`32`	`32`	`s = scaffold.NewScaffold(&scaffold.Options{`
`33`	`33`	`ControllerName: "apisix.apache.org/apisix-ingress-controller",`