xrpl::test::ProtocolMessage_test Class Reference

Inheritance diagram for xrpl::test::ProtocolMessage_test:

Collaboration diagram for xrpl::test::ProtocolMessage_test:

Classes
struct	TestHandler

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	testOversizedPingRejected ()
void	testOversizedPingRejectedFromHeaderAlone ()
void	testNormalPingDispatched ()
void	testPingWithSmallUnknownFieldDispatched ()
void	run () override
	Runs the suite.
void	propagateAbort () const

Static Private Member Functions
static std::vector< std::uint8_t >	makePingBuffer (std::size_t unknownFieldSize, bool compressed=false)
static std::optional< std::size_t >	declaredPingSize (std::vector< std::uint8_t > const &buffer)
static std::pair< std::size_t, boost::system::error_code >	invoke (std::vector< std::uint8_t > const &buffer, TestHandler &handler)
static Suite **	pThisSuite ()

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

Static Private Attributes
static constexpr std::size_t	kPingProtoOverheadWithUnknownLen = 6
static constexpr std::size_t	kMinimumPingSizeWithEmptyUnknownField
static constexpr std::size_t	kMinimumPingSizeCompressedWithEmptyUnknownField

Detailed Description

Definition at line 24 of file ProtocolMessage_test.cpp.

Member Function Documentation

makePingBuffer()

std::vector< std::uint8_t > xrpl::test::ProtocolMessage_test::makePingBuffer ( std::size_t unknownFieldSize, bool compressed = false )

staticprivate

Definition at line 89 of file ProtocolMessage_test.cpp.

declaredPingSize()

std::optional< std::size_t > xrpl::test::ProtocolMessage_test::declaredPingSize ( std::vector< std::uint8_t > const & buffer )

staticprivate

Definition at line 143 of file ProtocolMessage_test.cpp.

invoke()

std::pair< std::size_t, boost::system::error_code > xrpl::test::ProtocolMessage_test::invoke ( std::vector< std::uint8_t > const & buffer, TestHandler & handler )

staticprivate

Definition at line 155 of file ProtocolMessage_test.cpp.

testOversizedPingRejected()

void xrpl::test::ProtocolMessage_test::testOversizedPingRejected ( )

private

Definition at line 163 of file ProtocolMessage_test.cpp.

testOversizedPingRejectedFromHeaderAlone()

void xrpl::test::ProtocolMessage_test::testOversizedPingRejectedFromHeaderAlone ( )

private

Definition at line 194 of file ProtocolMessage_test.cpp.

testNormalPingDispatched()

void xrpl::test::ProtocolMessage_test::testNormalPingDispatched ( )

private

Definition at line 227 of file ProtocolMessage_test.cpp.

testPingWithSmallUnknownFieldDispatched()

void xrpl::test::ProtocolMessage_test::testPingWithSmallUnknownFieldDispatched ( )

private

Definition at line 252 of file ProtocolMessage_test.cpp.

run()

void xrpl::test::ProtocolMessage_test::run ( )

overrideprivatevirtual

Runs the suite.

Implements beast::unit_test::Suite.

Definition at line 285 of file ProtocolMessage_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

kPingProtoOverheadWithUnknownLen

std::size_t xrpl::test::ProtocolMessage_test::kPingProtoOverheadWithUnknownLen = 6

staticconstexprprivate

Definition at line 82 of file ProtocolMessage_test.cpp.

kMinimumPingSizeWithEmptyUnknownField

std::size_t xrpl::test::ProtocolMessage_test::kMinimumPingSizeWithEmptyUnknownField

staticconstexprprivate

Initial value:

                                                               =
compression::kHeaderBytes + kPingProtoOverheadWithUnknownLen

Definition at line 83 of file ProtocolMessage_test.cpp.

kMinimumPingSizeCompressedWithEmptyUnknownField

std::size_t xrpl::test::ProtocolMessage_test::kMinimumPingSizeCompressedWithEmptyUnknownField

staticconstexprprivate

Initial value:

                                                                         =
compression::kHeaderBytesCompressed + kPingProtoOverheadWithUnknownLen

Definition at line 85 of file ProtocolMessage_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.