xrpl::test::Invariants_test Class Reference

Inheritance diagram for xrpl::test::Invariants_test:

Collaboration diagram for xrpl::test::Invariants_test:

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)
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
enum class	TxAccount : int { None = 0 , A1 , A2 }
	Run a specific test case to put the ledger into a state that will be detected by an invariant. More...
using	Preclose = std::function< bool(test::jtx::Account const &a, test::jtx::Account const &b, test::jtx::Env &env)>
using	Precheck = std::function< bool(test::jtx::Account const &a, test::jtx::Account const &b, ApplyContext &ac)>

Private Member Functions
void	doInvariantCheck (std::vector< std::string > const &expect_logs, Precheck const &precheck, XRPAmount fee=XRPAmount{}, STTx tx=STTx{ttACCOUNT_SET, [](STObject &) {}}, std::initializer_list< TER > ters={tecINVARIANT_FAILED, tefINVARIANT_FAILED}, Preclose const &preclose={}, TxAccount setTxAccount=TxAccount::None)
void	doInvariantCheck (test::jtx::Env &&env, std::vector< std::string > const &expect_logs, Precheck const &precheck, XRPAmount fee=XRPAmount{}, STTx tx=STTx{ttACCOUNT_SET, [](STObject &) {}}, std::initializer_list< TER > ters={tecINVARIANT_FAILED, tefINVARIANT_FAILED}, Preclose const &preclose={}, TxAccount setTxAccount=TxAccount::None)
void	doInvariantCheck (test::jtx::Env &&env, test::jtx::Account const &A1, test::jtx::Account const &A2, std::vector< std::string > const &expect_logs, Precheck const &precheck, XRPAmount fee=XRPAmount{}, STTx tx=STTx{ttACCOUNT_SET, [](STObject &) {}}, std::initializer_list< TER > ters={tecINVARIANT_FAILED, tefINVARIANT_FAILED})
void	testXRPNotCreated ()
void	testAccountRootsNotRemoved ()
void	testAccountRootsDeletedClean ()
void	testTypesMatch ()
void	testNoXRPTrustLine ()
void	testNoDeepFreezeTrustLinesWithoutFreeze ()
void	testTransfersNotFrozen ()
void	testXRPBalanceCheck ()
void	testTransactionFeeCheck ()
void	testNoBadOffers ()
void	testNoZeroEscrow ()
void	testValidNewAccountRoot ()
void	testNFTokenPageInvariants ()
void	testPermissionedDomainInvariants (FeatureBitset features)
void	testValidPseudoAccounts ()
void	testPermissionedDEX (FeatureBitset features)
Keylet	createLoanBroker (jtx::Account const &a, jtx::Env &env, jtx::PrettyAsset const &asset)
void	testNoModifiedUnmodifiableFields ()
void	testValidLoanBroker ()
void	testVault ()
void	propagate_abort ()

Static Private Member Functions
static FeatureBitset	defaultAmendments ()
static std::shared_ptr< SLE >	createPermissionedDomain (ApplyContext &ac, test::jtx::Account const &A1, test::jtx::Account const &A2, std::uint32_t numCreds=2, std::uint32_t seq=10)
static std::pair< std::uint32_t, uint256 >	createPermissionedDomainEnv (test::jtx::Env &env, test::jtx::Account const &A1, test::jtx::Account const &A2, std::uint32_t numCreds=2)
static suite **	p_this_suite ()

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

Detailed Description

Definition at line 26 of file Invariants_test.cpp.

Member Typedef Documentation

Preclose

using xrpl::test::Invariants_test::Preclose = std::function<bool(test::jtx::Account const& a, test::jtx::Account const& b, test::jtx::Env& env)>

private

Definition at line 32 of file Invariants_test.cpp.

Precheck

using xrpl::test::Invariants_test::Precheck = std::function<bool(test::jtx::Account const& a, test::jtx::Account const& b, ApplyContext& ac)>

private

Definition at line 37 of file Invariants_test.cpp.

Member Enumeration Documentation

TxAccount

enum class xrpl::test::Invariants_test::TxAccount : int

strongprivate

Run a specific test case to put the ledger into a state that will be detected by an invariant.

Simulates the actions of a transaction that would violate an invariant.

Parameters

expect_logs

One or more messages related to the failing invariant that should be in the log output @precheck See "Precheck" above @fee If provided, the fee amount paid by the simulated transaction. @tx A mock transaction that took the actions to trigger the invariant. In most cases, only the type matters. @ters The TER results expected on the two passes of the invariant checker. @preclose See "Preclose" above. Note that @preclose runs before @precheck, but is the last parameter for historical reasons @setTxAccount optionally set to add sfAccount to tx (either A1 or A2)

Enumerator
None
A1
A2

Definition at line 61 of file Invariants_test.cpp.

Member Function Documentation

defaultAmendments()

static FeatureBitset xrpl::test::Invariants_test::defaultAmendments ( )

staticprivate

Definition at line 40 of file Invariants_test.cpp.

doInvariantCheck() [1/3]

void xrpl::test::Invariants_test::doInvariantCheck ( std::vector< std::string > const &  expect_logs, Precheck const &  precheck, XRPAmount  fee = XRPAmount{}, STTx  tx = STTx{ttACCOUNT_SET, [](STObject&) {}}, std::initializer_list< TER >  ters = {tecINVARIANT_FAILED, tefINVARIANT_FAILED}, Preclose const &  preclose = {}, TxAccount  setTxAccount = TxAccount::None  )

private

Definition at line 63 of file Invariants_test.cpp.

doInvariantCheck() [2/3]

