ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2025-12-03 01:55:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Separate unit tests and integration tests (#1393)

Browse Source 
Fixes #1391
This commit is contained in:
Alex Kremer
2024-05-07 15:12:48 +01:00
committed by GitHub
parent 98ef83d470
commit cbc856b190
177 changed files with 168 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

753
tests/unit/rpc/handlers/LedgerDataTests.cpp Normal file
View File

@@ -0,0 +1,753 @@
//------------------------------------------------------------------------------
/*
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 "data/Types.hpp"
#include "rpc/Errors.hpp"
#include "rpc/common/AnyHandler.hpp"
#include "rpc/common/Types.hpp"
#include "rpc/handlers/LedgerData.hpp"
#include "util/Fixtures.hpp"
#include "util/TestObject.hpp"
#include <boost/json/parse.hpp>
#include <boost/json/value.hpp>
#include <fmt/core.h>
#include <gmock/gmock.h>
#include <gtest/gtest.h>
#include <ripple/basics/base_uint.h>
#include <ripple/protocol/AccountID.h>
#include <cstdint>
#include <optional>
#include <string>
#include <vector>
using namespace rpc;
namespace json = boost::json;
using namespace testing;
constexpr static auto RANGEMIN = 10;
constexpr static auto RANGEMAX = 30;
constexpr static auto ACCOUNT = "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn";
constexpr static auto ACCOUNT2 = "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun";
constexpr static auto LEDGERHASH = "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652";
constexpr static auto INDEX1 = "05FB0EB4B899F056FA095537C5817163801F544BAFCEA39C995D76DB4D16F9DD";
constexpr static auto INDEX2 = "E6DBAFC99223B42257915A63DFC6B0C032D4070F9A574B255AD97466726FC322";
constexpr static auto TXNID = "05FB0EB4B899F056FA095537C5817163801F544BAFCEA39C995D76DB4D16F0DD";
class RPCLedgerDataHandlerTest : public HandlerBaseTest {};
struct LedgerDataParamTestCaseBundle {
std::string testName;
std::string testJson;
std::string expectedError;
std::string expectedErrorMessage;
};
// parameterized test cases for parameters check
struct LedgerDataParameterTest : public RPCLedgerDataHandlerTest,
public WithParamInterface<LedgerDataParamTestCaseBundle> {
struct NameGenerator {
template <class ParamType>
std::string
operator()(testing::TestParamInfo<ParamType> const& info) const
{
auto bundle = static_cast<LedgerDataParamTestCaseBundle>(info.param);
return bundle.testName;
}
};
};
static auto
generateTestValuesForParametersTest()
{
return std::vector<LedgerDataParamTestCaseBundle>{
LedgerDataParamTestCaseBundle{
"ledger_indexInvalid", R"({"ledger_index": "x"})", "invalidParams", "ledgerIndexMalformed"
},
LedgerDataParamTestCaseBundle{
"ledger_hashInvalid", R"({"ledger_hash": "x"})", "invalidParams", "ledger_hashMalformed"
},
LedgerDataParamTestCaseBundle{
"ledger_hashNotString", R"({"ledger_hash": 123})", "invalidParams", "ledger_hashNotString"
},
LedgerDataParamTestCaseBundle{"binaryNotBool", R"({"binary": 123})", "invalidParams", "Invalid parameters."},
LedgerDataParamTestCaseBundle{"limitNotInt", R"({"limit": "xxx"})", "invalidParams", "Invalid parameters."},
LedgerDataParamTestCaseBundle{"limitNagetive", R"({"limit": -1})", "invalidParams", "Invalid parameters."},
LedgerDataParamTestCaseBundle{"limitZero", R"({"limit": 0})", "invalidParams", "Invalid parameters."},
LedgerDataParamTestCaseBundle{"markerInvalid", R"({"marker": "xxx"})", "invalidParams", "markerMalformed"},
LedgerDataParamTestCaseBundle{
"markerOutOfOrder",
R"({
"marker": "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652",
"out_of_order": true
})",
"invalidParams",
"outOfOrderMarkerNotInt"
},
LedgerDataParamTestCaseBundle{"markerNotString", R"({"marker": 123})", "invalidParams", "markerNotString"},
LedgerDataParamTestCaseBundle{
"typeNotString", R"({"type": 123})", "invalidParams", "Invalid field 'type', not string."
},
LedgerDataParamTestCaseBundle{"typeNotValid", R"({"type": "xxx"})", "invalidParams", "Invalid field 'type'."},
};
}
INSTANTIATE_TEST_CASE_P(
RPCLedgerDataGroup1,
LedgerDataParameterTest,
ValuesIn(generateTestValuesForParametersTest()),
LedgerDataParameterTest::NameGenerator{}
);
TEST_P(LedgerDataParameterTest, InvalidParams)
{
backend->setRange(RANGEMIN, RANGEMAX);
auto const testBundle = GetParam();
runSpawn([&, this](auto yield) {
auto const handler = AnyHandler{LedgerDataHandler{backend}};
auto const req = json::parse(testBundle.testJson);
auto const output = handler.process(req, Context{yield});
ASSERT_FALSE(output);
auto const err = rpc::makeError(output.result.error());
EXPECT_EQ(err.at("error").as_string(), testBundle.expectedError);
EXPECT_EQ(err.at("error_message").as_string(), testBundle.expectedErrorMessage);
});
}
TEST_F(RPCLedgerDataHandlerTest, LedgerNotExistViaIntSequence)
{
backend->setRange(RANGEMIN, RANGEMAX);
EXPECT_CALL(*backend, fetchLedgerBySequence).Times(1);
ON_CALL(*backend, fetchLedgerBySequence(RANGEMAX, _)).WillByDefault(Return(std::nullopt));
runSpawn([&, this](auto yield) {
auto const handler = AnyHandler{LedgerDataHandler{backend}};
auto const req = json::parse(fmt::format(
R"({{
"ledger_index": {}
}})",
RANGEMAX
));
auto const output = handler.process(req, Context{yield});
ASSERT_FALSE(output);
auto const err = rpc::makeError(output.result.error());
EXPECT_EQ(err.at("error").as_string(), "lgrNotFound");
EXPECT_EQ(err.at("error_message").as_string(), "ledgerNotFound");
});
}
TEST_F(RPCLedgerDataHandlerTest, LedgerNotExistViaStringSequence)
{
backend->setRange(RANGEMIN, RANGEMAX);
EXPECT_CALL(*backend, fetchLedgerBySequence).Times(1);
ON_CALL(*backend, fetchLedgerBySequence(RANGEMAX, _)).WillByDefault(Return(std::nullopt));
runSpawn([&, this](auto yield) {
auto const handler = AnyHandler{LedgerDataHandler{backend}};
auto const req = json::parse(fmt::format(
R"({{
"ledger_index": "{}"
}})",
RANGEMAX
));
auto const output = handler.process(req, Context{yield});
ASSERT_FALSE(output);
auto const err = rpc::makeError(output.result.error());
EXPECT_EQ(err.at("error").as_string(), "lgrNotFound");
EXPECT_EQ(err.at("error_message").as_string(), "ledgerNotFound");
});
}
TEST_F(RPCLedgerDataHandlerTest, LedgerNotExistViaHash)
{
backend->setRange(RANGEMIN, RANGEMAX);
EXPECT_CALL(*backend, fetchLedgerByHash).Times(1);
ON_CALL(*backend, fetchLedgerByHash(ripple::uint256{LEDGERHASH}, _)).WillByDefault(Return(std::nullopt));
runSpawn([&, this](auto yield) {
auto const handler = AnyHandler{LedgerDataHandler{backend}};
auto const req = json::parse(fmt::format(
R"({{
"ledger_hash": "{}"
}})",
LEDGERHASH
));
auto const output = handler.process(req, Context{yield});
ASSERT_FALSE(output);
auto const err = rpc::makeError(output.result.error());
EXPECT_EQ(err.at("error").as_string(), "lgrNotFound");
EXPECT_EQ(err.at("error_message").as_string(), "ledgerNotFound");
});
}
TEST_F(RPCLedgerDataHandlerTest, MarkerNotExist)
{
backend->setRange(RANGEMIN, RANGEMAX);
EXPECT_CALL(*backend, fetchLedgerBySequence).Times(1);
ON_CALL(*backend, fetchLedgerBySequence(RANGEMAX, _)).WillByDefault(Return(CreateLedgerInfo(LEDGERHASH, RANGEMAX)));
EXPECT_CALL(*backend, doFetchLedgerObject).Times(1);
ON_CALL(*backend, doFetchLedgerObject(ripple::uint256{INDEX1}, RANGEMAX, _)).WillByDefault(Return(std::nullopt));
runSpawn([&, this](auto yield) {
auto const handler = AnyHandler{LedgerDataHandler{backend}};
auto const req = json::parse(fmt::format(
R"({{
"marker": "{}"
}})",
INDEX1
));
auto const output = handler.process(req, Context{yield});
ASSERT_FALSE(output);
auto const err = rpc::makeError(output.result.error());
EXPECT_EQ(err.at("error").as_string(), "invalidParams");
EXPECT_EQ(err.at("error_message").as_string(), "markerDoesNotExist");
});
}
TEST_F(RPCLedgerDataHandlerTest, NoMarker)
{
static auto const ledgerExpected = R"({
"account_hash":"0000000000000000000000000000000000000000000000000000000000000000",
"close_flags":0,
"close_time":0,
"close_time_resolution":0,
"close_time_iso":"2000-01-01T00:00:00Z",
"ledger_hash":"4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652",
"ledger_index":"30",
"parent_close_time":0,
"parent_hash":"0000000000000000000000000000000000000000000000000000000000000000",
"total_coins":"0",
"transaction_hash":"0000000000000000000000000000000000000000000000000000000000000000",
"closed":true
})";
backend->setRange(RANGEMIN, RANGEMAX);
EXPECT_CALL(*backend, fetchLedgerBySequence).WillOnce(Return(CreateLedgerInfo(LEDGERHASH, RANGEMAX)));
// when 'type' not specified, default to all the types
auto limitLine = 5;
auto limitTicket = 5;
std::vector<Blob> bbs;
EXPECT_CALL(*backend, doFetchSuccessorKey).Times(limitLine + limitTicket);
ON_CALL(*backend, doFetchSuccessorKey(_, RANGEMAX, _)).WillByDefault(Return(ripple::uint256{INDEX2}));
while ((limitLine--) != 0) {
auto const line = CreateRippleStateLedgerObject("USD", ACCOUNT2, 10, ACCOUNT, 100, ACCOUNT2, 200, TXNID, 123);
bbs.push_back(line.getSerializer().peekData());
}
while ((limitTicket--) != 0) {
auto const ticket = CreateTicketLedgerObject(ACCOUNT, limitTicket);
bbs.push_back(ticket.getSerializer().peekData());
}
EXPECT_CALL(*backend, doFetchLedgerObjects).WillOnce(Return(bbs));
runSpawn([&, this](auto yield) {
auto const handler = AnyHandler{LedgerDataHandler{backend}};
auto const req = json::parse(R"({"limit":10})");
auto output = handler.process(req, Context{yield});
ASSERT_TRUE(output);
EXPECT_TRUE(output.result->as_object().contains("ledger"));
// Note: the format of "close_time_human" depends on the platform and might differ per platform. It is however
// guaranteed to be consistent on the same platform.
EXPECT_EQ(output.result->as_object().at("ledger").as_object().erase("close_time_human"), 1);
EXPECT_EQ(output.result->as_object().at("ledger"), json::parse(ledgerExpected));
EXPECT_EQ(output.result->as_object().at("marker").as_string(), INDEX2);
EXPECT_EQ(output.result->as_object().at("state").as_array().size(), 10);
EXPECT_EQ(output.result->as_object().at("ledger_hash").as_string(), LEDGERHASH);
EXPECT_EQ(output.result->as_object().at("ledger_index").as_uint64(), RANGEMAX);
});
}
TEST_F(RPCLedgerDataHandlerTest, Version2)
{
static auto const ledgerExpected = R"({
"account_hash": "0000000000000000000000000000000000000000000000000000000000000000",
"close_flags": 0,
"close_time": 0,
"close_time_resolution": 0,
"close_time_iso": "2000-01-01T00:00:00Z",
"ledger_hash": "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652",
"ledger_index": 30,
"parent_close_time": 0,
"parent_hash": "0000000000000000000000000000000000000000000000000000000000000000",
"total_coins": "0",
"transaction_hash": "0000000000000000000000000000000000000000000000000000000000000000",
"closed": true
})";
backend->setRange(RANGEMIN, RANGEMAX);
EXPECT_CALL(*backend, fetchLedgerBySequence).WillOnce(Return(CreateLedgerInfo(LEDGERHASH, RANGEMAX)));
// When 'type' not specified, default to all the types
auto limitLine = 5;
auto limitTicket = 5;
std::vector<Blob> bbs;
EXPECT_CALL(*backend, doFetchSuccessorKey).Times(limitLine + limitTicket);
ON_CALL(*backend, doFetchSuccessorKey(_, RANGEMAX, _)).WillByDefault(Return(ripple::uint256{INDEX2}));
while ((limitLine--) != 0) {
auto const line = CreateRippleStateLedgerObject("USD", ACCOUNT2, 10, ACCOUNT, 100, ACCOUNT2, 200, TXNID, 123);
bbs.push_back(line.getSerializer().peekData());
}
while ((limitTicket--) != 0) {
auto const ticket = CreateTicketLedgerObject(ACCOUNT, limitTicket);
bbs.push_back(ticket.getSerializer().peekData());
}
EXPECT_CALL(*backend, doFetchLedgerObjects).WillOnce(Return(bbs));
runSpawn([&, this](auto yield) {
auto const handler = AnyHandler{LedgerDataHandler{backend}};
auto const req = json::parse(R"({"limit":10})");
auto output = handler.process(req, Context{.yield = yield, .apiVersion = 2});
ASSERT_TRUE(output);
EXPECT_TRUE(output.result->as_object().contains("ledger"));
// Note: the format of "close_time_human" depends on the platform and might differ per platform. It is however
// guaranteed to be consistent on the same platform.
EXPECT_EQ(output.result->as_object().at("ledger").as_object().erase("close_time_human"), 1);
EXPECT_EQ(output.result->as_object().at("ledger"), json::parse(ledgerExpected));
});
}
TEST_F(RPCLedgerDataHandlerTest, TypeFilter)
{
static auto const ledgerExpected = R"({
"account_hash":"0000000000000000000000000000000000000000000000000000000000000000",
"close_flags":0,
"close_time":0,
"close_time_resolution":0,
"close_time_iso":"2000-01-01T00:00:00Z",
"ledger_hash":"4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652",
"ledger_index":"30",
"parent_close_time":0,
"parent_hash":"0000000000000000000000000000000000000000000000000000000000000000",
"total_coins":"0",
"transaction_hash":"0000000000000000000000000000000000000000000000000000000000000000",
"closed":true
})";
backend->setRange(RANGEMIN, RANGEMAX);
EXPECT_CALL(*backend, fetchLedgerBySequence).Times(1);
ON_CALL(*backend, fetchLedgerBySequence(RANGEMAX, _)).WillByDefault(Return(CreateLedgerInfo(LEDGERHASH, RANGEMAX)));
auto limitLine = 5;
auto limitTicket = 5;
std::vector<Blob> bbs;
EXPECT_CALL(*backend, doFetchSuccessorKey).Times(limitLine + limitTicket);
ON_CALL(*backend, doFetchSuccessorKey(_, RANGEMAX, _)).WillByDefault(Return(ripple::uint256{INDEX2}));
while ((limitLine--) != 0) {
auto const line = CreateRippleStateLedgerObject("USD", ACCOUNT2, 10, ACCOUNT, 100, ACCOUNT2, 200, TXNID, 123);
bbs.push_back(line.getSerializer().peekData());
}
while ((limitTicket--) != 0) {
auto const ticket = CreateTicketLedgerObject(ACCOUNT, limitTicket);
bbs.push_back(ticket.getSerializer().peekData());
}
ON_CALL(*backend, doFetchLedgerObjects).WillByDefault(Return(bbs));
EXPECT_CALL(*backend, doFetchLedgerObjects).Times(1);
runSpawn([&, this](auto yield) {
auto const handler = AnyHandler{LedgerDataHandler{backend}};
auto const req = json::parse(R"({
"limit":10,
"type":"state"
})");
auto output = handler.process(req, Context{yield});
ASSERT_TRUE(output);
EXPECT_TRUE(output.result->as_object().contains("ledger"));
// Note: the format of "close_time_human" depends on the platform and might differ per platform. It is however
// guaranteed to be consistent on the same platform.
EXPECT_EQ(output.result->as_object().at("ledger").as_object().erase("close_time_human"), 1);
EXPECT_EQ(output.result->as_object().at("ledger"), json::parse(ledgerExpected));
EXPECT_EQ(output.result->as_object().at("marker").as_string(), INDEX2);
EXPECT_EQ(output.result->as_object().at("state").as_array().size(), 5);
EXPECT_EQ(output.result->as_object().at("ledger_hash").as_string(), LEDGERHASH);
EXPECT_EQ(output.result->as_object().at("ledger_index").as_uint64(), RANGEMAX);
});
}
TEST_F(RPCLedgerDataHandlerTest, TypeFilterAMM)
{
static auto const ledgerExpected = R"({
"account_hash":"0000000000000000000000000000000000000000000000000000000000000000",
"close_flags":0,
"close_time":0,
"close_time_resolution":0,
"close_time_iso":"2000-01-01T00:00:00Z",
"ledger_hash":"4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652",
"ledger_index":"30",
"parent_close_time":0,
"parent_hash":"0000000000000000000000000000000000000000000000000000000000000000",
"total_coins":"0",
"transaction_hash":"0000000000000000000000000000000000000000000000000000000000000000",
"closed":true
})";
backend->setRange(RANGEMIN, RANGEMAX);
EXPECT_CALL(*backend, fetchLedgerBySequence).Times(1);
ON_CALL(*backend, fetchLedgerBySequence(RANGEMAX, _)).WillByDefault(Return(CreateLedgerInfo(LEDGERHASH, RANGEMAX)));
auto limitLine = 5;
std::vector<Blob> bbs;
EXPECT_CALL(*backend, doFetchSuccessorKey).Times(limitLine + 1);
ON_CALL(*backend, doFetchSuccessorKey(_, RANGEMAX, _)).WillByDefault(Return(ripple::uint256{INDEX2}));
while ((limitLine--) != 0) {
auto const line = CreateRippleStateLedgerObject("USD", ACCOUNT2, 10, ACCOUNT, 100, ACCOUNT2, 200, TXNID, 123);
bbs.push_back(line.getSerializer().peekData());
}
auto const amm = CreateAMMObject(ACCOUNT, "XRP", ripple::toBase58(ripple::xrpAccount()), "JPY", ACCOUNT2);
bbs.push_back(amm.getSerializer().peekData());
ON_CALL(*backend, doFetchLedgerObjects).WillByDefault(Return(bbs));
EXPECT_CALL(*backend, doFetchLedgerObjects).Times(1);
runSpawn([&, this](auto yield) {
auto const handler = AnyHandler{LedgerDataHandler{backend}};
auto const req = json::parse(R"({
"limit":6,
"type":"amm"
})");
auto output = handler.process(req, Context{yield});
ASSERT_TRUE(output);
EXPECT_TRUE(output.result->as_object().contains("ledger"));
// Note: the format of "close_time_human" depends on the platform and might differ per platform. It is however
// guaranteed to be consistent on the same platform.
EXPECT_EQ(output.result->as_object().at("ledger").as_object().erase("close_time_human"), 1);
EXPECT_EQ(output.result->as_object().at("ledger"), json::parse(ledgerExpected));
EXPECT_EQ(output.result->as_object().at("marker").as_string(), INDEX2);
EXPECT_EQ(output.result->as_object().at("state").as_array().size(), 1);
EXPECT_EQ(output.result->as_object().at("ledger_hash").as_string(), LEDGERHASH);
EXPECT_EQ(output.result->as_object().at("ledger_index").as_uint64(), RANGEMAX);
});
}
TEST_F(RPCLedgerDataHandlerTest, OutOfOrder)
{
static auto const ledgerExpected = R"({
"account_hash":"0000000000000000000000000000000000000000000000000000000000000000",
"close_flags":0,
"close_time":0,
"close_time_resolution":0,
"close_time_iso":"2000-01-01T00:00:00Z",
"ledger_hash":"4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652",
"ledger_index":"30",
"parent_close_time":0,
"parent_hash":"0000000000000000000000000000000000000000000000000000000000000000",
"total_coins":"0",
"transaction_hash":"0000000000000000000000000000000000000000000000000000000000000000",
"closed":true
})";
backend->setRange(RANGEMIN, RANGEMAX);
EXPECT_CALL(*backend, fetchLedgerBySequence).Times(1);
ON_CALL(*backend, fetchLedgerBySequence(RANGEMAX, _)).WillByDefault(Return(CreateLedgerInfo(LEDGERHASH, RANGEMAX)));
// page end
// marker return seq
std::vector<Blob> bbs;
EXPECT_CALL(*backend, doFetchSuccessorKey).Times(2);
ON_CALL(*backend, doFetchSuccessorKey(firstKey, RANGEMAX, _)).WillByDefault(Return(ripple::uint256{INDEX2}));
ON_CALL(*backend, doFetchSuccessorKey(ripple::uint256{INDEX2}, RANGEMAX, _)).WillByDefault(Return(std::nullopt));
auto const line = CreateRippleStateLedgerObject("USD", ACCOUNT2, 10, ACCOUNT, 100, ACCOUNT2, 200, TXNID, 123);
bbs.push_back(line.getSerializer().peekData());
ON_CALL(*backend, doFetchLedgerObjects).WillByDefault(Return(bbs));
EXPECT_CALL(*backend, doFetchLedgerObjects).Times(1);
runSpawn([&, this](auto yield) {
auto const handler = AnyHandler{LedgerDataHandler{backend}};
auto const req = json::parse(R"({"limit":10, "out_of_order":true})");
auto output = handler.process(req, Context{yield});
ASSERT_TRUE(output);
EXPECT_TRUE(output.result->as_object().contains("ledger"));
EXPECT_EQ(output.result->as_object().at("ledger").as_object().erase("close_time_human"), 1);
EXPECT_EQ(output.result->as_object().at("ledger"), json::parse(ledgerExpected));
EXPECT_EQ(output.result->as_object().at("marker").as_uint64(), RANGEMAX);
EXPECT_EQ(output.result->as_object().at("state").as_array().size(), 1);
EXPECT_EQ(output.result->as_object().at("ledger_hash").as_string(), LEDGERHASH);
EXPECT_EQ(output.result->as_object().at("ledger_index").as_uint64(), RANGEMAX);
});
}
TEST_F(RPCLedgerDataHandlerTest, Marker)
{
backend->setRange(RANGEMIN, RANGEMAX);
EXPECT_CALL(*backend, fetchLedgerBySequence).Times(1);
ON_CALL(*backend, fetchLedgerBySequence(RANGEMAX, _)).WillByDefault(Return(CreateLedgerInfo(LEDGERHASH, RANGEMAX)));
EXPECT_CALL(*backend, doFetchLedgerObject).Times(1);
ON_CALL(*backend, doFetchLedgerObject(ripple::uint256{INDEX1}, RANGEMAX, _))
.WillByDefault(
Return(CreateRippleStateLedgerObject("USD", ACCOUNT2, 10, ACCOUNT, 100, ACCOUNT2, 200, TXNID, 123)
.getSerializer()
.peekData())
);
auto limit = 10;
std::vector<Blob> bbs;
EXPECT_CALL(*backend, doFetchSuccessorKey).Times(limit);
ON_CALL(*backend, doFetchSuccessorKey(ripple::uint256{INDEX1}, RANGEMAX, _))
.WillByDefault(Return(ripple::uint256{INDEX2}));
ON_CALL(*backend, doFetchSuccessorKey(ripple::uint256{INDEX2}, RANGEMAX, _))
.WillByDefault(Return(ripple::uint256{INDEX2}));
while ((limit--) != 0) {
auto const line = CreateRippleStateLedgerObject("USD", ACCOUNT2, 10, ACCOUNT, 100, ACCOUNT2, 200, TXNID, 123);
bbs.push_back(line.getSerializer().peekData());
}
ON_CALL(*backend, doFetchLedgerObjects).WillByDefault(Return(bbs));
EXPECT_CALL(*backend, doFetchLedgerObjects).Times(1);
runSpawn([&, this](auto yield) {
auto const handler = AnyHandler{LedgerDataHandler{backend}};
auto const req = json::parse(fmt::format(
R"({{
"limit":10,
"marker": "{}"
}})",
INDEX1
));
auto const output = handler.process(req, Context{yield});
ASSERT_TRUE(output);
EXPECT_FALSE(output.result->as_object().contains("ledger"));
EXPECT_EQ(output.result->as_object().at("marker").as_string(), INDEX2);
EXPECT_EQ(output.result->as_object().at("state").as_array().size(), 10);
EXPECT_EQ(output.result->as_object().at("ledger_hash").as_string(), LEDGERHASH);
EXPECT_EQ(output.result->as_object().at("ledger_index").as_uint64(), RANGEMAX);
});
}
TEST_F(RPCLedgerDataHandlerTest, DiffMarker)
{
backend->setRange(RANGEMIN, RANGEMAX);
EXPECT_CALL(*backend, fetchLedgerBySequence).Times(1);
ON_CALL(*backend, fetchLedgerBySequence(RANGEMAX, _)).WillByDefault(Return(CreateLedgerInfo(LEDGERHASH, RANGEMAX)));
auto limit = 10;
std::vector<LedgerObject> los;
std::vector<Blob> bbs;
EXPECT_CALL(*backend, fetchLedgerDiff).Times(1);
while ((limit--) != 0) {
auto const line = CreateRippleStateLedgerObject("USD", ACCOUNT2, 10, ACCOUNT, 100, ACCOUNT2, 200, TXNID, 123);
bbs.push_back(line.getSerializer().peekData());
los.emplace_back(LedgerObject{ripple::uint256{INDEX2}, Blob{}}); // NOLINT(modernize-use-emplace)
}
ON_CALL(*backend, fetchLedgerDiff(RANGEMAX, _)).WillByDefault(Return(los));
ON_CALL(*backend, doFetchLedgerObjects).WillByDefault(Return(bbs));
EXPECT_CALL(*backend, doFetchLedgerObjects).Times(1);
runSpawn([&, this](auto yield) {
auto const handler = AnyHandler{LedgerDataHandler{backend}};
auto const req = json::parse(fmt::format(
R"({{
"limit":10,
"marker": {},
"out_of_order": true
}})",
RANGEMAX
));
auto const output = handler.process(req, Context{yield});
ASSERT_TRUE(output);
EXPECT_FALSE(output.result->as_object().contains("ledger"));
EXPECT_EQ(output.result->as_object().at("state").as_array().size(), 10);
EXPECT_EQ(output.result->as_object().at("ledger_hash").as_string(), LEDGERHASH);
EXPECT_EQ(output.result->as_object().at("ledger_index").as_uint64(), RANGEMAX);
EXPECT_FALSE(output.result->as_object().at("cache_full").as_bool());
});
}
TEST_F(RPCLedgerDataHandlerTest, Binary)
{
backend->setRange(RANGEMIN, RANGEMAX);
EXPECT_CALL(*backend, fetchLedgerBySequence).Times(1);
ON_CALL(*backend, fetchLedgerBySequence(RANGEMAX, _)).WillByDefault(Return(CreateLedgerInfo(LEDGERHASH, RANGEMAX)));
auto limit = 10;
std::vector<Blob> bbs;
EXPECT_CALL(*backend, doFetchSuccessorKey).Times(limit);
ON_CALL(*backend, doFetchSuccessorKey(_, RANGEMAX, _)).WillByDefault(Return(ripple::uint256{INDEX2}));
while ((limit--) != 0) {
auto const line = CreateRippleStateLedgerObject("USD", ACCOUNT2, 10, ACCOUNT, 100, ACCOUNT2, 200, TXNID, 123);
bbs.push_back(line.getSerializer().peekData());
}
ON_CALL(*backend, doFetchLedgerObjects).WillByDefault(Return(bbs));
EXPECT_CALL(*backend, doFetchLedgerObjects).Times(1);
runSpawn([&, this](auto yield) {
auto const handler = AnyHandler{LedgerDataHandler{backend}};
auto const req = json::parse(
R"({
"limit":10,
"binary": true
})"
);
auto const output = handler.process(req, Context{yield});
ASSERT_TRUE(output);
EXPECT_TRUE(output.result->as_object().contains("ledger"));
EXPECT_TRUE(output.result->as_object().at("ledger").as_object().contains("ledger_data"));
EXPECT_TRUE(output.result->as_object().at("ledger").as_object().at("closed").as_bool());
EXPECT_EQ(output.result->as_object().at("state").as_array().size(), 10);
EXPECT_EQ(output.result->as_object().at("ledger_hash").as_string(), LEDGERHASH);
EXPECT_EQ(output.result->as_object().at("ledger_index").as_uint64(), RANGEMAX);
});
}
TEST_F(RPCLedgerDataHandlerTest, BinaryLimitMoreThanMax)
{
backend->setRange(RANGEMIN, RANGEMAX);
EXPECT_CALL(*backend, fetchLedgerBySequence).Times(1);
ON_CALL(*backend, fetchLedgerBySequence(RANGEMAX, _)).WillByDefault(Return(CreateLedgerInfo(LEDGERHASH, RANGEMAX)));
auto limit = LedgerDataHandler::LIMITBINARY + 1;
std::vector<Blob> bbs;
EXPECT_CALL(*backend, doFetchSuccessorKey).Times(LedgerDataHandler::LIMITBINARY);
ON_CALL(*backend, doFetchSuccessorKey(_, RANGEMAX, _)).WillByDefault(Return(ripple::uint256{INDEX2}));
while ((limit--) != 0u) {
auto const line = CreateRippleStateLedgerObject("USD", ACCOUNT2, 10, ACCOUNT, 100, ACCOUNT2, 200, TXNID, 123);
bbs.push_back(line.getSerializer().peekData());
}
ON_CALL(*backend, doFetchLedgerObjects).WillByDefault(Return(bbs));
EXPECT_CALL(*backend, doFetchLedgerObjects).Times(1);
runSpawn([&, this](auto yield) {
auto const handler = AnyHandler{LedgerDataHandler{backend}};
auto const req = json::parse(fmt::format(
R"({{
"limit":{},
"binary": true
}})",
LedgerDataHandler::LIMITBINARY + 1
));
auto const output = handler.process(req, Context{yield});
ASSERT_TRUE(output);
EXPECT_TRUE(output.result->as_object().contains("ledger"));
EXPECT_TRUE(output.result->as_object().at("ledger").as_object().contains("ledger_data"));
EXPECT_TRUE(output.result->as_object().at("ledger").as_object().at("closed").as_bool());
EXPECT_EQ(output.result->as_object().at("state").as_array().size(), LedgerDataHandler::LIMITBINARY);
EXPECT_EQ(output.result->as_object().at("ledger_hash").as_string(), LEDGERHASH);
EXPECT_EQ(output.result->as_object().at("ledger_index").as_uint64(), RANGEMAX);
});
}
TEST_F(RPCLedgerDataHandlerTest, JsonLimitMoreThanMax)
{
backend->setRange(RANGEMIN, RANGEMAX);
EXPECT_CALL(*backend, fetchLedgerBySequence).Times(1);
ON_CALL(*backend, fetchLedgerBySequence(RANGEMAX, _)).WillByDefault(Return(CreateLedgerInfo(LEDGERHASH, RANGEMAX)));
auto limit = LedgerDataHandler::LIMITJSON + 1;
std::vector<Blob> bbs;
EXPECT_CALL(*backend, doFetchSuccessorKey).Times(LedgerDataHandler::LIMITJSON);
ON_CALL(*backend, doFetchSuccessorKey(_, RANGEMAX, _)).WillByDefault(Return(ripple::uint256{INDEX2}));
while ((limit--) != 0u) {
auto const line = CreateRippleStateLedgerObject("USD", ACCOUNT2, 10, ACCOUNT, 100, ACCOUNT2, 200, TXNID, 123);
bbs.push_back(line.getSerializer().peekData());
}
ON_CALL(*backend, doFetchLedgerObjects).WillByDefault(Return(bbs));
EXPECT_CALL(*backend, doFetchLedgerObjects).Times(1);
runSpawn([&, this](auto yield) {
auto const handler = AnyHandler{LedgerDataHandler{backend}};
auto const req = json::parse(fmt::format(
R"({{
"limit":{},
"binary": false
}})",
LedgerDataHandler::LIMITJSON + 1
));
auto const output = handler.process(req, Context{yield});
ASSERT_TRUE(output);
EXPECT_TRUE(output.result->as_object().contains("ledger"));
EXPECT_TRUE(output.result->as_object().at("ledger").as_object().at("closed").as_bool());
EXPECT_EQ(output.result->as_object().at("state").as_array().size(), LedgerDataHandler::LIMITJSON);
EXPECT_EQ(output.result->as_object().at("ledger_hash").as_string(), LEDGERHASH);
EXPECT_EQ(output.result->as_object().at("ledger_index").as_uint64(), RANGEMAX);
});
}
TEST(RPCLedgerDataHandlerSpecTest, DeprecatedFields)
{
boost::json::value const json{
{"ledger", 1},
{"out_of_order", true},
{"ledger_hash", "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652"},
{"ledger_index", 1},
{"limit", 10},
{"marker", "4BC50C9B0D8515D3EAAE1E74B29A95804346C491EE1A95BF25E4AAB854A6A652"},
{"type", "state"},
{"ledger", "some"}
};
auto const spec = LedgerDataHandler::spec(2);
auto const warnings = spec.check(json);
ASSERT_EQ(warnings.size(), 1);
ASSERT_TRUE(warnings[0].is_object());
auto const& warning = warnings[0].as_object();
ASSERT_TRUE(warning.contains("id"));
ASSERT_TRUE(warning.contains("message"));
EXPECT_EQ(warning.at("id").as_int64(), static_cast<int64_t>(rpc::WarningCode::warnRPC_DEPRECATED));
EXPECT_NE(warning.at("message").as_string().find("Field 'ledger' is deprecated."), std::string::npos) << warning;
}