-
Notifications
You must be signed in to change notification settings - Fork 360
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
e2e: Add backend health check e2e case via active http (#3677)
* Add backend health check e2e case via active http Signed-off-by: Dingkang Li <dingkang1743@gmail.com> * Use membership_healthy stats to check backend health check Signed-off-by: Dingkang Li <dingkang1743@gmail.com> * Use non-zero cluster health check stats to verify backend health check Signed-off-by: Dingkang Li <dingkang1743@gmail.com> --------- Signed-off-by: Dingkang Li <dingkang1743@gmail.com> Co-authored-by: zirain <zirain2009@gmail.com>
- Loading branch information
Showing
2 changed files
with
252 additions
and
0 deletions.
There are no files selected for viewing
110 changes: 110 additions & 0 deletions
110
test/e2e/testdata/backend-health-check-active-http.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| apiVersion: gateway.envoyproxy.io/v1alpha1 | ||
| kind: BackendTrafficPolicy | ||
| metadata: | ||
| name: health-check-active-http-pass-btp | ||
| namespace: gateway-conformance-infra | ||
| spec: | ||
| targetRefs: | ||
| - group: gateway.networking.k8s.io | ||
| kind: HTTPRoute | ||
| name: http-with-health-check-active-http-pass | ||
| namespace: gateway-conformance-infra | ||
| healthCheck: | ||
| active: | ||
| timeout: 3s | ||
| interval: 5s | ||
| unhealthyThreshold: 3 | ||
| healthyThreshold: 1 | ||
| type: HTTP | ||
| http: | ||
| path: "/status/200" | ||
| expectedStatuses: | ||
| - 200 | ||
| --- | ||
| apiVersion: gateway.envoyproxy.io/v1alpha1 | ||
| kind: BackendTrafficPolicy | ||
| metadata: | ||
| name: health-check-active-http-fail-btp | ||
| namespace: gateway-conformance-infra | ||
| spec: | ||
| targetRefs: | ||
| - group: gateway.networking.k8s.io | ||
| kind: HTTPRoute | ||
| name: http-with-health-check-active-http-fail | ||
| namespace: gateway-conformance-infra | ||
| healthCheck: | ||
| active: | ||
| timeout: 3s | ||
| interval: 5s | ||
| unhealthyThreshold: 3 | ||
| healthyThreshold: 1 | ||
| type: HTTP | ||
| http: | ||
| path: "/status/418" | ||
| expectedStatuses: | ||
| - 200 | ||
| --- | ||
| apiVersion: gateway.networking.k8s.io/v1 | ||
| kind: HTTPRoute | ||
| metadata: | ||
| name: http-with-health-check-active-http-pass | ||
| namespace: gateway-conformance-infra | ||
| spec: | ||
| parentRefs: | ||
| - name: same-namespace | ||
| rules: | ||
| - matches: | ||
| - path: | ||
| type: PathPrefix | ||
| value: /health-check-active-http-pass | ||
| backendRefs: | ||
| - name: infra-backend-v1 | ||
| port: 8080 | ||
| --- | ||
| apiVersion: gateway.networking.k8s.io/v1 | ||
| kind: HTTPRoute | ||
| metadata: | ||
| name: http-with-health-check-active-http-fail | ||
| namespace: gateway-conformance-infra | ||
| spec: | ||
| parentRefs: | ||
| - name: same-namespace | ||
| rules: | ||
| - matches: | ||
| - path: | ||
| type: PathPrefix | ||
| value: /health-check-active-http-fail | ||
| backendRefs: | ||
| - name: infra-backend-v1 | ||
| port: 8080 | ||
| --- | ||
| # cluster panic threshold should be set to 0.0 to disable panic, to check whether health check works. | ||
| apiVersion: gateway.envoyproxy.io/v1alpha1 | ||
| kind: EnvoyPatchPolicy | ||
| metadata: | ||
| name: disable-cluster-panic-patch-policy | ||
| namespace: gateway-conformance-infra | ||
| spec: | ||
| targetRef: | ||
| group: gateway.networking.k8s.io | ||
| kind: Gateway | ||
| name: same-namespace | ||
| namespace: gateway-conformance-infra | ||
| type: JSONPatch | ||
| jsonPatches: | ||
| - type: "type.googleapis.com/envoy.config.cluster.v3.Cluster" | ||
| name: "httproute/gateway-conformance-infra/http-with-health-check-active-http-pass/rule/0" | ||
| operation: | ||
| op: add | ||
| path: "/common_lb_config" | ||
| value: | ||
| healthy_panic_threshold: | ||
| value: 0.0 | ||
| - type: "type.googleapis.com/envoy.config.cluster.v3.Cluster" | ||
| name: "httproute/gateway-conformance-infra/http-with-health-check-active-http-fail/rule/0" | ||
| operation: | ||
| op: add | ||
| path: "/common_lb_config" | ||
| value: | ||
| healthy_panic_threshold: | ||
| value: 0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| // Copyright Envoy Gateway Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // The full text of the Apache license is available in the LICENSE file at | ||
| // the root of the repo. | ||
|
|
||
| //go:build e2e | ||
| // +build e2e | ||
|
|
||
| package tests | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| gwapiv1 "sigs.k8s.io/gateway-api/apis/v1" | ||
| gwapiv1a2 "sigs.k8s.io/gateway-api/apis/v1alpha2" | ||
| "sigs.k8s.io/gateway-api/conformance/utils/http" | ||
| "sigs.k8s.io/gateway-api/conformance/utils/kubernetes" | ||
| "sigs.k8s.io/gateway-api/conformance/utils/suite" | ||
|
|
||
| "github.com/envoyproxy/gateway/internal/gatewayapi" | ||
| "github.com/envoyproxy/gateway/test/e2e/utils/prometheus" | ||
| ) | ||
|
|
||
| func init() { | ||
| ConformanceTests = append(ConformanceTests, BackendHealthCheckActiveHTTPTest) | ||
| } | ||
|
|
||
| var BackendHealthCheckActiveHTTPTest = suite.ConformanceTest{ | ||
| ShortName: "BackendHealthCheckActiveHTTP", | ||
| Description: "Resource with BackendHealthCheckActiveHTTP enabled", | ||
| Manifests: []string{"testdata/backend-health-check-active-http.yaml"}, | ||
| Test: func(t *testing.T, suite *suite.ConformanceTestSuite) { | ||
| t.Run("active http", func(t *testing.T) { | ||
| ns := "gateway-conformance-infra" | ||
| passRouteNN := types.NamespacedName{Name: "http-with-health-check-active-http-pass", Namespace: ns} | ||
| failRouteNN := types.NamespacedName{Name: "http-with-health-check-active-http-fail", Namespace: ns} | ||
| gwNN := types.NamespacedName{Name: "same-namespace", Namespace: ns} | ||
| gwAddr := kubernetes.GatewayAndHTTPRoutesMustBeAccepted(t, suite.Client, suite.TimeoutConfig, suite.ControllerName, kubernetes.NewGatewayRef(gwNN), passRouteNN, failRouteNN) | ||
|
|
||
| ancestorRef := gwapiv1a2.ParentReference{ | ||
| Group: gatewayapi.GroupPtr(gwapiv1.GroupName), | ||
| Kind: gatewayapi.KindPtr(gatewayapi.KindGateway), | ||
| Namespace: gatewayapi.NamespacePtr(gwNN.Namespace), | ||
| Name: gwapiv1.ObjectName(gwNN.Name), | ||
| } | ||
| BackendTrafficPolicyMustBeAccepted(t, suite.Client, types.NamespacedName{Name: "health-check-active-http-pass-btp", Namespace: ns}, suite.ControllerName, ancestorRef) | ||
| BackendTrafficPolicyMustBeAccepted(t, suite.Client, types.NamespacedName{Name: "health-check-active-http-fail-btp", Namespace: ns}, suite.ControllerName, ancestorRef) | ||
|
|
||
| promAddr, err := prometheus.Address(suite.Client, | ||
| types.NamespacedName{Name: "prometheus", Namespace: "monitoring"}, | ||
| ) | ||
| require.NoError(t, err) | ||
|
|
||
| passClusterName := fmt.Sprintf("httproute/%s/%s/rule/0", ns, passRouteNN.Name) | ||
| failClusterName := fmt.Sprintf("httproute/%s/%s/rule/0", ns, failRouteNN.Name) | ||
| gtwName := "same-namespace" | ||
|
|
||
| // health check requests will be distributed to the cluster with configured path. | ||
| // we can use membership_healthy stats to check whether health check works as expected. | ||
| passPromQL := fmt.Sprintf(`envoy_cluster_health_check_success{envoy_cluster_name="%s",gateway_envoyproxy_io_owning_gateway_name="%s"}`, passClusterName, gtwName) | ||
| failPromQL := fmt.Sprintf(`envoy_cluster_health_check_failure{envoy_cluster_name="%s",gateway_envoyproxy_io_owning_gateway_name="%s"}`, failClusterName, gtwName) | ||
|
|
||
| http.AwaitConvergence( | ||
| t, | ||
| suite.TimeoutConfig.RequiredConsecutiveSuccesses, | ||
| suite.TimeoutConfig.MaxTimeToConsistency, | ||
| func(_ time.Duration) bool { | ||
| // check membership_healthy stats from Prometheus | ||
| v, err := prometheus.QuerySum(promAddr, passPromQL) | ||
| if err != nil { | ||
| // wait until Prometheus sync stats | ||
| return false | ||
| } | ||
| t.Logf("cluster pass health check: success stats query count: %v", v) | ||
|
|
||
| if v == 0 { | ||
| t.Error("success is not the same as expected") | ||
| } else { | ||
| t.Log("success is the same as expected") | ||
| } | ||
|
|
||
| return true | ||
| }, | ||
| ) | ||
|
|
||
| http.AwaitConvergence( | ||
| t, | ||
| suite.TimeoutConfig.RequiredConsecutiveSuccesses, | ||
| suite.TimeoutConfig.MaxTimeToConsistency, | ||
| func(_ time.Duration) bool { | ||
| // check membership_healthy stats from Prometheus | ||
| v, err := prometheus.QuerySum(promAddr, failPromQL) | ||
| if err != nil { | ||
| // wait until Prometheus sync stats | ||
| return false | ||
| } | ||
| t.Logf("cluster fail health check: failure stats query count: %v", v) | ||
|
|
||
| if v == 0 { | ||
| t.Error("failure is not same as expected") | ||
| } else { | ||
| t.Log("failure is same as expected") | ||
| } | ||
|
|
||
| return true | ||
| }, | ||
| ) | ||
|
|
||
| t.Run("health check pass", func(t *testing.T) { | ||
| expectedResponse := http.ExpectedResponse{ | ||
| Request: http.Request{ | ||
| Path: "/health-check-active-http-pass", | ||
| }, | ||
| Response: http.Response{ | ||
| StatusCode: 200, | ||
| }, | ||
| Namespace: ns, | ||
| } | ||
|
|
||
| http.MakeRequestAndExpectEventuallyConsistentResponse(t, suite.RoundTripper, suite.TimeoutConfig, gwAddr, expectedResponse) | ||
| }) | ||
|
|
||
| t.Run("health check fail", func(t *testing.T) { | ||
| expectedResponse := http.ExpectedResponse{ | ||
| Request: http.Request{ | ||
| Path: "/health-check-active-http-fail", | ||
| }, | ||
| Response: http.Response{ | ||
| StatusCode: 503, | ||
| }, | ||
| Namespace: ns, | ||
| } | ||
|
|
||
| http.MakeRequestAndExpectEventuallyConsistentResponse(t, suite.RoundTripper, suite.TimeoutConfig, gwAddr, expectedResponse) | ||
| }) | ||
| }) | ||
| }, | ||
| } |