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

Public Member Functions

unsigned int nextSeed ()
 A seed no other chain in this suite has used.
void testHappyPathCompletesAcquisition (jtx::Env &env)
 A chain ending in a leaf completes the acquisition, which stops the asking and hands the map to InboundTransactions.
void testTwoPeersEachSupplyPartOfTheSet (jtx::Env &env)
 Two peers each answering with a different missing piece are both accepted without penalty, and the set completes from their combined replies.
void testBadRootKeepsAcquireAlive (jtx::Env &env)
 A root that does not hash to the set we asked for is a plain mismatch, and has to leave the acquisition able to try another peer.
void testDuplicateRootReplyIsFree (jtx::Env &env)
 A second reply carrying a root we already have must stay free.
void testDuplicateNonRootReplyIsFree (jtx::Env &env)
 A repeated non-root node stays free too.
void testUndeserializableNodeIsCharged (jtx::Env &env)
 A reply whose node data cannot be deserialized is charged for.
void testMismatchedRootThroughGotDataIsCharged (jtx::Env &env)
 A well-formed reply whose root hashes to a different set is charged for.
void testInitFiltersCandidatesByHasTxSet (jtx::Env &env)
 init() passes hasTxSet() to addPeers() as its candidate filter.
void testTimerBroadcastsThenGivesUp (jtx::Env &env)
 The retry timer broadcasts with no peer of its own, then gives up on its own.
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 bool wasIgnored (SHAMapAddNode const &san)
 Whether takeNodes() declined to look at the data at all.
static std::shared_ptr< SHAMap > waitForDeliveredSet (jtx::Env &env, UInt256 const &setHash)
 Wait for a finished set to reach InboundTransactions.
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 69 of file TransactionAcquire_test.cpp.

Member Function Documentation

◆ nextSeed()

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

A seed no other chain in this suite has used.

The Env below is shared, and ConsensusTransSetSF::gotNode() puts every node it accepts into the application-wide NodeCache while InboundTransactions keys its acquisitions by set hash. A fresh seed per chain gives every chain distinct hashes, so each case resolves and revives only its own.

Returns
The seed.

Definition at line 94 of file TransactionAcquire_test.cpp.

◆ wasIgnored()

bool xrpl::test::TransactionAcquire_test::wasIgnored ( SHAMapAddNode const & san)
static

Whether takeNodes() declined to look at the data at all.

TimeoutCounter::complete_ and failed_ are both protected, so this stands in for either: a done acquisition returns a verdict with every count at zero.

Parameters
sanThe verdict a takeNodes() call returned.
Returns
Whether that verdict shows the data was never looked at.

Definition at line 110 of file TransactionAcquire_test.cpp.

◆ waitForDeliveredSet()

std::shared_ptr< SHAMap > xrpl::test::TransactionAcquire_test::waitForDeliveredSet ( jtx::Env & env,
UInt256 const & setHash )
staticnodiscard

Wait for a finished set to reach InboundTransactions.

done() hands the map over through a job, so a delivered set is what separates completion from a stop.

Parameters
envThe environment whose InboundTransactions to watch.
setHashThe set to wait for.
Returns
The delivered map, or nullptr if none arrived.

Definition at line 126 of file TransactionAcquire_test.cpp.

◆ testHappyPathCompletesAcquisition()

void xrpl::test::TransactionAcquire_test::testHappyPathCompletesAcquisition ( jtx::Env & env)

A chain ending in a leaf completes the acquisition, which stops the asking and hands the map to InboundTransactions.

Later replies for it are then left alone.

Parameters
envThe environment to run in.

Definition at line 148 of file TransactionAcquire_test.cpp.

◆ testTwoPeersEachSupplyPartOfTheSet()

void xrpl::test::TransactionAcquire_test::testTwoPeersEachSupplyPartOfTheSet ( jtx::Env & env)

Two peers each answering with a different missing piece are both accepted without penalty, and the set completes from their combined replies.

Driven through InboundTransactions::gotData(), so the leaf goes over the real dispatch, which derives a leaf's position from its own key.

Parameters
envThe environment to run in.

Definition at line 200 of file TransactionAcquire_test.cpp.

◆ testBadRootKeepsAcquireAlive()

void xrpl::test::TransactionAcquire_test::testBadRootKeepsAcquireAlive ( jtx::Env & env)

