ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2026-07-27 09:00:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Warn about deprecated fields (#1314)

Browse Source 
Fixes #1251.
This commit is contained in:
Sergey Kuznetsov
2024-04-11 15:23:59 +01:00
committed by GitHub
parent 230212213b
commit e744a5a8a9
64 changed files with 1902 additions and 761 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
unittests/rpc/ErrorTests.cpp
View File

@@ -77,6 +77,12 @@ TEST(RPCErrorsTest, StatusAsBool)
EXPECT_TRUE(Status{ec});
}
TEST(RPCErrorsTest, StatusEquals)
{
EXPECT_EQ(Status{RippledError::rpcUNKNOWN}, Status{RippledError::rpcUNKNOWN});
EXPECT_NE(Status{RippledError::rpcUNKNOWN}, Status{RippledError::rpcREPORTING_UNSUPPORTED});
}
TEST(RPCErrorsTest, SuccessToJSON)
{
auto const status = Status{RippledError::rpcSUCCESS};
@@ -130,17 +136,48 @@ TEST(RPCErrorsTest, InvalidClioErrorToJSON)
EXPECT_ANY_THROW((void)makeError(static_cast<ClioError>(999999)));
}
TEST(RPCErrorsTest, WarningToJSON)
struct WarningCodeTestBundle {
std::string name;
WarningCode code;
std::string message;
};
struct WarningCodeTest : public ::testing::TestWithParam<WarningCodeTestBundle> {};
INSTANTIATE_TEST_SUITE_P(
WarningCodeTestGroup,
WarningCodeTest,
testing::Values(
WarningCodeTestBundle{"Unknown", WarningCode::warnUNKNOWN, "Unknown warning"},
WarningCodeTestBundle{
"Clio",
WarningCode::warnRPC_CLIO,
"This is a clio server. clio only serves validated data. If you want to talk to rippled, include "
"'ledger_index':'current' in your request"
},
WarningCodeTestBundle{"Outdated", WarningCode::warnRPC_OUTDATED, "This server may be out of date"},
WarningCodeTestBundle{"RateLimit", WarningCode::warnRPC_RATE_LIMIT, "You are about to be rate limited"},
WarningCodeTestBundle{
"Deprecated",
WarningCode::warnRPC_DEPRECATED,
"Some fields from your request are deprecated. Please check the documentation at "
"https://xrpl.org/docs/references/http-websocket-apis/ and update your request."
}
),
[](testing::TestParamInfo<WarningCodeTestBundle> const& info) { return info.param.name; }
);
TEST_P(WarningCodeTest, WarningToJSON)
{
auto j = makeWarning(WarningCode::warnRPC_OUTDATED);
auto j = makeWarning(GetParam().code);
EXPECT_TRUE(j.contains("id"));
EXPECT_TRUE(j.contains("message"));
EXPECT_TRUE(j.at("id").is_int64());
EXPECT_TRUE(j.at("message").is_string());
EXPECT_EQ(j.at("id").as_int64(), static_cast<uint32_t>(WarningCode::warnRPC_OUTDATED));
EXPECT_EQ(boost::json::value_to<std::string>(j.at("message")), "This server may be out of date");
EXPECT_EQ(j.at("id").as_int64(), static_cast<int64_t>(GetParam().code));
EXPECT_EQ(boost::json::value_to<std::string>(j.at("message")), GetParam().message);
}
TEST(RPCErrorsTest, InvalidWarningToJSON)