higress/test/README_CN.md

Higress E2E 测试

Higress E2E 测试主要关注两个部分：

• Ingress API 的一致性测试
• Gateway API 的一致性测试

Ingress API 一致性测试

架构

工作流程

Higress 提供了运行 Ingress API 一致性测试和 wasmplugin 测试的 make 目标，

• API 测试: make higress-conformance-test
• Gateway API 测试: make gateway-conformance-test
• WasmPlugin 测试: make higress-wasmplugin-test
  • 为测试构建所有 GO WasmPlugins: make higress-wasmplugin-test
  • 仅为一个 GO WasmPlugin 构建测试: PLUGIN_NAME=request-block make higress-wasmplugin-test
  • 仅为一个 CPP WasmPlugin 构建测试: PLUGIN_TYPE=CPP PLUGIN_NAME=key_auth make higress-wasmplugin-test
  • 为测试构建所有 Rust WasmPlugins: PLUGIN_TYPE=RUST make higress-wasmplugin-test
  • 仅为一个 Rust WasmPlugin 构建测试: PLUGIN_TYPE=RUST PLUGIN_NAME=request-block make higress-wasmplugin-test
  • 仅运行指定测试,用逗号分隔 TEST_SHORTNAME=WasmPluginsIPRestrictionAllow,WasmPluginsIPRestrictionDeny make higress-wasmplugin-test
  • 仅构建一个 Go WasmPlugin 并运行指定测试: PLUGIN_NAME=ip-restriction TEST_SHORTNAME=WasmPluginsIPRestrictionAllow,WasmPluginsIPRestrictionDeny make higress-wasmplugin-test
  • 跳过构建 higress dev 镜像，仅构建一个 Go WasmPlugin 并运行指定测试: PLUGIN_NAME=ip-restriction TEST_SHORTNAME=WasmPluginsIPRestrictionAllow,WasmPluginsIPRestrictionDeny make higress-wasmplugin-test-skip-docker-build

可以分为以下步骤：

1. delete-cluster: 检查是否有未删除的 kind 集群。
2. create-cluster: 创建一个新的 kind 集群。
3. docker-build: 构建 higress 的开发镜像。
4. kube-load-image: 将 dev higress-controller 镜像加载到 kind 集群中。
5. install-dev: 使用 helm 安装带有 dev 镜像的 higress-controller，并安装最新的 higress-gateway、istiod。
6. run-e2e-test:
   1. 所有测试都在 test/e2e/conformance/tests 中定义，并在初始化阶段被注册到ConformanceTests中。ConformanceTests 是一个全局变量，用于存储所有的一致性测试用例。
   2. 准备资源并将它们安装到集群中，例如后端服务/部署。
   3. 加载选择打开的一致性测试，并逐个运行它们，如果不符合预期，则失败。

如何编写测试用例

要添加新的测试用例，首先需要在 test/ingress/conformance/tests 中添加 xxx.go 和 xxx.yaml。xxx.yaml 是您需要在集群中应用的 Ingress 资源，xxx.go 定义了 HigressConformanceTest。

然后，您应该将您定义的测试用例注册到ConformanceTests中，方法是在xxx.go中使用init() 函数调用Register(YOUR_PLUGIN_SHORT_NAME)。

通过查看 test/ingress/conformance/tests/httproute-simple-same-namespace.go 和 test/ingress/conformance/tests/httproute-simple-same-namespace.yaml 中的代码，您可以快速了解并尝试编写一个测试用例。

如何实现测试环境的复用

主要通过 Makefile 中的以下几个目标实现：

1. make higress-conformance-test: 用于运行整个 Conformance 测试流程，包括搭建测试环境、运行测试用例、清理测试环境。

   • make higress-conformance-test-prepare: 可用于搭建 higress-controller、higress-gateway 等 deployment 的环境。
   • make run-higress-e2e-test: 可用于运行测试用例。
     • make run-higress-e2e-test-setup: 可用于安装测试用例所需的基础资源，例如 nacos、dubbo 等。
     • make run-higress-e2e-test-run: 可用于运行测试用例。
     • make run-higress-e2e-test-clean: 可用于清理测试用例在 setup 阶段所安装的基础资源。
   • make higress-conformance-test-clean: 可用于清理 higress-controller、higress-gateway 等 deployment 的测试环境。

2. make higress-wasmplugin-test: 用于运行整个 WasmPlugin 测试流程，包括搭建测试环境、编译 WasmPlugin 插件、运行测试用例、清理测试环境。使用 make higress-wasmplugin-test-skip-docker-build 可以跳过构建 higress dev 镜像。

   • make higress-wasmplugin-test-prepare: 可用于搭建 higress-controller、higress-gateway 等 deployment 的环境，并编译 WasmPlugin 插件。通过设置变量PLUGIN_NAME仅编译指定插件。使用 make higress-wasmplugin-test-prepare-skip-docker-build 可以跳过构建 higress dev 镜像。
   • make run-higress-e2e-test-wasmplugin: 可用于运行测试用例。
     • make run-higress-e2e-test-wasmplugin-setup: 可用于安装测试用例所需的基础资源，例如 nacos、dubbo 等。
     • make run-higress-e2e-test-wasmplugin-run: 可用于运行测试用例。通过设置变量TEST_SHORTNAME仅运行指定测试。
     • make run-higress-e2e-test-wasmplugin-clean: 可用于清理测试用例在 setup 阶段所安装的基础资源。
   • make higress-wasmplugin-test-clean: 可用于清理 higress-controller、higress-gateway 等 deployment 的测试环境。

Gateway API 一致性测试

执行 make gateway-conformance-test 可运行上游 Gateway API v1.4.0 Conformance Suite。默认范围只包含 GATEWAY-HTTP Profile 的必选 Core 能力：Gateway、HTTPRoute 和 ReferenceGrant，不启用 Extended 能力。

Runner 直接引用上游 Suite 及其内嵌 manifests，Higress 不复制维护官方测试用例。只有调试单个上游用例时才设置 GATEWAY_CONFORMANCE_RUN_TEST=<ShortName>；默认 PR 流水线始终执行完整 Core Profile，并将官方报告保存为 CI artifact。