ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2025-12-06 17:27:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

test: Fix prometheus tests (#2312)

Browse Source
This commit is contained in:
Sergey Kuznetsov
2025-07-23 15:26:01 +01:00
committed by GitHub
parent 3f0f20a542
commit bcaa5f3392
4 changed files with 24 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
tests/common/util/MockPrometheus.hpp
View File

@@ -214,7 +214,7 @@ struct WithMockPrometheus : virtual ::testing::Test {
{"prometheus.compress_reply", config::ConfigValue{config::ConfigType::Boolean}.defaultValue(true)}, {"prometheus.compress_reply", config::ConfigValue{config::ConfigType::Boolean}.defaultValue(true)},
{"prometheus.enabled", config::ConfigValue{config::ConfigType::Boolean}.defaultValue(true)} {"prometheus.enabled", config::ConfigValue{config::ConfigType::Boolean}.defaultValue(true)}
}; };
PrometheusService::init(config); PrometheusService::replaceInstance(nullptr);
} }
static MockPrometheusImpl& static MockPrometheusImpl&
@@ -258,20 +258,24 @@ struct WithMockPrometheus : virtual ::testing::Test {
/** /**
* @note this class should be the first in the inheritance list * @note this class should be the first in the inheritance list
*/ */
struct WithPrometheus : virtual ::testing::Test { template <bool IsEnabled = true>
WithPrometheus() struct WithPrometheusImpl : virtual ::testing::Test {
WithPrometheusImpl()
{ {
config::ClioConfigDefinition const config{ config::ClioConfigDefinition const config{
{"prometheus.compress_reply", config::ConfigValue{config::ConfigType::Boolean}.defaultValue(false)}, {"prometheus.compress_reply", config::ConfigValue{config::ConfigType::Boolean}.defaultValue(false)},
{"prometheus.enabled", config::ConfigValue{config::ConfigType::Boolean}.defaultValue(true)} {"prometheus.enabled", config::ConfigValue{config::ConfigType::Boolean}.defaultValue(IsEnabled)}
}; };
PrometheusService::init(config); PrometheusService::init(config);
} }
~WithPrometheus() override ~WithPrometheusImpl() override
{ {
PrometheusService::replaceInstance(nullptr); PrometheusService::replaceInstance(nullptr);
} }
}; };
using WithPrometheus = WithPrometheusImpl<>;
using WithPrometheusDisabled = WithPrometheusImpl<false>;
} // namespace util::prometheus } // namespace util::prometheus

21
tests/unit/util/prometheus/HttpTests.cpp
View File

