xrpl::test::ServerStatus_test Class Reference

Inheritance diagram for xrpl::test::ServerStatus_test:

Collaboration diagram for xrpl::test::ServerStatus_test:

Classes
class	MyFields

Public Types
using	YieldContext = boost::asio::yield_context
	The type of yield context passed to functions.

Public Member Functions
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)
boost::asio::io_context &	getIoContext ()
	Return the io_context associated with the object.
template<class F0, class... FN>
void	yieldTo (F0 &&f0, FN &&... fn)
	Run one or more functions, each in a coroutine.
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.

Protected Attributes
boost::asio::io_context	ios_

Private Member Functions
void	doRequest (boost::asio::yield_context &yield, boost::beast::http::request< boost::beast::http::string_body > const &req, std::string const &host, uint16_t port, bool secure, boost::beast::http::response< boost::beast::http::string_body > &resp, boost::system::error_code &ec)
void	doWSRequest (test::jtx::Env &env, boost::asio::yield_context &yield, bool secure, boost::beast::http::response< boost::beast::http::string_body > &resp, boost::system::error_code &ec)
void	doHTTPRequest (test::jtx::Env &env, boost::asio::yield_context &yield, bool secure, boost::beast::http::response< boost::beast::http::string_body > &resp, boost::system::error_code &ec, std::string const &body="", MyFields const &fields={})
void	testAdminRequest (std::string const &proto, bool admin, bool credentials)
void	testWSClientToHttpServer (boost::asio::yield_context &yield)
void	testStatusRequest (boost::asio::yield_context &yield)
void	testTruncatedWSUpgrade (boost::asio::yield_context &yield)
void	testCantConnect (std::string const &clientProtocol, std::string const &serverProtocol, boost::asio::yield_context &yield)
void	testAuth (bool secure, boost::asio::yield_context &yield)
void	testLimit (boost::asio::yield_context &yield, int limit)
void	testWSHandoff (boost::asio::yield_context &yield)
void	testNoRPC (boost::asio::yield_context &yield)
void	testWSRequests (boost::asio::yield_context &yield)
void	testAmendmentWarning (boost::asio::yield_context &yield)
void	testAmendmentBlock (boost::asio::yield_context &yield)
void	testRPCRequests (boost::asio::yield_context &yield)
void	testStatusNotOkay (boost::asio::yield_context &yield)
void	propagateAbort () const
void	spawn ()
template<class F0, class... FN>
void	spawn (F0 &&f, FN &&... fn)

Static Private Member Functions
static auto	makeConfig (std::string const &proto, bool admin=true, bool credentials=false)
static auto	makeWSUpgrade (std::string const &host, uint16_t port)
static auto	makeHTTPRequest (std::string const &host, uint16_t port, std::string const &body, MyFields const &fields)
static auto	makeAdminRequest (jtx::Env &env, std::string const &proto, std::string const &user, std::string const &password, bool subobject=false)
static Suite **	pThisSuite ()

Private Attributes
bool	abort_ = false
bool	aborted_ = false
Runner *	runner_ = nullptr
boost::optional< boost::asio::executor_work_guard< boost::asio::io_context::executor_type > >	work_
std::vector< std::thread >	threads_
std::mutex	m_
std::condition_variable	cv_
std::size_t	running_ = 0

Detailed Description

Definition at line 50 of file ServerStatus_test.cpp.

Member Typedef Documentation

YieldContext

using beast::test::EnableYieldTo::YieldContext = boost::asio::yield_context

inherited

The type of yield context passed to functions.

Definition at line 45 of file yield_to.h.

Member Function Documentation

makeConfig()

auto xrpl::test::ServerStatus_test::makeConfig ( std::string const & proto, bool admin = true, bool credentials = false )

staticprivate

Definition at line 57 of file ServerStatus_test.cpp.

makeWSUpgrade()

auto xrpl::test::ServerStatus_test::makeWSUpgrade ( std::string const & host, uint16_t port )

staticprivate

Definition at line 93 of file ServerStatus_test.cpp.

makeHTTPRequest()

auto xrpl::test::ServerStatus_test::makeHTTPRequest ( std::string const & host, uint16_t port, std::string const & body, MyFields const & fields )

staticprivate

Definition at line 121 of file ServerStatus_test.cpp.

doRequest()

void xrpl::test::ServerStatus_test::doRequest ( boost::asio::yield_context & yield, boost::beast::http::request< boost::beast::http::string_body > const & req, std::string const & host, uint16_t port, bool secure, boost::beast::http::response< boost::beast::http::string_body > & resp, boost::system::error_code & ec )

private

Definition at line 153 of file ServerStatus_test.cpp.

doWSRequest()

void xrpl::test::ServerStatus_test::doWSRequest ( test::jtx::Env & env, boost::asio::yield_context & yield, bool secure, boost::beast::http::response< boost::beast::http::string_body > & resp, boost::system::error_code & ec )

private

Definition at line 207 of file ServerStatus_test.cpp.

doHTTPRequest()

void xrpl::test::ServerStatus_test::doHTTPRequest ( test::jtx::Env & env, boost::asio::yield_context & yield, bool secure, boost::beast::http::response< boost::beast::http::string_body > & resp, boost::system::error_code & ec, std::string const & body = "", MyFields const & fields = {} )

