1.4.11 路由表检查工具

优质

小牛编辑

125浏览

2023-12-01

注意：以下配置仅适用于路由表检查工具，不是Envoy二进制文件的一部分。路由表检查工具是一个独立的二进制文件，可用于验证给定配置文件的Envoy路由。

路由表检查工具的需要相应的输入，并且检查之后返回的路由配置是否符合预期。该工具可用于检查群集名称，虚拟群集名称，虚拟主机名称，手动路径重写，手动主机重写，路径重定向和标题字段匹配。可以扩展添加其他测试用例。有关安装工具和示例工具输入/输出的详细信息，请参见安装。

路由表检查工具配置由一个json测试对象数组组成。每个测试对象由三部分组成。

test_name
该字段指定每个测试对象的名称。
input
输入值字段是指定要传递给路由器的参数。示例：输入字段包括:authority，:path和:method 头部字段。其中:authority和:path字段是指定发送到路由器的url，并且是必填字段。所有其他字段是可选的。
validate
检验字段是指定要检查的期望值和测试用例。至少需要一个测试用例。

一个简单的json格式的工具配置，以及一个测试用例，写法如下。测试与“instant-server”的群集匹配。

[
  {
    "test_name: "Cluster_name_test",
    "input":
      {
        ":authority":"api.lyft.com",
        ":path": "/api/locations"
      }
    "validate"
      {
        "cluster_name": "instant-server"
      }
   }
]

[
  {
    "test_name": "...",
    "input":
      {
        ":authority": "...",
        ":path": "...",
        ":method": "...",
        "internal" : "...",
        "random_value" : "...",
        "ssl" : "...",
        "additional_headers": [
          {
            "field": "...",
            "value": "..."
          },
          {
             "..."
          }
        ]
      }
    "validate": {
      "cluster_name": "...",
      "virtual_cluster_name": "...",
      "virtual_host_name": "...",
      "host_rewrite": "...",
      "path_rewrite": "...",
      "path_redirect": "...",
      "header_fields" : [
        {
          "field": "...",
          "value": "..."
        },
        {
          "..."
        }
      ]
    }
  },
  {
    "..."
  }
]

test_name

(required, string) 测试对象名称

input

(required, object) 做为路由器输入，并测试返回的路由

:authority
(required, string) 权威的URL。此值与:path参数一起定义，匹配需要的url路径。示例值是“api.lyft.com”。
:path
(required, string) URL路径。示例值是“/foo”。
:method
(optional, string) 请求方法。如果未指定，则默认方法是GET。选项是GET，PUT或POST。
internal
(optional, boolean) 是否将x-envoy-internal设置为“true”的标志。如果未指定，或者如果 internal等于false，则不会设置x-envoy-internal。
random_value
(optional, integer) 用于标识加权群集选择的目标的整数。random_value的默认值是0。
ssl
(optional, boolean) 确定是否将x-forwarded-proto设置为https或http的标志。通过将x-forwarded-proto设置为给定的协议，该工具能够模拟通过http或https发出请求的客户端行为。默认情况是false，与之对应x-forwarded-proto设置为http。
additional_headers
(optional, array) 需要额外添加头部为路由器的输入。其他配置选项“:authority”，“:path”，“:method”，“x-forwarded-proto”和“x-envoy-internal”字段，不应在此设置。
- field
  (required, string) 被添加头部的名称
- value
  (required, string) 被添加头部的值

validate

(required, object) 校验对象是指定要匹配的路由返回的参数。至少必须指定一个测试参数。使用“”（空字符串）表示没有返回值。例如，若测试不需要集群匹配，请使用{“cluster_name”:“”}。

cluster_name
(optional, string) 匹配的集群名称
virutal_cluster_name
(optional, string) 匹配的虚拟集群名称
virtual_host_name
(optional, string) 匹配的虚拟主机名称
host_rewrite
(optional, string) 重写后匹配主机头部字段
path_rewrite
(optional, string) 重写后匹配路径头部字段
path_redirect
(optional, string) 匹配返回的重定向路径
header_fields
(optional, array) 匹配列出的标题字段。示例标题字段包括“:path”，“cookie”和“date”字段。在所有其他测试用例之后检查标题字段。因此，检查的标题字段将是适用时重定向或重写路由的字段。
- field
  (required, string) 要匹配的标题字段的名称
- value
  (required, string) 要匹配的标题字段的值

上一级