ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 11:05:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Review feedback from @mvadari: Document test lambdas

Browse Source
This commit is contained in:
Ed Hennis
2025-09-25 14:23:10 -04:00
parent 8450970b80
commit 5ea7b562a2
1 changed files with 40 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
src/test/rpc/LedgerEntry_test.cpp
View File

@@ -2045,6 +2045,16 @@ class LedgerEntry_test : public beast::unit_test::suite
env.close(); env.close();
/** Verifies that the RPC result has the expected data
*
* @param good: Indicates that the request should have succeeded
* and returned a ledger object of `expectedType` type.
* @param jv: The RPC result Json value
* @param expectedType: The type that the ledger object should
* have if "good".
* @param expectedError: Optional. The expected error if not
* good. Defaults to "entryNotFound".
*/
auto checkResult = auto checkResult =
[&](bool good, [&](bool good,
Json::Value const& jv, Json::Value const& jv,
@@ -2074,6 +2084,16 @@ class LedgerEntry_test : public beast::unit_test::suite
} }
}; };
/** Runs a series of tests for a given fixed-position ledger
* entry.
*
* @param field: The Json request field to use.
* @param expectedType: The type that the ledger object should
* have if "good".
* @param expectedKey: The keylet of the fixed object.
* @param good: Indicates whether the object is expected to
* exist.
*/
auto test = [&](Json::StaticString const& field, auto test = [&](Json::StaticString const& field,
Json::StaticString const& expectedType, Json::StaticString const& expectedType,
Keylet const& expectedKey, Keylet const& expectedKey,
@@ -2191,6 +2211,16 @@ class LedgerEntry_test : public beast::unit_test::suite
env.close(); env.close();
/** Verifies that the RPC result has the expected data
*
* @param good: Indicates that the request should have succeeded
* and returned a ledger object of `expectedType` type.
* @param jv: The RPC result Json value
* @param expectedCount: The number of Hashes expected in the
* object if "good".
* @param expectedError: Optional. The expected error if not
* good. Defaults to "entryNotFound".
*/
auto checkResult = auto checkResult =
[&](bool good, [&](bool good,
Json::Value const& jv, Json::Value const& jv,
@@ -2226,6 +2256,16 @@ class LedgerEntry_test : public beast::unit_test::suite
} }
}; };
/** Runs a series of tests for a given ledger index.
*
* @param ledger: The ledger index value of the "hashes" request
* parameter. May not necessarily be a number.
* @param expectedKey: The expected keylet of the object.
* @param good: Indicates whether the object is expected to
* exist.
* @param expectedCount: The number of Hashes expected in the
* object if "good".
*/
auto test = [&](Json::Value ledger, auto test = [&](Json::Value ledger,
Keylet const& expectedKey, Keylet const& expectedKey,
bool good, bool good,