xrpld
Loading...
Searching...
No Matches
xrpl::test::InboundLedger_test Struct Reference
Inheritance diagram for xrpl::test::InboundLedger_test:
Collaboration diagram for xrpl::test::InboundLedger_test:

Public Member Functions

unsigned int nextSeed ()
 A seed unique to this chain within the suite.
void testLocalLedgerCompletesAcquire (jtx::Env &env)
 A ledger whose maps all resolve locally finishes on the spot, and the finished ledger is immutable and handed on.
void testInvalidatedLedgerFailsInDone (jtx::Env &env)
 A ledger whose map goes invalid on the way to being settled must be discarded rather than delivered.
void testLocalFailureSignalsDone (jtx::Env &env)
 An acquisition that fails on local data must still signal.
void testPeerZeroAccountHashFails (jtx::Env &env)
 A peer-supplied header whose account hash is zero fails the acquisition and signals, as a local one does.
void testPeerHeaderWithoutTransactionsCompletes (jtx::Env &env)
 A peer-supplied header with a zero transaction hash is taken, since that is an empty transaction set, and the acquisition finishes once the peer supplies the state map.
void testTimerRetriesThenGivesUp (jtx::Env &env)
 The retry timer re-asks, then gives up and signals.
void run () override
 Runs the suite.
template<class = void>
void operator() (Runner &r)
 Invokes the test using the specified runner.
template<class = void>
void pass ()
 Record a successful test condition.
template<class F, class String>
bool except (F &&f, String const &reason)
template<class F>
bool except (F &&f)
template<class E, class F, class String>
bool except (F &&f, String const &reason)
template<class E, class F>
bool except (F &&f)
template<class F, class String>
bool unexcept (F &&f, String const &reason)
template<class F>
bool unexcept (F &&f)
std::string const & arg () const
 Return the argument associated with the runner.
template<class Condition, class String>
bool unexpected (Condition shouldBeFalse, String const &reason)
 DEPRECATED.
template<class Condition>
bool unexpected (Condition shouldBeFalse)
template<class String>
void fail (String const &reason, char const *file, int line)
 Record a failure.
template<class = void>
void fail (std::string const &reason="")
template<class Condition>
bool expect (Condition const &shouldBeTrue)
 Evaluate a test condition.
template<class Condition, class String>
bool expect (Condition const &shouldBeTrue, String const &reason)
template<class Condition>
bool expect (Condition const &shouldBeTrue, char const *file, int line)
template<class Condition, class String>
bool expect (Condition const &shouldBeTrue, String const &reason, char const *file, int line)

Static Public Member Functions

static LedgerHeader makeHeader (UInt256 const &txHash, UInt256 const &accountHash)
 A ledger header naming the given map roots, with a hash derived from the fields, so an acquisition accepts the header as its own however the roots are chosen.
static LedgerHeader makeHeader (DeepChain const &chain)
 The common shape: no transactions, so only the state map is in play.
static void storeHeader (jtx::Env &env, LedgerHeader const &header)
 Put the header in the local store, which is the first place tryDB() looks.
static void storeStateNodes (jtx::Env &env, LedgerHeader const &header, DeepChain const &chain, unsigned int maxDepth)
 Put every node of a chain in the local store, so a state-map walk resolves the whole map from the store.
static std::shared_ptr< protocol::TMLedgerData > headerPacket (LedgerHeader const &header)
 The header alone as a liBASE reply, so takeHeader() alone judges the packet.
static std::shared_ptr< TestableInboundLedger > startPeerAcquire (jtx::Env &env, LedgerHeader const &header)
 An acquisition started with nothing in the store for its hash, so it waits on its peers.
static Suite * thisSuite ()
 Returns the "current" running suite.

Public Attributes

LogOs< char > log
 Logging output stream.
TestcaseT testcase
 Memberspace for declaring test cases.

Static Public Attributes

static constexpr auto kFastRetry = std::chrono::milliseconds{20}
 A retry interval short enough that a whole timeout chain costs a fraction of a second.

Protected Member Functions

