mirror of
https://github.com/XRPLF/clio.git
synced 2025-11-20 03:35:55 +00:00
b62cfe949f
- Stop accepting connections during graceful shutdown in the old web server - Stop all the services before Clio exits - Move cache saving into stop callback
124 lines
4.5 KiB
C++
124 lines
4.5 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
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 "app/Stopper.hpp"
|
|
#include "util/AsioContextTestFixture.hpp"
|
|
#include "util/MockBackend.hpp"
|
|
#include "util/MockETLService.hpp"
|
|
#include "util/MockLoadBalancer.hpp"
|
|
#include "util/MockPrometheus.hpp"
|
|
#include "util/MockSubscriptionManager.hpp"
|
|
#include "util/config/ConfigDefinition.hpp"
|
|
#include "web/interface/Concepts.hpp"
|
|
|
|
#include <boost/asio/executor_work_guard.hpp>
|
|
#include <boost/asio/io_context.hpp>
|
|
#include <boost/asio/spawn.hpp>
|
|
#include <gmock/gmock.h>
|
|
#include <gtest/gtest.h>
|
|
|
|
#include <thread>
|
|
|
|
using namespace app;
|
|
|
|
struct StopperTest : virtual public ::testing::Test {
|
|
protected:
|
|
// Order here is important, stopper_ should die before mockCallback_, otherwise UB
|
|
testing::StrictMock<testing::MockFunction<void(boost::asio::yield_context)>> mockCallback_;
|
|
Stopper stopper_;
|
|
};
|
|
|
|
TEST_F(StopperTest, stopCallsCallback)
|
|
{
|
|
stopper_.setOnStop(mockCallback_.AsStdFunction());
|
|
EXPECT_CALL(mockCallback_, Call);
|
|
stopper_.stop();
|
|
}
|
|
|
|
TEST_F(StopperTest, stopCalledMultipleTimes)
|
|
{
|
|
stopper_.setOnStop(mockCallback_.AsStdFunction());
|
|
EXPECT_CALL(mockCallback_, Call);
|
|
stopper_.stop();
|
|
stopper_.stop();
|
|
stopper_.stop();
|
|
stopper_.stop();
|
|
}
|
|
|
|
struct StopperMakeCallbackTest : util::prometheus::WithPrometheus, SyncAsioContextTest {
|
|
struct ServerMock : web::ServerTag {
|
|
MOCK_METHOD(void, stop, (boost::asio::yield_context), ());
|
|
};
|
|
|
|
struct MockLedgerCacheSaver {
|
|
MOCK_METHOD(void, save, ());
|
|
MOCK_METHOD(void, waitToFinish, ());
|
|
};
|
|
|
|
protected:
|
|
testing::StrictMock<ServerMock> serverMock_;
|
|
testing::StrictMock<MockLoadBalancer> loadBalancerMock_;
|
|
testing::StrictMock<MockETLService> etlServiceMock_;
|
|
testing::StrictMock<MockSubscriptionManager> subscriptionManagerMock_;
|
|
testing::StrictMock<MockBackend> backendMock_{util::config::ClioConfigDefinition{}};
|
|
testing::StrictMock<MockLedgerCacheSaver> cacheSaverMock_;
|
|
boost::asio::io_context ioContextToStop_;
|
|
|
|
bool
|
|
isContextStopped() const
|
|
{
|
|
return ioContextToStop_.stopped();
|
|
}
|
|
};
|
|
|
|
TEST_F(StopperMakeCallbackTest, makeCallbackTest)
|
|
{
|
|
auto contextWorkGuard = boost::asio::make_work_guard(ioContextToStop_);
|
|
std::thread t{[this]() { ioContextToStop_.run(); }};
|
|
|
|
auto callback = Stopper::makeOnStopCallback(
|
|
serverMock_,
|
|
loadBalancerMock_,
|
|
etlServiceMock_,
|
|
subscriptionManagerMock_,
|
|
backendMock_,
|
|
cacheSaverMock_,
|
|
ioContextToStop_
|
|
);
|
|
|
|
testing::Sequence const s1, s2;
|
|
EXPECT_CALL(cacheSaverMock_, save).InSequence(s1).WillOnce([this]() { EXPECT_FALSE(isContextStopped()); });
|
|
EXPECT_CALL(serverMock_, stop).InSequence(s1).WillOnce([this]() { EXPECT_FALSE(isContextStopped()); });
|
|
EXPECT_CALL(loadBalancerMock_, stop).InSequence(s2).WillOnce([this]() { EXPECT_FALSE(isContextStopped()); });
|
|
EXPECT_CALL(etlServiceMock_, stop).InSequence(s1, s2).WillOnce([this]() { EXPECT_FALSE(isContextStopped()); });
|
|
EXPECT_CALL(subscriptionManagerMock_, stop).InSequence(s1, s2).WillOnce([this]() {
|
|
EXPECT_FALSE(isContextStopped());
|
|
});
|
|
EXPECT_CALL(backendMock_, waitForWritesToFinish).InSequence(s1, s2).WillOnce([this]() {
|
|
EXPECT_FALSE(isContextStopped());
|
|
});
|
|
EXPECT_CALL(cacheSaverMock_, waitToFinish).InSequence(s1).WillOnce([this]() { EXPECT_FALSE(isContextStopped()); });
|
|
|
|
runSpawn([&](boost::asio::yield_context yield) {
|
|
callback(yield);
|
|
EXPECT_TRUE(isContextStopped());
|
|
});
|
|
|
|
t.join();
|
|
}
|