void xrpl::test::Invariants_test::doInvariantCheck ( test::jtx::Env &&  env, std::vector< std::string > const &  expect_logs, Precheck const &  precheck, XRPAmount  fee = XRPAmount{}, STTx  tx = STTx{ttACCOUNT_SET, [](STObject&) {}}, std::initializer_list< TER >  ters = {tecINVARIANT_FAILED, tefINVARIANT_FAILED}, Preclose const &  preclose = {}, TxAccount  setTxAccount = TxAccount::None  )

private

Definition at line 77 of file Invariants_test.cpp.

doInvariantCheck() [3/3]

void xrpl::test::Invariants_test::doInvariantCheck ( test::jtx::Env &&  env, test::jtx::Account const &  A1, test::jtx::Account const &  A2, std::vector< std::string > const &  expect_logs, Precheck const &  precheck, XRPAmount  fee = XRPAmount{}, STTx  tx = STTx{ttACCOUNT_SET, [](STObject&) {}}, std::initializer_list< TER >  ters = {tecINVARIANT_FAILED, tefINVARIANT_FAILED}  )

private

Definition at line 103 of file Invariants_test.cpp.

testXRPNotCreated()

void xrpl::test::Invariants_test::testXRPNotCreated ( )

private

Definition at line 150 of file Invariants_test.cpp.

testAccountRootsNotRemoved()

void xrpl::test::Invariants_test::testAccountRootsNotRemoved ( )

private

Definition at line 168 of file Invariants_test.cpp.

testAccountRootsDeletedClean()

void xrpl::test::Invariants_test::testAccountRootsDeletedClean ( )

private

Definition at line 222 of file Invariants_test.cpp.

testTypesMatch()

void xrpl::test::Invariants_test::testTypesMatch ( )

private

Definition at line 430 of file Invariants_test.cpp.

testNoXRPTrustLine()

void xrpl::test::Invariants_test::testNoXRPTrustLine ( )

private

Definition at line 467 of file Invariants_test.cpp.

testNoDeepFreezeTrustLinesWithoutFreeze()

void xrpl::test::Invariants_test::testNoDeepFreezeTrustLinesWithoutFreeze ( )

private

Definition at line 481 of file Invariants_test.cpp.

testTransfersNotFrozen()

void xrpl::test::Invariants_test::testTransfersNotFrozen ( )

private

Definition at line 559 of file Invariants_test.cpp.

testXRPBalanceCheck()

void xrpl::test::Invariants_test::testXRPBalanceCheck ( )

private

Definition at line 647 of file Invariants_test.cpp.

testTransactionFeeCheck()

void xrpl::test::Invariants_test::testTransactionFeeCheck ( )

private

Definition at line 695 of file Invariants_test.cpp.

testNoBadOffers()

void xrpl::test::Invariants_test::testNoBadOffers ( )

private

Definition at line 720 of file Invariants_test.cpp.

testNoZeroEscrow()

void xrpl::test::Invariants_test::testNoZeroEscrow ( )

private

Definition at line 768 of file Invariants_test.cpp.

testValidNewAccountRoot()

void xrpl::test::Invariants_test::testValidNewAccountRoot ( )

private

Definition at line 927 of file Invariants_test.cpp.

testNFTokenPageInvariants()

void xrpl::test::Invariants_test::testNFTokenPageInvariants ( )

private

Definition at line 1037 of file Invariants_test.cpp.

createPermissionedDomain()

static std::shared_ptr< SLE > xrpl::test::Invariants_test::createPermissionedDomain ( ApplyContext &  ac, test::jtx::Account const &  A1, test::jtx::Account const &  A2, std::uint32_t  numCreds = 2, std::uint32_t  seq = 10  )

staticprivate

Definition at line 1161 of file Invariants_test.cpp.

testPermissionedDomainInvariants()

void xrpl::test::Invariants_test::testPermissionedDomainInvariants ( FeatureBitset  features )

private

Definition at line 1195 of file Invariants_test.cpp.

testValidPseudoAccounts()

void xrpl::test::Invariants_test::testValidPseudoAccounts ( )

private

Definition at line 1534 of file Invariants_test.cpp.

createPermissionedDomainEnv()

static std::pair< std::uint32_t, uint256 > xrpl::test::Invariants_test::createPermissionedDomainEnv ( test::jtx::Env &  env, test::jtx::Account const &  A1, test::jtx::Account const &  A2, std::uint32_t  numCreds = 2  )

staticprivate

Definition at line 1651 of file Invariants_test.cpp.

testPermissionedDEX()

void xrpl::test::Invariants_test::testPermissionedDEX ( FeatureBitset  features )

private

Definition at line 1677 of file Invariants_test.cpp.

createLoanBroker()

Keylet xrpl::test::Invariants_test::createLoanBroker ( jtx::Account const &  a, jtx::Env &  env, jtx::PrettyAsset const &  asset  )

private

Definition at line 1881 of file Invariants_test.cpp.

testNoModifiedUnmodifiableFields()

void xrpl::test::Invariants_test::testNoModifiedUnmodifiableFields ( )

private

Definition at line 1905 of file Invariants_test.cpp.

testValidLoanBroker()

void xrpl::test::Invariants_test::testValidLoanBroker ( )

private

Definition at line 1977 of file Invariants_test.cpp.

testVault()

void xrpl::test::Invariants_test::testVault ( )

private

Definition at line 2193 of file Invariants_test.cpp.

run()

void xrpl::test::Invariants_test::run ( )

overridevirtual

Runs the suite.

Implements beast::unit_test::suite.

Definition at line 3712 of file Invariants_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

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.