路由表檢查工具 · ENVOY 智能代理中文參考文檔

## 路由表檢查工具 **注意：以下配置僅適用于路由表檢查工具，不是Envoy二進制文件的一部分。路由表檢查工具是一個獨立的二進制文件，可用于驗證給定配置文件的Envoy路由。** 路由表檢查工具的需要相應的輸入，并且檢查之后返回的[路由配置](../v1APIreference/HTTPRouteconfiguration.md)是否符合預期。該工具可用于檢查群集名稱，虛擬群集名稱，虛擬主機名稱，手動路徑重寫，手動主機重寫，路徑重定向和標題字段匹配。可以擴展添加其他測試用例。有關安裝工具和示例工具輸入/輸出的詳細信息，請參見[安裝](../Buildingandinstallation/Tools.md)。路由表檢查工具配置由一個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) 要匹配的標題字段的值 ## 返回 - [上一級](../Configurationreference.md) - [首頁目錄](../README.md)