xrpl::test::reduce_relay_test Class Reference

Inheritance diagram for xrpl::test::reduce_relay_test:

Collaboration diagram for xrpl::test::reduce_relay_test:

Classes
struct	Event
struct	Handler

Public Member Functions
	reduce_relay_test ()
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 Suite *	thisSuite ()
	Returns the "current" running suite.

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

Protected Types
enum class	State { On , Off , WaitReset }
enum class	EventType { LinkDown = 0 , PeerDisconnected = 1 }

Protected Member Functions
void	printPeers (std::string const &msg, std::uint16_t validator=0)
void	random (bool log)
	Randomly brings the link between a validator and a peer down.
bool	checkCounting (PublicKey const &validator, bool isCountingState)
void	doTest (std::string const &msg, bool log, std::function< void(bool)> f)
void	testInitialRound (bool log)
	Initial counting round: three peers receive message "faster" then others.
void	testPeerUnsquelchedTooSoon (bool log)
	Receiving message from squelched peer too soon should not change the slot's state to Counting.
void	testPeerUnsquelched (bool log)
	Receiving message from squelched peer should change the slot's state to Counting.
bool	propagateAndSquelch (bool log, bool purge=true, bool resetClock=true)
	Propagate enough messages to generate one squelch event.
bool	propagateNoSquelch (bool log, std::uint16_t nMessages, bool countingState, bool purge=true, bool resetClock=true)
	Send fewer message so that squelch event is not generated.
void	testNewPeer (bool log)
	Receiving a message from new peer should change the slot's state to Counting.
void	testSelectedPeerDisconnects (bool log)
	Selected peer disconnects.
void	testSelectedPeerStopsRelaying (bool log)
	Selected peer stops relaying.
void	testSquelchedPeerDisconnects (bool log)
	Squelched peer disconnects.