A root that does not hash to the set we asked for is a plain mismatch, and has to leave the acquisition able to try another peer.

Parameters
envThe environment to run in.

Definition at line 234 of file TransactionAcquire_test.cpp.

◆ testDuplicateRootReplyIsFree()

void xrpl::test::TransactionAcquire_test::testDuplicateRootReplyIsFree ( jtx::Env & env)

A second reply carrying a root we already have must stay free.

This is what an honest second responder to the initial fan-out sends: trigger() broadcasts to every tracked peer, so several answer the same request and all but the first carry data the map already holds, so they go uncharged.

Covers the root specifically, which takeNodes() short-circuits on haveRoot_ without consulting the map. A repeated non-root node takes the other route, through addKnownNode() - see testDuplicateNonRootReplyIsFree().

Parameters
envThe environment to run in.

Definition at line 272 of file TransactionAcquire_test.cpp.

◆ testDuplicateNonRootReplyIsFree()

void xrpl::test::TransactionAcquire_test::testDuplicateNonRootReplyIsFree ( jtx::Env & env)

A repeated non-root node stays free too.

The counterpart to testDuplicateRootReplyIsFree(), covering the route that consults the map: addKnownNode() reports a node it already holds as a duplicate, which isGood() counts as success.

Parameters
envThe environment to run in.

Definition at line 306 of file TransactionAcquire_test.cpp.

◆ testUndeserializableNodeIsCharged()

void xrpl::test::TransactionAcquire_test::testUndeserializableNodeIsCharged ( jtx::Env & env)

A reply whose node data cannot be deserialized is charged for.

gotData() rejects the packet before the acquisition is handed anything, so this pins the charge on the dispatch layer rather than on takeNodes(). It also gives this suite's "was not charged" assertions their teeth: a harness that recorded no charge at all would satisfy all of them and fail only here.

Parameters
envThe environment to run in.

Definition at line 345 of file TransactionAcquire_test.cpp.

◆ testMismatchedRootThroughGotDataIsCharged()

void xrpl::test::TransactionAcquire_test::testMismatchedRootThroughGotDataIsCharged ( jtx::Env & env)

A well-formed reply whose root hashes to a different set is charged for.

The counterpart to testUndeserializableNodeIsCharged(), which gotData() rejects before the acquisition sees it. This reply deserializes cleanly and reaches takeNodes(), whose invalid verdict gotData() turns into the charge. testBadRootKeepsAcquireAlive() reads that verdict directly, so this is the case that pins the charge made from it.

Parameters
envThe environment to run in.

Definition at line 383 of file TransactionAcquire_test.cpp.

◆ testInitFiltersCandidatesByHasTxSet()

void xrpl::test::TransactionAcquire_test::testInitFiltersCandidatesByHasTxSet ( jtx::Env & env)

init() passes hasTxSet() to addPeers() as its candidate filter.

init() hands addPeers() hasTxSet(hash_) as its hasItem callback and trigger() as its onPeerAdded callback. The harness selects on that callback while the real peer set only scores with it, so this pins which callbacks the acquisition supplies, not how many peers production asks.

Parameters
envThe environment to run in.

Definition at line 417 of file TransactionAcquire_test.cpp.

◆ testTimerBroadcastsThenGivesUp()

void xrpl::test::TransactionAcquire_test::testTimerBroadcastsThenGivesUp ( jtx::Env & env)

The retry timer broadcasts with no peer of its own, then gives up on its own.

The only case that reaches onTimer(). Pins the two behaviors, not the thresholds they trip at: bounding those means asserting on wall clock. The broadcast count is read after the give-up, which the failed_ guard in trigger() makes safe.

The acquisition tracks no peer, so the broadcast this case counts reaches nobody in production either. What is pinned is that onTimer() issues it.

Parameters
envThe environment to run in.

Definition at line 463 of file TransactionAcquire_test.cpp.

◆ run()

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

Runs the suite.

Implements beast::unit_test::Suite.

Definition at line 500 of file TransactionAcquire_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::TransactionAcquire_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. At this interval the window between the first retry (four timeouts in) and giving up (twenty) is still a third of a second, which is what the one case that watches both needs.

Definition at line 80 of file TransactionAcquire_test.cpp.

◆ seed_

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

Definition at line 520 of file TransactionAcquire_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.