private

Definition at line 221 of file ServerStatus_test.cpp.

makeAdminRequest()

auto xrpl::test::ServerStatus_test::makeAdminRequest ( jtx::Env & env, std::string const & proto, std::string const & user, std::string const & password, bool subobject = false )

staticprivate

Definition at line 237 of file ServerStatus_test.cpp.

testAdminRequest()

void xrpl::test::ServerStatus_test::testAdminRequest ( std::string const & proto, bool admin, bool credentials )

private

Definition at line 282 of file ServerStatus_test.cpp.

testWSClientToHttpServer()

void xrpl::test::ServerStatus_test::testWSClientToHttpServer ( boost::asio::yield_context & yield )

private

Definition at line 364 of file ServerStatus_test.cpp.

testStatusRequest()

void xrpl::test::ServerStatus_test::testStatusRequest ( boost::asio::yield_context & yield )

private

Definition at line 395 of file ServerStatus_test.cpp.

testTruncatedWSUpgrade()

void xrpl::test::ServerStatus_test::testTruncatedWSUpgrade ( boost::asio::yield_context & yield )

private

Definition at line 427 of file ServerStatus_test.cpp.

testCantConnect()

void xrpl::test::ServerStatus_test::testCantConnect ( std::string const & clientProtocol, std::string const & serverProtocol, boost::asio::yield_context & yield )

private

Definition at line 472 of file ServerStatus_test.cpp.

testAuth()

void xrpl::test::ServerStatus_test::testAuth ( bool secure, boost::asio::yield_context & yield )

private

Definition at line 500 of file ServerStatus_test.cpp.

testLimit()

void xrpl::test::ServerStatus_test::testLimit ( boost::asio::yield_context & yield, int limit )

private

Definition at line 553 of file ServerStatus_test.cpp.

testWSHandoff()

void xrpl::test::ServerStatus_test::testWSHandoff ( boost::asio::yield_context & yield )

private

Definition at line 633 of file ServerStatus_test.cpp.

testNoRPC()

void xrpl::test::ServerStatus_test::testNoRPC ( boost::asio::yield_context & yield )

private

Definition at line 657 of file ServerStatus_test.cpp.

testWSRequests()

void xrpl::test::ServerStatus_test::testWSRequests ( boost::asio::yield_context & yield )

private

Definition at line 679 of file ServerStatus_test.cpp.

testAmendmentWarning()

void xrpl::test::ServerStatus_test::testAmendmentWarning ( boost::asio::yield_context & yield )

private

Definition at line 758 of file ServerStatus_test.cpp.

testAmendmentBlock()

void xrpl::test::ServerStatus_test::testAmendmentBlock ( boost::asio::yield_context & yield )

private

Definition at line 886 of file ServerStatus_test.cpp.

testRPCRequests()

void xrpl::test::ServerStatus_test::testRPCRequests ( boost::asio::yield_context & yield )

private

Definition at line 1017 of file ServerStatus_test.cpp.

testStatusNotOkay()

void xrpl::test::ServerStatus_test::testStatusNotOkay ( boost::asio::yield_context & yield )

private

Definition at line 1127 of file ServerStatus_test.cpp.

run()

void xrpl::test::ServerStatus_test::run ( )

overridevirtual

Runs the suite.

Implements beast::unit_test::Suite.

Definition at line 1150 of file ServerStatus_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.

getIoContext()

boost::asio::io_context & beast::test::EnableYieldTo::getIoContext ( )

inherited

Return the io_context associated with the object.

Definition at line 67 of file yield_to.h.

yieldTo()

template<class F0, class... FN>

void beast::test::EnableYieldTo::yieldTo ( F0 && f0, FN &&... fn )

inherited

Run one or more functions, each in a coroutine.

This call will block until all coroutines terminate.

Each functions should have this signature:

void f(yield_context);

Parameters

fn...

One or more functions to invoke.

Definition at line 107 of file yield_to.h.

spawn() [1/2]

void beast::test::EnableYieldTo::spawn ( )

privateinherited

Definition at line 96 of file yield_to.h.

spawn() [2/2]

template<class F0, class... FN>

void beast::test::EnableYieldTo::spawn ( F0 && f, FN &&... fn )

privateinherited

Definition at line 117 of file yield_to.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.

ios_

boost::asio::io_context beast::test::EnableYieldTo::ios_

protectedinherited

Definition at line 32 of file yield_to.h.

work_

boost::optional<boost::asio::executor_work_guard<boost::asio::io_context::executor_type> > beast::test::EnableYieldTo::work_

privateinherited

Definition at line 35 of file yield_to.h.

threads_

std::vector<std::thread> beast::test::EnableYieldTo::threads_

privateinherited

Definition at line 36 of file yield_to.h.

m_

std::mutex beast::test::EnableYieldTo::m_

privateinherited

Definition at line 37 of file yield_to.h.

cv_

std::condition_variable beast::test::EnableYieldTo::cv_

privateinherited

Definition at line 38 of file yield_to.h.

running_

std::size_t beast::test::EnableYieldTo::running_ = 0

privateinherited

Definition at line 39 of file yield_to.h.