ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2025-11-20 11:45:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Create generate free port class to avoid conflicting ports (#1439)

Browse Source 
Fixes #1317
This commit is contained in:
Peter Chen
2024-06-18 06:29:05 -04:00
committed by GitHub
parent 5ba08b1d26
commit e135aa49d5
14 changed files with 313 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
tests/common/CMakeLists.txt
View File

@@ -2,6 +2,7 @@ add_library(clio_testing_common)
target_sources( target_sources(
clio_testing_common PRIVATE util/StringUtils.cpp util/TestHttpServer.cpp util/TestWsServer.cpp util/TestObject.cpp clio_testing_common PRIVATE util/StringUtils.cpp util/TestHttpServer.cpp util/TestWsServer.cpp util/TestObject.cpp
util/AssignRandomPort.cpp
) )
include(deps/gtest) include(deps/gtest)

45
tests/common/util/AssignRandomPort.cpp Normal file
View File

@@ -0,0 +1,45 @@
//------------------------------------------------------------------------------
/*
This file is part of clio: https://github.com/XRPLF/clio
Copyright (c) 2024, the clio developers.
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
#include "util/AssignRandomPort.hpp"
#include <boost/asio/io_context.hpp>
#include <boost/asio/ip/tcp.hpp>
#include <cstdint>
using tcp = boost::asio::ip::tcp;
namespace tests::util {
uint32_t
generateFreePort()
{
boost::asio::io_context io_context;
tcp::acceptor acceptor(io_context);
tcp::endpoint const endpoint(tcp::v4(), 0);
acceptor.open(endpoint.protocol());
acceptor.set_option(tcp::acceptor::reuse_address(true));
acceptor.bind(endpoint);
return acceptor.local_endpoint().port();
}
} // namespace tests::util

29
tests/common/util/AssignRandomPort.hpp Normal file
View File

@@ -0,0 +1,29 @@
//------------------------------------------------------------------------------
/*
This file is part of clio: https://github.com/XRPLF/clio
Copyright (c) 2024, the clio developers.
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
#pragma once
#include <cstdint>
namespace tests::util {
uint32_t
generateFreePort();
} // namespace tests::util

8
tests/common/util/MockXrpLedgerAPIService.hpp
View File

@@ -82,7 +82,7 @@ struct WithMockXrpLedgerAPIService : virtual ::testing::Test {
WithMockXrpLedgerAPIService(std::string serverAddress) WithMockXrpLedgerAPIService(std::string serverAddress)
{ {
grpc::ServerBuilder builder; grpc::ServerBuilder builder;
builder.AddListeningPort(serverAddress, grpc::InsecureServerCredentials()); builder.AddListeningPort(serverAddress, grpc::InsecureServerCredentials(), &port_);
builder.RegisterService(&mockXrpLedgerAPIService); builder.RegisterService(&mockXrpLedgerAPIService);
server_ = builder.BuildAndStart(); server_ = builder.BuildAndStart();
serverThread_ = std::thread([this] { server_->Wait(); }); serverThread_ = std::thread([this] { server_->Wait(); });
@@ -94,11 +94,17 @@ struct WithMockXrpLedgerAPIService : virtual ::testing::Test {
serverThread_.join(); serverThread_.join();
} }
int
getXRPLMockPort() const
{
return port_;
}
MockXrpLedgerAPIService mockXrpLedgerAPIService; MockXrpLedgerAPIService mockXrpLedgerAPIService;
private: private:
std::unique_ptr<grpc::Server> server_; std::unique_ptr<grpc::Server> server_;
std::thread serverThread_; std::thread serverThread_;
int port_{};
}; };
} // namespace tests::util } // namespace tests::util

10
tests/common/util/TestHttpServer.cpp
View File

@@ -105,9 +105,9 @@ doSession(
} // namespace } // namespace
TestHttpServer::TestHttpServer(boost::asio::io_context& context, std::string host, int const port) : acceptor_(context) TestHttpServer::TestHttpServer(boost::asio::io_context& context, std::string host) : acceptor_(context)
{ {
boost::asio::ip::tcp::endpoint const endpoint(boost::asio::ip::make_address(host), port); boost::asio::ip::tcp::endpoint const endpoint(boost::asio::ip::make_address(host), 0);
acceptor_.open(endpoint.protocol()); acceptor_.open(endpoint.protocol());
acceptor_.set_option(asio::socket_base::reuse_address(true)); acceptor_.set_option(asio::socket_base::reuse_address(true));
acceptor_.bind(endpoint); acceptor_.bind(endpoint);
@@ -134,3 +134,9 @@ TestHttpServer::handleRequest(TestHttpServer::RequestHandler handler, bool const
boost::asio::detached boost::asio::detached
); );
} }
std::string
TestHttpServer::port() const
{
return std::to_string(acceptor_.local_endpoint().port());
}

11
tests/common/util/TestHttpServer.hpp
View File

@@ -41,9 +41,8 @@ public:
* *
* @param context boost::asio::io_context to use for networking * @param context boost::asio::io_context to use for networking
* @param host host to bind to * @param host host to bind to
* @param port port to bind to
*/ */
TestHttpServer(boost::asio::io_context& context, std::string host, int port); TestHttpServer(boost::asio::io_context& context, std::string host);
/** /**
* @brief Start the server * @brief Start the server
@@ -56,6 +55,14 @@ public:
void void
handleRequest(RequestHandler handler, bool allowToFail = false); handleRequest(RequestHandler handler, bool allowToFail = false);
/**
* @brief Return the port HTTP server is connected to
*
* @return string port number
*/
std::string
port() const;
private: private:
boost::asio::ip::tcp::acceptor acceptor_; boost::asio::ip::tcp::acceptor acceptor_;
}; };

10
tests/common/util/TestWsServer.cpp
View File

