test(telemetry): cover the [telemetry] batch-setting bounds

Guards the validation the parser gained upstream: zero rejected for all three
keys, a non-numeric value raising std::runtime_error rather than leaking
boost::bad_lexical_cast, a negative value rejected instead of wrapping to
4294967295, both bounds accepted exactly, and batch_size held at or below
max_queue_size.

The catch is std::runtime_error, not std::exception, on purpose: if the parser
ever stops wrapping, a bad_cast escapes and the suite fails loudly instead of
swallowing it.
This commit is contained in:
Pratik Mankawde
2026-09-07 15:02:48 +01:00
parent caa704de10
commit 161d28b6dd

View File

@@ -4,8 +4,85 @@
#include <gtest/gtest.h>
#include <chrono>
#include <cstdint>
#include <initializer_list>
#include <limits>
#include <stdexcept>
#include <string>
#include <utility>
using namespace xrpl;
namespace {
/**
* Batch-setting keys of the [telemetry] section.
*
* Spelled once so every case below matches what the parser reads. A
* misspelling cannot hide: the accepting cases would see the default instead
* of the value they wrote, and the rejecting cases would stop rejecting.
*/
namespace key {
constexpr char const* batchSize = "batch_size";
constexpr char const* batchDelayMs = "batch_delay_ms";
constexpr char const* maxQueueSize = "max_queue_size";
} // namespace key
/**
* The upper bound quoted in the expected messages below.
*
* makeTelemetrySetup() derives it from std::uint32_t, so pin the literal to
* that type here rather than repeating an unanchored number in 5 messages.
*/
static_assert(std::numeric_limits<std::uint32_t>::max() == 4294967295u);
using KeyValue = std::pair<char const*, char const*>;
/**
* Parse a [telemetry] section holding only the given keys.
*
* A key that is not listed stays absent, so its default applies.
*
* @param values Key/value pairs to write into the section.
* @return The populated Setup struct.
*/
telemetry::Telemetry::Setup
parseBatch(std::initializer_list<KeyValue> values)
{
Section section;
for (auto const& [name, value] : values)
section.set(name, value);
return telemetry::makeTelemetrySetup(section, "nHUtest123", "2.0.0", 0);
}
/**
* Parse and return the rejection message.
*
* Only std::runtime_error is caught. A boost::bad_lexical_cast escaping the
* parser derives from std::bad_cast, so it propagates and fails the test
* instead of being mistaken for a clean rejection. That is the point of the
* not-a-number cases.
*
* @param values Key/value pairs to write into the section.
* @return The exception message, or "" if the parse succeeded.
*/
std::string
batchRejection(std::initializer_list<KeyValue> values)
{
try
{
static_cast<void>(parseBatch(values));
return {};
}
catch (std::runtime_error const& e)
{
return e.what();
}
}
} // namespace
TEST(TelemetryConfig, setup_defaults)
{
telemetry::Telemetry::Setup const s;
@@ -39,6 +116,11 @@ TEST(TelemetryConfig, parse_empty_section)
EXPECT_EQ(setup.serviceVersion, "2.0.0");
EXPECT_EQ(setup.serviceInstanceId, "nHUtest123");
EXPECT_DOUBLE_EQ(setup.samplingRatio, 1.0);
// An absent key takes the documented default. setup_defaults covers the
// struct's own initializers; these three cover the parser applying them.
EXPECT_EQ(setup.batchSize, 512u);
EXPECT_EQ(setup.batchDelay, std::chrono::milliseconds{5000});
EXPECT_EQ(setup.maxQueueSize, 2048u);
EXPECT_TRUE(setup.traceRpc);
EXPECT_TRUE(setup.traceTransactions);
EXPECT_TRUE(setup.traceConsensus);
@@ -83,6 +165,127 @@ TEST(TelemetryConfig, parse_full_section)
EXPECT_FALSE(setup.traceLedger);
}
TEST(TelemetryConfig, batch_settings_accept_the_lower_bound_exactly)
{
auto const setup =
parseBatch({{key::batchSize, "1"}, {key::batchDelayMs, "1"}, {key::maxQueueSize, "1"}});
EXPECT_EQ(setup.batchSize, 1u);
EXPECT_EQ(setup.batchDelay, std::chrono::milliseconds{1});
EXPECT_EQ(setup.maxQueueSize, 1u);
}
TEST(TelemetryConfig, batch_settings_accept_the_upper_bound_exactly)
{
auto const setup = parseBatch(
{{key::batchSize, "4294967295"},
{key::batchDelayMs, "4294967295"},
{key::maxQueueSize, "4294967295"}});
EXPECT_EQ(setup.batchSize, 4294967295u);
EXPECT_EQ(setup.batchDelay, std::chrono::milliseconds{4294967295});
EXPECT_EQ(setup.maxQueueSize, 4294967295u);
}
TEST(TelemetryConfig, batch_size_zero_is_rejected)
{
EXPECT_EQ(
batchRejection({{key::batchSize, "0"}}),
"Invalid value 'batch_size' in [telemetry]: must be between 1 and 4294967295.");
}
TEST(TelemetryConfig, batch_delay_ms_zero_is_rejected)
{
EXPECT_EQ(
batchRejection({{key::batchDelayMs, "0"}}),
"Invalid value 'batch_delay_ms' in [telemetry]: must be between 1 and 4294967295.");
}
TEST(TelemetryConfig, max_queue_size_zero_is_rejected)
{
EXPECT_EQ(
batchRejection({{key::maxQueueSize, "0"}}),
"Invalid value 'max_queue_size' in [telemetry]: must be between 1 and 4294967295.");
}
TEST(TelemetryConfig, batch_size_not_a_number_is_rejected_as_runtime_error)
{
// Section::get() reaches boost::lexical_cast, which throws a std::bad_cast.
// Catching only std::runtime_error is the point: this fails unless the
// parser turned that into a message naming the key.
EXPECT_EQ(
batchRejection({{key::batchSize, "abc"}}),
"Invalid value 'batch_size' in [telemetry]: must be a whole number.");
}
TEST(TelemetryConfig, batch_delay_ms_not_a_number_is_rejected_as_runtime_error)
{
EXPECT_EQ(
batchRejection({{key::batchDelayMs, "abc"}}),
"Invalid value 'batch_delay_ms' in [telemetry]: must be a whole number.");
}
TEST(TelemetryConfig, max_queue_size_not_a_number_is_rejected_as_runtime_error)
{
EXPECT_EQ(
batchRejection({{key::maxQueueSize, "abc"}}),
"Invalid value 'max_queue_size' in [telemetry]: must be a whole number.");
}
TEST(TelemetryConfig, batch_size_fractional_is_rejected)
{
// A batch counts spans, so "512.5" must not silently truncate to 512.
EXPECT_EQ(
batchRejection({{key::batchSize, "512.5"}}),
"Invalid value 'batch_size' in [telemetry]: must be a whole number.");
}
TEST(TelemetryConfig, batch_settings_reject_negative_rather_than_wrapping)
{
// boost::lexical_cast to an unsigned type turns "-1" into 4294967295
// instead of failing, so a negative must land on the range check.
EXPECT_EQ(
batchRejection({{key::batchSize, "-1"}}),
"Invalid value 'batch_size' in [telemetry]: must be between 1 and 4294967295.");
EXPECT_EQ(
batchRejection({{key::batchDelayMs, "-1"}}),
"Invalid value 'batch_delay_ms' in [telemetry]: must be between 1 and 4294967295.");
EXPECT_EQ(
batchRejection({{key::maxQueueSize, "-1"}}),
"Invalid value 'max_queue_size' in [telemetry]: must be between 1 and 4294967295.");
}
TEST(TelemetryConfig, max_queue_size_above_the_upper_bound_is_rejected)
{
EXPECT_EQ(
batchRejection({{key::maxQueueSize, "4294967296"}}),
"Invalid value 'max_queue_size' in [telemetry]: must be between 1 and 4294967295.");
}
TEST(TelemetryConfig, batch_size_above_max_queue_size_is_rejected)
{
// The OTel SDK documents max_export_batch_size <= max_queue_size as a
// precondition and does not enforce it, so the parser must.
EXPECT_EQ(
batchRejection({{key::batchSize, "600"}, {key::maxQueueSize, "512"}}),
"Invalid value 'batch_size' in [telemetry]: must not exceed 'max_queue_size' (512).");
}
TEST(TelemetryConfig, batch_size_above_a_lowered_max_queue_size_is_rejected)
{
// The likely operator mistake: lowering only max_queue_size and leaving
// batch_size at its 512 default.
EXPECT_EQ(
batchRejection({{key::maxQueueSize, "256"}}),
"Invalid value 'batch_size' in [telemetry]: must not exceed 'max_queue_size' (256).");
}
TEST(TelemetryConfig, batch_size_equal_to_max_queue_size_is_accepted)
{
// The cross-check rejects only batchSize > maxQueueSize, so equal passes.
auto const setup = parseBatch({{key::batchSize, "512"}, {key::maxQueueSize, "512"}});
EXPECT_EQ(setup.batchSize, 512u);
EXPECT_EQ(setup.maxQueueSize, 512u);
}
TEST(TelemetryConfig, null_telemetry_factory)
{
telemetry::Telemetry::Setup setup;