//------------------------------------------------------------------------------ /* This file is part of clio: https://github.com/XRPLF/clio Copyright (c) 2023, 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 #include #include #include #include #include #include #include using namespace rpc; using namespace testing; constexpr static auto ACCOUNT = "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"; constexpr static auto ACCOUNT2 = "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun"; constexpr static auto INDEX1 = "E6DBAFC99223B42257915A63DFC6B0C032D4070F9A574B255AD97466726FC321"; constexpr static auto INDEX2 = "E6DBAFC99223B42257915A63DFC6B0C032D4070F9A574B255AD97466726FC322"; constexpr static auto TXNID = "E6DBAFC99223B42257915A63DFC6B0C032D4070F9A574B255AD97466726FC321"; class RPCHelpersTest : public MockBackendTest, public SyncAsioContextTest { void SetUp() override { MockBackendTest::SetUp(); SyncAsioContextTest::SetUp(); } void TearDown() override { MockBackendTest::TearDown(); SyncAsioContextTest::TearDown(); } }; TEST_F(RPCHelpersTest, TraverseOwnedNodesMarkerInvalidIndexNotHex) { boost::asio::spawn(ctx, [this](boost::asio::yield_context yield) { auto account = GetAccountIDWithString(ACCOUNT); auto ret = traverseOwnedNodes(*mockBackendPtr, account, 9, 10, "nothex,10", yield, [](auto) { }); auto status = std::get_if(&ret); EXPECT_TRUE(status != nullptr); EXPECT_EQ(*status, ripple::rpcINVALID_PARAMS); EXPECT_EQ(status->message, "Malformed cursor."); }); ctx.run(); } TEST_F(RPCHelpersTest, TraverseOwnedNodesMarkerInvalidPageNotInt) { boost::asio::spawn(ctx, [this](boost::asio::yield_context yield) { auto account = GetAccountIDWithString(ACCOUNT); auto ret = traverseOwnedNodes(*mockBackendPtr, account, 9, 10, "nothex,abc", yield, [](auto) { }); auto status = std::get_if(&ret); EXPECT_TRUE(status != nullptr); EXPECT_EQ(*status, ripple::rpcINVALID_PARAMS); EXPECT_EQ(status->message, "Malformed cursor."); }); ctx.run(); } // limit = 10, return 2 objects TEST_F(RPCHelpersTest, TraverseOwnedNodesNoInputMarker) { MockBackend* rawBackendPtr = dynamic_cast(mockBackendPtr.get()); ASSERT_NE(rawBackendPtr, nullptr); auto account = GetAccountIDWithString(ACCOUNT); auto owneDirKk = ripple::keylet::ownerDir(account).key; EXPECT_CALL(*rawBackendPtr, doFetchLedgerObject).Times(1); // return owner index ripple::STObject const ownerDir = CreateOwnerDirLedgerObject({ripple::uint256{INDEX1}, ripple::uint256{INDEX2}}, INDEX1); ON_CALL(*rawBackendPtr, doFetchLedgerObject(owneDirKk, testing::_, testing::_)) .WillByDefault(Return(ownerDir.getSerializer().peekData())); // return two payment channel objects std::vector bbs; ripple::STObject const channel1 = CreatePaymentChannelLedgerObject(ACCOUNT, ACCOUNT2, 100, 10, 32, TXNID, 28); bbs.push_back(channel1.getSerializer().peekData()); bbs.push_back(channel1.getSerializer().peekData()); ON_CALL(*rawBackendPtr, doFetchLedgerObjects).WillByDefault(Return(bbs)); EXPECT_CALL(*rawBackendPtr, doFetchLedgerObjects).Times(1); boost::asio::spawn(ctx, [this, &account](boost::asio::yield_context yield) { auto ret = traverseOwnedNodes(*mockBackendPtr, account, 9, 10, {}, yield, [](auto) { }); auto cursor = std::get_if(&ret); EXPECT_TRUE(cursor != nullptr); EXPECT_EQ( cursor->toString(), "0000000000000000000000000000000000000000000000000000000000000000," "0" ); }); ctx.run(); } // limit = 10, return 10 objects and marker TEST_F(RPCHelpersTest, TraverseOwnedNodesNoInputMarkerReturnSamePageMarker) { MockBackend* rawBackendPtr = dynamic_cast(mockBackendPtr.get()); ASSERT_NE(rawBackendPtr, nullptr); auto account = GetAccountIDWithString(ACCOUNT); auto owneDirKk = ripple::keylet::ownerDir(account).key; EXPECT_CALL(*rawBackendPtr, doFetchLedgerObject).Times(1); std::vector bbs; int objectsCount = 11; ripple::STObject const channel1 = CreatePaymentChannelLedgerObject(ACCOUNT, ACCOUNT2, 100, 10, 32, TXNID, 28); std::vector indexes; while (objectsCount != 0) { // return owner index indexes.emplace_back(INDEX1); bbs.push_back(channel1.getSerializer().peekData()); objectsCount--; } ripple::STObject ownerDir = CreateOwnerDirLedgerObject(indexes, INDEX1); ownerDir.setFieldU64(ripple::sfIndexNext, 99); ON_CALL(*rawBackendPtr, doFetchLedgerObject(owneDirKk, testing::_, testing::_)) .WillByDefault(Return(ownerDir.getSerializer().peekData())); ON_CALL(*rawBackendPtr, doFetchLedgerObjects).WillByDefault(Return(bbs)); EXPECT_CALL(*rawBackendPtr, doFetchLedgerObjects).Times(1); boost::asio::spawn(ctx, [this, &account](boost::asio::yield_context yield) { auto count = 0; auto ret = traverseOwnedNodes(*mockBackendPtr, account, 9, 10, {}, yield, [&](auto) { count++; }); auto cursor = std::get_if(&ret); EXPECT_TRUE(cursor != nullptr); EXPECT_EQ(count, 10); EXPECT_EQ(cursor->toString(), fmt::format("{},0", INDEX1)); }); ctx.run(); } // 10 objects per page, limit is 15, return the second page as marker TEST_F(RPCHelpersTest, TraverseOwnedNodesNoInputMarkerReturnOtherPageMarker) { MockBackend* rawBackendPtr = dynamic_cast(mockBackendPtr.get()); ASSERT_NE(rawBackendPtr, nullptr); auto account = GetAccountIDWithString(ACCOUNT); auto ownerDirKk = ripple::keylet::ownerDir(account).key; constexpr static auto nextPage = 99; constexpr static auto limit = 15; auto ownerDir2Kk = ripple::keylet::page(ripple::keylet::ownerDir(account), nextPage).key; EXPECT_CALL(*rawBackendPtr, doFetchLedgerObject).Times(2); std::vector bbs; int objectsCount = 10; ripple::STObject const channel1 = CreatePaymentChannelLedgerObject(ACCOUNT, ACCOUNT2, 100, 10, 32, TXNID, 28); std::vector indexes; while (objectsCount != 0) { // return owner index indexes.emplace_back(INDEX1); objectsCount--; } objectsCount = 15; while (objectsCount != 0) { bbs.push_back(channel1.getSerializer().peekData()); objectsCount--; } ripple::STObject ownerDir = CreateOwnerDirLedgerObject(indexes, INDEX1); ownerDir.setFieldU64(ripple::sfIndexNext, nextPage); // first page 's next page is 99 ON_CALL(*rawBackendPtr, doFetchLedgerObject(ownerDirKk, testing::_, testing::_)) .WillByDefault(Return(ownerDir.getSerializer().peekData())); ripple::STObject ownerDir2 = CreateOwnerDirLedgerObject(indexes, INDEX1); // second page's next page is 0 ownerDir2.setFieldU64(ripple::sfIndexNext, 0); ON_CALL(*rawBackendPtr, doFetchLedgerObject(ownerDir2Kk, testing::_, testing::_)) .WillByDefault(Return(ownerDir2.getSerializer().peekData())); ON_CALL(*rawBackendPtr, doFetchLedgerObjects).WillByDefault(Return(bbs)); EXPECT_CALL(*rawBackendPtr, doFetchLedgerObjects).Times(1); boost::asio::spawn(ctx, [&, this](boost::asio::yield_context yield) { auto count = 0; auto ret = traverseOwnedNodes(*mockBackendPtr, account, 9, limit, {}, yield, [&](auto) { count++; }); auto cursor = std::get_if(&ret); EXPECT_TRUE(cursor != nullptr); EXPECT_EQ(count, limit); EXPECT_EQ(cursor->toString(), fmt::format("{},{}", INDEX1, nextPage)); }); ctx.run(); } // Send a valid marker TEST_F(RPCHelpersTest, TraverseOwnedNodesWithMarkerReturnSamePageMarker) { MockBackend* rawBackendPtr = dynamic_cast(mockBackendPtr.get()); ASSERT_NE(rawBackendPtr, nullptr); auto account = GetAccountIDWithString(ACCOUNT); auto ownerDir2Kk = ripple::keylet::page(ripple::keylet::ownerDir(account), 99).key; constexpr static auto limit = 8; constexpr static auto pageNum = 99; EXPECT_CALL(*rawBackendPtr, doFetchLedgerObject).Times(2); std::vector bbs; int objectsCount = 10; ripple::STObject const channel1 = CreatePaymentChannelLedgerObject(ACCOUNT, ACCOUNT2, 100, 10, 32, TXNID, 28); std::vector indexes; while (objectsCount != 0) { // return owner index indexes.emplace_back(INDEX1); objectsCount--; } objectsCount = 10; while (objectsCount != 0) { bbs.push_back(channel1.getSerializer().peekData()); objectsCount--; } ripple::STObject ownerDir = CreateOwnerDirLedgerObject(indexes, INDEX1); ownerDir.setFieldU64(ripple::sfIndexNext, 0); // return ownerdir when search by marker ON_CALL(*rawBackendPtr, doFetchLedgerObject(ownerDir2Kk, testing::_, testing::_)) .WillByDefault(Return(ownerDir.getSerializer().peekData())); ON_CALL(*rawBackendPtr, doFetchLedgerObjects).WillByDefault(Return(bbs)); EXPECT_CALL(*rawBackendPtr, doFetchLedgerObjects).Times(1); boost::asio::spawn(ctx, [&, this](boost::asio::yield_context yield) { auto count = 0; auto ret = traverseOwnedNodes( *mockBackendPtr, account, 9, limit, fmt::format("{},{}", INDEX1, pageNum), yield, [&](auto) { count++; } ); auto cursor = std::get_if(&ret); EXPECT_TRUE(cursor != nullptr); EXPECT_EQ(count, limit); EXPECT_EQ(cursor->toString(), fmt::format("{},{}", INDEX1, pageNum)); }); ctx.run(); } // Send a valid marker, but marker contain an unexisting index // return invalid params error TEST_F(RPCHelpersTest, TraverseOwnedNodesWithUnexistingIndexMarker) { MockBackend* rawBackendPtr = dynamic_cast(mockBackendPtr.get()); ASSERT_NE(rawBackendPtr, nullptr); auto account = GetAccountIDWithString(ACCOUNT); auto ownerDir2Kk = ripple::keylet::page(ripple::keylet::ownerDir(account), 99).key; constexpr static auto limit = 8; constexpr static auto pageNum = 99; EXPECT_CALL(*rawBackendPtr, doFetchLedgerObject).Times(1); int objectsCount = 10; ripple::STObject const channel1 = CreatePaymentChannelLedgerObject(ACCOUNT, ACCOUNT2, 100, 10, 32, TXNID, 28); std::vector indexes; while (objectsCount != 0) { // return owner index indexes.emplace_back(INDEX1); objectsCount--; } ripple::STObject ownerDir = CreateOwnerDirLedgerObject(indexes, INDEX1); ownerDir.setFieldU64(ripple::sfIndexNext, 0); // return ownerdir when search by marker ON_CALL(*rawBackendPtr, doFetchLedgerObject(ownerDir2Kk, testing::_, testing::_)) .WillByDefault(Return(ownerDir.getSerializer().peekData())); boost::asio::spawn(ctx, [&, this](boost::asio::yield_context yield) { auto count = 0; auto ret = traverseOwnedNodes( *mockBackendPtr, account, 9, limit, fmt::format("{},{}", INDEX2, pageNum), yield, [&](auto) { count++; } ); auto status = std::get_if(&ret); EXPECT_TRUE(status != nullptr); EXPECT_EQ(*status, ripple::rpcINVALID_PARAMS); EXPECT_EQ(status->message, "Invalid marker."); }); ctx.run(); } TEST_F(RPCHelpersTest, EncodeCTID) { auto const ctid = encodeCTID(0x1234, 0x67, 0x89); ASSERT_TRUE(ctid); EXPECT_EQ(*ctid, "C000123400670089"); EXPECT_FALSE(encodeCTID(0x1FFFFFFF, 0x67, 0x89)); } TEST_F(RPCHelpersTest, DecodeCTIDString) { auto const ctid = decodeCTID("C000123400670089"); ASSERT_TRUE(ctid); EXPECT_EQ(*ctid, std::make_tuple(0x1234, 0x67, 0x89)); EXPECT_FALSE(decodeCTID("F000123400670089")); EXPECT_FALSE(decodeCTID("F0001234006700")); EXPECT_FALSE(decodeCTID("F000123400*700")); } TEST_F(RPCHelpersTest, DecodeCTIDInt) { uint64_t ctidStr = 0xC000123400670089; auto const ctid = decodeCTID(ctidStr); ASSERT_TRUE(ctid); EXPECT_EQ(*ctid, std::make_tuple(0x1234, 0x67, 0x89)); ctidStr = 0xF000123400670089; EXPECT_FALSE(decodeCTID(ctidStr)); } TEST_F(RPCHelpersTest, DecodeInvalidCTID) { EXPECT_FALSE(decodeCTID('c')); EXPECT_FALSE(decodeCTID(true)); } TEST_F(RPCHelpersTest, DeliverMaxAliasV1) { std::array const inputArray = { R"({ "TransactionType": "Payment", "Amount": { "test": "test" } })", R"({ "TransactionType": "OfferCreate", "Amount": { "test": "test" } })", R"({ "TransactionType": "Payment", "Amount1": { "test": "test" } })"}; std::array outputArray = { R"({ "TransactionType": "Payment", "Amount": { "test": "test" }, "DeliverMax": { "test": "test" } })", R"({ "TransactionType": "OfferCreate", "Amount": { "test": "test" } })", R"({ "TransactionType": "Payment", "Amount1": { "test": "test" } })"}; for (size_t i = 0; i < inputArray.size(); i++) { auto req = boost::json::parse(inputArray[i]).as_object(); insertDeliverMaxAlias(req, 1); EXPECT_EQ(req, boost::json::parse(outputArray[i]).as_object()); } } TEST_F(RPCHelpersTest, DeliverMaxAliasV2) { auto req = boost::json::parse( R"({ "TransactionType": "Payment", "Amount": { "test": "test" } })" ) .as_object(); insertDeliverMaxAlias(req, 2); EXPECT_EQ( req, boost::json::parse( R"({ "TransactionType": "Payment", "DeliverMax": { "test": "test" } })" ) ); }