Inheritance diagram for xrpl::test::tx_reduce_relay_test:

Collaboration diagram for xrpl::test::tx_reduce_relay_test:

[legend]

Classes
class	TxReducePeer
	Counts queued transaction hashes. More...

Public Member Functions
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 Member Functions
Runner &	runner () const
	Lets a suite compose other suites (e.g.

Private Member Functions
void	doTest (std::string const &msg, bool log, std::function< void(bool)> f)
void	testConfig (bool log)
void	addPeer (jtx::Env &env, std::vector< std::shared_ptr< TxReducePeer > > &peers, std::uint16_t &nDisabled)
	Build one peer and register it with the overlay.
void	testRelay (std::string const &test, bool txRREnabled, std::uint16_t nPeers, std::uint16_t nDisabled, std::uint16_t minPeers, std::uint16_t relayPercentage, std::uint16_t expectRelay, std::uint16_t expectQueue, std::size_t nSkip=0)
	Relay one transaction to nPeers peers and check the split.
void	testQueueOnly (std::string const &test, bool txRREnabled, std::uint16_t nPeers, std::uint16_t nDisabled, std::uint16_t expectQueue)
	Exercises the branch that only queues, reached when relay() is handed no transaction to send: a pseudo-transaction, or an explicit nullopt as here.
void	run () override
	Runs the suite.
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 35 of file tx_reduce_relay_test.cpp.

Member Function Documentation

◆ doTest()

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

private

Definition at line 38 of file tx_reduce_relay_test.cpp.

◆ testConfig()

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

private

Definition at line 45 of file tx_reduce_relay_test.cpp.

◆ addPeer()

void xrpl::test::tx_reduce_relay_test::addPeer	(	jtx::Env &	env,
		std::vector< std::shared_ptr< TxReducePeer > > &	peers,
		std::uint16_t &	nDisabled )

private

Build one peer and register it with the overlay.

The first nDisabled peers get no X-Protocol-Ctl header, which leaves tx reduce-relay disabled on them. Built first, they sit at the front of peers, where testRelay's skip set expects them.

Parameters

env	The environment owning the overlay.
peers	Receives the peer; the overlay holds only a weak pointer, so the caller keeps it alive.
nDisabled	How many more peers to leave disabled; decremented per peer built.

Definition at line 141 of file tx_reduce_relay_test.cpp.

◆ testRelay()

void xrpl::test::tx_reduce_relay_test::testRelay	(	std::string const &	test,
		bool	txRREnabled,
		std::uint16_t	nPeers,
		std::uint16_t	nDisabled,
		std::uint16_t	minPeers,
		std::uint16_t	relayPercentage,
		std::uint16_t	expectRelay,
		std::uint16_t	expectQueue,
		std::size_t	nSkip = 0 )

private

Relay one transaction to nPeers peers and check the split.

Parameters

test	The testcase name.
txRREnabled	The tx_enable config value.
nPeers	How many peers to attach to the overlay.
nDisabled	How many of those peers have reduce-relay disabled.
minPeers	The tx_min_peers config value.
relayPercentage	The tx_relay_percentage config value.
expectRelay	The expected number of peers relayed to.
expectQueue	The expected number of peers queued for.
nSkip	How many of the first-built peers to skip.

Definition at line 177 of file tx_reduce_relay_test.cpp.

◆ testQueueOnly()

void xrpl::test::tx_reduce_relay_test::testQueueOnly	(	std::string const &	test,
		bool	txRREnabled,
		std::uint16_t	nPeers,
		std::uint16_t	nDisabled,
		std::uint16_t	expectQueue )

private

Exercises the branch that only queues, reached when relay() is handed no transaction to send: a pseudo-transaction, or an explicit nullopt as here.

A queued hash is announced later in a TMHaveTransactions, a type only a peer that negotiated tx reduce-relay recognizes, so a peer without it must not be queued. The relay branch below checks that; this one has to as well, since the check is only as good as its least-guarded send path.

Parameters

test	Name of the case.
txRREnabled	Whether the server's tx reduce-relay is configured on.
nPeers	How many peers to attach.
nDisabled	How many of those did not negotiate the feature.
expectQueue	How many peers are expected to be queued.

Definition at line 248 of file tx_reduce_relay_test.cpp.

◆ run()

void xrpl::test::tx_reduce_relay_test::run ( )

overrideprivatevirtual

Runs the suite.

Implements beast::unit_test::Suite.

Definition at line 277 of file tx_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

◆ 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.

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ doTest()

◆ testConfig()

◆ addPeer()

◆ testRelay()

◆ testQueueOnly()

◆ run()

◆ thisSuite()

◆ operator()()

◆ pass()

◆ fail() [1/2]

◆ fail() [2/2]

◆ expect() [1/4]

◆ expect() [2/4]

◆ expect() [3/4]

◆ expect() [4/4]

◆ except() [1/4]

◆ except() [2/4]

◆ except() [3/4]

◆ except() [4/4]

◆ unexcept() [1/2]

◆ unexcept() [2/2]

◆ arg()

◆ runner()

◆ unexpected() [1/2]

◆ unexpected() [2/2]

◆ pThisSuite()

◆ propagateAbort()

Member Data Documentation

◆ abort_

◆ aborted_

◆ runner_

◆ log

◆ testcase