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 1001 1002 1003 1004 1005
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "net/test/embedded_test_server/embedded_test_server.h"
#include <memory>
#include <tuple>
#include <utility>
#include "base/containers/span.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/memory/weak_ptr.h"
#include "base/message_loop/message_pump_type.h"
#include "base/path_service.h"
#include "base/run_loop.h"
#include "base/strings/stringprintf.h"
#include "base/synchronization/atomic_flag.h"
#include "base/synchronization/lock.h"
#include "base/task/single_thread_task_executor.h"
#include "base/task/single_thread_task_runner.h"
#include "base/test/bind.h"
#include "base/threading/thread.h"
#include "base/types/expected.h"
#include "build/build_config.h"
#include "net/base/elements_upload_data_stream.h"
#include "net/base/proxy_chain.h"
#include "net/base/proxy_server.h"
#include "net/base/test_completion_callback.h"
#include "net/base/upload_bytes_element_reader.h"
#include "net/http/http_response_headers.h"
#include "net/http/http_status_code.h"
#include "net/log/net_log_source.h"
#include "net/proxy_resolution/configured_proxy_resolution_service.h"
#include "net/proxy_resolution/proxy_config.h"
#include "net/proxy_resolution/proxy_config_service_fixed.h"
#include "net/socket/client_socket_factory.h"
#include "net/socket/stream_socket.h"
#include "net/test/embedded_test_server/embedded_test_server_connection_listener.h"
#include "net/test/embedded_test_server/http_request.h"
#include "net/test/embedded_test_server/http_response.h"
#include "net/test/embedded_test_server/request_handler_util.h"
#include "net/test/gtest_util.h"
#include "net/test/test_with_task_environment.h"
#include "net/traffic_annotation/network_traffic_annotation_test_helper.h"
#include "net/url_request/url_request.h"
#include "net/url_request/url_request_context.h"
#include "net/url_request/url_request_context_builder.h"
#include "net/url_request/url_request_test_util.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using net::test::IsOk;
namespace net::test_server {
// Gets notified by the EmbeddedTestServer on incoming connections being
// accepted, read from, or closed.
class TestConnectionListener
: public net::test_server::EmbeddedTestServerConnectionListener {
public:
TestConnectionListener()
: task_runner_(base::SingleThreadTaskRunner::GetCurrentDefault()) {}
TestConnectionListener(const TestConnectionListener&) = delete;
TestConnectionListener& operator=(const TestConnectionListener&) = delete;
~TestConnectionListener() override = default;
// Get called from the EmbeddedTestServer thread to be notified that
// a connection was accepted.
std::unique_ptr<StreamSocket> AcceptedSocket(
std::unique_ptr<StreamSocket> connection) override {
base::AutoLock lock(lock_);
++socket_accepted_count_;
accept_loop_.Quit();
return connection;
}
// Get called from the EmbeddedTestServer thread to be notified that
// a connection was read from.
void ReadFromSocket(const net::StreamSocket& connection, int rv) override {
base::AutoLock lock(lock_);
did_read_from_socket_ = true;
}
void OnResponseCompletedSuccessfully(
std::unique_ptr<StreamSocket> socket) override {
base::AutoLock lock(lock_);
did_get_socket_on_complete_ = socket && socket->IsConnected();
complete_loop_.Quit();
}
void WaitUntilFirstConnectionAccepted() { accept_loop_.Run(); }
void WaitUntilGotSocketFromResponseCompleted() { complete_loop_.Run(); }
size_t SocketAcceptedCount() const {
base::AutoLock lock(lock_);
return socket_accepted_count_;
}
bool DidReadFromSocket() const {
base::AutoLock lock(lock_);
return did_read_from_socket_;
}
bool DidGetSocketOnComplete() const {
base::AutoLock lock(lock_);
return did_get_socket_on_complete_;
}
private:
size_t socket_accepted_count_ = 0;
bool did_read_from_socket_ = false;
bool did_get_socket_on_complete_ = false;
base::RunLoop accept_loop_;
base::RunLoop complete_loop_;
scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
mutable base::Lock lock_;
};
struct EmbeddedTestServerConfig {
EmbeddedTestServer::Type type;
HttpConnection::Protocol protocol;
std::optional<EmbeddedTestServer::Type> proxy_type;
};
std::vector<EmbeddedTestServerConfig> EmbeddedTestServerConfigs() {
return {
{EmbeddedTestServer::TYPE_HTTP, HttpConnection::Protocol::kHttp1,
/*proxy_type=*/std::nullopt},
{EmbeddedTestServer::TYPE_HTTPS, HttpConnection::Protocol::kHttp1,
/*proxy_type=*/std::nullopt},
{EmbeddedTestServer::TYPE_HTTPS, HttpConnection::Protocol::kHttp2,
/*proxy_type=*/std::nullopt},
// Proxy is HTTP/1.x CONNECT only, so can't be used with HTTP and proxy
// itself can't use HTTP/2. Testing all combinations of proxy server and
// destination server protocol seems not useful, so test HTTP/1.x server
// with HTTP proxy, and HTTP/2 server with HTTPS proxy, but each
// non-HTTP destination server type should work with the other proxy type.
{EmbeddedTestServer::TYPE_HTTPS, HttpConnection::Protocol::kHttp1,
/*proxy_type=*/EmbeddedTestServer::TYPE_HTTP},
{EmbeddedTestServer::TYPE_HTTPS, HttpConnection::Protocol::kHttp2,
/*proxy_type=*/EmbeddedTestServer::TYPE_HTTPS},
};
}
class EmbeddedTestServerTest
: public testing::TestWithParam<EmbeddedTestServerConfig>,
public WithTaskEnvironment {
public:
EmbeddedTestServerTest() {
server_ = std::make_unique<EmbeddedTestServer>(GetParam().type,
GetParam().protocol);
server_->AddDefaultHandlers();
server_->SetConnectionListener(&connection_listener_);
}
~EmbeddedTestServerTest() override {
if (server_->Started()) {
EXPECT_TRUE(server_->ShutdownAndWaitUntilComplete());
}
if (proxy_server_ && proxy_server_->Started()) {
EXPECT_TRUE(proxy_server_->ShutdownAndWaitUntilComplete());
}
}
// Helper to start `server_`, `proxy_server_` (if needed), and populate
// `context_`. This is need because the proxy server needs the server to be
// started, but starting the server (or even just creating the listen socket)
// prevents modifying the server in certain ways, so some individual tests
// have to configure the server before any of this can happen.
//
// `disable_proxy_destination_restrictions` remove the destination
// restrictions on the connect proxy, which normally restrict connections to
// be only to `server_->host_port_pair()`.
testing::AssertionResult StartServerAndSetUpContext(
bool disable_proxy_destination_restrictions = false) {
if (!server_->Start()) {
return testing::AssertionFailure() << "Failed to start server.";
}
auto builder = CreateTestURLRequestContextBuilder();
if (GetParam().proxy_type) {
proxy_server_ =
std::make_unique<EmbeddedTestServer>(*GetParam().proxy_type);
proxy_server_->EnableConnectProxy(
server_->port(),
disable_proxy_destination_restrictions
? std::nullopt
: std::optional(/*expected_dest=*/server_->host_port_pair()));
if (!proxy_server_->Start()) {
return testing::AssertionFailure() << "Failed to start proxy.";
}
// Set up the URLRequestContext to use the proxy server.
ProxyConfig proxy_config;
proxy_config.proxy_rules().ParseFromString(
proxy_server_->GetOrigin().Serialize());
// Need this to avoid default bypass rules to not use proxy for localhost.
proxy_config.proxy_rules().bypass_rules.AddRulesToSubtractImplicit();
ProxyConfigWithAnnotation annotated_config(proxy_config,
TRAFFIC_ANNOTATION_FOR_TESTS);
builder->set_proxy_resolution_service(
ConfiguredProxyResolutionService::CreateWithoutProxyResolver(
std::make_unique<ProxyConfigServiceFixed>(
std::move(annotated_config)),
/*net_log=*/nullptr));
}
context_ = builder->Build();
return testing::AssertionSuccess();
}
// Handles |request| sent to |path| and returns the response per |content|,
// |content type|, and |code|. Saves the request URL for verification.
std::unique_ptr<HttpResponse> HandleRequest(const std::string& path,
const std::string& content,
const std::string& content_type,
HttpStatusCode code,
const HttpRequest& request) {
request_relative_url_ = request.relative_url;
request_absolute_url_ = request.GetURL();
if (request_absolute_url_.path() == path) {
auto http_response = std::make_unique<BasicHttpResponse>();
http_response->set_code(code);
http_response->set_content(content);
http_response->set_content_type(content_type);
return http_response;
}
return nullptr;
}
// The ProxyChain requests are expected to use.
ProxyChain ExpectedProxyChain() const {
if (GetParam().proxy_type) {
return ProxyChain(GetParam().proxy_type == EmbeddedTestServer::TYPE_HTTP
? ProxyServer::SCHEME_HTTP
: ProxyServer::SCHEME_HTTPS,
proxy_server_->host_port_pair());
} else {
return ProxyChain::Direct();
}
}
protected:
std::string request_relative_url_;
GURL request_absolute_url_;
std::unique_ptr<URLRequestContext> context_;
TestConnectionListener connection_listener_;
std::unique_ptr<EmbeddedTestServer> server_;
std::unique_ptr<EmbeddedTestServer> proxy_server_;
base::OnceClosure quit_run_loop_;
};
TEST_P(EmbeddedTestServerTest, GetBaseURL) {
ASSERT_TRUE(StartServerAndSetUpContext());
if (GetParam().type == EmbeddedTestServer::TYPE_HTTPS) {
EXPECT_EQ(base::StringPrintf("https://127.0.0.1:%u/", server_->port()),
server_->base_url().spec());
} else {
EXPECT_EQ(base::StringPrintf("http://127.0.0.1:%u/", server_->port()),
server_->base_url().spec());
}
}
TEST_P(EmbeddedTestServerTest, GetURL) {
ASSERT_TRUE(StartServerAndSetUpContext());
if (GetParam().type == EmbeddedTestServer::TYPE_HTTPS) {
EXPECT_EQ(base::StringPrintf("https://127.0.0.1:%u/path?query=foo",
server_->port()),
server_->GetURL("/path?query=foo").spec());
} else {
EXPECT_EQ(base::StringPrintf("http://127.0.0.1:%u/path?query=foo",
server_->port()),
server_->GetURL("/path?query=foo").spec());
}
}
TEST_P(EmbeddedTestServerTest, GetURLWithHostname) {
ASSERT_TRUE(StartServerAndSetUpContext());
if (GetParam().type == EmbeddedTestServer::TYPE_HTTPS) {
EXPECT_EQ(base::StringPrintf("https://foo.com:%d/path?query=foo",
server_->port()),
server_->GetURL("foo.com", "/path?query=foo").spec());
} else {
EXPECT_EQ(
base::StringPrintf("http://foo.com:%d/path?query=foo", server_->port()),
server_->GetURL("foo.com", "/path?query=foo").spec());
}
}
TEST_P(EmbeddedTestServerTest, RegisterRequestHandler) {
server_->RegisterRequestHandler(base::BindRepeating(
&EmbeddedTestServerTest::HandleRequest, base::Unretained(this), "/test",
"<b>Worked!</b>", "text/html", HTTP_OK));
ASSERT_TRUE(StartServerAndSetUpContext());
TestDelegate delegate;
std::unique_ptr<URLRequest> request(
context_->CreateRequest(server_->GetURL("/test?q=foo"), DEFAULT_PRIORITY,
&delegate, TRAFFIC_ANNOTATION_FOR_TESTS));
request->Start();
delegate.RunUntilComplete();
EXPECT_EQ(net::OK, delegate.request_status());
ASSERT_TRUE(request->response_headers());
EXPECT_EQ(HTTP_OK, request->response_headers()->response_code());
EXPECT_EQ("<b>Worked!</b>", delegate.data_received());
EXPECT_EQ(request->response_headers()->GetNormalizedHeader("Content-Type"),
"text/html");
EXPECT_EQ(request->proxy_chain(), ExpectedProxyChain());
EXPECT_EQ("/test?q=foo", request_relative_url_);
EXPECT_EQ(server_->GetURL("/test?q=foo"), request_absolute_url_);
}
TEST_P(EmbeddedTestServerTest, ServeFilesFromDirectory) {
base::FilePath src_dir;
ASSERT_TRUE(base::PathService::Get(base::DIR_SRC_TEST_DATA_ROOT, &src_dir));
server_->ServeFilesFromDirectory(
src_dir.AppendASCII("net").AppendASCII("data"));
ASSERT_TRUE(StartServerAndSetUpContext());
TestDelegate delegate;
std::unique_ptr<URLRequest> request(
context_->CreateRequest(server_->GetURL("/test.html"), DEFAULT_PRIORITY,
&delegate, TRAFFIC_ANNOTATION_FOR_TESTS));
request->Start();
delegate.RunUntilComplete();
EXPECT_EQ(net::OK, delegate.request_status());
ASSERT_TRUE(request->response_headers());
EXPECT_EQ(HTTP_OK, request->response_headers()->response_code());
EXPECT_EQ("<p>Hello World!</p>", delegate.data_received());
EXPECT_EQ(request->response_headers()->GetNormalizedHeader("Content-Type"),
"text/html");
EXPECT_EQ(request->proxy_chain(), ExpectedProxyChain());
}
TEST_P(EmbeddedTestServerTest, MockHeadersWithoutCRLF) {
// Messing with raw headers isn't compatible with HTTP/2
if (GetParam().protocol == HttpConnection::Protocol::kHttp2)
return;
base::FilePath src_dir;
ASSERT_TRUE(base::PathService::Get(base::DIR_SRC_TEST_DATA_ROOT, &src_dir));
server_->ServeFilesFromDirectory(
src_dir.AppendASCII("net").AppendASCII("data").AppendASCII(
"embedded_test_server"));
ASSERT_TRUE(StartServerAndSetUpContext());
TestDelegate delegate;
std::unique_ptr<URLRequest> request(context_->CreateRequest(
server_->GetURL("/mock-headers-without-crlf.html"), DEFAULT_PRIORITY,
&delegate, TRAFFIC_ANNOTATION_FOR_TESTS));
request->Start();
delegate.RunUntilComplete();
EXPECT_EQ(net::OK, delegate.request_status());
ASSERT_TRUE(request->response_headers());
EXPECT_EQ(HTTP_OK, request->response_headers()->response_code());
EXPECT_EQ("<p>Hello World!</p>", delegate.data_received());
EXPECT_EQ(request->response_headers()->GetNormalizedHeader("Content-Type"),
"text/html");
EXPECT_EQ(request->proxy_chain(), ExpectedProxyChain());
}
TEST_P(EmbeddedTestServerTest, DefaultNotFoundResponse) {
ASSERT_TRUE(StartServerAndSetUpContext());
TestDelegate delegate;
std::unique_ptr<URLRequest> request(context_->CreateRequest(
server_->GetURL("/non-existent"), DEFAULT_PRIORITY, &delegate,
TRAFFIC_ANNOTATION_FOR_TESTS));
request->Start();
delegate.RunUntilComplete();
EXPECT_EQ(net::OK, delegate.request_status());
ASSERT_TRUE(request->response_headers());
EXPECT_EQ(HTTP_NOT_FOUND, request->response_headers()->response_code());
EXPECT_EQ(request->proxy_chain(), ExpectedProxyChain());
}
TEST_P(EmbeddedTestServerTest, ConnectionListenerAccept) {
ASSERT_TRUE(StartServerAndSetUpContext());
net::AddressList address_list;
EXPECT_TRUE(server_->GetAddressList(&address_list));
std::unique_ptr<StreamSocket> socket =
ClientSocketFactory::GetDefaultFactory()->CreateTransportClientSocket(
address_list, nullptr, nullptr, NetLog::Get(), NetLogSource());
TestCompletionCallback callback;
ASSERT_THAT(callback.GetResult(socket->Connect(callback.callback())), IsOk());
connection_listener_.WaitUntilFirstConnectionAccepted();
EXPECT_EQ(1u, connection_listener_.SocketAcceptedCount());
EXPECT_FALSE(connection_listener_.DidReadFromSocket());
EXPECT_FALSE(connection_listener_.DidGetSocketOnComplete());
}
TEST_P(EmbeddedTestServerTest, ConnectionListenerRead) {
ASSERT_TRUE(StartServerAndSetUpContext());
TestDelegate delegate;
std::unique_ptr<URLRequest> request(context_->CreateRequest(
server_->GetURL("/non-existent"), DEFAULT_PRIORITY, &delegate,
TRAFFIC_ANNOTATION_FOR_TESTS));
request->Start();
delegate.RunUntilComplete();
EXPECT_EQ(1u, connection_listener_.SocketAcceptedCount());
EXPECT_TRUE(connection_listener_.DidReadFromSocket());
}
TEST_P(EmbeddedTestServerTest,
UpgradeRequestHandlerEvalContinuesOnKNotHandled) {
if (GetParam().protocol == HttpConnection::Protocol::kHttp2 ||
GetParam().proxy_type) {
GTEST_SKIP() << "This test is not supported on HTTP/2 or with proxies";
}
const std::string websocket_upgrade_path = "/websocket_upgrade_path";
base::AtomicFlag first_handler_called, second_handler_called;
server_->RegisterUpgradeRequestHandler(base::BindLambdaForTesting(
[&](const HttpRequest& request, HttpConnection* connection)
-> EmbeddedTestServer::UpgradeResultOrHttpResponse {
first_handler_called.Set();
if (request.relative_url == websocket_upgrade_path) {
return UpgradeResult::kUpgraded;
}
return UpgradeResult::kNotHandled;
}));
server_->RegisterUpgradeRequestHandler(base::BindLambdaForTesting(
[&](const HttpRequest& request, HttpConnection* connection)
-> EmbeddedTestServer::UpgradeResultOrHttpResponse {
second_handler_called.Set();
if (request.relative_url == websocket_upgrade_path) {
return UpgradeResult::kUpgraded;
}
return UpgradeResult::kNotHandled;
}));
auto server_handle = server_->StartAndReturnHandle();
ASSERT_TRUE(server_handle);
// Have to manually create the context, since proxy setup code isn't
// compatible with EmbeddedTestServer::StartAndReturnHandle()
context_ = CreateTestURLRequestContextBuilder()->Build();
GURL a_different_url = server_->GetURL("/a_different_path");
TestDelegate delegate;
std::unique_ptr<URLRequest> request(
context_->CreateRequest(a_different_url, DEFAULT_PRIORITY, &delegate,
TRAFFIC_ANNOTATION_FOR_TESTS));
request->Start();
delegate.RunUntilComplete();
EXPECT_TRUE(first_handler_called.IsSet());
EXPECT_TRUE(second_handler_called.IsSet());
}
// Tests the case of a connection failure after the destination server has been
// shut down. Primarily intended to test the CONNECT proxy case.
TEST_P(EmbeddedTestServerTest, ConnectionFailure) {
ASSERT_TRUE(StartServerAndSetUpContext());
TestDelegate delegate;
std::unique_ptr<URLRequest> request(
context_->CreateRequest(server_->GetURL("/"), DEFAULT_PRIORITY, &delegate,
TRAFFIC_ANNOTATION_FOR_TESTS));
// A recently closed socket should be blocked from reuse for some time, so the
// closed socket should not be reopened by some other app in the small windows
// before this test tries to connect to it.
EXPECT_TRUE(server_->ShutdownAndWaitUntilComplete());
request->Start();
delegate.RunUntilComplete();
if (GetParam().proxy_type) {
EXPECT_EQ(ERR_TUNNEL_CONNECTION_FAILED, delegate.request_status());
} else {
EXPECT_EQ(ERR_CONNECTION_REFUSED, delegate.request_status());
}
}
TEST_P(EmbeddedTestServerTest, UpgradeRequestHandlerTransfersSocket) {
if (GetParam().protocol == HttpConnection::Protocol::kHttp2 ||
GetParam().proxy_type) {
GTEST_SKIP() << "This test is not supported on HTTP/2 or with proxies";
}
const std::string websocket_upgrade_path = "/websocket_upgrade_path";
base::AtomicFlag handler_called;
server_->RegisterUpgradeRequestHandler(base::BindLambdaForTesting(
[&](const HttpRequest& request, HttpConnection* connection)
-> EmbeddedTestServer::UpgradeResultOrHttpResponse {
handler_called.Set();
if (request.relative_url == websocket_upgrade_path) {
auto socket = connection->TakeSocket();
EXPECT_TRUE(socket);
return UpgradeResult::kUpgraded;
}
return UpgradeResult::kNotHandled;
}));
auto server_handle = server_->StartAndReturnHandle();
ASSERT_TRUE(server_handle);
// Have to manually create the context, since proxy setup code isn't
// compatible with EmbeddedTestServer::StartAndReturnHandle()
context_ = CreateTestURLRequestContextBuilder()->Build();
GURL websocket_upgrade_url = server_->GetURL(websocket_upgrade_path);
TestDelegate delegate;
std::unique_ptr<URLRequest> request(
context_->CreateRequest(websocket_upgrade_url, DEFAULT_PRIORITY,
&delegate, TRAFFIC_ANNOTATION_FOR_TESTS));
request->Start();
delegate.RunUntilComplete();
EXPECT_TRUE(handler_called.IsSet());
}
TEST_P(EmbeddedTestServerTest, UpgradeRequestHandlerEvalStopsOnErrorResponse) {
if (GetParam().protocol == HttpConnection::Protocol::kHttp2 ||
GetParam().proxy_type) {
GTEST_SKIP() << "This test is not supported on HTTP/2 or with proxies";
}
const std::string websocket_upgrade_path = "/websocket_upgrade_path";
base::AtomicFlag first_handler_called;
base::AtomicFlag second_handler_called;
server_->RegisterUpgradeRequestHandler(base::BindLambdaForTesting(
[&](const HttpRequest& request, HttpConnection* connection)
-> EmbeddedTestServer::UpgradeResultOrHttpResponse {
first_handler_called.Set();
if (request.relative_url == websocket_upgrade_path) {
auto error_response = std::make_unique<BasicHttpResponse>();
error_response->set_code(HttpStatusCode::HTTP_INTERNAL_SERVER_ERROR);
error_response->set_content("Internal Server Error");
error_response->set_content_type("text/plain");
return base::unexpected(std::move(error_response));
}
return UpgradeResult::kNotHandled;
}));
server_->RegisterUpgradeRequestHandler(base::BindLambdaForTesting(
[&](const HttpRequest& request, HttpConnection* connection)
-> EmbeddedTestServer::UpgradeResultOrHttpResponse {
second_handler_called.Set();
return UpgradeResult::kNotHandled;
}));
auto server_handle = server_->StartAndReturnHandle();
ASSERT_TRUE(server_handle);
// Have to manually create the context, since proxy setup code isn't
// compatible with EmbeddedTestServer::StartAndReturnHandle()
context_ = CreateTestURLRequestContextBuilder()->Build();
GURL websocket_upgrade_url = server_->GetURL(websocket_upgrade_path);
TestDelegate delegate;
std::unique_ptr<URLRequest> request(
context_->CreateRequest(websocket_upgrade_url, DEFAULT_PRIORITY,
&delegate, TRAFFIC_ANNOTATION_FOR_TESTS));
request->Start();
delegate.RunUntilComplete();
EXPECT_TRUE(first_handler_called.IsSet());
EXPECT_EQ(net::OK, delegate.request_status());
ASSERT_TRUE(request->response_headers());
EXPECT_EQ(HTTP_INTERNAL_SERVER_ERROR,
request->response_headers()->response_code());
EXPECT_FALSE(second_handler_called.IsSet());
}
// TODO(http://crbug.com/1166868): Flaky on ChromeOS.
#if BUILDFLAG(IS_CHROMEOS)
#define MAYBE_ConnectionListenerComplete DISABLED_ConnectionListenerComplete
#else
#define MAYBE_ConnectionListenerComplete ConnectionListenerComplete
#endif
TEST_P(EmbeddedTestServerTest, MAYBE_ConnectionListenerComplete) {
// OnResponseCompletedSuccessfully() makes the assumption that a connection is
// "finished" before the socket is closed, and in the case of HTTP/2 this is
// not supported
if (GetParam().protocol == HttpConnection::Protocol::kHttp2)
return;
ASSERT_TRUE(StartServerAndSetUpContext());
TestDelegate delegate;
// Need to send a Keep-Alive response header since the EmbeddedTestServer only
// invokes OnResponseCompletedSuccessfully() if the socket is still open, and
// the network stack will close the socket if not reuable, resulting in
// potentially racilly closing the socket before
// OnResponseCompletedSuccessfully() is invoked.
std::unique_ptr<URLRequest> request(context_->CreateRequest(
server_->GetURL("/set-header?Connection: Keep-Alive"), DEFAULT_PRIORITY,
&delegate, TRAFFIC_ANNOTATION_FOR_TESTS));
request->Start();
delegate.RunUntilComplete();
EXPECT_EQ(1u, connection_listener_.SocketAcceptedCount());
EXPECT_TRUE(connection_listener_.DidReadFromSocket());
connection_listener_.WaitUntilGotSocketFromResponseCompleted();
EXPECT_TRUE(connection_listener_.DidGetSocketOnComplete());
}
TEST_P(EmbeddedTestServerTest, ConcurrentFetches) {
server_->RegisterRequestHandler(base::BindRepeating(
&EmbeddedTestServerTest::HandleRequest, base::Unretained(this), "/test1",
"Raspberry chocolate", "text/html", HTTP_OK));
server_->RegisterRequestHandler(base::BindRepeating(
&EmbeddedTestServerTest::HandleRequest, base::Unretained(this), "/test2",
"Vanilla chocolate", "text/html", HTTP_OK));
server_->RegisterRequestHandler(base::BindRepeating(
&EmbeddedTestServerTest::HandleRequest, base::Unretained(this), "/test3",
"No chocolates", "text/plain", HTTP_NOT_FOUND));
ASSERT_TRUE(StartServerAndSetUpContext());
TestDelegate delegate1;
std::unique_ptr<URLRequest> request1(
context_->CreateRequest(server_->GetURL("/test1"), DEFAULT_PRIORITY,
&delegate1, TRAFFIC_ANNOTATION_FOR_TESTS));
TestDelegate delegate2;
std::unique_ptr<URLRequest> request2(
context_->CreateRequest(server_->GetURL("/test2"), DEFAULT_PRIORITY,
&delegate2, TRAFFIC_ANNOTATION_FOR_TESTS));
TestDelegate delegate3;
std::unique_ptr<URLRequest> request3(
context_->CreateRequest(server_->GetURL("/test3"), DEFAULT_PRIORITY,
&delegate3, TRAFFIC_ANNOTATION_FOR_TESTS));
// Fetch the three URLs concurrently. Have to manually create RunLoops when
// running multiple requests simultaneously, to avoid the deprecated
// RunUntilIdle() path.
base::RunLoop run_loop1;
base::RunLoop run_loop2;
base::RunLoop run_loop3;
delegate1.set_on_complete(run_loop1.QuitClosure());
delegate2.set_on_complete(run_loop2.QuitClosure());
delegate3.set_on_complete(run_loop3.QuitClosure());
request1->Start();
request2->Start();
request3->Start();
run_loop1.Run();
run_loop2.Run();
run_loop3.Run();
EXPECT_EQ(net::OK, delegate2.request_status());
ASSERT_TRUE(request1->response_headers());
EXPECT_EQ(HTTP_OK, request1->response_headers()->response_code());
EXPECT_EQ("Raspberry chocolate", delegate1.data_received());
EXPECT_EQ(request1->response_headers()->GetNormalizedHeader("Content-Type"),
"text/html");
EXPECT_EQ(net::OK, delegate2.request_status());
ASSERT_TRUE(request2->response_headers());
EXPECT_EQ(HTTP_OK, request2->response_headers()->response_code());
EXPECT_EQ("Vanilla chocolate", delegate2.data_received());
EXPECT_EQ(request2->response_headers()->GetNormalizedHeader("Content-Type"),
"text/html");
EXPECT_EQ(net::OK, delegate3.request_status());
ASSERT_TRUE(request3->response_headers());
EXPECT_EQ(HTTP_NOT_FOUND, request3->response_headers()->response_code());
EXPECT_EQ("No chocolates", delegate3.data_received());
EXPECT_EQ(request3->response_headers()->GetNormalizedHeader("Content-Type"),
"text/plain");
}
namespace {
class CancelRequestDelegate : public TestDelegate {
public:
CancelRequestDelegate() { set_on_complete(base::DoNothing()); }
CancelRequestDelegate(const CancelRequestDelegate&) = delete;
CancelRequestDelegate& operator=(const CancelRequestDelegate&) = delete;
~CancelRequestDelegate() override = default;
void OnResponseStarted(URLRequest* request, int net_error) override {
TestDelegate::OnResponseStarted(request, net_error);
base::SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE, run_loop_.QuitClosure(), base::Seconds(1));
}
void WaitUntilDone() { run_loop_.Run(); }
private:
base::RunLoop run_loop_;
};
class InfiniteResponse : public BasicHttpResponse {
public:
InfiniteResponse() = default;
InfiniteResponse(const InfiniteResponse&) = delete;
InfiniteResponse& operator=(const InfiniteResponse&) = delete;
void SendResponse(base::WeakPtr<HttpResponseDelegate> delegate) override {
delegate->SendResponseHeaders(code(), GetHttpReasonPhrase(code()),
BuildHeaders());
SendInfinite(delegate);
}
private:
void SendInfinite(base::WeakPtr<HttpResponseDelegate> delegate) {
if (!delegate) {
return;
}
delegate->SendContents(
"echo", base::BindOnce(&InfiniteResponse::OnSendDone,
weak_ptr_factory_.GetWeakPtr(), delegate));
}
void OnSendDone(base::WeakPtr<HttpResponseDelegate> delegate) {
base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(&InfiniteResponse::SendInfinite,
weak_ptr_factory_.GetWeakPtr(), delegate));
}
base::WeakPtrFactory<InfiniteResponse> weak_ptr_factory_{this};
};
std::unique_ptr<HttpResponse> HandleInfiniteRequest(
const HttpRequest& request) {
return std::make_unique<InfiniteResponse>();
}
} // anonymous namespace
// Tests the case the connection is closed while the server is sending a
// response. May non-deterministically end up at one of three paths
// (Discover the close event synchronously, asynchronously, or server
// shutting down before it is discovered).
TEST_P(EmbeddedTestServerTest, CloseDuringWrite) {
CancelRequestDelegate cancel_delegate;
cancel_delegate.set_cancel_in_response_started(true);
server_->RegisterRequestHandler(
base::BindRepeating(&HandlePrefixedRequest, "/infinite",
base::BindRepeating(&HandleInfiniteRequest)));
ASSERT_TRUE(StartServerAndSetUpContext());
std::unique_ptr<URLRequest> request =
context_->CreateRequest(server_->GetURL("/infinite"), DEFAULT_PRIORITY,
&cancel_delegate, TRAFFIC_ANNOTATION_FOR_TESTS);
request->Start();
cancel_delegate.WaitUntilDone();
}
const struct CertificateValuesEntry {
const EmbeddedTestServer::ServerCertificate server_cert;
const bool is_expired;
const char* common_name;
const char* issuer_common_name;
size_t certs_count;
} kCertificateValuesEntry[] = {
{EmbeddedTestServer::CERT_OK, false, "127.0.0.1", "Test Root CA", 1},
{EmbeddedTestServer::CERT_OK_BY_INTERMEDIATE, false, "127.0.0.1",
"Test Intermediate CA", 2},
{EmbeddedTestServer::CERT_MISMATCHED_NAME, false, "127.0.0.1",
"Test Root CA", 1},
{EmbeddedTestServer::CERT_COMMON_NAME_IS_DOMAIN, false, "localhost",
"Test Root CA", 1},
{EmbeddedTestServer::CERT_EXPIRED, true, "127.0.0.1", "Test Root CA", 1},
};
TEST_P(EmbeddedTestServerTest, GetCertificate) {
if (GetParam().type != EmbeddedTestServer::TYPE_HTTPS)
return;
for (const auto& cert_entry : kCertificateValuesEntry) {
SCOPED_TRACE(cert_entry.server_cert);
server_->SetSSLConfig(cert_entry.server_cert);
scoped_refptr<X509Certificate> cert = server_->GetCertificate();
ASSERT_TRUE(cert);
EXPECT_EQ(cert->HasExpired(), cert_entry.is_expired);
EXPECT_EQ(cert->subject().common_name, cert_entry.common_name);
EXPECT_EQ(cert->issuer().common_name, cert_entry.issuer_common_name);
EXPECT_EQ(cert->intermediate_buffers().size(), cert_entry.certs_count - 1);
}
}
TEST_P(EmbeddedTestServerTest, AcceptCHFrame) {
// The ACCEPT_CH frame is only supported for HTTP/2 connections
if (GetParam().protocol == HttpConnection::Protocol::kHttp1)
return;
server_->SetAlpsAcceptCH("", "foo");
server_->SetSSLConfig(net::EmbeddedTestServer::CERT_OK);
ASSERT_TRUE(StartServerAndSetUpContext());
TestDelegate delegate;
std::unique_ptr<URLRequest> request_a(context_->CreateRequest(
server_->GetURL("/non-existent"), DEFAULT_PRIORITY, &delegate,
TRAFFIC_ANNOTATION_FOR_TESTS));
request_a->Start();
delegate.RunUntilComplete();
EXPECT_EQ(1u, delegate.transports().size());
EXPECT_EQ("foo", delegate.transports().back().accept_ch_frame);
}
TEST_P(EmbeddedTestServerTest, AcceptCHFrameDifferentOrigins) {
// The ACCEPT_CH frame is only supported for HTTP/2 connections
if (GetParam().protocol == HttpConnection::Protocol::kHttp1)
return;
server_->SetAlpsAcceptCH("a.test", "a");
server_->SetAlpsAcceptCH("b.test", "b");
server_->SetAlpsAcceptCH("c.b.test", "c");
server_->SetSSLConfig(net::EmbeddedTestServer::CERT_TEST_NAMES);
ASSERT_TRUE(StartServerAndSetUpContext(
/*disable_proxy_destination_restrictions=*/true));
{
TestDelegate delegate;
std::unique_ptr<URLRequest> request_a(context_->CreateRequest(
server_->GetURL("a.test", "/non-existent"), DEFAULT_PRIORITY, &delegate,
TRAFFIC_ANNOTATION_FOR_TESTS));
request_a->Start();
delegate.RunUntilComplete();
EXPECT_EQ(1u, delegate.transports().size());
EXPECT_EQ("a", delegate.transports().back().accept_ch_frame);
}
{
TestDelegate delegate;
std::unique_ptr<URLRequest> request_a(context_->CreateRequest(
server_->GetURL("b.test", "/non-existent"), DEFAULT_PRIORITY, &delegate,
TRAFFIC_ANNOTATION_FOR_TESTS));
request_a->Start();
delegate.RunUntilComplete();
EXPECT_EQ(1u, delegate.transports().size());
EXPECT_EQ("b", delegate.transports().back().accept_ch_frame);
}
{
TestDelegate delegate;
std::unique_ptr<URLRequest> request_a(context_->CreateRequest(
server_->GetURL("c.b.test", "/non-existent"), DEFAULT_PRIORITY,
&delegate, TRAFFIC_ANNOTATION_FOR_TESTS));
request_a->Start();
delegate.RunUntilComplete();
EXPECT_EQ(1u, delegate.transports().size());
EXPECT_EQ("c", delegate.transports().back().accept_ch_frame);
}
}
TEST_P(EmbeddedTestServerTest, LargePost) {
// HTTP/2's default flow-control window is 65K. Send a larger request body
// than that to verify the server correctly updates flow control.
std::string large_post_body(100 * 1024, 'a');
server_->RegisterRequestMonitor(
base::BindLambdaForTesting([=](const HttpRequest& request) {
EXPECT_EQ(request.method, METHOD_POST);
EXPECT_TRUE(request.has_content);
EXPECT_EQ(large_post_body, request.content);
}));
server_->SetSSLConfig(net::EmbeddedTestServer::CERT_OK);
ASSERT_TRUE(StartServerAndSetUpContext());
auto reader = std::make_unique<UploadBytesElementReader>(
base::as_byte_span(large_post_body));
auto stream = ElementsUploadDataStream::CreateWithReader(std::move(reader));
TestDelegate delegate;
std::unique_ptr<URLRequest> request(
context_->CreateRequest(server_->GetURL("/test"), DEFAULT_PRIORITY,
&delegate, TRAFFIC_ANNOTATION_FOR_TESTS));
request->set_method("POST");
request->set_upload(std::move(stream));
request->Start();
delegate.RunUntilComplete();
}
INSTANTIATE_TEST_SUITE_P(EmbeddedTestServerTestInstantiation,
EmbeddedTestServerTest,
testing::ValuesIn(EmbeddedTestServerConfigs()));
// Below test exercises EmbeddedTestServer's ability to cope with the situation
// where there is no MessageLoop available on the thread at EmbeddedTestServer
// initialization and/or destruction.
typedef std::tuple<bool, bool, EmbeddedTestServerConfig> ThreadingTestParams;
class EmbeddedTestServerThreadingTest
: public testing::TestWithParam<ThreadingTestParams>,
public WithTaskEnvironment {};
class EmbeddedTestServerThreadingTestDelegate
: public base::PlatformThread::Delegate {
public:
EmbeddedTestServerThreadingTestDelegate(
bool message_loop_present_on_initialize,
bool message_loop_present_on_shutdown,
EmbeddedTestServerConfig config)
: message_loop_present_on_initialize_(message_loop_present_on_initialize),
message_loop_present_on_shutdown_(message_loop_present_on_shutdown),
type_(config.type),
protocol_(config.protocol) {}
EmbeddedTestServerThreadingTestDelegate(
const EmbeddedTestServerThreadingTestDelegate&) = delete;
EmbeddedTestServerThreadingTestDelegate& operator=(
const EmbeddedTestServerThreadingTestDelegate&) = delete;
// base::PlatformThread::Delegate:
void ThreadMain() override {
std::unique_ptr<base::SingleThreadTaskExecutor> executor;
if (message_loop_present_on_initialize_) {
executor = std::make_unique<base::SingleThreadTaskExecutor>(
base::MessagePumpType::IO);
}
// Create the test server instance.
EmbeddedTestServer server(type_, protocol_);
base::FilePath src_dir;
ASSERT_TRUE(base::PathService::Get(base::DIR_SRC_TEST_DATA_ROOT, &src_dir));
ASSERT_TRUE(server.Start());
// Make a request and wait for the reply.
if (!executor) {
executor = std::make_unique<base::SingleThreadTaskExecutor>(
base::MessagePumpType::IO);
}
auto context = CreateTestURLRequestContextBuilder()->Build();
TestDelegate delegate;
std::unique_ptr<URLRequest> request(
context->CreateRequest(server.GetURL("/test?q=foo"), DEFAULT_PRIORITY,
&delegate, TRAFFIC_ANNOTATION_FOR_TESTS));
request->Start();
delegate.RunUntilComplete();
request.reset();
// Flush the socket pool on the same thread by destroying the context.
context.reset();
// Shut down.
if (message_loop_present_on_shutdown_)
executor.reset();
ASSERT_TRUE(server.ShutdownAndWaitUntilComplete());
}
private:
const bool message_loop_present_on_initialize_;
const bool message_loop_present_on_shutdown_;
const EmbeddedTestServer::Type type_;
const HttpConnection::Protocol protocol_;
};
TEST_P(EmbeddedTestServerThreadingTest, RunTest) {
// The actual test runs on a separate thread so it can screw with the presence
// of a MessageLoop - the test suite already sets up a MessageLoop for the
// main test thread.
base::PlatformThreadHandle thread_handle;
EmbeddedTestServerThreadingTestDelegate delegate(std::get<0>(GetParam()),
std::get<1>(GetParam()),
std::get<2>(GetParam()));
ASSERT_TRUE(base::PlatformThread::Create(0, &delegate, &thread_handle));
base::PlatformThread::Join(thread_handle);
}
INSTANTIATE_TEST_SUITE_P(
EmbeddedTestServerThreadingTestInstantiation,
EmbeddedTestServerThreadingTest,
testing::Combine(testing::Bool(),
testing::Bool(),
testing::ValuesIn(EmbeddedTestServerConfigs())));
} // namespace net::test_server
|