@@ -48,15 +48,11 @@ struct PrometheusCheckRequestTestsParams {
bool expected; bool expected;
}; };
struct PrometheusCheckRequestTests : public ::testing::TestWithParam<PrometheusCheckRequestTestsParams> {}; struct PrometheusCheckRequestTests : WithPrometheus,
::testing::WithParamInterface<PrometheusCheckRequestTestsParams> {};
TEST_P(PrometheusCheckRequestTests, isPrometheusRequest) TEST_P(PrometheusCheckRequestTests, isPrometheusRequest)
{ {
ClioConfigDefinition const config{
{"prometheus.enabled", ConfigValue{ConfigType::Boolean}.defaultValue(GetParam().prometheusEnabled)},
{"prometheus.compress_reply", ConfigValue{ConfigType::Boolean}.defaultValue(true)}
};
PrometheusService::init(config);
boost::beast::http::request<boost::beast::http::string_body> req; boost::beast::http::request<boost::beast::http::string_body> req;
req.method(GetParam().method); req.method(GetParam().method);
req.target(GetParam().target); req.target(GetParam().target);
@@ -111,9 +107,10 @@ INSTANTIATE_TEST_CASE_P(
tests::util::kNAME_GENERATOR tests::util::kNAME_GENERATOR
); );
struct PrometheusHandleRequestTests : util::prometheus::WithPrometheus { struct PrometheusHandleRequestTestsBase {
http::request<http::string_body> const req{http::verb::get, "/metrics", 11}; http::request<http::string_body> const req{http::verb::get, "/metrics", 11};
}; };
struct PrometheusHandleRequestTests : util::prometheus::WithPrometheus, PrometheusHandleRequestTestsBase {};
TEST_F(PrometheusHandleRequestTests, emptyResponse) TEST_F(PrometheusHandleRequestTests, emptyResponse)
{ {
@@ -124,13 +121,11 @@ TEST_F(PrometheusHandleRequestTests, emptyResponse)
EXPECT_EQ(response->body(), ""); EXPECT_EQ(response->body(), "");
} }
TEST_F(PrometheusHandleRequestTests, prometheusDisabled) struct PrometheusDisabledHandleRequestTests : util::prometheus::WithPrometheusDisabled,
PrometheusHandleRequestTestsBase {};
TEST_F(PrometheusDisabledHandleRequestTests, prometheusDisabled)
{ {
ClioConfigDefinition const config{
{"prometheus.enabled", ConfigValue{ConfigType::Boolean}.defaultValue(false)},
{"prometheus.compress_reply", ConfigValue{ConfigType::Boolean}.defaultValue(true)}
};
PrometheusService::init(config);
auto response = handlePrometheusRequest(req, true); auto response = handlePrometheusRequest(req, true);
ASSERT_TRUE(response.has_value()); ASSERT_TRUE(response.has_value());
EXPECT_EQ(response->result(), http::status::forbidden); EXPECT_EQ(response->result(), http::status::forbidden);

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

@@ -688,7 +688,9 @@ TEST_F(WebServerPrometheusTest, rejectedWithoutAdminPassword)
EXPECT_EQ(status, boost::beast::http::status::unauthorized); EXPECT_EQ(status, boost::beast::http::status::unauthorized);
} }
TEST_F(WebServerPrometheusTest, rejectedIfPrometheusIsDisabled) struct WebServerPrometheusDisabledTest : util::prometheus::WithPrometheusDisabled, WebServerTest {};
TEST_F(WebServerPrometheusDisabledTest, rejectedIfPrometheusIsDisabled)
{ {
uint32_t webServerPort = tests::util::generateFreePort(); uint32_t webServerPort = tests::util::generateFreePort();
std::string const jsonServerConfigWithDisabledPrometheus = fmt::format( std::string const jsonServerConfigWithDisabledPrometheus = fmt::format(
@@ -698,8 +700,7 @@ TEST_F(WebServerPrometheusTest, rejectedIfPrometheusIsDisabled)
"port": {}, "port": {},
"admin_password": "secret", "admin_password": "secret",
"ws_max_sending_queue_size": 1500 "ws_max_sending_queue_size": 1500
}}, }}
"prometheus": {{ "enabled": false }}
}})JSON", }})JSON",
webServerPort webServerPort
); );
@@ -708,7 +709,6 @@ TEST_F(WebServerPrometheusTest, rejectedIfPrometheusIsDisabled)
ClioConfigDefinition const serverConfig{ ClioConfigDefinition const serverConfig{
getParseAdminServerConfig(boost::json::parse(jsonServerConfigWithDisabledPrometheus)) getParseAdminServerConfig(boost::json::parse(jsonServerConfigWithDisabledPrometheus))
}; };
PrometheusService::init(serverConfig);
auto server = makeServerSync(serverConfig, ctx, dosGuard, e); auto server = makeServerSync(serverConfig, ctx, dosGuard, e);
auto const [status, res] = HttpSyncClient::get( auto const [status, res] = HttpSyncClient::get(
"localhost", "localhost",

4
tests/unit/web/ng/ServerTests.cpp
View File

@@ -69,7 +69,9 @@ struct MakeServerTestBundle {
bool expectSuccess; bool expectSuccess;
}; };
struct MakeServerTest : NoLoggerFixture, testing::WithParamInterface<MakeServerTestBundle> { struct MakeServerTest : util::prometheus::WithPrometheus,
NoLoggerFixture,
testing::WithParamInterface<MakeServerTestBundle> {
protected: protected:
boost::asio::io_context ioContext_; boost::asio::io_context ioContext_;
}; };