Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

Commit

Permalink
Fix health probe test flakiness (#5163)
Browse files Browse the repository at this point in the history 
Signed-off-by: Keith Mattix II <[email protected]>
  • Loading branch information
@keithmattix
keithmattix authored Oct 4, 2022
1 parent a8fe89e commit 9858c75
Showing 1 changed file with 350 additions and 2 deletions.
352 changes: 350 additions & 2 deletions pkg/envoy/bootstrap/config_test.go
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package bootstrap

import (
"fmt"
"testing"

tassert "github.com/stretchr/testify/assert"
Expand Down Expand Up @@ -29,7 +30,7 @@ func TestBuild(t *testing.T) {
},
"my-container-2": {
Liveness: &models.HealthProbe{Path: "/liveness", Port: 84, IsHTTP: true},
Readiness: &models.HealthProbe{Path: "/readiness", Port: 85}, // HTTPS (should overwrite my-containers probe)
Readiness: &models.HealthProbe{Path: "/readiness", Port: 85}, // HTTPS
Startup: &models.HealthProbe{Path: "/startup", Port: 86, IsHTTP: true},
},
},
Expand Down Expand Up @@ -382,5 +383,352 @@ static_resources:
'@type': type.googleapis.com/envoy.extensions.filters.listener.tls_inspector.v3.TlsInspector
name: startup_listener
`
assert.Equal(expectedYAML, string(actualYAML))

reversedExpectedYAML := `admin:
access_log:
- name: envoy.access_loggers.stream
typed_config:
'@type': type.googleapis.com/envoy.extensions.access_loggers.stream.v3.StdoutAccessLog
address:
socket_address:
address: 127.0.0.1
port_value: 15000
dynamic_resources:
ads_config:
api_type: GRPC
grpc_services:
- envoy_grpc:
cluster_name: osm-controller
set_node_on_first_message_only: true
transport_api_version: V3
cds_config:
ads: {}
resource_api_version: V3
lds_config:
ads: {}
resource_api_version: V3
node:
id: foo.bar.co.uk
static_resources:
clusters:
- load_assignment:
cluster_name: osm-controller
endpoints:
- lb_endpoints:
- endpoint:
address:
socket_address:
address: osm-controller.osm-system.svc.cluster.local
port_value: 15128
name: osm-controller
transport_socket:
name: envoy.transport_sockets.tls
typed_config:
'@type': type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext
common_tls_context:
alpn_protocols:
- h2
tls_certificate_sds_secret_configs:
- name: tls_sds
sds_config:
path: /etc/envoy/tls_certificate_sds_secret.yaml
tls_params:
cipher_suites:
- abc
- xyz
ecdh_curves:
- ABC
- XYZ
tls_maximum_protocol_version: TLSv1_2
tls_minimum_protocol_version: TLSv1_0
validation_context_sds_secret_config:
name: validation_context_sds
sds_config:
path: /etc/envoy/validation_context_sds_secret.yaml
type: LOGICAL_DNS
typed_extension_protocol_options:
envoy.extensions.upstreams.http.v3.HttpProtocolOptions:
'@type': type.googleapis.com/envoy.extensions.upstreams.http.v3.HttpProtocolOptions
explicit_http_config:
http2_protocol_options: {}
- load_assignment:
cluster_name: my-container-2_liveness_cluster
endpoints:
- lb_endpoints:
- endpoint:
address:
socket_address:
address: 127.0.0.1
port_value: 84
name: my-container-2_liveness_cluster
type: STATIC
- load_assignment:
cluster_name: my-container-2_readiness_cluster
endpoints:
- lb_endpoints:
- endpoint:
address:
socket_address:
address: 127.0.0.1
port_value: 85
name: my-container-2_readiness_cluster
type: STATIC
- load_assignment:
cluster_name: my-container-2_startup_cluster
endpoints:
- lb_endpoints:
- endpoint:
address:
socket_address:
address: 127.0.0.1
port_value: 86
name: my-container-2_startup_cluster
type: STATIC
- load_assignment:
cluster_name: my-container_liveness_cluster
endpoints:
- lb_endpoints:
- endpoint:
address:
socket_address:
address: 127.0.0.1
port_value: 81
name: my-container_liveness_cluster
type: STATIC
- load_assignment:
cluster_name: my-container_readiness_cluster
endpoints:
- lb_endpoints:
- endpoint:
address:
socket_address:
address: 127.0.0.1
port_value: 82
name: my-container_readiness_cluster
type: STATIC
- load_assignment:
cluster_name: my-container_startup_cluster
endpoints:
- lb_endpoints:
- endpoint:
address:
socket_address:
address: 127.0.0.1
port_value: 83
name: my-container_startup_cluster
type: STATIC
listeners:
- address:
socket_address:
address: 0.0.0.0
port_value: 15901
filter_chains:
- filters:
- name: envoy.filters.network.http_connection_manager
typed_config:
'@type': type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
access_log:
- name: envoy.access_loggers.stream
typed_config:
'@type': type.googleapis.com/envoy.extensions.access_loggers.stream.v3.StdoutAccessLog
log_format:
json_format:
authority: '%REQ(:AUTHORITY)%'
bytes_received: '%BYTES_RECEIVED%'
bytes_sent: '%BYTES_SENT%'
duration: '%DURATION%'
method: '%REQ(:METHOD)%'
path: '%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%'
protocol: '%PROTOCOL%'
request_id: '%REQ(X-REQUEST-ID)%'
requested_server_name: '%REQUESTED_SERVER_NAME%'
response_code: '%RESPONSE_CODE%'
response_code_details: '%RESPONSE_CODE_DETAILS%'
response_flags: '%RESPONSE_FLAGS%'
start_time: '%START_TIME%'
time_to_first_byte: '%RESPONSE_DURATION%'
upstream_cluster: '%UPSTREAM_CLUSTER%'
upstream_host: '%UPSTREAM_HOST%'
upstream_service_time: '%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%'
user_agent: '%REQ(USER-AGENT)%'
x_forwarded_for: '%REQ(X-FORWARDED-FOR)%'
http_filters:
- name: http_router
typed_config:
'@type': type.googleapis.com/envoy.extensions.filters.http.router.v3.Router
route_config:
name: local_route
virtual_hosts:
- domains:
- '*'
name: local_service
routes:
- match:
prefix: /osm-liveness-probe/my-container-2
route:
cluster: my-container-2_liveness_cluster
prefix_rewrite: /liveness
timeout: 1s
- match:
prefix: /osm-liveness-probe/my-container
route:
cluster: my-container_liveness_cluster
prefix_rewrite: /liveness
timeout: 1s
stat_prefix: health_probes_http
listener_filters:
- name: tls_inspector
typed_config:
'@type': type.googleapis.com/envoy.extensions.filters.listener.tls_inspector.v3.TlsInspector
name: liveness_listener
- address:
socket_address:
address: 0.0.0.0
port_value: 15902
filter_chains:
- filter_chain_match:
transport_protocol: tls
filters:
- name: tcp_proxy
typed_config:
'@type': type.googleapis.com/envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy
access_log:
- name: envoy.access_loggers.stream
typed_config:
'@type': type.googleapis.com/envoy.extensions.access_loggers.stream.v3.StdoutAccessLog
log_format:
json_format:
bytes_received: '%BYTES_RECEIVED%'
bytes_sent: '%BYTES_SENT%'
duration: '%DURATION%'
requested_server_name: '%REQUESTED_SERVER_NAME%'
response_flags: '%RESPONSE_FLAGS%'
start_time: '%START_TIME%'
upstream_cluster: '%UPSTREAM_CLUSTER%'
upstream_host: '%UPSTREAM_HOST%'
cluster: my-container-2_readiness_cluster
stat_prefix: health_probes_https
- filters:
- name: envoy.filters.network.http_connection_manager
typed_config:
'@type': type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
access_log:
- name: envoy.access_loggers.stream
typed_config:
'@type': type.googleapis.com/envoy.extensions.access_loggers.stream.v3.StdoutAccessLog
log_format:
json_format:
authority: '%REQ(:AUTHORITY)%'
bytes_received: '%BYTES_RECEIVED%'
bytes_sent: '%BYTES_SENT%'
duration: '%DURATION%'
method: '%REQ(:METHOD)%'
path: '%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%'
protocol: '%PROTOCOL%'
request_id: '%REQ(X-REQUEST-ID)%'
requested_server_name: '%REQUESTED_SERVER_NAME%'
response_code: '%RESPONSE_CODE%'
response_code_details: '%RESPONSE_CODE_DETAILS%'
response_flags: '%RESPONSE_FLAGS%'
start_time: '%START_TIME%'
time_to_first_byte: '%RESPONSE_DURATION%'
upstream_cluster: '%UPSTREAM_CLUSTER%'
upstream_host: '%UPSTREAM_HOST%'
upstream_service_time: '%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%'
user_agent: '%REQ(USER-AGENT)%'
x_forwarded_for: '%REQ(X-FORWARDED-FOR)%'
http_filters:
- name: http_router
typed_config:
'@type': type.googleapis.com/envoy.extensions.filters.http.router.v3.Router
route_config:
name: local_route
virtual_hosts:
- domains:
- '*'
name: local_service
routes:
- match:
prefix: /osm-readiness-probe/my-container
route:
cluster: my-container_readiness_cluster
prefix_rewrite: /readiness
timeout: 1s
stat_prefix: health_probes_http
listener_filters:
- name: tls_inspector
typed_config:
'@type': type.googleapis.com/envoy.extensions.filters.listener.tls_inspector.v3.TlsInspector
name: readiness_listener
- address:
socket_address:
address: 0.0.0.0
port_value: 15903
filter_chains:
- filters:
- name: envoy.filters.network.http_connection_manager
typed_config:
'@type': type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
access_log:
- name: envoy.access_loggers.stream
typed_config:
'@type': type.googleapis.com/envoy.extensions.access_loggers.stream.v3.StdoutAccessLog
log_format:
json_format:
authority: '%REQ(:AUTHORITY)%'
bytes_received: '%BYTES_RECEIVED%'
bytes_sent: '%BYTES_SENT%'
duration: '%DURATION%'
method: '%REQ(:METHOD)%'
path: '%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%'
protocol: '%PROTOCOL%'
request_id: '%REQ(X-REQUEST-ID)%'
requested_server_name: '%REQUESTED_SERVER_NAME%'
response_code: '%RESPONSE_CODE%'
response_code_details: '%RESPONSE_CODE_DETAILS%'
response_flags: '%RESPONSE_FLAGS%'
start_time: '%START_TIME%'
time_to_first_byte: '%RESPONSE_DURATION%'
upstream_cluster: '%UPSTREAM_CLUSTER%'
upstream_host: '%UPSTREAM_HOST%'
upstream_service_time: '%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%'
user_agent: '%REQ(USER-AGENT)%'
x_forwarded_for: '%REQ(X-FORWARDED-FOR)%'
http_filters:
- name: http_router
typed_config:
'@type': type.googleapis.com/envoy.extensions.filters.http.router.v3.Router
route_config:
name: local_route
virtual_hosts:
- domains:
- '*'
name: local_service
routes:
- match:
prefix: /osm-startup-probe/my-container-2
route:
cluster: my-container-2_startup_cluster
prefix_rewrite: /startup
timeout: 1s
- match:
prefix: /osm-startup-probe/my-container
route:
cluster: my-container_startup_cluster
prefix_rewrite: /startup
timeout: 1s
stat_prefix: health_probes_http
listener_filters:
- name: tls_inspector
typed_config:
'@type': type.googleapis.com/envoy.extensions.filters.listener.tls_inspector.v3.TlsInspector
name: startup_listener
`

// Because OriginalHealthProbes is a map and not a slice, it's unordered, so we need to use a more complex assertion here
assert.Conditionf(func() (success bool) {
return tassert.ObjectsAreEqual(expectedYAML, string(actualYAML)) || tassert.ObjectsAreEqual(reversedExpectedYAML, string(actualYAML))
}, fmt.Sprintf("Not equal: \n"+
"expected:\n%s\n--------OR----------\n%s\n"+
"actual :\n%s\n", expectedYAML, reversedExpectedYAML, actualYAML))
}

0 comments on commit 9858c75

Please sign in to comment.