test: modify logging_filesize_rate_limit params
What the developer wrote
Authored by Eugene Siegel
test: modify logging_filesize_rate_limit params
Change time_window from 20s to 1h so Reset is not accidentally called
if the test takes a while.
Change num_lines from 1024 to 10 since LogRateLimiter is parameterized
and does not require logging 1MiB of data.
Co-Authored-By: stickies-v <stickies-v@protonmail.com>
What changed, and why it matters
This commit only changes a test file. It makes a unit test for log-rate-limiting run faster and more reliably by reducing the amount of test data and extending the time window. There is no change to the actual Bitcoin Core software that users run, and no security issue is introduced or fixed.
No security action needed. This is a normal test-maintenance commit.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch modifies src/test/logging_tests.cpp. It lowers num_lines from 1024 to 10 in the logging_filesize_rate_limit test, changes time_window from 20s to 1h, and refactors BOOST_TEST_CONTEXT into BOOST_TEST_INFO_SCOPE. These are test-hygiene changes: the LogRateLimiter is parameterized, so 10 lines suffice, and a longer window prevents the rate limiter’s Reset from firing if the test machine is slow. No production code is touched.
Changed components
src/test/logging_tests.cppInspect captured patch +16 / −17
diff --git a/src/test/logging_tests.cpp b/src/test/logging_tests.cpp
index ad51de13..2e3b1c39 100644
--- a/src/test/logging_tests.cpp
+++ b/src/test/logging_tests.cpp
@@ -417,30 +417,29 @@ void TestLogFromLocation(Location location, const std::string& message,
BCLog::LogRateLimiter::Status status, bool suppressions_active,
std::source_location source = std::source_location::current())
{
+ BOOST_TEST_INFO_SCOPE("TestLogFromLocation called from " << source.file_name() << ":" << source.line());
using Status = BCLog::LogRateLimiter::Status;
if (!suppressions_active) assert(status == Status::UNSUPPRESSED); // developer error
std::ofstream ofs(LogInstance().m_file_path, std::ios::out | std::ios::trunc); // clear debug log
LogFromLocation(location, message);
auto log_lines{ReadDebugLogLines()};
+ BOOST_TEST_INFO_SCOPE(log_lines.size() << " log_lines read: \n" << util::Join(log_lines, "\n"));
- BOOST_TEST_CONTEXT("TestLogFromLocation failed from " << source.file_name() << ":" << source.line())
- {
- if (status == Status::STILL_SUPPRESSED) {
- BOOST_CHECK_EQUAL(log_lines.size(), 0);
- return;
- }
+ if (status == Status::STILL_SUPPRESSED) {
+ BOOST_CHECK_EQUAL(log_lines.size(), 0);
+ return;
+ }
- if (status == Status::NEWLY_SUPPRESSED) {
- BOOST_REQUIRE_EQUAL(log_lines.size(), 2);
- BOOST_CHECK(log_lines[0].starts_with("[*] [warning] Excessive logging detected"));
- log_lines.erase(log_lines.begin());
- }
- BOOST_REQUIRE_EQUAL(log_lines.size(), 1);
- auto& payload{log_lines.back()};
- BOOST_CHECK_EQUAL(suppressions_active, payload.starts_with("[*]"));
- BOOST_CHECK(payload.ends_with(message));
+ if (status == Status::NEWLY_SUPPRESSED) {
+ BOOST_REQUIRE_EQUAL(log_lines.size(), 2);
+ BOOST_CHECK(log_lines[0].starts_with("[*] [warning] Excessive logging detected"));
+ log_lines.erase(log_lines.begin());
}
+ BOOST_REQUIRE_EQUAL(log_lines.size(), 1);
+ auto& payload{log_lines.back()};
+ BOOST_CHECK_EQUAL(suppressions_active, payload.starts_with("[*]"));
+ BOOST_CHECK(payload.ends_with(message));
}
} // namespace
@@ -454,9 +453,9 @@ BOOST_FIXTURE_TEST_CASE(logging_filesize_rate_limit, LogSetup)
LogInstance().EnableCategory(BCLog::LogFlags::HTTP);
constexpr int64_t line_length{1024};
- constexpr int64_t num_lines{1024};
+ constexpr int64_t num_lines{10};
constexpr int64_t bytes_quota{line_length * num_lines};
- constexpr auto time_window{20s};
+ constexpr auto time_window{1h};
ScopedScheduler scheduler{};
auto limiter{scheduler.GetLimiter(bytes_quota, time_window)};
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.