//------------------------------------------------------------------------------ /* This file is part of clio: https://github.com/XRPLF/clio Copyright (c) 2025, 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 "etlng/ExtractorInterface.hpp" #include "etlng/LoaderInterface.hpp" #include "etlng/Models.hpp" #include "etlng/MonitorInterface.hpp" #include "etlng/SchedulerInterface.hpp" #include "etlng/impl/Loading.hpp" #include "etlng/impl/TaskManager.hpp" #include "util/BinaryTestObject.hpp" #include "util/LoggerFixtures.hpp" #include "util/TestObject.hpp" #include "util/async/AnyExecutionContext.hpp" #include "util/async/context/BasicExecutionContext.hpp" #include #include #include #include #include #include #include #include #include #include #include #include using namespace etlng::model; using namespace etlng::impl; namespace { constinit auto const kSEQ = 30; constinit auto const kLEDGER_HASH = "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652"; struct MockScheduler : etlng::SchedulerInterface { MOCK_METHOD(std::optional, next, (), (override)); }; struct MockExtractor : etlng::ExtractorInterface { MOCK_METHOD(std::optional, extractLedgerWithDiff, (uint32_t), (override)); MOCK_METHOD(std::optional, extractLedgerOnly, (uint32_t), (override)); }; struct MockLoader : etlng::LoaderInterface { using ExpectedType = std::expected; MOCK_METHOD(ExpectedType, load, (LedgerData const&), (override)); MOCK_METHOD(std::optional, loadInitialLedger, (LedgerData const&), (override)); }; struct MockMonitor : etlng::MonitorInterface { MOCK_METHOD(void, notifySequenceLoaded, (uint32_t), (override)); MOCK_METHOD(void, notifyWriteConflict, (uint32_t), (override)); MOCK_METHOD( boost::signals2::scoped_connection, subscribeToNewSequence, (NewSequenceSignalType::slot_type const&), (override) ); MOCK_METHOD( boost::signals2::scoped_connection, subscribeToDbStalled, (DbStalledSignalType::slot_type const&), (override) ); MOCK_METHOD(void, run, (std::chrono::steady_clock::duration), (override)); MOCK_METHOD(void, stop, (), (override)); }; struct TaskManagerTests : virtual public ::testing::Test { using MockSchedulerType = testing::NiceMock; using MockExtractorType = testing::NiceMock; using MockLoaderType = testing::NiceMock; using MockMonitorType = testing::NiceMock; protected: util::async::CoroExecutionContext ctx_{2}; std::shared_ptr mockSchedulerPtr_ = std::make_shared(); std::shared_ptr mockExtractorPtr_ = std::make_shared(); std::shared_ptr mockLoaderPtr_ = std::make_shared(); std::shared_ptr mockMonitorPtr_ = std::make_shared(); TaskManager taskManager_{ctx_, mockSchedulerPtr_, *mockExtractorPtr_, *mockLoaderPtr_, *mockMonitorPtr_, kSEQ}; }; auto createTestData(uint32_t seq) { auto const header = createLedgerHeader(kLEDGER_HASH, seq); return LedgerData{ .transactions = {}, .objects = {util::createObject(), util::createObject(), util::createObject()}, .successors = {}, .edgeKeys = {}, .header = header, .rawHeader = {}, .seq = seq }; } } // namespace TEST_F(TaskManagerTests, LoaderGetsDataIfNextSequenceIsExtracted) { static constexpr auto kTOTAL = 64uz; static constexpr auto kEXTRACTORS = 4uz; std::atomic_uint32_t seq = kSEQ; std::vector loaded; std::binary_semaphore done{0}; EXPECT_CALL(*mockSchedulerPtr_, next()).WillRepeatedly([&]() { return Task{.priority = Task::Priority::Higher, .seq = seq++}; }); EXPECT_CALL(*mockExtractorPtr_, extractLedgerWithDiff(testing::_)) .WillRepeatedly([](uint32_t seq) -> std::optional { if (seq > kSEQ + kTOTAL - 1) return std::nullopt; return createTestData(seq); }); EXPECT_CALL(*mockLoaderPtr_, load(testing::_)) .Times(kTOTAL) .WillRepeatedly([&](LedgerData data) -> std::expected { loaded.push_back(data.seq); if (loaded.size() == kTOTAL) done.release(); return {}; }); EXPECT_CALL(*mockMonitorPtr_, notifySequenceLoaded(testing::_)).Times(kTOTAL); taskManager_.run(kEXTRACTORS); done.acquire(); taskManager_.stop(); EXPECT_EQ(loaded.size(), kTOTAL); for (std::size_t i = 0; i < loaded.size(); ++i) EXPECT_EQ(loaded[i], kSEQ + i); } TEST_F(TaskManagerTests, WriteConflictHandling) { static constexpr auto kTOTAL = 64uz; static constexpr auto kCONFLICT_AFTER = 32uz; // Conflict after 32 ledgers static constexpr auto kEXTRACTORS = 4uz; std::atomic_uint32_t seq = kSEQ; std::vector loaded; std::binary_semaphore done{0}; bool conflictOccurred = false; EXPECT_CALL(*mockSchedulerPtr_, next()).WillRepeatedly([&]() { return Task{.priority = Task::Priority::Higher, .seq = seq++}; }); EXPECT_CALL(*mockExtractorPtr_, extractLedgerWithDiff(testing::_)) .WillRepeatedly([](uint32_t seq) -> std::optional { if (seq > kSEQ + kTOTAL - 1) return std::nullopt; return createTestData(seq); }); // First kCONFLICT_AFTER calls succeed, then we get a write conflict EXPECT_CALL(*mockLoaderPtr_, load(testing::_)) .WillRepeatedly([&](LedgerData data) -> std::expected { loaded.push_back(data.seq); if (loaded.size() == kCONFLICT_AFTER) { conflictOccurred = true; done.release(); return std::unexpected(etlng::LoaderError::WriteConflict); } if (loaded.size() == kTOTAL) done.release(); return {}; }); EXPECT_CALL(*mockMonitorPtr_, notifySequenceLoaded(testing::_)).Times(kCONFLICT_AFTER - 1); EXPECT_CALL(*mockMonitorPtr_, notifyWriteConflict(kSEQ + kCONFLICT_AFTER - 1)); taskManager_.run(kEXTRACTORS); done.acquire(); taskManager_.stop(); EXPECT_EQ(loaded.size(), kCONFLICT_AFTER); EXPECT_TRUE(conflictOccurred); for (std::size_t i = 0; i < loaded.size(); ++i) EXPECT_EQ(loaded[i], kSEQ + i); } TEST_F(TaskManagerTests, AmendmentBlockedHandling) { static constexpr auto kTOTAL = 64uz; static constexpr auto kAMENDMENT_BLOCKED_AFTER = 20uz; // Amendment block after 20 ledgers static constexpr auto kEXTRACTORS = 2uz; std::atomic_uint32_t seq = kSEQ; std::vector loaded; std::binary_semaphore done{0}; bool amendmentBlockedOccurred = false; EXPECT_CALL(*mockSchedulerPtr_, next()).WillRepeatedly([&]() { return Task{.priority = Task::Priority::Higher, .seq = seq++}; }); EXPECT_CALL(*mockExtractorPtr_, extractLedgerWithDiff(testing::_)) .WillRepeatedly([](uint32_t seq) -> std::optional { if (seq > kSEQ + kTOTAL - 1) return std::nullopt; return createTestData(seq); }); EXPECT_CALL(*mockLoaderPtr_, load(testing::_)) .WillRepeatedly([&](LedgerData data) -> std::expected { loaded.push_back(data.seq); if (loaded.size() == kAMENDMENT_BLOCKED_AFTER) { amendmentBlockedOccurred = true; done.release(); return std::unexpected(etlng::LoaderError::AmendmentBlocked); } if (loaded.size() == kTOTAL) done.release(); return {}; }); EXPECT_CALL(*mockMonitorPtr_, notifySequenceLoaded(testing::_)).Times(kAMENDMENT_BLOCKED_AFTER - 1); EXPECT_CALL(*mockMonitorPtr_, notifyWriteConflict(testing::_)).Times(0); taskManager_.run(kEXTRACTORS); done.acquire(); taskManager_.stop(); EXPECT_EQ(loaded.size(), kAMENDMENT_BLOCKED_AFTER); EXPECT_TRUE(amendmentBlockedOccurred); for (std::size_t i = 0; i < loaded.size(); ++i) EXPECT_EQ(loaded[i], kSEQ + i); }