//------------------------------------------------------------------------------ /* 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 "cluster/ClioNode.hpp" #include "util/MockWriterState.hpp" #include "util/NameGenerator.hpp" #include "util/TimeUtils.hpp" #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace cluster; struct ClioNodeTest : testing::Test { std::string const updateTimeStr = "2015-05-15T12:00:00Z"; std::chrono::system_clock::time_point const updateTime = util::systemTpFromUtcStr(updateTimeStr, ClioNode::kTIME_FORMAT).value(); }; TEST_F(ClioNodeTest, Serialization) { ClioNode const node{ .uuid = std::make_shared(boost::uuids::random_generator()()), .updateTime = updateTime, .dbRole = ClioNode::DbRole::Writer }; boost::json::value jsonValue; EXPECT_NO_THROW(boost::json::value_from(node, jsonValue)); ASSERT_TRUE(jsonValue.is_object()) << jsonValue; auto const& obj = jsonValue.as_object(); EXPECT_TRUE(obj.contains("update_time")); EXPECT_TRUE(obj.at("update_time").is_string()); EXPECT_TRUE(obj.contains("db_role")); EXPECT_TRUE(obj.at("db_role").is_number()); EXPECT_EQ(obj.at("db_role").as_int64(), static_cast(node.dbRole)); } TEST_F(ClioNodeTest, Deserialization) { boost::json::value const jsonValue = {{"update_time", updateTimeStr}, {"db_role", 1}}; ClioNode node{ .uuid = std::make_shared(), .updateTime = {}, .dbRole = ClioNode::DbRole::ReadOnly }; ASSERT_NO_THROW(node = boost::json::value_to(jsonValue)); EXPECT_NE(node.uuid, nullptr); EXPECT_EQ(*node.uuid, boost::uuids::uuid{}); EXPECT_EQ(node.updateTime, updateTime); EXPECT_EQ(node.dbRole, ClioNode::DbRole::LoadingCache); } TEST_F(ClioNodeTest, DeserializationInvalidTime) { boost::json::value const jsonValue{"update_time", "invalid_format"}; EXPECT_THROW(boost::json::value_to(jsonValue), std::runtime_error); } TEST_F(ClioNodeTest, DeserializationMissingTime) { // Prepare a JSON object without update_time boost::json::value const jsonValue = {{}}; // Expect an exception EXPECT_THROW(boost::json::value_to(jsonValue), std::runtime_error); } struct ClioNodeDbRoleTestBundle { std::string testName; ClioNode::DbRole role; }; struct ClioNodeDbRoleTest : ClioNodeTest, testing::WithParamInterface {}; INSTANTIATE_TEST_SUITE_P( AllDbRoles, ClioNodeDbRoleTest, testing::Values( ClioNodeDbRoleTestBundle{.testName = "ReadOnly", .role = ClioNode::DbRole::ReadOnly}, ClioNodeDbRoleTestBundle{.testName = "LoadingCache", .role = ClioNode::DbRole::LoadingCache}, ClioNodeDbRoleTestBundle{.testName = "NotWriter", .role = ClioNode::DbRole::NotWriter}, ClioNodeDbRoleTestBundle{.testName = "Writer", .role = ClioNode::DbRole::Writer}, ClioNodeDbRoleTestBundle{.testName = "Fallback", .role = ClioNode::DbRole::Fallback} ), tests::util::kNAME_GENERATOR ); TEST_P(ClioNodeDbRoleTest, Serialization) { auto const param = GetParam(); ClioNode const node{ .uuid = std::make_shared(boost::uuids::random_generator()()), .updateTime = updateTime, .dbRole = param.role }; auto const jsonValue = boost::json::value_from(node); EXPECT_EQ(jsonValue.as_object().at("db_role").as_int64(), static_cast(param.role)); } TEST_P(ClioNodeDbRoleTest, Deserialization) { auto const param = GetParam(); boost::json::value const jsonValue = { {"update_time", updateTimeStr}, {"db_role", static_cast(param.role)} }; auto const node = boost::json::value_to(jsonValue); EXPECT_EQ(node.dbRole, param.role); } TEST_F(ClioNodeDbRoleTest, DeserializationInvalidDbRole) { boost::json::value const jsonValue = {{"update_time", updateTimeStr}, {"db_role", 10}}; EXPECT_THROW(boost::json::value_to(jsonValue), std::runtime_error); } TEST_F(ClioNodeDbRoleTest, DeserializationMissingDbRole) { boost::json::value const jsonValue = {{"update_time", updateTimeStr}}; EXPECT_THROW(boost::json::value_to(jsonValue), std::runtime_error); } struct ClioNodeFromTestBundle { std::string testName; bool readOnly; bool fallback; bool loadingCache; bool writing; ClioNode::DbRole expectedRole; }; struct ClioNodeFromTest : ClioNodeTest, testing::WithParamInterface { std::shared_ptr uuid = std::make_shared(boost::uuids::random_generator()()); MockWriterState writerState; }; INSTANTIATE_TEST_SUITE_P( AllWriterStates, ClioNodeFromTest, testing::Values( ClioNodeFromTestBundle{ .testName = "ReadOnly", .readOnly = true, .fallback = false, .loadingCache = false, .writing = false, .expectedRole = ClioNode::DbRole::ReadOnly }, ClioNodeFromTestBundle{ .testName = "Fallback", .readOnly = false, .fallback = true, .loadingCache = false, .writing = false, .expectedRole = ClioNode::DbRole::Fallback }, ClioNodeFromTestBundle{ .testName = "LoadingCache", .readOnly = false, .fallback = false, .loadingCache = true, .writing = false, .expectedRole = ClioNode::DbRole::LoadingCache }, ClioNodeFromTestBundle{ .testName = "NotWriterNotReadOnly", .readOnly = false, .fallback = false, .loadingCache = false, .writing = false, .expectedRole = ClioNode::DbRole::NotWriter }, ClioNodeFromTestBundle{ .testName = "Writer", .readOnly = false, .fallback = false, .loadingCache = false, .writing = true, .expectedRole = ClioNode::DbRole::Writer } ), tests::util::kNAME_GENERATOR ); TEST_P(ClioNodeFromTest, FromWriterState) { auto const& param = GetParam(); EXPECT_CALL(writerState, isReadOnly()).WillOnce(testing::Return(param.readOnly)); if (not param.readOnly) { EXPECT_CALL(writerState, isFallback()).WillOnce(testing::Return(param.fallback)); if (not param.fallback) { EXPECT_CALL(writerState, isLoadingCache()).WillOnce(testing::Return(param.loadingCache)); if (not param.loadingCache) { EXPECT_CALL(writerState, isWriting()).WillOnce(testing::Return(param.writing)); } } } auto const beforeTime = std::chrono::system_clock::now(); auto const node = ClioNode::from(uuid, writerState); auto const afterTime = std::chrono::system_clock::now(); EXPECT_EQ(node.uuid, uuid); EXPECT_EQ(node.dbRole, param.expectedRole); EXPECT_GE(node.updateTime, beforeTime); EXPECT_LE(node.updateTime, afterTime); }