Test for TMGetObjectByHash reply size limiting. More...

Inheritance diagram for xrpl::test::TMGetObjectByHash_test:

Collaboration diagram for xrpl::test::TMGetObjectByHash_test:

[legend]

Classes
class	PeerTest
	Test peer that captures sent messages for verification. 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)

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 *	this_suite ()
	Returns the "current" running suite.

Public Attributes
log_os< char >	log
	Logging output stream.

testcase_t	testcase
	Memberspace for declaring test cases.

Private Types
using	middle_type = boost::beast::tcp_stream

using	stream_type = boost::beast::ssl_stream< middle_type >

using	socket_type = boost::asio::ip::tcp::socket

using	shared_context = std::shared_ptr< boost::asio::ssl::context >

Private Member Functions
std::shared_ptr< PeerTest >	createPeer (jtx::Env &env)

std::shared_ptr< protocol::TMGetObjectByHash >	createRequest (size_t const numObjects, Env &env)

void	testReplyLimit (size_t const numObjects, int const expectedReplySize)
	Test that reply is limited to hardMaxReplyNodes when more objects are requested than the limit allows.

void	run () override
	Runs the suite.

void	propagate_abort ()

Static Private Member Functions
static suite **	p_this_suite ()

Private Attributes
shared_context	context_ {make_SSLContext("")}

ProtocolVersion	protocolVersion_ {1, 7}

bool	abort_ = false

bool	aborted_ = false

runner *	runner_ = nullptr

Detailed Description

Test for TMGetObjectByHash reply size limiting.

This verifies the fix that limits TMGetObjectByHash replies to Tuning::hardMaxReplyNodes to prevent excessive memory usage and potential DoS attacks from peers requesting large numbers of objects.

Definition at line 28 of file TMGetObjectByHash_test.cpp.

Member Typedef Documentation

◆ middle_type

using xrpl::test::TMGetObjectByHash_test::middle_type = boost::beast::tcp_stream

private

Definition at line 30 of file TMGetObjectByHash_test.cpp.

◆ stream_type

using xrpl::test::TMGetObjectByHash_test::stream_type = boost::beast::ssl_stream<middle_type>

private

Definition at line 31 of file TMGetObjectByHash_test.cpp.

◆ socket_type

using xrpl::test::TMGetObjectByHash_test::socket_type = boost::asio::ip::tcp::socket

private

Definition at line 32 of file TMGetObjectByHash_test.cpp.

◆ shared_context

using xrpl::test::TMGetObjectByHash_test::shared_context = std::shared_ptr<boost::asio::ssl::context>

private

Definition at line 33 of file TMGetObjectByHash_test.cpp.

Member Function Documentation

◆ createPeer()

std::shared_ptr< PeerTest > xrpl::test::TMGetObjectByHash_test::createPeer ( jtx::Env & env )

private

Definition at line 96 of file TMGetObjectByHash_test.cpp.

◆ createRequest()

std::shared_ptr< protocol::TMGetObjectByHash > xrpl::test::TMGetObjectByHash_test::createRequest	(	size_t const	numObjects,
		Env &	env
	)

private

Definition at line 117 of file TMGetObjectByHash_test.cpp.

◆ testReplyLimit()

void xrpl::test::TMGetObjectByHash_test::testReplyLimit	(	size_t const	numObjects,
		int const	expectedReplySize
	)

private

Test that reply is limited to hardMaxReplyNodes when more objects are requested than the limit allows.

Definition at line 153 of file TMGetObjectByHash_test.cpp.

◆ run()

void xrpl::test::TMGetObjectByHash_test::run ( )

overrideprivatevirtual

Runs the suite.

Implements beast::unit_test::suite.

Definition at line 183 of file TMGetObjectByHash_test.cpp.

◆ this_suite()

static suite * beast::unit_test::suite::this_suite ( )

staticinherited

Returns the "current" running suite.

If no suite is running, nullptr is returned.

Definition at line 153 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 386 of file suite.h.

◆ pass()

template<class >

void beast::unit_test::suite::pass ( )

inherited

Record a successful test condition.

Definition at line 494 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 516 of file suite.h.

◆ fail() [2/2]

template<class >

void beast::unit_test::suite::fail ( std::string const & reason = "" )

inherited

Definition at line 503 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 221 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 403 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 232 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 416 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 431 of file suite.h.

◆ except() [2/4]

template<class F >

bool beast::unit_test::suite::except ( F && f )

inherited

Definition at line 251 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 448 of file suite.h.

◆ except() [4/4]

template<class E , class F >

bool beast::unit_test::suite::except ( F && f )

inherited

Definition at line 260 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 465 of file suite.h.

◆ unexcept() [2/2]

template<class F >

bool beast::unit_test::suite::unexcept ( F && f )

inherited

Definition at line 269 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 276 of file suite.h.

◆ unexpected() [1/2]

template<class Condition , class String >

bool beast::unit_test::suite::unexpected	(	Condition	shouldBeFalse,
		String const &	reason
	)

inherited

Definition at line 482 of file suite.h.

◆ unexpected() [2/2]

template<class Condition >

bool beast::unit_test::suite::unexpected ( Condition shouldBeFalse )

inherited

Definition at line 289 of file suite.h.

◆ p_this_suite()

static suite ** beast::unit_test::suite::p_this_suite ( )

staticprivateinherited

Definition at line 298 of file suite.h.

◆ propagate_abort()

void beast::unit_test::suite::propagate_abort ( )

privateinherited

Definition at line 522 of file suite.h.

Member Data Documentation

◆ context_

shared_context xrpl::test::TMGetObjectByHash_test::context_ {make_SSLContext("")}

private

Definition at line 92 of file TMGetObjectByHash_test.cpp.

◆ protocolVersion_

ProtocolVersion xrpl::test::TMGetObjectByHash_test::protocolVersion_ {1, 7}

private

Definition at line 93 of file TMGetObjectByHash_test.cpp.

◆ abort_

bool beast::unit_test::suite::abort_ = false

privateinherited

Definition at line 53 of file suite.h.

◆ aborted_

bool beast::unit_test::suite::aborted_ = false

privateinherited

Definition at line 54 of file suite.h.

◆ runner_

runner* beast::unit_test::suite::runner_ = nullptr

privateinherited

Definition at line 55 of file suite.h.

◆ log

log_os<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 144 of file suite.h.

◆ testcase

testcase_t beast::unit_test::suite::testcase

inherited

Memberspace for declaring test cases.

Definition at line 147 of file suite.h.

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ middle_type

◆ stream_type

◆ socket_type

◆ shared_context

Member Function Documentation

◆ createPeer()

◆ createRequest()

◆ testReplyLimit()

◆ run()

◆ this_suite()

◆ 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()

◆ unexpected() [1/2]

◆ unexpected() [2/2]

◆ p_this_suite()

◆ propagate_abort()

Member Data Documentation

◆ context_

◆ protocolVersion_

◆ abort_

◆ aborted_

◆ runner_

◆ log

◆ testcase