void	testConfig (bool log)
void	testBaseSquelchReady (bool log)
void	testInternalHashRouter (bool log)
void	testRandomSquelch (bool l)
void	testHandshake (bool log)
Runner &	runner () const
	Lets a suite compose other suites (e.g.

Static Protected Member Functions
static Peer::id_t	sendSquelch (PublicKey const &validator, PeerWPtr const &peerPtr, std::optional< std::uint32_t > duration)
	Send squelch (if duration is set) or unsquelch (if duration not set).

Protected Attributes
jtx::Env	env_
Network	network_

Private Types
using	Slot = reduce_relay::Slot<ManualClock>
using	id_t = Peer::id_t

Private Member Functions
void	propagateAbort () const

Static Private Member Functions
static Suite **	pThisSuite ()

Private Attributes
bool	abort_ = false
bool	aborted_ = false
Runner *	runner_ = nullptr

Detailed Description

Definition at line 893 of file reduce_relay_test.cpp.

Member Typedef Documentation

Slot

using xrpl::test::reduce_relay_test::Slot = reduce_relay::Slot<ManualClock>

private

Definition at line 895 of file reduce_relay_test.cpp.

id_t

using xrpl::test::reduce_relay_test::id_t = Peer::id_t

private

Definition at line 896 of file reduce_relay_test.cpp.

Member Enumeration Documentation

State

enum class xrpl::test::reduce_relay_test::State

strongprotected

Enumerator
On
Off
WaitReset

Definition at line 931 of file reduce_relay_test.cpp.

EventType

enum class xrpl::test::reduce_relay_test::EventType

strongprotected

Enumerator
LinkDown
PeerDisconnected

Definition at line 932 of file reduce_relay_test.cpp.

Constructor & Destructor Documentation

reduce_relay_test()

xrpl::test::reduce_relay_test::reduce_relay_test

(

)

Definition at line 1628 of file reduce_relay_test.cpp.

Member Function Documentation

printPeers()

void xrpl::test::reduce_relay_test::printPeers ( std::string const & msg, std::uint16_t validator = 0 )

protected

Definition at line 900 of file reduce_relay_test.cpp.

sendSquelch()

Peer::id_t xrpl::test::reduce_relay_test::sendSquelch ( PublicKey const & validator, PeerWPtr const & peerPtr, std::optional< std::uint32_t > duration )

staticprotected

Send squelch (if duration is set) or unsquelch (if duration not set).

Definition at line 914 of file reduce_relay_test.cpp.

random()

void xrpl::test::reduce_relay_test::random ( bool log )

protected

Randomly brings the link between a validator and a peer down.

Randomly disconnects a peer. Those events are generated one at a time.

Definition at line 955 of file reduce_relay_test.cpp.

checkCounting()

bool xrpl::test::reduce_relay_test::checkCounting ( PublicKey const & validator, bool isCountingState )

protected

Definition at line 1115 of file reduce_relay_test.cpp.

doTest()

void xrpl::test::reduce_relay_test::doTest ( std::string const & msg, bool log, std::function< void(bool)> f )

protected

Definition at line 1123 of file reduce_relay_test.cpp.

testInitialRound()

void xrpl::test::reduce_relay_test::testInitialRound ( bool log )

protected

Initial counting round: three peers receive message "faster" then others.

Once the message count for the three peers reaches threshold the rest of the peers are squelched and the slot for the given validator is in Selected state.

Definition at line 1136 of file reduce_relay_test.cpp.

testPeerUnsquelchedTooSoon()

void xrpl::test::reduce_relay_test::testPeerUnsquelchedTooSoon ( bool log )

protected

Receiving message from squelched peer too soon should not change the slot's state to Counting.

Definition at line 1146 of file reduce_relay_test.cpp.

testPeerUnsquelched()

void xrpl::test::reduce_relay_test::testPeerUnsquelched ( bool log )

protected

Receiving message from squelched peer should change the slot's state to Counting.

Definition at line 1158 of file reduce_relay_test.cpp.

propagateAndSquelch()

bool xrpl::test::reduce_relay_test::propagateAndSquelch ( bool log, bool purge = true, bool resetClock = true )

protected

Propagate enough messages to generate one squelch event.

Definition at line 1170 of file reduce_relay_test.cpp.

propagateNoSquelch()

bool xrpl::test::reduce_relay_test::propagateNoSquelch ( bool log, std::uint16_t nMessages, bool countingState, bool purge = true, bool resetClock = true )

protected

Send fewer message so that squelch event is not generated.

Definition at line 1206 of file reduce_relay_test.cpp.

testNewPeer()

void xrpl::test::reduce_relay_test::testNewPeer ( bool log )

protected

Receiving a message from new peer should change the slot's state to Counting.

Definition at line 1236 of file reduce_relay_test.cpp.

testSelectedPeerDisconnects()

void xrpl::test::reduce_relay_test::testSelectedPeerDisconnects ( bool log )

protected

Selected peer disconnects.

Should change the state to counting and unsquelch squelched peers.

Definition at line 1250 of file reduce_relay_test.cpp.

testSelectedPeerStopsRelaying()

void xrpl::test::reduce_relay_test::testSelectedPeerStopsRelaying ( bool log )

protected

Selected peer stops relaying.

Should change the state to counting and unsquelch squelched peers.

Definition at line 1271 of file reduce_relay_test.cpp.

testSquelchedPeerDisconnects()

void xrpl::test::reduce_relay_test::testSquelchedPeerDisconnects ( bool log )

protected

Squelched peer disconnects.

Should not change the state to counting.

Definition at line 1292 of file reduce_relay_test.cpp.

testConfig()

void xrpl::test::reduce_relay_test::testConfig ( bool log )

protected

Definition at line 1312 of file reduce_relay_test.cpp.

testBaseSquelchReady()

void xrpl::test::reduce_relay_test::testBaseSquelchReady ( bool log )

protected

Definition at line 1420 of file reduce_relay_test.cpp.

testInternalHashRouter()

void xrpl::test::reduce_relay_test::testInternalHashRouter ( bool log )

protected

Definition at line 1448 of file reduce_relay_test.cpp.

testRandomSquelch()

void xrpl::test::reduce_relay_test::testRandomSquelch ( bool l )

protected

Definition at line 1498 of file reduce_relay_test.cpp.

testHandshake()

void xrpl::test::reduce_relay_test::testHandshake ( bool log )

protected

Definition at line 1570 of file reduce_relay_test.cpp.

run()

void xrpl::test::reduce_relay_test::run ( )

overridevirtual

Runs the suite.

Implements beast::unit_test::Suite.

Definition at line 1639 of file reduce_relay_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

reason	Optional text added to the output on a failure.
file	The source code file where the test failed.
line	The 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

shouldBeTrue	The condition to test. The condition is evaluated in a boolean context.
reason	Optional added text to output on a failure.
file	The source code file where the test failed.
line	The 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

env_

jtx::Env xrpl::test::reduce_relay_test::env_

protected

Definition at line 1624 of file reduce_relay_test.cpp.

network_

Network xrpl::test::reduce_relay_test::network_

protected

Definition at line 1625 of file reduce_relay_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.