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)
	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 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
using	Precheck

Private Member Functions
test::jtx::Env	makeEnv (FeatureBitset features)
void	doInvariantCheck (std::vector< std::string > const &expectLogs, 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, std::source_location const &loc=std::source_location::current())
void	doInvariantCheck (test::jtx::Env &&env, std::vector< std::string > const &expectLogs, 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, std::source_location const &loc=std::source_location::current())
void	doInvariantCheck (test::jtx::Env &&env, test::jtx::Account const &a1, test::jtx::Account const &a2, std::vector< std::string > const &expectLogs, Precheck const &precheck, XRPAmount fee=XRPAmount{}, STTx tx=STTx{ttACCOUNT_SET, [](STObject &) {}}, std::initializer_list< TER > ters={tecINVARIANT_FAILED, tefINVARIANT_FAILED}, std::source_location const &loc=std::source_location::current())
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	testAMMDeleteInvariants (FeatureBitset features)
void	testPermissionedDomainInvariants (FeatureBitset features)
void	testValidPseudoAccounts ()
void	testPermissionedDEX (FeatureBitset features)
void	testBookDirectoryExchangeRate ()
Keylet	createLoanBroker (jtx::Account const &a, jtx::Env &env, jtx::PrettyAsset const &asset)
void	testNoModifiedUnmodifiableFields ()
void	testValidLoanBroker ()
void	testVault ()
void	testMPT ()
void	testAMM ()
void	testInvariantOverwrite (FeatureBitset features)
void	testVaultComputeCoarsestScale ()
void	testSponsorship ()
void	testObjectHasPseudoAccount ()
void	testConfidentialMPTTransfer ()
void	propagateAbort () const

Static Private Member Functions
static FeatureBitset	defaultAmendments ()
static SLE::pointer	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 **	pThisSuite ()

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

Detailed Description

Definition at line 87 of file Invariants_test.cpp.

Member Typedef Documentation

Preclose

using xrpl::test::Invariants_test::Preclose

private

Initial value:

std::function<
       bool(test::jtx::Account const& a, test::jtx::Account const& b, test::jtx::Env& env)>

Definition at line 93 of file Invariants_test.cpp.

Precheck

using xrpl::test::Invariants_test::Precheck

private

Initial value:

std::function<
       bool(test::jtx::Account const& a, test::jtx::Account const& b, ApplyContext& ac)>

Definition at line 99 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 131 of file Invariants_test.cpp.

Member Function Documentation

defaultAmendments()

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

staticprivate

Definition at line 103 of file Invariants_test.cpp.

makeEnv()

test::jtx::Env xrpl::test::Invariants_test::makeEnv ( FeatureBitset features )

private

Definition at line 109 of file Invariants_test.cpp.

doInvariantCheck() [1/3]

void xrpl::test::Invariants_test::doInvariantCheck ( std::vector< std::string > const & expectLogs, 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, std::source_location const & loc = std::source_location::current() )

private

Definition at line 133 of file Invariants_test.cpp.

doInvariantCheck() [2/3]

void xrpl::test::Invariants_test::doInvariantCheck ( test::jtx::Env && env, std::vector< std::string > const & expectLogs, 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, std::source_location const & loc = std::source_location::current() )

private

Definition at line 156 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 & expectLogs, Precheck const & precheck, XRPAmount fee = XRPAmount{}, STTx tx = STTx{ttACCOUNT_SET, [](STObject&) {}}, std::initializer_list< TER > ters = {tecINVARIANT_FAILED, tefINVARIANT_FAILED}, std::source_location const & loc = std::source_location::current() )

private

Definition at line 183 of file Invariants_test.cpp.

testXRPNotCreated()

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

private

Definition at line 246 of file Invariants_test.cpp.

testAccountRootsNotRemoved()

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

private

Definition at line 265 of file Invariants_test.cpp.

testAccountRootsDeletedClean()

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

private

Definition at line 321 of file Invariants_test.cpp.

testTypesMatch()

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

private

Definition at line 614 of file Invariants_test.cpp.

testNoXRPTrustLine()

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

private

Definition at line 653 of file Invariants_test.cpp.

testNoDeepFreezeTrustLinesWithoutFreeze()

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

private

Definition at line 669 of file Invariants_test.cpp.

testTransfersNotFrozen()

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

private

Definition at line 752 of file Invariants_test.cpp.

testXRPBalanceCheck()

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

private

Definition at line 843 of file Invariants_test.cpp.

testTransactionFeeCheck()

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

private

Definition at line 892 of file Invariants_test.cpp.

testNoBadOffers()

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

private

Definition at line 918 of file Invariants_test.cpp.

testNoZeroEscrow()

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

private

Definition at line 972 of file Invariants_test.cpp.

testValidNewAccountRoot()

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

private

Definition at line 1146 of file Invariants_test.cpp.

testNFTokenPageInvariants()

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

private

Definition at line 1260 of file Invariants_test.cpp.

testAMMDeleteInvariants()

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

private

Definition at line 1391 of file Invariants_test.cpp.

createPermissionedDomain()

SLE::pointer 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 1472 of file Invariants_test.cpp.

testPermissionedDomainInvariants()

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

private

Definition at line 1506 of file Invariants_test.cpp.

testValidPseudoAccounts()

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

private

Definition at line 1848 of file Invariants_test.cpp.

createPermissionedDomainEnv()

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 1983 of file Invariants_test.cpp.

testPermissionedDEX()

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

private

Definition at line 2009 of file Invariants_test.cpp.

testBookDirectoryExchangeRate()

void xrpl::test::Invariants_test::testBookDirectoryExchangeRate ( )

private

Definition at line 2251 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 2414 of file Invariants_test.cpp.

testNoModifiedUnmodifiableFields()

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

private

Definition at line 2438 of file Invariants_test.cpp.

testValidLoanBroker()

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

private

Definition at line 2559 of file Invariants_test.cpp.

testVault()

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

private

Definition at line 2829 of file Invariants_test.cpp.

testMPT()

void xrpl::test::Invariants_test::testMPT ( )

private

Definition at line 4711 of file Invariants_test.cpp.

testAMM()

void xrpl::test::Invariants_test::testAMM ( )

private

Definition at line 5710 of file Invariants_test.cpp.

testInvariantOverwrite()

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

private

Definition at line 5820 of file Invariants_test.cpp.

testVaultComputeCoarsestScale()

void xrpl::test::Invariants_test::testVaultComputeCoarsestScale ( )

private

Definition at line 5949 of file Invariants_test.cpp.

testSponsorship()

void xrpl::test::Invariants_test::testSponsorship ( )

private

Definition at line 6080 of file Invariants_test.cpp.

testObjectHasPseudoAccount()

void xrpl::test::Invariants_test::testObjectHasPseudoAccount ( )

private

Definition at line 6185 of file Invariants_test.cpp.

testConfidentialMPTTransfer()

void xrpl::test::Invariants_test::testConfidentialMPTTransfer ( )

private

Definition at line 6304 of file Invariants_test.cpp.

run()

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

overridevirtual

Runs the suite.

Implements beast::unit_test::Suite.

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