forked from envoyproxy/envoy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
hds_integration_test.cc
1290 lines (1039 loc) · 53.5 KB
/
hds_integration_test.cc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include <memory>
#include "envoy/config/bootstrap/v3/bootstrap.pb.h"
#include "envoy/config/core/v3/config_source.pb.h"
#include "envoy/config/core/v3/health_check.pb.h"
#include "envoy/service/health/v3/hds.pb.h"
#include "envoy/type/v3/http.pb.h"
#include "envoy/upstream/upstream.h"
#include "source/common/config/metadata.h"
#include "source/common/network/utility.h"
#include "source/common/protobuf/utility.h"
#include "source/common/upstream/health_checker_impl.h"
#include "source/common/upstream/health_discovery_service.h"
#include "test/common/upstream/utility.h"
#include "test/config/utility.h"
#include "test/integration/http_integration.h"
#include "test/test_common/network_utility.h"
#include "test/test_common/resources.h"
#include "test/test_common/simulated_time_system.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
namespace Envoy {
namespace {
// TODO(jmarantz): switch this to simulated-time after debugging flakes.
class HdsIntegrationTest : public Grpc::GrpcClientIntegrationParamTest, public HttpIntegrationTest {
public:
HdsIntegrationTest() : HttpIntegrationTest(Http::CodecType::HTTP1, ipVersion()) {}
void createUpstreams() override {
addFakeUpstream(Http::CodecType::HTTP2);
hds_upstream_ = fake_upstreams_.back().get();
HttpIntegrationTest::createUpstreams();
}
void initialize() override {
setUpstreamCount(upstream_endpoints_);
config_helper_.addConfigModifier([](envoy::config::bootstrap::v3::Bootstrap& bootstrap) {
// Setup hds and corresponding gRPC cluster.
auto* hds_config = bootstrap.mutable_hds_config();
hds_config->set_api_type(envoy::config::core::v3::ApiConfigSource::GRPC);
hds_config->set_transport_api_version(envoy::config::core::v3::ApiVersion::V3);
hds_config->add_grpc_services()->mutable_envoy_grpc()->set_cluster_name("hds_cluster");
auto* hds_cluster = bootstrap.mutable_static_resources()->add_clusters();
hds_cluster->MergeFrom(bootstrap.static_resources().clusters()[0]);
hds_cluster->mutable_circuit_breakers()->Clear();
hds_cluster->set_name("hds_cluster");
ConfigHelper::setHttp2(*hds_cluster);
auto* cluster_0 = bootstrap.mutable_static_resources()->mutable_clusters(0);
cluster_0->clear_load_assignment();
});
HttpIntegrationTest::initialize();
// Endpoint connections
if (tls_hosts_) {
host_upstream_ = &addFakeUpstream(
HttpIntegrationTest::createUpstreamTlsContext(upstreamConfig()), http_conn_type_);
host2_upstream_ = &addFakeUpstream(
HttpIntegrationTest::createUpstreamTlsContext(upstreamConfig()), http_conn_type_);
} else {
host_upstream_ = &addFakeUpstream(http_conn_type_);
host2_upstream_ = &addFakeUpstream(http_conn_type_);
}
}
// Sets up a connection between Envoy and the management server.
void waitForHdsStream() {
AssertionResult result =
hds_upstream_->waitForHttpConnection(*dispatcher_, hds_fake_connection_);
RELEASE_ASSERT(result, result.message());
result = hds_fake_connection_->waitForNewStream(*dispatcher_, hds_stream_);
RELEASE_ASSERT(result, result.message());
}
// Envoy sends health check messages to the endpoints of cluster2
void healthcheckEndpointsCluster2(std::string cluster2) {
ASSERT_TRUE(host2_upstream_->waitForHttpConnection(*dispatcher_, host2_fake_connection_));
ASSERT_TRUE(host2_fake_connection_->waitForNewStream(*dispatcher_, host2_stream_));
ASSERT_TRUE(host2_stream_->waitForEndStream(*dispatcher_));
EXPECT_EQ(host2_stream_->headers().getPathValue(), "/healthcheck");
EXPECT_EQ(host2_stream_->headers().getMethodValue(), "GET");
EXPECT_EQ(host2_stream_->headers().getHostValue(), cluster2);
}
// Envoy sends health check messages to the endpoints
void healthcheckEndpoints(std::string cluster2 = "") {
ASSERT_TRUE(host_upstream_->waitForHttpConnection(*dispatcher_, host_fake_connection_));
ASSERT_TRUE(host_fake_connection_->waitForNewStream(*dispatcher_, host_stream_));
ASSERT_TRUE(host_stream_->waitForEndStream(*dispatcher_));
EXPECT_EQ(host_stream_->headers().getPathValue(), "/healthcheck");
EXPECT_EQ(host_stream_->headers().getMethodValue(), "GET");
EXPECT_EQ(host_stream_->headers().getHostValue(), "anna");
if (!cluster2.empty()) {
healthcheckEndpointsCluster2(cluster2);
}
}
// Clean up the connection between Envoy and the management server
void cleanupHdsConnection() {
if (hds_fake_connection_ != nullptr) {
AssertionResult result = hds_fake_connection_->close();
RELEASE_ASSERT(result, result.message());
result = hds_fake_connection_->waitForDisconnect();
RELEASE_ASSERT(result, result.message());
}
}
// Clean up connections between Envoy and endpoints
void cleanupHostConnections() {
if (host_fake_connection_ != nullptr) {
AssertionResult result = host_fake_connection_->close();
RELEASE_ASSERT(result, result.message());
result = host_fake_connection_->waitForDisconnect();
RELEASE_ASSERT(result, result.message());
}
if (host2_fake_connection_ != nullptr) {
AssertionResult result = host2_fake_connection_->close();
RELEASE_ASSERT(result, result.message());
result = host2_fake_connection_->waitForDisconnect();
RELEASE_ASSERT(result, result.message());
}
}
// Creates a basic HealthCheckSpecifier message containing one endpoint and
// one HTTP health_check
envoy::service::health::v3::HealthCheckSpecifier
makeHttpHealthCheckSpecifier(envoy::type::v3::CodecClientType codec_type, bool use_tls) {
envoy::service::health::v3::HealthCheckSpecifier server_health_check_specifier_;
server_health_check_specifier_.mutable_interval()->set_nanos(100000000); // 0.1 seconds
auto* cluster_health_check = server_health_check_specifier_.add_cluster_health_checks();
cluster_health_check->set_cluster_name("anna");
Network::Utility::addressToProtobufAddress(
*host_upstream_->localAddress(),
*cluster_health_check->add_locality_endpoints()->add_endpoints()->mutable_address());
cluster_health_check->mutable_locality_endpoints(0)->mutable_locality()->set_region(
"middle_earth");
cluster_health_check->mutable_locality_endpoints(0)->mutable_locality()->set_zone("shire");
cluster_health_check->mutable_locality_endpoints(0)->mutable_locality()->set_sub_zone(
"hobbiton");
auto* health_check = cluster_health_check->add_health_checks();
health_check->mutable_timeout()->set_seconds(MaxTimeout);
health_check->mutable_interval()->set_seconds(MaxTimeout);
health_check->mutable_unhealthy_threshold()->set_value(2);
health_check->mutable_healthy_threshold()->set_value(2);
health_check->mutable_grpc_health_check();
auto* http_health_check = health_check->mutable_http_health_check();
http_health_check->set_path("/healthcheck");
http_health_check->set_codec_client_type(codec_type);
if (use_tls) {
// Map our transport socket matches with our matcher.
const std::string criteria_yaml = absl::StrFormat(
R"EOF(
transport_socket_match_criteria:
good_match: "true"
)EOF");
health_check->MergeFrom(
TestUtility::parseYaml<envoy::config::core::v3::HealthCheck>(criteria_yaml));
// Create the list of all possible matches.
const std::string match_yaml = absl::StrFormat(
R"EOF(
transport_socket_matches:
- name: "tls_socket"
match:
good_match: "true"
transport_socket:
name: tls
typed_config:
"@type": type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext
common_tls_context:
tls_certificates:
- certificate_chain: { filename: "%s" }
private_key: { filename: "%s" }
)EOF",
TestEnvironment::runfilesPath("test/config/integration/certs/clientcert.pem"),
TestEnvironment::runfilesPath("test/config/integration/certs/clientkey.pem"));
cluster_health_check->MergeFrom(
TestUtility::parseYaml<envoy::service::health::v3::ClusterHealthCheck>(match_yaml));
}
return server_health_check_specifier_;
}
envoy::service::health::v3::ClusterHealthCheck createSecondCluster(std::string name) {
// Add endpoint
envoy::service::health::v3::ClusterHealthCheck health_check;
health_check.set_cluster_name(name);
Network::Utility::addressToProtobufAddress(
*host2_upstream_->localAddress(),
*health_check.add_locality_endpoints()->add_endpoints()->mutable_address());
health_check.mutable_locality_endpoints(0)->mutable_locality()->set_region("kounopetra");
health_check.mutable_locality_endpoints(0)->mutable_locality()->set_zone("emplisi");
health_check.mutable_locality_endpoints(0)->mutable_locality()->set_sub_zone("paris");
health_check.add_health_checks()->mutable_timeout()->set_seconds(MaxTimeout);
health_check.mutable_health_checks(0)->mutable_interval()->set_seconds(MaxTimeout);
health_check.mutable_health_checks(0)->mutable_unhealthy_threshold()->set_value(2);
health_check.mutable_health_checks(0)->mutable_healthy_threshold()->set_value(2);
health_check.mutable_health_checks(0)->mutable_grpc_health_check();
health_check.mutable_health_checks(0)->mutable_http_health_check()->set_path("/healthcheck");
return health_check;
}
// Creates a basic HealthCheckSpecifier message containing one endpoint and
// one TCP health_check
envoy::service::health::v3::HealthCheckSpecifier makeTcpHealthCheckSpecifier() {
envoy::service::health::v3::HealthCheckSpecifier server_health_check_specifier_;
server_health_check_specifier_.mutable_interval()->set_nanos(100000000); // 0.1 seconds
auto* health_check = server_health_check_specifier_.add_cluster_health_checks();
health_check->set_cluster_name("anna");
Network::Utility::addressToProtobufAddress(
*host_upstream_->localAddress(),
*health_check->add_locality_endpoints()->add_endpoints()->mutable_address());
health_check->mutable_locality_endpoints(0)->mutable_locality()->set_region("middle_earth");
health_check->mutable_locality_endpoints(0)->mutable_locality()->set_zone("eriador");
health_check->mutable_locality_endpoints(0)->mutable_locality()->set_sub_zone("rivendell");
health_check->add_health_checks()->mutable_timeout()->set_seconds(MaxTimeout);
health_check->mutable_health_checks(0)->mutable_interval()->set_seconds(MaxTimeout);
health_check->mutable_health_checks(0)->mutable_unhealthy_threshold()->set_value(2);
health_check->mutable_health_checks(0)->mutable_healthy_threshold()->set_value(2);
auto* tcp_health_check = health_check->mutable_health_checks(0)->mutable_tcp_health_check();
tcp_health_check->mutable_send()->set_text("50696E67");
tcp_health_check->add_receive()->set_text("506F6E67");
return server_health_check_specifier_;
}
// Checks if Envoy reported the health status of an endpoint correctly
bool checkEndpointHealthResponse(envoy::service::health::v3::EndpointHealth endpoint,
envoy::config::core::v3::HealthStatus healthy,
Network::Address::InstanceConstSharedPtr address) {
if (healthy != endpoint.health_status()) {
return false;
}
if (address->ip()->port() != endpoint.endpoint().address().socket_address().port_value()) {
return false;
}
if (address->ip()->addressAsString() !=
endpoint.endpoint().address().socket_address().address()) {
return false;
}
return true;
}
// Checks if the cluster counters are correct
void checkCounters(int requests, int responses, int successes, int failures) {
EXPECT_EQ(requests, test_server_->counter("hds_delegate.requests")->value());
EXPECT_LE(responses, test_server_->counter("hds_delegate.responses")->value());
EXPECT_EQ(successes, test_server_->counter("cluster.anna.health_check.success")->value());
EXPECT_EQ(failures, test_server_->counter("cluster.anna.health_check.failure")->value());
}
void waitForEndpointHealthResponse(envoy::config::core::v3::HealthStatus healthy) {
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, response_));
while (!checkEndpointHealthResponse(response_.endpoint_health_response().endpoints_health(0),
healthy, host_upstream_->localAddress())) {
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, response_));
EXPECT_EQ("POST", hds_stream_->headers().getMethodValue());
EXPECT_EQ("/envoy.service.health.v3.HealthDiscoveryService/StreamHealthCheck",
hds_stream_->headers().getPathValue());
EXPECT_EQ("application/grpc", hds_stream_->headers().getContentTypeValue());
}
}
// check response has correct format and health response.
bool checkClusterEndpointHealthResponse(envoy::config::core::v3::HealthStatus healthy,
Network::Address::InstanceConstSharedPtr address,
int cluster, int locality, int endpoint) {
// Ensure that this grpc message is a health response.
if (response_.has_endpoint_health_response()) {
auto& health_response = response_.endpoint_health_response();
// Ensure that this response has a cluster available at the index.
if (health_response.cluster_endpoints_health_size() > cluster) {
auto& cluster_response = health_response.cluster_endpoints_health(cluster);
// Ensure that this response has a locality available at the index.
if (cluster_response.locality_endpoints_health_size() > locality) {
auto& locality_response = cluster_response.locality_endpoints_health(locality);
// Ensure that this response has a endpoint available at the index.
if (locality_response.endpoints_health_size() > endpoint) {
auto& endpoint_response = locality_response.endpoints_health(endpoint);
// Check to see if this endpoint has specified health status.
return checkEndpointHealthResponse(endpoint_response, healthy, address);
}
}
}
}
// Some field is missing, return false.
return false;
}
// wait until our response has desired health status for desired endpoint.
bool waitForClusterHealthResponse(envoy::config::core::v3::HealthStatus healthy,
Network::Address::InstanceConstSharedPtr address, int cluster,
int locality, int endpoint) {
// Get some response.
if (!hds_stream_->waitForGrpcMessage(*dispatcher_, response_)) {
return false;
}
// Check endpoint health status by indices.
while (!checkClusterEndpointHealthResponse(healthy, address, cluster, locality, endpoint)) {
if (!hds_stream_->waitForGrpcMessage(*dispatcher_, response_)) {
return false;
}
EXPECT_EQ("POST", hds_stream_->headers().getMethodValue());
EXPECT_EQ("/envoy.service.health.v3.HealthDiscoveryService/StreamHealthCheck",
hds_stream_->headers().getPathValue());
EXPECT_EQ("application/grpc", hds_stream_->headers().getContentTypeValue());
}
return true;
}
static constexpr uint32_t upstream_endpoints_ = 0;
FakeHttpConnectionPtr hds_fake_connection_;
FakeStreamPtr hds_stream_;
FakeUpstream* hds_upstream_{};
uint32_t hds_requests_{};
// These two are owned by fake_upstreams_
FakeUpstream* host_upstream_{};
FakeUpstream* host2_upstream_{};
FakeStreamPtr host_stream_;
FakeStreamPtr host2_stream_;
FakeHttpConnectionPtr host_fake_connection_;
FakeHttpConnectionPtr host2_fake_connection_;
FakeRawConnectionPtr host_fake_raw_connection_;
Http::CodecType http_conn_type_{Http::CodecType::HTTP1};
bool tls_hosts_{false};
static constexpr int MaxTimeout = 100;
envoy::service::health::v3::HealthCheckRequestOrEndpointHealthResponse envoy_msg_;
envoy::service::health::v3::HealthCheckRequestOrEndpointHealthResponse response_;
envoy::service::health::v3::HealthCheckSpecifier server_health_check_specifier_;
};
INSTANTIATE_TEST_SUITE_P(IpVersionsClientType, HdsIntegrationTest, GRPC_CLIENT_INTEGRATION_PARAMS,
Grpc::GrpcClientIntegrationParamTest::protocolTestParamsToString);
// Tests Envoy HTTP health checking a single healthy endpoint and reporting that it is
// indeed healthy to the server.
TEST_P(HdsIntegrationTest, SingleEndpointHealthyHttp) {
initialize();
// Server <--> Envoy
waitForHdsStream();
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, envoy_msg_));
EXPECT_EQ(envoy_msg_.health_check_request().capability().health_check_protocols(0),
envoy::service::health::v3::Capability::HTTP);
// Server asks for health checking
server_health_check_specifier_ =
makeHttpHealthCheckSpecifier(envoy::type::v3::CodecClientType::HTTP1, false);
hds_stream_->startGrpcStream();
hds_stream_->sendGrpcMessage(server_health_check_specifier_);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
// Envoy sends a health check message to an endpoint
healthcheckEndpoints();
// Endpoint responds to the health check
host_stream_->encodeHeaders(Http::TestResponseHeaderMapImpl{{":status", "200"}}, false);
host_stream_->encodeData(1024, true);
// Receive updates until the one we expect arrives
waitForEndpointHealthResponse(envoy::config::core::v3::HEALTHY);
checkCounters(1, 2, 1, 0);
// Clean up connections
cleanupHostConnections();
cleanupHdsConnection();
}
// Tests Envoy HTTP health checking a single endpoint that times out and reporting
// that it is unhealthy to the server.
TEST_P(HdsIntegrationTest, SingleEndpointTimeoutHttp) {
initialize();
server_health_check_specifier_ =
makeHttpHealthCheckSpecifier(envoy::type::v3::CodecClientType::HTTP1, false);
server_health_check_specifier_.mutable_cluster_health_checks(0)
->mutable_health_checks(0)
->mutable_timeout()
->set_seconds(0);
server_health_check_specifier_.mutable_cluster_health_checks(0)
->mutable_health_checks(0)
->mutable_timeout()
->set_nanos(100000000); // 0.1 seconds
// Server <--> Envoy
waitForHdsStream();
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, envoy_msg_));
// Server asks for health checking
hds_stream_->startGrpcStream();
hds_stream_->sendGrpcMessage(server_health_check_specifier_);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
// Envoy sends a health check message to an endpoint
ASSERT_TRUE(host_upstream_->waitForRawConnection(host_fake_raw_connection_));
// Endpoint doesn't respond to the health check
ASSERT_TRUE(host_fake_raw_connection_->waitForDisconnect());
// Receive updates until the one we expect arrives
waitForEndpointHealthResponse(envoy::config::core::v3::TIMEOUT);
checkCounters(1, 2, 0, 1);
// Clean up connections
cleanupHostConnections();
cleanupHdsConnection();
}
// Tests Envoy HTTP health checking a single unhealthy endpoint and reporting that it is
// indeed unhealthy to the server.
TEST_P(HdsIntegrationTest, SingleEndpointUnhealthyHttp) {
initialize();
server_health_check_specifier_ =
makeHttpHealthCheckSpecifier(envoy::type::v3::CodecClientType::HTTP1, false);
// Server <--> Envoy
waitForHdsStream();
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, envoy_msg_));
// Server asks for health checking
hds_stream_->startGrpcStream();
hds_stream_->sendGrpcMessage(server_health_check_specifier_);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
// Envoy sends a health check message to an endpoint
healthcheckEndpoints();
// Endpoint responds to the health check
host_stream_->encodeHeaders(Http::TestResponseHeaderMapImpl{{":status", "404"}}, false);
host_stream_->encodeData(1024, true);
// Receive updates until the one we expect arrives
waitForEndpointHealthResponse(envoy::config::core::v3::UNHEALTHY);
checkCounters(1, 2, 0, 1);
// Clean up connections
cleanupHostConnections();
cleanupHdsConnection();
}
// Tests Envoy TCP health checking an endpoint that doesn't respond and reporting that it is
// unhealthy to the server.
TEST_P(HdsIntegrationTest, SingleEndpointTimeoutTcp) {
initialize();
// Server <--> Envoy
waitForHdsStream();
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, envoy_msg_));
EXPECT_EQ(envoy_msg_.health_check_request().capability().health_check_protocols(1),
envoy::service::health::v3::Capability::TCP);
// Server asks for health checking
server_health_check_specifier_ = makeTcpHealthCheckSpecifier();
server_health_check_specifier_.mutable_cluster_health_checks(0)
->mutable_health_checks(0)
->mutable_timeout()
->set_seconds(0);
server_health_check_specifier_.mutable_cluster_health_checks(0)
->mutable_health_checks(0)
->mutable_timeout()
->set_nanos(100000000); // 0.1 seconds
hds_stream_->startGrpcStream();
hds_stream_->sendGrpcMessage(server_health_check_specifier_);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
// Envoys asks the endpoint if it's healthy
ASSERT_TRUE(host_upstream_->waitForRawConnection(host_fake_raw_connection_));
// No response from the endpoint
ASSERT_TRUE(host_fake_raw_connection_->waitForDisconnect());
// Receive updates until the one we expect arrives
waitForEndpointHealthResponse(envoy::config::core::v3::TIMEOUT);
// Clean up connections
cleanupHostConnections();
cleanupHdsConnection();
}
// Tests Envoy TCP health checking a single healthy endpoint and reporting that it is
// indeed healthy to the server.
TEST_P(HdsIntegrationTest, SingleEndpointHealthyTcp) {
initialize();
// Server <--> Envoy
waitForHdsStream();
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, envoy_msg_));
// Server asks for health checking
server_health_check_specifier_ = makeTcpHealthCheckSpecifier();
hds_stream_->startGrpcStream();
hds_stream_->sendGrpcMessage(server_health_check_specifier_);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
// Envoy asks the endpoint if it's healthy
ASSERT_TRUE(host_upstream_->waitForRawConnection(host_fake_raw_connection_));
ASSERT_TRUE(
host_fake_raw_connection_->waitForData(FakeRawConnection::waitForInexactMatch("Ping")));
AssertionResult result = host_fake_raw_connection_->write("Pong");
RELEASE_ASSERT(result, result.message());
// Receive updates until the one we expect arrives
waitForEndpointHealthResponse(envoy::config::core::v3::HEALTHY);
// Clean up connections
cleanupHostConnections();
cleanupHdsConnection();
}
// Tests Envoy TCP health checking a single unhealthy endpoint and reporting that it is
// indeed unhealthy to the server.
TEST_P(HdsIntegrationTest, SingleEndpointUnhealthyTcp) {
initialize();
// Server <--> Envoy
waitForHdsStream();
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, envoy_msg_));
// Server asks for health checking
server_health_check_specifier_ = makeTcpHealthCheckSpecifier();
server_health_check_specifier_.mutable_cluster_health_checks(0)
->mutable_health_checks(0)
->mutable_timeout()
->set_seconds(2);
hds_stream_->startGrpcStream();
hds_stream_->sendGrpcMessage(server_health_check_specifier_);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
// Envoy asks the endpoint if it's healthy
ASSERT_TRUE(host_upstream_->waitForRawConnection(host_fake_raw_connection_));
ASSERT_TRUE(
host_fake_raw_connection_->waitForData(FakeRawConnection::waitForInexactMatch("Ping")));
AssertionResult result = host_fake_raw_connection_->write("Voronoi");
RELEASE_ASSERT(result, result.message());
// Receive updates until the one we expect arrives
waitForEndpointHealthResponse(envoy::config::core::v3::UNHEALTHY);
// Clean up connections
cleanupHostConnections();
cleanupHdsConnection();
}
// Tests that Envoy can HTTP health check two hosts that are in the same cluster, and
// the same locality and report back the correct health statuses.
TEST_P(HdsIntegrationTest, TwoEndpointsSameLocality) {
initialize();
server_health_check_specifier_ =
makeHttpHealthCheckSpecifier(envoy::type::v3::CodecClientType::HTTP1, false);
Network::Utility::addressToProtobufAddress(
*host2_upstream_->localAddress(),
*server_health_check_specifier_.mutable_cluster_health_checks(0)
->mutable_locality_endpoints(0)
->add_endpoints()
->mutable_address());
// Server <--> Envoy
waitForHdsStream();
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, envoy_msg_));
// Server asks for health checking
hds_stream_->startGrpcStream();
hds_stream_->sendGrpcMessage(server_health_check_specifier_);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
healthcheckEndpoints("anna");
// Endpoints respond to the health check
host_stream_->encodeHeaders(Http::TestResponseHeaderMapImpl{{":status", "404"}}, false);
host_stream_->encodeData(1024, true);
host2_stream_->encodeHeaders(Http::TestResponseHeaderMapImpl{{":status", "200"}}, false);
host2_stream_->encodeData(1024, true);
// Receive updates until the one we expect arrives
ASSERT_TRUE(waitForClusterHealthResponse(envoy::config::core::v3::HEALTHY,
host2_upstream_->localAddress(), 0, 0, 1));
// Ensure we have at least one cluster before trying to read it.
ASSERT_EQ(response_.endpoint_health_response().cluster_endpoints_health_size(), 1);
// store cluster response info for easier reference.
const auto& cluster_response = response_.endpoint_health_response().cluster_endpoints_health(0);
// Check cluster has correct name and number of localities (1)
EXPECT_EQ(cluster_response.cluster_name(), "anna");
ASSERT_EQ(cluster_response.locality_endpoints_health_size(), 1);
// check the only locality and its endpoints.
const auto& locality_response = cluster_response.locality_endpoints_health(0);
EXPECT_EQ(locality_response.locality().sub_zone(), "hobbiton");
ASSERT_EQ(locality_response.endpoints_health_size(), 2);
EXPECT_TRUE(checkEndpointHealthResponse(locality_response.endpoints_health(0),
envoy::config::core::v3::UNHEALTHY,
host_upstream_->localAddress()));
checkCounters(1, 2, 1, 1);
// Clean up connections
cleanupHostConnections();
cleanupHdsConnection();
}
// Tests that Envoy can HTTP health check two hosts that are in the same cluster, and
// different localities and report back the correct health statuses.
TEST_P(HdsIntegrationTest, TwoEndpointsDifferentLocality) {
initialize();
server_health_check_specifier_ =
makeHttpHealthCheckSpecifier(envoy::type::v3::CodecClientType::HTTP1, false);
// Add endpoint
auto* health_check = server_health_check_specifier_.mutable_cluster_health_checks(0);
Network::Utility::addressToProtobufAddress(
*host2_upstream_->localAddress(),
*health_check->add_locality_endpoints()->add_endpoints()->mutable_address());
health_check->mutable_locality_endpoints(1)->mutable_locality()->set_region("plakias");
health_check->mutable_locality_endpoints(1)->mutable_locality()->set_zone("fragokastelo");
health_check->mutable_locality_endpoints(1)->mutable_locality()->set_sub_zone("emplisi");
// Server <--> Envoy
waitForHdsStream();
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, envoy_msg_));
// Server asks for health checking
hds_stream_->startGrpcStream();
hds_stream_->sendGrpcMessage(server_health_check_specifier_);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
// Envoy sends health check messages to two endpoints
healthcheckEndpoints("anna");
// Endpoint responds to the health check
host_stream_->encodeHeaders(Http::TestResponseHeaderMapImpl{{":status", "404"}}, false);
host_stream_->encodeData(1024, true);
host2_stream_->encodeHeaders(Http::TestResponseHeaderMapImpl{{":status", "200"}}, false);
host2_stream_->encodeData(1024, true);
// Receive updates until the one we expect arrives
ASSERT_TRUE(waitForClusterHealthResponse(envoy::config::core::v3::HEALTHY,
host2_upstream_->localAddress(), 0, 1, 0));
ASSERT_EQ(response_.endpoint_health_response().cluster_endpoints_health_size(), 1);
// store cluster response info for easier reference.
const auto& cluster_response = response_.endpoint_health_response().cluster_endpoints_health(0);
// Check cluster has correct name and number of localities (2)
EXPECT_EQ(cluster_response.cluster_name(), "anna");
ASSERT_EQ(cluster_response.locality_endpoints_health_size(), 2);
// check first locality.
const auto& locality_resp0 = cluster_response.locality_endpoints_health(0);
EXPECT_EQ(locality_resp0.locality().sub_zone(), "hobbiton");
ASSERT_EQ(locality_resp0.endpoints_health_size(), 1);
EXPECT_TRUE(checkEndpointHealthResponse(locality_resp0.endpoints_health(0),
envoy::config::core::v3::UNHEALTHY,
host_upstream_->localAddress()));
// check second locality.
const auto& locality_resp1 = cluster_response.locality_endpoints_health(1);
EXPECT_EQ(locality_resp1.locality().sub_zone(), "emplisi");
ASSERT_EQ(locality_resp1.endpoints_health_size(), 1);
checkCounters(1, 2, 1, 1);
// Clean up connections
cleanupHostConnections();
cleanupHdsConnection();
}
// Tests that Envoy can HTTP health check two hosts that are in different clusters, and
// report back the correct health statuses.
TEST_P(HdsIntegrationTest, TwoEndpointsDifferentClusters) {
initialize();
server_health_check_specifier_ =
makeHttpHealthCheckSpecifier(envoy::type::v3::CodecClientType::HTTP1, false);
// Add Second Cluster
server_health_check_specifier_.add_cluster_health_checks()->MergeFrom(createSecondCluster("cat"));
// Server <--> Envoy
waitForHdsStream();
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, envoy_msg_));
// Server asks for health checking
hds_stream_->startGrpcStream();
hds_stream_->sendGrpcMessage(server_health_check_specifier_);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
// Envoy sends health check messages to two endpoints
healthcheckEndpoints("cat");
// Endpoint responds to the health check
host_stream_->encodeHeaders(Http::TestResponseHeaderMapImpl{{":status", "404"}}, false);
host_stream_->encodeData(1024, true);
host2_stream_->encodeHeaders(Http::TestResponseHeaderMapImpl{{":status", "200"}}, false);
host2_stream_->encodeData(1024, true);
// Receive updates until the one we expect arrives
ASSERT_TRUE(waitForClusterHealthResponse(envoy::config::core::v3::HEALTHY,
host2_upstream_->localAddress(), 1, 0, 0));
ASSERT_EQ(response_.endpoint_health_response().cluster_endpoints_health_size(), 2);
// store cluster response info for easier reference.
const auto& cluster_resp0 = response_.endpoint_health_response().cluster_endpoints_health(0);
const auto& cluster_resp1 = response_.endpoint_health_response().cluster_endpoints_health(1);
// check cluster info and sizes.
EXPECT_EQ(cluster_resp0.cluster_name(), "anna");
ASSERT_EQ(cluster_resp0.locality_endpoints_health_size(), 1);
EXPECT_EQ(cluster_resp1.cluster_name(), "cat");
ASSERT_EQ(cluster_resp1.locality_endpoints_health_size(), 1);
// store locality response info for easier reference.
const auto& locality_resp0 = cluster_resp0.locality_endpoints_health(0);
const auto& locality_resp1 = cluster_resp1.locality_endpoints_health(0);
// check locality info and sizes.
EXPECT_EQ(locality_resp0.locality().sub_zone(), "hobbiton");
ASSERT_EQ(locality_resp0.endpoints_health_size(), 1);
EXPECT_EQ(locality_resp1.locality().sub_zone(), "paris");
ASSERT_EQ(locality_resp1.endpoints_health_size(), 1);
// check endpoints.
EXPECT_TRUE(checkEndpointHealthResponse(locality_resp0.endpoints_health(0),
envoy::config::core::v3::UNHEALTHY,
host_upstream_->localAddress()));
checkCounters(1, 2, 0, 1);
EXPECT_EQ(1, test_server_->counter("cluster.cat.health_check.success")->value());
EXPECT_EQ(0, test_server_->counter("cluster.cat.health_check.failure")->value());
// Clean up connections
cleanupHostConnections();
cleanupHdsConnection();
}
// Tests Envoy HTTP health checking a single endpoint, receiving an update
// message from the management server and health checking a new endpoint
TEST_P(HdsIntegrationTest, TestUpdateMessage) {
initialize();
// Server <--> Envoy
waitForHdsStream();
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, envoy_msg_));
// Server asks for health checking
server_health_check_specifier_ =
makeHttpHealthCheckSpecifier(envoy::type::v3::CodecClientType::HTTP1, false);
hds_stream_->startGrpcStream();
hds_stream_->sendGrpcMessage(server_health_check_specifier_);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
// Envoy sends a health check message to an endpoint
healthcheckEndpoints();
// Endpoint responds to the health check
host_stream_->encodeHeaders(Http::TestResponseHeaderMapImpl{{":status", "200"}}, false);
host_stream_->encodeData(1024, true);
// Receive updates until the one we expect arrives
waitForEndpointHealthResponse(envoy::config::core::v3::HEALTHY);
checkCounters(1, 2, 1, 0);
cleanupHostConnections();
// New HealthCheckSpecifier message
envoy::service::health::v3::HealthCheckSpecifier new_message;
new_message.mutable_interval()->set_nanos(100000000); // 0.1 seconds
auto* health_check = new_message.add_cluster_health_checks();
health_check->set_cluster_name("cat");
Network::Utility::addressToProtobufAddress(
*host2_upstream_->localAddress(),
*health_check->add_locality_endpoints()->add_endpoints()->mutable_address());
health_check->mutable_locality_endpoints(0)->mutable_locality()->set_region("matala");
health_check->mutable_locality_endpoints(0)->mutable_locality()->set_zone("tilburg");
health_check->mutable_locality_endpoints(0)->mutable_locality()->set_sub_zone("rivendell");
health_check->add_health_checks()->mutable_timeout()->set_seconds(MaxTimeout);
health_check->mutable_health_checks(0)->mutable_interval()->set_seconds(MaxTimeout);
health_check->mutable_health_checks(0)->mutable_unhealthy_threshold()->set_value(2);
health_check->mutable_health_checks(0)->mutable_healthy_threshold()->set_value(2);
health_check->mutable_health_checks(0)->mutable_grpc_health_check();
health_check->mutable_health_checks(0)->mutable_http_health_check()->set_path("/healthcheck");
// Server asks for health checking with the new message
hds_stream_->sendGrpcMessage(new_message);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
// Envoy sends a health check message to an endpoint
ASSERT_TRUE(host2_upstream_->waitForHttpConnection(*dispatcher_, host2_fake_connection_));
ASSERT_TRUE(host2_fake_connection_->waitForNewStream(*dispatcher_, host2_stream_));
ASSERT_TRUE(host2_stream_->waitForEndStream(*dispatcher_));
// Endpoint responds to the health check
host2_stream_->encodeHeaders(Http::TestResponseHeaderMapImpl{{":status", "404"}}, false);
host2_stream_->encodeData(1024, true);
// Receive updates until the one we expect arrives
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, response_));
while (!checkEndpointHealthResponse(response_.endpoint_health_response().endpoints_health(0),
envoy::config::core::v3::UNHEALTHY,
host2_upstream_->localAddress())) {
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, response_));
}
// Clean up connections
cleanupHostConnections();
cleanupHdsConnection();
}
// Tests Envoy HTTP health checking a single endpoint, receiving an update
// message from the management server and reporting in a new interval
TEST_P(HdsIntegrationTest, TestUpdateChangesTimer) {
initialize();
// Server <--> Envoy
waitForHdsStream();
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, envoy_msg_));
// Server asks for health checking
server_health_check_specifier_ =
makeHttpHealthCheckSpecifier(envoy::type::v3::CodecClientType::HTTP1, false);
hds_stream_->startGrpcStream();
hds_stream_->sendGrpcMessage(server_health_check_specifier_);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
healthcheckEndpoints();
// an update should be received after interval
ASSERT_TRUE(
hds_stream_->waitForGrpcMessage(*dispatcher_, response_, std::chrono::milliseconds(250)));
// New HealthCheckSpecifier message
server_health_check_specifier_.mutable_interval()->set_nanos(300000000); // 0.3 seconds
// Server asks for health checking with the new message
hds_stream_->sendGrpcMessage(server_health_check_specifier_);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
// A response should not be received until the new timer is completed
ASSERT_FALSE(
hds_stream_->waitForGrpcMessage(*dispatcher_, response_, std::chrono::milliseconds(100)));
// Response should be received now
ASSERT_TRUE(
hds_stream_->waitForGrpcMessage(*dispatcher_, response_, std::chrono::milliseconds(400)));
// Clean up connections
cleanupHostConnections();
cleanupHdsConnection();
}
// Tests Envoy HTTP health checking a single endpoint when interval hasn't been defined
TEST_P(HdsIntegrationTest, TestDefaultTimer) {
initialize();
// Server <--> Envoy
waitForHdsStream();
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, envoy_msg_));
// Server asks for health checking
server_health_check_specifier_ =
makeHttpHealthCheckSpecifier(envoy::type::v3::CodecClientType::HTTP1, false);
server_health_check_specifier_.clear_interval();
hds_stream_->startGrpcStream();
hds_stream_->sendGrpcMessage(server_health_check_specifier_);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
healthcheckEndpoints();
// an update should be received after interval
ASSERT_TRUE(
hds_stream_->waitForGrpcMessage(*dispatcher_, response_, std::chrono::milliseconds(2500)));
// Clean up connections
cleanupHostConnections();
cleanupHdsConnection();
}
// Health checks a single endpoint over TLS with HTTP/2
TEST_P(HdsIntegrationTest, SingleEndpointHealthyTlsHttp2) {
// Change member variable to specify host streams to have tls transport socket.
tls_hosts_ = true;
// Change hosts to operate over HTTP/2 instead of default HTTP.
http_conn_type_ = Http::CodecType::HTTP2;
initialize();
// Server <--> Envoy
waitForHdsStream();
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, envoy_msg_));
EXPECT_EQ(envoy_msg_.health_check_request().capability().health_check_protocols(0),
envoy::service::health::v3::Capability::HTTP);
// Server asks for health checking
server_health_check_specifier_ =
makeHttpHealthCheckSpecifier(envoy::type::v3::CodecClientType::HTTP2, true);
hds_stream_->startGrpcStream();
hds_stream_->sendGrpcMessage(server_health_check_specifier_);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
// Envoy sends a health check message to an endpoint
healthcheckEndpoints();
// Endpoint responds to the health check
host_stream_->encodeHeaders(Http::TestResponseHeaderMapImpl{{":status", "200"}}, false);
host_stream_->encodeData(1024, true);
// Receive updates until the one we expect arrives
waitForEndpointHealthResponse(envoy::config::core::v3::HEALTHY);
checkCounters(1, 2, 1, 0);
// Clean up connections
cleanupHostConnections();
cleanupHdsConnection();
}
// Health checks a single endpoint over TLS with HTTP/1
TEST_P(HdsIntegrationTest, SingleEndpointHealthyTlsHttp1) {
// Change member variable to specify host streams to have tls transport socket.
tls_hosts_ = true;
initialize();
// Server <--> Envoy
waitForHdsStream();
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, envoy_msg_));
EXPECT_EQ(envoy_msg_.health_check_request().capability().health_check_protocols(0),
envoy::service::health::v3::Capability::HTTP);
// Server asks for health checking
server_health_check_specifier_ =
makeHttpHealthCheckSpecifier(envoy::type::v3::CodecClientType::HTTP1, true);
hds_stream_->startGrpcStream();
hds_stream_->sendGrpcMessage(server_health_check_specifier_);
test_server_->waitForCounterGe("hds_delegate.requests", ++hds_requests_);
// Envoy sends a health check message to an endpoint
healthcheckEndpoints();
// Endpoint responds to the health check
host_stream_->encodeHeaders(Http::TestResponseHeaderMapImpl{{":status", "200"}}, false);
host_stream_->encodeData(1024, true);
// Receive updates until the one we expect arrives
waitForEndpointHealthResponse(envoy::config::core::v3::HEALTHY);
checkCounters(1, 2, 1, 0);
// Clean up connections
cleanupHostConnections();
cleanupHdsConnection();
}
// Attempts to health check a TLS endpoint over plaintext, which should fail.
TEST_P(HdsIntegrationTest, SingleEndpointUnhealthyTlsMissingSocketMatch) {
// Make the endpoints expect communication over TLS.
tls_hosts_ = true;
initialize();
// Server <--> Envoy
waitForHdsStream();
ASSERT_TRUE(hds_stream_->waitForGrpcMessage(*dispatcher_, envoy_msg_));