Runner & runner () const
 Lets a suite compose other suites (e.g.

Private Member Functions

void propagateAbort () const

Static Private Member Functions

static Suite ** pThisSuite ()

Private Attributes

unsigned int seed_ {0}
bool abort_ = false
bool aborted_ = false
Runner * runner_ = nullptr

Detailed Description

Definition at line 110 of file InboundLedger_test.cpp.

Member Function Documentation

◆ nextSeed()

unsigned int xrpl::test::InboundLedger_test::nextSeed ( )
nodiscard

A seed unique to this chain within the suite.

The Env below is shared, and its node store, fetch packs and remembered failures are all keyed by hash. A fresh seed per chain gives every chain distinct hashes, so each case resolves only its own nodes.

Returns
The seed.

Definition at line 128 of file InboundLedger_test.cpp.

◆ makeHeader() [1/2]

LedgerHeader xrpl::test::InboundLedger_test::makeHeader ( UInt256 const & txHash,
UInt256 const & accountHash )
static

A ledger header naming the given map roots, with a hash derived from the fields, so an acquisition accepts the header as its own however the roots are chosen.

Parameters
txHashThe transaction map root. Zero means no transactions.
accountHashThe state map root. Zero is a ledger no acquisition can finish.
Returns
The header, with its hash filled in.

Definition at line 144 of file InboundLedger_test.cpp.

◆ makeHeader() [2/2]

LedgerHeader xrpl::test::InboundLedger_test::makeHeader ( DeepChain const & chain)
static

The common shape: no transactions, so only the state map is in play.

Parameters
chainThe chain whose root to name as the state hash.
Returns
The header, with its hash filled in.

Definition at line 165 of file InboundLedger_test.cpp.

◆ storeHeader()

void xrpl::test::InboundLedger_test::storeHeader ( jtx::Env & env,
LedgerHeader const & header )
static

Put the header in the local store, which is the first place tryDB() looks.

The store keeps its entries, where a fetch pack hands each out once, so more than one acquisition of the same ledger can find it.

Parameters
envThe environment whose node store to seed.
headerThe header to store, keyed by its own hash.

Definition at line 179 of file InboundLedger_test.cpp.

◆ storeStateNodes()

void xrpl::test::InboundLedger_test::storeStateNodes ( jtx::Env & env,
LedgerHeader const & header,
DeepChain const & chain,
unsigned int maxDepth )
static

Put every node of a chain in the local store, so a state-map walk resolves the whole map from the store.

Parameters
envThe environment whose node store to seed.
headerThe header whose sequence the nodes are stored under.
chainThe chain supplying the nodes.
maxDepthThe deepest node to store, so a caller can leave a walk something to ask for.

Definition at line 200 of file InboundLedger_test.cpp.

◆ headerPacket()

std::shared_ptr< protocol::TMLedgerData > xrpl::test::InboundLedger_test::headerPacket ( LedgerHeader const & header)
static

The header alone as a liBASE reply, so takeHeader() alone judges the packet.

Parameters
headerThe header to carry, serialized without a hash prefix, as takeHeader() expects.
Returns
The reply packet.

Definition at line 227 of file InboundLedger_test.cpp.

◆ startPeerAcquire()

std::shared_ptr< TestableInboundLedger > xrpl::test::InboundLedger_test::startPeerAcquire ( jtx::Env & env,
LedgerHeader const & header )
static

An acquisition started with nothing in the store for its hash, so it waits on its peers.

Parameters
envThe environment to run in.
headerThe header of the ledger to acquire.
Returns
The acquisition, started.

Definition at line 249 of file InboundLedger_test.cpp.

◆ testLocalLedgerCompletesAcquire()

void xrpl::test::InboundLedger_test::testLocalLedgerCompletesAcquire ( jtx::Env & env)

A ledger whose maps all resolve locally finishes on the spot, and the finished ledger is immutable and handed on.

Both entry points into tryDB() are driven: InboundLedgers::acquire(), the only caller of init(), and checkLocal(), which reaches done().

Parameters
envThe environment to run in.

Definition at line 272 of file InboundLedger_test.cpp.

◆ testInvalidatedLedgerFailsInDone()

void xrpl::test::InboundLedger_test::testInvalidatedLedgerFailsInDone ( jtx::Env & env)

A ledger whose map goes invalid on the way to being settled must be discarded rather than delivered.

done() settles the ledger before it logs or acts on the outcome, and an abandoned map makes settling refuse, so the acquisition records a failure.

Parameters
envThe environment to run in.

Definition at line 374 of file InboundLedger_test.cpp.

◆ testLocalFailureSignalsDone()

void xrpl::test::InboundLedger_test::testLocalFailureSignalsDone ( jtx::Env & env)

An acquisition that fails on local data must still signal.

Both entry points that reach tryDB() are covered. done() is what signals, runs logFailure(), and lands the hash in recentFailures_, which stops the next round asking for the same ledger. recentFailures_ is what the assertions watch, since it is the caller-visible consequence of having signaled.

Parameters
envThe environment to run in.

Definition at line 440 of file InboundLedger_test.cpp.

◆ testPeerZeroAccountHashFails()

void xrpl::test::InboundLedger_test::testPeerZeroAccountHashFails ( jtx::Env & env)

A peer-supplied header whose account hash is zero fails the acquisition and signals, as a local one does.

The peer is not charged, and recentFailures_ is what shows done() ran.

Parameters
envThe environment to run in.

Definition at line 513 of file InboundLedger_test.cpp.

◆ testPeerHeaderWithoutTransactionsCompletes()

void xrpl::test::InboundLedger_test::testPeerHeaderWithoutTransactionsCompletes ( jtx::Env & env)

A peer-supplied header with a zero transaction hash is taken, since that is an empty transaction set, and the acquisition finishes once the peer supplies the state map.

Parameters
envThe environment to run in.

Definition at line 553 of file InboundLedger_test.cpp.

◆ testTimerRetriesThenGivesUp()

void xrpl::test::InboundLedger_test::testTimerRetriesThenGivesUp ( jtx::Env & env)

The retry timer re-asks, then gives up and signals.

The only case that drives onTimer() rather than trigger() directly, which is what covers the give-up: past kLedgerTimeoutRetriesMax the acquisition fails itself and done() records that, so the same doomed ledger is not asked for again on the next round. It is also what the retry interval is a constructor parameter for, since the chain runs past kLedgerTimeoutRetriesMax ticks of three seconds apiece in production.

The store is empty for this hash and no reply arrives, so every tick counts a timeout and the count climbs to the limit. A hash of its own, so this case owns its entry in the failure list.

Parameters
envThe environment to run in.

Definition at line 622 of file InboundLedger_test.cpp.

◆ run()

void xrpl::test::InboundLedger_test::run ( )
overridevirtual

Runs the suite.

Implements beast::unit_test::Suite.

Definition at line 671 of file InboundLedger_test.cpp.

◆ thisSuite()

Suite * beast::unit_test::Suite::thisSuite ( )
staticinherited

Returns the "current" running suite.

If no suite is running, nullptr is returned.

Definition at line 162 of file suite.h.

◆ operator()()

template<class>
void beast::unit_test::Suite::operator() ( Runner & r)
inherited

Invokes the test using the specified runner.

Data members are set up here instead of the constructor as a convenience to writing the derived class to avoid repetition of forwarded constructor arguments to the base. Normally this is called by the framework for you.

Definition at line 420 of file suite.h.

◆ pass()

template<class>
void beast::unit_test::Suite::pass ( )
inherited

Record a successful test condition.

Definition at line 532 of file suite.h.

◆ fail() [1/2]

template<class String>
void beast::unit_test::Suite::fail ( String const & reason,
char const * file,
int line )
inherited

Record a failure.

Parameters
reasonOptional text added to the output on a failure.
fileThe source code file where the test failed.
lineThe source code line number where the test failed.

Definition at line 554 of file suite.h.

◆ fail() [2/2]

template<class>
void beast::unit_test::Suite::fail ( std::string const & reason = "")
inherited

Definition at line 541 of file suite.h.

◆ expect() [1/4]

template<class Condition>
bool beast::unit_test::Suite::expect ( Condition const & shouldBeTrue)
inherited

Evaluate a test condition.

This function provides improved logging by incorporating the file name and line number into the reported output on failure, as well as additional text specified by the caller.

Parameters
shouldBeTrueThe condition to test. The condition is evaluated in a boolean context.
reasonOptional added text to output on a failure.
fileThe source code file where the test failed.
lineThe source code line number where the test failed.
Returns
true if the test condition indicates success.

Definition at line 235 of file suite.h.

◆ expect() [2/4]

template<class Condition, class String>
bool beast::unit_test::Suite::expect ( Condition const & shouldBeTrue,
String const & reason )
inherited

Definition at line 437 of file suite.h.

◆ expect() [3/4]

template<class Condition>
bool beast::unit_test::Suite::expect ( Condition const & shouldBeTrue,
char const * file,
int line )
inherited

Definition at line 246 of file suite.h.

◆ expect() [4/4]

template<class Condition, class String>
bool beast::unit_test::Suite::expect ( Condition const & shouldBeTrue,
String const & reason,
char const * file,
int line )
inherited

Definition at line 450 of file suite.h.

◆ except() [1/4]

template<class F, class String>
bool beast::unit_test::Suite::except ( F && f,
String const & reason )
inherited

Definition at line 465 of file suite.h.

◆ except() [2/4]

template<class F>
bool beast::unit_test::Suite::except ( F && f)
inherited

Definition at line 265 of file suite.h.

◆ except() [3/4]

template<class E, class F, class String>
bool beast::unit_test::Suite::except ( F && f,
String const & reason )
inherited

Definition at line 482 of file suite.h.

◆ except() [4/4]

template<class E, class F>
bool beast::unit_test::Suite::except ( F && f)
inherited

Definition at line 274 of file suite.h.

◆ unexcept() [1/2]

template<class F, class String>
bool beast::unit_test::Suite::unexcept ( F && f,
String const & reason )
inherited

Definition at line 499 of file suite.h.

◆ unexcept() [2/2]

template<class F>
bool beast::unit_test::Suite::unexcept ( F && f)
inherited

Definition at line 283 of file suite.h.

◆ arg()

std::string const & beast::unit_test::Suite::arg ( ) const
inherited

Return the argument associated with the runner.

Definition at line 292 of file suite.h.

◆ runner()

Runner & beast::unit_test::Suite::runner ( ) const
protectedinherited

Lets a suite compose other suites (e.g.

an aggregator that reruns a group of related suites under its own name) via SuiteInfo::run.

Returns
The runner this suite is executing under.

Definition at line 305 of file suite.h.

◆ unexpected() [1/2]

template<class Condition, class String>
bool beast::unit_test::Suite::unexpected ( Condition shouldBeFalse,
String const & reason )
inherited

DEPRECATED.

Returns
true if the test condition indicates success(a false value)

Definition at line 516 of file suite.h.

◆ unexpected() [2/2]

template<class Condition>
bool beast::unit_test::Suite::unexpected ( Condition shouldBeFalse)
inherited

Definition at line 321 of file suite.h.

◆ pThisSuite()

Suite ** beast::unit_test::Suite::pThisSuite ( )
staticprivateinherited

Definition at line 330 of file suite.h.

◆ propagateAbort()

void beast::unit_test::Suite::propagateAbort ( ) const
privateinherited

Definition at line 560 of file suite.h.

Member Data Documentation

◆ kFastRetry

auto xrpl::test::InboundLedger_test::kFastRetry = std::chrono::milliseconds{20}
staticconstexpr

A retry interval short enough that a whole timeout chain costs a fraction of a second.

TimeoutCounter refuses anything at or below 10ms.

Definition at line 116 of file InboundLedger_test.cpp.

◆ seed_

unsigned int xrpl::test::InboundLedger_test::seed_ {0}
private

Definition at line 689 of file InboundLedger_test.cpp.

◆ abort_

bool beast::unit_test::Suite::abort_ = false
privateinherited

Definition at line 54 of file suite.h.

◆ aborted_

bool beast::unit_test::Suite::aborted_ = false
privateinherited

Definition at line 55 of file suite.h.

◆ runner_

Runner* beast::unit_test::Suite::runner_ = nullptr
privateinherited

Definition at line 56 of file suite.h.

◆ log

LogOs<char> beast::unit_test::Suite::log
inherited

Logging output stream.

Text sent to the log output stream will be forwarded to the output stream associated with the runner.

Definition at line 150 of file suite.h.

◆ testcase

TestcaseT beast::unit_test::Suite::testcase
inherited

Memberspace for declaring test cases.

Definition at line 155 of file suite.h.