@@ -105,14 +105,20 @@ TestWsConnection::headers() const
return headers_; return headers_;
} }
TestWsServer::TestWsServer(asio::io_context& context, std::string const& host, int port) : acceptor_(context) TestWsServer::TestWsServer(asio::io_context& context, std::string const& host) : acceptor_(context)
{ {
auto endpoint = asio::ip::tcp::endpoint(boost::asio::ip::make_address(host), port); auto endpoint = asio::ip::tcp::endpoint(boost::asio::ip::make_address(host), 0);
acceptor_.open(endpoint.protocol()); acceptor_.open(endpoint.protocol());
acceptor_.set_option(asio::socket_base::reuse_address(true)); acceptor_.set_option(asio::socket_base::reuse_address(true));
acceptor_.bind(endpoint); acceptor_.bind(endpoint);
} }
std::string
TestWsServer::port() const
{
return std::to_string(this->acceptor_.local_endpoint().port());
}
std::expected<TestWsConnection, util::requests::RequestError> std::expected<TestWsConnection, util::requests::RequestError>
TestWsServer::acceptConnection(asio::yield_context yield) TestWsServer::acceptConnection(asio::yield_context yield)
{ {

5
tests/common/util/TestWsServer.hpp
View File

@@ -70,7 +70,10 @@ class TestWsServer {
boost::asio::ip::tcp::acceptor acceptor_; boost::asio::ip::tcp::acceptor acceptor_;
public: public:
TestWsServer(boost::asio::io_context& context, std::string const& host, int port); TestWsServer(boost::asio::io_context& context, std::string const& host);
std::string
port() const;
std::expected<TestWsConnection, util::requests::RequestError> std::expected<TestWsConnection, util::requests::RequestError>
acceptConnection(boost::asio::yield_context yield); acceptConnection(boost::asio::yield_context yield);

9
tests/unit/etl/ForwardingSourceTests.cpp
View File

@@ -37,8 +37,13 @@
using namespace etl::impl; using namespace etl::impl;
struct ForwardingSourceTests : SyncAsioContextTest { struct ForwardingSourceTests : SyncAsioContextTest {
TestWsServer server_{ctx, "0.0.0.0", 11114}; TestWsServer server_{ctx, "0.0.0.0"};
ForwardingSource forwardingSource{"127.0.0.1", "11114", std::chrono::milliseconds{1}, std::chrono::milliseconds{1}}; ForwardingSource forwardingSource{
"127.0.0.1",
server_.port(),
std::chrono::milliseconds{1},
std::chrono::milliseconds{1}
};
}; };
TEST_F(ForwardingSourceTests, ConnectionFailed) TEST_F(ForwardingSourceTests, ConnectionFailed)

4
tests/unit/etl/GrpcSourceTests.cpp
View File

@@ -42,9 +42,9 @@ using namespace etl::impl;
struct GrpcSourceTests : NoLoggerFixture, util::prometheus::WithPrometheus, tests::util::WithMockXrpLedgerAPIService { struct GrpcSourceTests : NoLoggerFixture, util::prometheus::WithPrometheus, tests::util::WithMockXrpLedgerAPIService {
GrpcSourceTests() GrpcSourceTests()
: WithMockXrpLedgerAPIService("localhost:55051") : WithMockXrpLedgerAPIService("localhost:0")
, mockBackend_(std::make_shared<testing::StrictMock<MockBackend>>(util::Config{})) , mockBackend_(std::make_shared<testing::StrictMock<MockBackend>>(util::Config{}))
, grpcSource_("127.0.0.1", "55051", mockBackend_) , grpcSource_("127.0.0.1", std::to_string(getXRPLMockPort()), mockBackend_)
{ {
} }

7
tests/unit/etl/SubscriptionSourceTests.cpp
View File

@@ -18,6 +18,7 @@
//============================================================================== //==============================================================================
#include "etl/impl/SubscriptionSource.hpp" #include "etl/impl/SubscriptionSource.hpp"
#include "util/AssignRandomPort.hpp"
#include "util/Fixtures.hpp" #include "util/Fixtures.hpp"
#include "util/MockNetworkValidatedLedgers.hpp" #include "util/MockNetworkValidatedLedgers.hpp"
#include "util/MockSubscriptionManager.hpp" #include "util/MockSubscriptionManager.hpp"
@@ -31,6 +32,7 @@
#include <gtest/gtest.h> #include <gtest/gtest.h>
#include <chrono> #include <chrono>
#include <cstdint>
#include <optional> #include <optional>
#include <string> #include <string>
#include <utility> #include <utility>
@@ -46,8 +48,7 @@ struct SubscriptionSourceConnectionTests : public NoLoggerFixture {
} }
boost::asio::io_context ioContext_; boost::asio::io_context ioContext_;
TestWsServer wsServer_{ioContext_, "0.0.0.0"};
TestWsServer wsServer_{ioContext_, "0.0.0.0", 11113};
StrictMockNetworkValidatedLedgersPtr networkValidatedLedgers_; StrictMockNetworkValidatedLedgersPtr networkValidatedLedgers_;
StrictMockSubscriptionManagerSharedPtr subscriptionManager_; StrictMockSubscriptionManagerSharedPtr subscriptionManager_;
@@ -59,7 +60,7 @@ struct SubscriptionSourceConnectionTests : public NoLoggerFixture {
SubscriptionSource subscriptionSource_{ SubscriptionSource subscriptionSource_{
ioContext_, ioContext_,
"127.0.0.1", "127.0.0.1",
"11113", wsServer_.port(),
networkValidatedLedgers_, networkValidatedLedgers_,
subscriptionManager_, subscriptionManager_,
onConnectHook_.AsStdFunction(), onConnectHook_.AsStdFunction(),

8
tests/unit/util/requests/RequestBuilderTests.cpp
View File

@@ -17,6 +17,7 @@
*/ */
//============================================================================== //==============================================================================
#include "util/AssignRandomPort.hpp"
#include "util/Fixtures.hpp" #include "util/Fixtures.hpp"
#include "util/TestHttpServer.hpp" #include "util/TestHttpServer.hpp"
#include "util/requests/RequestBuilder.hpp" #include "util/requests/RequestBuilder.hpp"
@@ -31,6 +32,7 @@
#include <gtest/gtest.h> #include <gtest/gtest.h>
#include <chrono> #include <chrono>
#include <cstdint>
#include <expected> #include <expected>
#include <optional> #include <optional>
#include <string> #include <string>
@@ -50,8 +52,8 @@ struct RequestBuilderTestBundle {
}; };
struct RequestBuilderTestBase : SyncAsioContextTest { struct RequestBuilderTestBase : SyncAsioContextTest {
TestHttpServer server{ctx, "0.0.0.0", 11111}; TestHttpServer server{ctx, "0.0.0.0"};
RequestBuilder builder{"localhost", "11111"}; RequestBuilder builder{"localhost", server.port()};
}; };
struct RequestBuilderTest : RequestBuilderTestBase, testing::WithParamInterface<RequestBuilderTestBundle> {}; struct RequestBuilderTest : RequestBuilderTestBase, testing::WithParamInterface<RequestBuilderTestBundle> {};
@@ -182,7 +184,7 @@ TEST_F(RequestBuilderTest, ResolveError)
TEST_F(RequestBuilderTest, ConnectionError) TEST_F(RequestBuilderTest, ConnectionError)
{ {
builder = RequestBuilder{"localhost", "11112"}; builder = RequestBuilder{"localhost", std::to_string(tests::util::generateFreePort())};
builder.setTimeout(std::chrono::milliseconds{1}); builder.setTimeout(std::chrono::milliseconds{1});
runSpawn([this](asio::yield_context yield) { runSpawn([this](asio::yield_context yield) {
auto const response = builder.getPlain(yield); auto const response = builder.getPlain(yield);

6
tests/unit/util/requests/WsConnectionTests.cpp
View File

@@ -17,6 +17,7 @@
*/ */
//============================================================================== //==============================================================================
#include "util/AssignRandomPort.hpp"
#include "util/Fixtures.hpp" #include "util/Fixtures.hpp"
#include "util/TestWsServer.hpp" #include "util/TestWsServer.hpp"
#include "util/requests/Types.hpp" #include "util/requests/Types.hpp"
@@ -29,6 +30,7 @@
#include <chrono> #include <chrono>
#include <cstddef> #include <cstddef>
#include <cstdint>
#include <expected> #include <expected>
#include <memory> #include <memory>
#include <optional> #include <optional>
@@ -41,8 +43,8 @@ namespace asio = boost::asio;
namespace http = boost::beast::http; namespace http = boost::beast::http;
struct WsConnectionTestsBase : SyncAsioContextTest { struct WsConnectionTestsBase : SyncAsioContextTest {
WsConnectionBuilder builder{"localhost", "11112"}; TestWsServer server{ctx, "0.0.0.0"};
TestWsServer server{ctx, "0.0.0.0", 11112}; WsConnectionBuilder builder{"localhost", server.port()};
template <typename T, typename E> template <typename T, typename E>
T T

309
tests/unit/web/ServerTests.cpp
View File

@@ -17,6 +17,7 @@
*/ */
//============================================================================== //==============================================================================
#include "util/AssignRandomPort.hpp"
#include "util/Fixtures.hpp" #include "util/Fixtures.hpp"
#include "util/MockPrometheus.hpp" #include "util/MockPrometheus.hpp"
#include "util/TestHttpSyncClient.hpp" #include "util/TestHttpSyncClient.hpp"
@@ -43,13 +44,17 @@
#include <fmt/core.h> #include <fmt/core.h>
#include <gtest/gtest.h> #include <gtest/gtest.h>
#include <chrono>
#include <condition_variable> #include <condition_variable>
#include <cstdint>
#include <functional> #include <functional>
#include <iostream>
#include <memory> #include <memory>
#include <mutex> #include <mutex>
#include <optional> #include <optional>
#include <stdexcept> #include <stdexcept>
#include <string> #include <string>
#include <string_view>
#include <thread> #include <thread>
#include <utility> #include <utility>
#include <vector> #include <vector>
@@ -57,37 +62,48 @@
using namespace util; using namespace util;
using namespace web::impl; using namespace web::impl;
using namespace web; using namespace web;
using namespace boost::json;
constexpr static auto JSONData = R"JSON( std::string
{ generateJSONWithDynamicPort(std::string_view port)
"server":{ {
"ip":"0.0.0.0", return fmt::format(
"port":8888 R"JSON({{
}, "server": {{
"dos_guard": { "ip": "0.0.0.0",
"max_fetches": 100, "port": {}
"sweep_interval": 1000, }},
"max_connections": 2, "dos_guard": {{
"max_requests": 3, "max_fetches": 100,
"whitelist": ["127.0.0.1"] "sweep_interval": 1000,
} "max_connections": 2,
} "max_requests": 3,
)JSON"; "whitelist": ["127.0.0.1"]
}}
}})JSON",
port
);
}
constexpr static auto JSONDataOverload = R"JSON( std::string
{ generateJSONDataOverload(std::string_view port)
"server":{ {
"ip":"0.0.0.0", return fmt::format(
"port":8888 R"JSON({{
}, "server": {{
"dos_guard": { "ip": "0.0.0.0",
"max_fetches": 100, "port": {}
"sweep_interval": 1000, }},
"max_connections": 2, "dos_guard": {{
"max_requests": 1 "max_fetches": 100,
} "sweep_interval": 1000,
} "max_connections": 2,
)JSON"; "max_requests": 1
}}
}})JSON",
port
);
}
// for testing, we use a self-signed certificate // for testing, we use a self-signed certificate
std::optional<ssl::context> std::optional<ssl::context>
@@ -168,12 +184,13 @@ protected:
// this ctx is for dos timer // this ctx is for dos timer
boost::asio::io_context ctxSync; boost::asio::io_context ctxSync;
Config cfg{boost::json::parse(JSONData)}; std::string const port = std::to_string(tests::util::generateFreePort());
Config cfg{parse(generateJSONWithDynamicPort(port))};
IntervalSweepHandler sweepHandler = web::IntervalSweepHandler{cfg, ctxSync}; IntervalSweepHandler sweepHandler = web::IntervalSweepHandler{cfg, ctxSync};
WhitelistHandler whitelistHandler = web::WhitelistHandler{cfg}; WhitelistHandler whitelistHandler = web::WhitelistHandler{cfg};
DOSGuard dosGuard = web::DOSGuard{cfg, whitelistHandler, sweepHandler}; DOSGuard dosGuard = web::DOSGuard{cfg, whitelistHandler, sweepHandler};
Config cfgOverload{boost::json::parse(JSONDataOverload)}; Config cfgOverload{parse(generateJSONDataOverload(port))};
IntervalSweepHandler sweepHandlerOverload = web::IntervalSweepHandler{cfgOverload, ctxSync}; IntervalSweepHandler sweepHandlerOverload = web::IntervalSweepHandler{cfgOverload, ctxSync};
WhitelistHandler whitelistHandlerOverload = web::WhitelistHandler{cfgOverload}; WhitelistHandler whitelistHandlerOverload = web::WhitelistHandler{cfgOverload};
DOSGuard dosGuardOverload = web::DOSGuard{cfgOverload, whitelistHandlerOverload, sweepHandlerOverload}; DOSGuard dosGuardOverload = web::DOSGuard{cfgOverload, whitelistHandlerOverload, sweepHandlerOverload};
@@ -250,7 +267,7 @@ TEST_F(WebServerTest, Http)
{ {
auto e = std::make_shared<EchoExecutor>(); auto e = std::make_shared<EchoExecutor>();
auto const server = makeServerSync(cfg, ctx, std::nullopt, dosGuard, e); auto const server = makeServerSync(cfg, ctx, std::nullopt, dosGuard, e);
auto const res = HttpSyncClient::syncPost("localhost", "8888", R"({"Hello":1})"); auto const res = HttpSyncClient::syncPost("localhost", port, R"({"Hello":1})");
EXPECT_EQ(res, R"({"Hello":1})"); EXPECT_EQ(res, R"({"Hello":1})");
} }
@@ -259,7 +276,7 @@ TEST_F(WebServerTest, Ws)
auto e = std::make_shared<EchoExecutor>(); auto e = std::make_shared<EchoExecutor>();
auto const server = makeServerSync(cfg, ctx, std::nullopt, dosGuard, e); auto const server = makeServerSync(cfg, ctx, std::nullopt, dosGuard, e);
WebSocketSyncClient wsClient; WebSocketSyncClient wsClient;
wsClient.connect("localhost", "8888"); wsClient.connect("localhost", port);
auto const res = wsClient.syncPost(R"({"Hello":1})"); auto const res = wsClient.syncPost(R"({"Hello":1})");
EXPECT_EQ(res, R"({"Hello":1})"); EXPECT_EQ(res, R"({"Hello":1})");
wsClient.disconnect(); wsClient.disconnect();
@@ -269,7 +286,7 @@ TEST_F(WebServerTest, HttpInternalError)
{ {
auto e = std::make_shared<ExceptionExecutor>(); auto e = std::make_shared<ExceptionExecutor>();
auto const server = makeServerSync(cfg, ctx, std::nullopt, dosGuard, e); auto const server = makeServerSync(cfg, ctx, std::nullopt, dosGuard, e);
auto const res = HttpSyncClient::syncPost("localhost", "8888", R"({})"); auto const res = HttpSyncClient::syncPost("localhost", port, R"({})");
EXPECT_EQ( EXPECT_EQ(
res, res,
R"({"error":"internal","error_code":73,"error_message":"Internal error.","status":"error","type":"response"})" R"({"error":"internal","error_code":73,"error_message":"Internal error.","status":"error","type":"response"})"
@@ -281,7 +298,7 @@ TEST_F(WebServerTest, WsInternalError)
auto e = std::make_shared<ExceptionExecutor>(); auto e = std::make_shared<ExceptionExecutor>();
auto const server = makeServerSync(cfg, ctx, std::nullopt, dosGuard, e); auto const server = makeServerSync(cfg, ctx, std::nullopt, dosGuard, e);
WebSocketSyncClient wsClient; WebSocketSyncClient wsClient;
wsClient.connect("localhost", "8888"); wsClient.connect("localhost", port);
auto const res = wsClient.syncPost(R"({"id":"id1"})"); auto const res = wsClient.syncPost(R"({"id":"id1"})");
wsClient.disconnect(); wsClient.disconnect();
EXPECT_EQ( EXPECT_EQ(
@@ -295,7 +312,7 @@ TEST_F(WebServerTest, WsInternalErrorNotJson)
auto e = std::make_shared<ExceptionExecutor>(); auto e = std::make_shared<ExceptionExecutor>();
auto const server = makeServerSync(cfg, ctx, std::nullopt, dosGuard, e); auto const server = makeServerSync(cfg, ctx, std::nullopt, dosGuard, e);
WebSocketSyncClient wsClient; WebSocketSyncClient wsClient;
wsClient.connect("localhost", "8888"); wsClient.connect("localhost", port);
auto const res = wsClient.syncPost("not json"); auto const res = wsClient.syncPost("not json");
wsClient.disconnect(); wsClient.disconnect();
EXPECT_EQ( EXPECT_EQ(
@@ -310,7 +327,7 @@ TEST_F(WebServerTest, Https)
auto sslCtx = parseCertsForTest(); auto sslCtx = parseCertsForTest();
auto const ctxSslRef = sslCtx ? std::optional<std::reference_wrapper<ssl::context>>{sslCtx.value()} : std::nullopt; auto const ctxSslRef = sslCtx ? std::optional<std::reference_wrapper<ssl::context>>{sslCtx.value()} : std::nullopt;
auto const server = makeServerSync(cfg, ctx, ctxSslRef, dosGuard, e); auto const server = makeServerSync(cfg, ctx, ctxSslRef, dosGuard, e);
auto const res = HttpsSyncClient::syncPost("localhost", "8888", R"({"Hello":1})"); auto const res = HttpsSyncClient::syncPost("localhost", port, R"({"Hello":1})");
EXPECT_EQ(res, R"({"Hello":1})"); EXPECT_EQ(res, R"({"Hello":1})");
} }
@@ -322,7 +339,7 @@ TEST_F(WebServerTest, Wss)
auto server = makeServerSync(cfg, ctx, ctxSslRef, dosGuard, e); auto server = makeServerSync(cfg, ctx, ctxSslRef, dosGuard, e);
WebServerSslSyncClient wsClient; WebServerSslSyncClient wsClient;
wsClient.connect("localhost", "8888"); wsClient.connect("localhost", port);
auto const res = wsClient.syncPost(R"({"Hello":1})"); auto const res = wsClient.syncPost(R"({"Hello":1})");
EXPECT_EQ(res, R"({"Hello":1})"); EXPECT_EQ(res, R"({"Hello":1})");
wsClient.disconnect(); wsClient.disconnect();
@@ -332,9 +349,9 @@ TEST_F(WebServerTest, HttpRequestOverload)
{ {
auto e = std::make_shared<EchoExecutor>(); auto e = std::make_shared<EchoExecutor>();
auto const server = makeServerSync(cfg, ctx, std::nullopt, dosGuardOverload, e); auto const server = makeServerSync(cfg, ctx, std::nullopt, dosGuardOverload, e);
auto res = HttpSyncClient::syncPost("localhost", "8888", R"({})"); auto res = HttpSyncClient::syncPost("localhost", port, R"({})");
EXPECT_EQ(res, "{}"); EXPECT_EQ(res, "{}");
res = HttpSyncClient::syncPost("localhost", "8888", R"({})"); res = HttpSyncClient::syncPost("localhost", port, R"({})");
EXPECT_EQ( EXPECT_EQ(
res, res,
R"({"error":"slowDown","error_code":10,"error_message":"You are placing too much load on the server.","status":"error","type":"response"})" R"({"error":"slowDown","error_code":10,"error_message":"You are placing too much load on the server.","status":"error","type":"response"})"
@@ -346,12 +363,12 @@ TEST_F(WebServerTest, WsRequestOverload)
auto e = std::make_shared<EchoExecutor>(); auto e = std::make_shared<EchoExecutor>();
auto const server = makeServerSync(cfg, ctx, std::nullopt, dosGuardOverload, e); auto const server = makeServerSync(cfg, ctx, std::nullopt, dosGuardOverload, e);
WebSocketSyncClient wsClient; WebSocketSyncClient wsClient;
wsClient.connect("localhost", "8888"); wsClient.connect("localhost", port);
auto res = wsClient.syncPost(R"({})"); auto res = wsClient.syncPost(R"({})");
wsClient.disconnect(); wsClient.disconnect();
EXPECT_EQ(res, "{}"); EXPECT_EQ(res, "{}");
WebSocketSyncClient wsClient2; WebSocketSyncClient wsClient2;
wsClient2.connect("localhost", "8888"); wsClient2.connect("localhost", port);
res = wsClient2.syncPost(R"({})"); res = wsClient2.syncPost(R"({})");
wsClient2.disconnect(); wsClient2.disconnect();
EXPECT_EQ( EXPECT_EQ(
@@ -365,7 +382,7 @@ TEST_F(WebServerTest, HttpPayloadOverload)
std::string const s100(100, 'a'); std::string const s100(100, 'a');
auto e = std::make_shared<EchoExecutor>(); auto e = std::make_shared<EchoExecutor>();
auto server = makeServerSync(cfg, ctx, std::nullopt, dosGuardOverload, e); auto server = makeServerSync(cfg, ctx, std::nullopt, dosGuardOverload, e);
auto const res = HttpSyncClient::syncPost("localhost", "8888", fmt::format(R"({{"payload":"{}"}})", s100)); auto const res = HttpSyncClient::syncPost("localhost", port, fmt::format(R"({{"payload":"{}"}})", s100));
EXPECT_EQ( EXPECT_EQ(
res, res,
R"({"payload":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","warning":"load","warnings":[{"id":2003,"message":"You are about to be rate limited"}]})" R"({"payload":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","warning":"load","warnings":[{"id":2003,"message":"You are about to be rate limited"}]})"
@@ -378,7 +395,7 @@ TEST_F(WebServerTest, WsPayloadOverload)
auto e = std::make_shared<EchoExecutor>(); auto e = std::make_shared<EchoExecutor>();
auto server = makeServerSync(cfg, ctx, std::nullopt, dosGuardOverload, e); auto server = makeServerSync(cfg, ctx, std::nullopt, dosGuardOverload, e);
WebSocketSyncClient wsClient; WebSocketSyncClient wsClient;
wsClient.connect("localhost", "8888"); wsClient.connect("localhost", port);
auto const res = wsClient.syncPost(fmt::format(R"({{"payload":"{}"}})", s100)); auto const res = wsClient.syncPost(fmt::format(R"({{"payload":"{}"}})", s100));
wsClient.disconnect(); wsClient.disconnect();
EXPECT_EQ( EXPECT_EQ(
@@ -393,13 +410,13 @@ TEST_F(WebServerTest, WsTooManyConnection)
auto server = makeServerSync(cfg, ctx, std::nullopt, dosGuardOverload, e); auto server = makeServerSync(cfg, ctx, std::nullopt, dosGuardOverload, e);
// max connection is 2, exception should happen when the third connection is made // max connection is 2, exception should happen when the third connection is made
WebSocketSyncClient wsClient1; WebSocketSyncClient wsClient1;
wsClient1.connect("localhost", "8888"); wsClient1.connect("localhost", port);
WebSocketSyncClient wsClient2; WebSocketSyncClient wsClient2;
wsClient2.connect("localhost", "8888"); wsClient2.connect("localhost", port);
bool exceptionThrown = false; bool exceptionThrown = false;
try { try {
WebSocketSyncClient wsClient3; WebSocketSyncClient wsClient3;
wsClient3.connect("localhost", "8888"); wsClient3.connect("localhost", port);
} catch (boost::system::system_error const& ex) { } catch (boost::system::system_error const& ex) {
exceptionThrown = true; exceptionThrown = true;
EXPECT_EQ(ex.code(), boost::beast::websocket::error::upgrade_declined); EXPECT_EQ(ex.code(), boost::beast::websocket::error::upgrade_declined);
@@ -409,45 +426,65 @@ TEST_F(WebServerTest, WsTooManyConnection)
EXPECT_TRUE(exceptionThrown); EXPECT_TRUE(exceptionThrown);
} }
static auto constexpr JSONServerConfigWithAdminPassword = R"JSON( std::string
{ JSONServerConfigWithAdminPassword(uint32_t const port)
"server":{ {
"ip": "0.0.0.0", return fmt::format(
"port": 8888, R"JSON({{
"admin_password": "secret" "server": {{
} "ip": "0.0.0.0",
} "port": {},
)JSON"; "admin_password": "secret"
}}
}})JSON",
port
);
}
static auto constexpr JSONServerConfigWithLocalAdmin = R"JSON( std::string
{ JSONServerConfigWithLocalAdmin(uint32_t const port)
"server":{ {
"ip": "0.0.0.0", return fmt::format(
"port": 8888, R"JSON({{
"local_admin": true "server": {{
} "ip": "0.0.0.0",
} "port": {},
)JSON"; "local_admin": true
}}
}})JSON",
port
);
}
static auto constexpr JSONServerConfigWithBothAdminPasswordAndLocalAdminFalse = R"JSON( std::string
{ JSONServerConfigWithBothAdminPasswordAndLocalAdminFalse(uint32_t const port)
"server":{ {
"ip": "0.0.0.0", return fmt::format(
"port": 8888, R"JSON({{
"admin_password": "secret", "server": {{
"local_admin": false "ip": "0.0.0.0",
} "port": {},
} "admin_password": "secret",
)JSON"; "local_admin": false
}}
}})JSON",
port
);
}
static auto constexpr JSONServerConfigWithNoSpecifiedAdmin = R"JSON( std::string
{ JSONServerConfigWithNoSpecifiedAdmin(uint32_t const port)
"server":{ {
"ip": "0.0.0.0", return fmt::format(
"port": 8888 R"JSON({{
} "server": {{
} "ip": "0.0.0.0",
)JSON"; "port": {}
}}
}})JSON",
port
);
}
// get this value from online sha256 generator // get this value from online sha256 generator
static auto constexpr SecertSha256 = "2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b"; static auto constexpr SecertSha256 = "2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b";
@@ -478,10 +515,11 @@ class WebServerAdminTest : public WebServerTest, public ::testing::WithParamInte
TEST_P(WebServerAdminTest, WsAdminCheck) TEST_P(WebServerAdminTest, WsAdminCheck)
{ {
auto e = std::make_shared<AdminCheckExecutor>(); auto e = std::make_shared<AdminCheckExecutor>();
Config const serverConfig{boost::json::parse(GetParam().config)}; Config const serverConfig{parse(GetParam().config)};
auto server = makeServerSync(serverConfig, ctx, std::nullopt, dosGuardOverload, e); auto server = makeServerSync(serverConfig, ctx, std::nullopt, dosGuardOverload, e);
WebSocketSyncClient wsClient; WebSocketSyncClient wsClient;
wsClient.connect("localhost", "8888", GetParam().headers); uint32_t webServerPort = serverConfig.value<uint32_t>("server.port");
wsClient.connect("localhost", std::to_string(webServerPort), GetParam().headers);
std::string const request = "Why hello"; std::string const request = "Why hello";
auto const res = wsClient.syncPost(request); auto const res = wsClient.syncPost(request);
wsClient.disconnect(); wsClient.disconnect();
@@ -491,10 +529,11 @@ TEST_P(WebServerAdminTest, WsAdminCheck)
TEST_P(WebServerAdminTest, HttpAdminCheck) TEST_P(WebServerAdminTest, HttpAdminCheck)
{ {
auto e = std::make_shared<AdminCheckExecutor>(); auto e = std::make_shared<AdminCheckExecutor>();
Config const serverConfig{boost::json::parse(GetParam().config)}; Config const serverConfig{parse(GetParam().config)};
auto server = makeServerSync(serverConfig, ctx, std::nullopt, dosGuardOverload, e); auto server = makeServerSync(serverConfig, ctx, std::nullopt, dosGuardOverload, e);
std::string const request = "Why hello"; std::string const request = "Why hello";
auto const res = HttpSyncClient::syncPost("localhost", "8888", request, GetParam().headers); uint32_t webServerPort = serverConfig.value<uint32_t>("server.port");
auto const res = HttpSyncClient::syncPost("localhost", std::to_string(webServerPort), request, GetParam().headers);
EXPECT_EQ(res, fmt::format("{} {}", request, GetParam().expectedResponse)); EXPECT_EQ(res, fmt::format("{} {}", request, GetParam().expectedResponse));
} }
@@ -503,27 +542,27 @@ INSTANTIATE_TEST_CASE_P(
WebServerAdminTest, WebServerAdminTest,
::testing::Values( ::testing::Values(
WebServerAdminTestParams{ WebServerAdminTestParams{
.config = JSONServerConfigWithAdminPassword, .config = JSONServerConfigWithAdminPassword(tests::util::generateFreePort()),
.headers = {}, .headers = {},
.expectedResponse = "user" .expectedResponse = "user"
}, },
WebServerAdminTestParams{ WebServerAdminTestParams{
.config = JSONServerConfigWithAdminPassword, .config = JSONServerConfigWithAdminPassword(tests::util::generateFreePort()),
.headers = {WebHeader(http::field::authorization, "")}, .headers = {WebHeader(http::field::authorization, "")},
.expectedResponse = "user" .expectedResponse = "user"
}, },
WebServerAdminTestParams{ WebServerAdminTestParams{
.config = JSONServerConfigWithAdminPassword, .config = JSONServerConfigWithAdminPassword(tests::util::generateFreePort()),
.headers = {WebHeader(http::field::authorization, "s")}, .headers = {WebHeader(http::field::authorization, "s")},
.expectedResponse = "user" .expectedResponse = "user"
}, },
WebServerAdminTestParams{ WebServerAdminTestParams{
.config = JSONServerConfigWithAdminPassword, .config = JSONServerConfigWithAdminPassword(tests::util::generateFreePort()),
.headers = {WebHeader(http::field::authorization, SecertSha256)}, .headers = {WebHeader(http::field::authorization, SecertSha256)},
.expectedResponse = "user" .expectedResponse = "user"
}, },
WebServerAdminTestParams{ WebServerAdminTestParams{
.config = JSONServerConfigWithAdminPassword, .config = JSONServerConfigWithAdminPassword(tests::util::generateFreePort()),
.headers = {WebHeader( .headers = {WebHeader(
http::field::authorization, http::field::authorization,
fmt::format("{}{}", PasswordAdminVerificationStrategy::passwordPrefix, SecertSha256) fmt::format("{}{}", PasswordAdminVerificationStrategy::passwordPrefix, SecertSha256)
@@ -531,12 +570,12 @@ INSTANTIATE_TEST_CASE_P(
.expectedResponse = "admin" .expectedResponse = "admin"
}, },
WebServerAdminTestParams{ WebServerAdminTestParams{
.config = JSONServerConfigWithBothAdminPasswordAndLocalAdminFalse, .config = JSONServerConfigWithBothAdminPasswordAndLocalAdminFalse(tests::util::generateFreePort()),
.headers = {WebHeader(http::field::authorization, SecertSha256)}, .headers = {WebHeader(http::field::authorization, SecertSha256)},
.expectedResponse = "user" .expectedResponse = "user"
}, },
WebServerAdminTestParams{ WebServerAdminTestParams{
.config = JSONServerConfigWithBothAdminPasswordAndLocalAdminFalse, .config = JSONServerConfigWithBothAdminPasswordAndLocalAdminFalse(tests::util::generateFreePort()),
.headers = {WebHeader( .headers = {WebHeader(
http::field::authorization, http::field::authorization,
fmt::format("{}{}", PasswordAdminVerificationStrategy::passwordPrefix, SecertSha256) fmt::format("{}{}", PasswordAdminVerificationStrategy::passwordPrefix, SecertSha256)
@@ -544,16 +583,20 @@ INSTANTIATE_TEST_CASE_P(
.expectedResponse = "admin" .expectedResponse = "admin"
}, },
WebServerAdminTestParams{ WebServerAdminTestParams{
.config = JSONServerConfigWithAdminPassword, .config = JSONServerConfigWithAdminPassword(tests::util::generateFreePort()),
.headers = {WebHeader( .headers = {WebHeader(
http::field::authentication_info, http::field::authentication_info,
fmt::format("{}{}", PasswordAdminVerificationStrategy::passwordPrefix, SecertSha256) fmt::format("{}{}", PasswordAdminVerificationStrategy::passwordPrefix, SecertSha256)
)}, )},
.expectedResponse = "user" .expectedResponse = "user"
}, },
WebServerAdminTestParams{.config = JSONServerConfigWithLocalAdmin, .headers = {}, .expectedResponse = "admin"},
WebServerAdminTestParams{ WebServerAdminTestParams{
.config = JSONServerConfigWithNoSpecifiedAdmin, .config = JSONServerConfigWithLocalAdmin(tests::util::generateFreePort()),
.headers = {},
.expectedResponse = "admin"
},
WebServerAdminTestParams{
.config = JSONServerConfigWithNoSpecifiedAdmin(tests::util::generateFreePort()),
.headers = {}, .headers = {},
.expectedResponse = "admin" .expectedResponse = "admin"
} }
@@ -563,36 +606,40 @@ INSTANTIATE_TEST_CASE_P(
TEST_F(WebServerTest, AdminErrorCfgTestBothAdminPasswordAndLocalAdminSet) TEST_F(WebServerTest, AdminErrorCfgTestBothAdminPasswordAndLocalAdminSet)
{ {
static auto constexpr JSONServerConfigWithBothAdminPasswordAndLocalAdmin = R"JSON( uint32_t webServerPort = tests::util::generateFreePort();
{ std::string JSONServerConfigWithBothAdminPasswordAndLocalAdmin = fmt::format(
"server":{ R"JSON({{
"server":{{
"ip": "0.0.0.0", "ip": "0.0.0.0",
"port": 8888, "port": {},
"admin_password": "secret", "admin_password": "secret",
"local_admin": true "local_admin": true
} }}
} }})JSON",
)JSON"; webServerPort
);
auto e = std::make_shared<AdminCheckExecutor>(); auto e = std::make_shared<AdminCheckExecutor>();
Config const serverConfig{boost::json::parse(JSONServerConfigWithBothAdminPasswordAndLocalAdmin)}; Config const serverConfig{parse(JSONServerConfigWithBothAdminPasswordAndLocalAdmin)};
EXPECT_THROW(web::make_HttpServer(serverConfig, ctx, std::nullopt, dosGuardOverload, e), std::logic_error); EXPECT_THROW(web::make_HttpServer(serverConfig, ctx, std::nullopt, dosGuardOverload, e), std::logic_error);
} }
TEST_F(WebServerTest, AdminErrorCfgTestBothAdminPasswordAndLocalAdminFalse) TEST_F(WebServerTest, AdminErrorCfgTestBothAdminPasswordAndLocalAdminFalse)
{ {
static auto constexpr JSONServerConfigWithNoAdminPasswordAndLocalAdminFalse = R"JSON( uint32_t webServerPort = tests::util::generateFreePort();
{ std::string JSONServerConfigWithNoAdminPasswordAndLocalAdminFalse = fmt::format(
"server":{ R"JSON({{
"ip": "0.0.0.0", "server": {{
"port": 8888, "ip": "0.0.0.0",
"local_admin": false "port": {},
} "local_admin": false
} }}
)JSON"; }})JSON",
webServerPort
);
auto e = std::make_shared<AdminCheckExecutor>(); auto e = std::make_shared<AdminCheckExecutor>();
Config const serverConfig{boost::json::parse(JSONServerConfigWithNoAdminPasswordAndLocalAdminFalse)}; Config const serverConfig{parse(JSONServerConfigWithNoAdminPasswordAndLocalAdminFalse)};
EXPECT_THROW(web::make_HttpServer(serverConfig, ctx, std::nullopt, dosGuardOverload, e), std::logic_error); EXPECT_THROW(web::make_HttpServer(serverConfig, ctx, std::nullopt, dosGuardOverload, e), std::logic_error);
} }
@@ -601,32 +648,35 @@ struct WebServerPrometheusTest : util::prometheus::WithPrometheus, WebServerTest
TEST_F(WebServerPrometheusTest, rejectedWithoutAdminPassword) TEST_F(WebServerPrometheusTest, rejectedWithoutAdminPassword)
{ {
auto e = std::make_shared<EchoExecutor>(); auto e = std::make_shared<EchoExecutor>();
Config const serverConfig{boost::json::parse(JSONServerConfigWithAdminPassword)}; uint32_t webServerPort = tests::util::generateFreePort();
Config const serverConfig{parse(JSONServerConfigWithAdminPassword(webServerPort))};
auto server = makeServerSync(serverConfig, ctx, std::nullopt, dosGuard, e); auto server = makeServerSync(serverConfig, ctx, std::nullopt, dosGuard, e);
auto const res = HttpSyncClient::syncGet("localhost", "8888", "", "/metrics"); auto const res = HttpSyncClient::syncGet("localhost", std::to_string(webServerPort), "", "/metrics");
EXPECT_EQ(res, "Only admin is allowed to collect metrics"); EXPECT_EQ(res, "Only admin is allowed to collect metrics");
} }
TEST_F(WebServerPrometheusTest, rejectedIfPrometheusIsDisabled) TEST_F(WebServerPrometheusTest, rejectedIfPrometheusIsDisabled)
{ {
static auto constexpr JSONServerConfigWithDisabledPrometheus = R"JSON( uint32_t webServerPort = tests::util::generateFreePort();
{ std::string JSONServerConfigWithDisabledPrometheus = fmt::format(
"server": { R"JSON({{
"server":{{
"ip": "0.0.0.0", "ip": "0.0.0.0",
"port": 8888, "port": {},
"admin_password": "secret" "admin_password": "secret"
}, }},
"prometheus": { "enabled": false } "prometheus": {{ "enabled": false }}
} }})JSON",
)JSON"; webServerPort
);
auto e = std::make_shared<EchoExecutor>(); auto e = std::make_shared<EchoExecutor>();
Config const serverConfig{boost::json::parse(JSONServerConfigWithDisabledPrometheus)}; Config const serverConfig{parse(JSONServerConfigWithDisabledPrometheus)};
PrometheusService::init(serverConfig); PrometheusService::init(serverConfig);
auto server = makeServerSync(serverConfig, ctx, std::nullopt, dosGuard, e); auto server = makeServerSync(serverConfig, ctx, std::nullopt, dosGuard, e);
auto const res = HttpSyncClient::syncGet( auto const res = HttpSyncClient::syncGet(
"localhost", "localhost",
"8888", std::to_string(webServerPort),
"", "",
"/metrics", "/metrics",
{WebHeader( {WebHeader(
@@ -639,14 +689,15 @@ TEST_F(WebServerPrometheusTest, rejectedIfPrometheusIsDisabled)
TEST_F(WebServerPrometheusTest, validResponse) TEST_F(WebServerPrometheusTest, validResponse)
{ {
uint32_t webServerPort = tests::util::generateFreePort();
auto& testCounter = PrometheusService::counterInt("test_counter", util::prometheus::Labels()); auto& testCounter = PrometheusService::counterInt("test_counter", util::prometheus::Labels());
++testCounter; ++testCounter;
auto e = std::make_shared<EchoExecutor>(); auto e = std::make_shared<EchoExecutor>();
Config const serverConfig{boost::json::parse(JSONServerConfigWithAdminPassword)}; Config const serverConfig{parse(JSONServerConfigWithAdminPassword(webServerPort))};
auto server = makeServerSync(serverConfig, ctx, std::nullopt, dosGuard, e); auto server = makeServerSync(serverConfig, ctx, std::nullopt, dosGuard, e);
auto const res = HttpSyncClient::syncGet( auto const res = HttpSyncClient::syncGet(
"localhost", "localhost",
"8888", std::to_string(webServerPort),
"", "",
"/metrics", "/metrics",
{WebHeader( {WebHeader(