ripple::test::jtx::AMMTestBase Class Reference

#include <AMMTest.h>

Inheritance diagram for ripple::test::jtx::AMMTestBase:

Collaboration diagram for ripple::test::jtx::AMMTestBase:

Public Member Functions
	AMMTestBase ()
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.

Protected Member Functions
void	testAMM (std::function< void(jtx::AMM &, jtx::Env &)> &&cb, std::optional< std::pair< STAmount, STAmount > > const &pool=std::nullopt, std::uint16_t tfee=0, std::optional< jtx::ter > const &ter=std::nullopt, std::vector< FeatureBitset > const &features={testable_amendments()})
	testAMM() funds 30,000XRP and 30,000IOU for each non-XRP asset to Alice and Carol
void	testAMM (std::function< void(jtx::AMM &, jtx::Env &)> &&cb, TestAMMArg const &arg)

Protected Attributes
jtx::Account const	gw
jtx::Account const	carol
jtx::Account const	alice
jtx::Account const	bob
jtx::IOU const	USD
jtx::IOU const	EUR
jtx::IOU const	GBP
jtx::IOU const	BTC
jtx::IOU const	BAD

Private Member Functions
virtual void	run ()=0
	Runs the suite.
template<class = void>
void	run (runner &r)
void	propagate_abort ()

Static Private Member Functions
static suite **	p_this_suite ()

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

Detailed Description

Definition at line 53 of file AMMTest.h.

Constructor & Destructor Documentation

AMMTestBase()

ripple::test::jtx::AMMTestBase::AMMTestBase

(

)

Definition at line 70 of file AMMTest.cpp.

Member Function Documentation

testAMM() [1/2]

void ripple::test::jtx::AMMTestBase::testAMM ( std::function< void(jtx::AMM &, jtx::Env &)> &&  cb, std::optional< std::pair< STAmount, STAmount > > const &  pool = std::nullopt, std::uint16_t  tfee = 0, std::optional< jtx::ter > const &  ter = std::nullopt, std::vector< FeatureBitset > const &  features = {testable_amendments()}  )

protected

testAMM() funds 30,000XRP and 30,000IOU for each non-XRP asset to Alice and Carol

Definition at line 84 of file AMMTest.cpp.

testAMM() [2/2]

void ripple::test::jtx::AMMTestBase::testAMM ( std::function< void(jtx::AMM &, jtx::Env &)> &&  cb, TestAMMArg const &  arg  )

protected

Definition at line 98 of file AMMTest.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 158 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 396 of file suite.h.

pass()

template<class >

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

inherited

Record a successful test condition.

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

fail() [2/2]

template<class >

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

inherited

Definition at line 517 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 226 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 413 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 237 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 426 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 445 of file suite.h.

except() [2/4]

template<class F >

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

inherited

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

except() [4/4]

template<class E , class F >

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

inherited

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

unexcept() [2/2]

template<class F >

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

inherited

Definition at line 278 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 285 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 496 of file suite.h.

unexpected() [2/2]

template<class Condition >

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

inherited

Definition at line 298 of file suite.h.

p_this_suite()

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

staticprivateinherited

Definition at line 307 of file suite.h.

run() [1/2]

virtual void beast::unit_test::suite::run ( )

privatepure virtualinherited

Runs the suite.

Implemented in ripple::test::AccountDelete_test, ripple::AccountTxPaging_test, ripple::AmendmentTable_test, ripple::test::AMM_test, ripple::test::AMMCalc_test, ripple::test::AMMClawback_test, ripple::test::AMMExtended_test, ripple::test::Batch_test, ripple::Check_test, ripple::Clawback_test, ripple::test::Credentials_test, ripple::test::CrossingLimits_test, ripple::test::Delegate_test, ripple::test::DeliverMin_test, ripple::test::DepositAuth_test, ripple::test::DepositPreauth_test, ripple::test::DID_test, ripple::Discrepancy_test, ripple::test::DNS_test, ripple::test::Escrow_test, ripple::test::EscrowToken_test, ripple::test::FeeVote_test, ripple::FixNFTokenPageLinks_test, ripple::test::Flow_test, ripple::test::Flow_manual_test, ripple::Freeze_test, ripple::test::HashRouter_test, ripple::test::Invariants_test, ripple::test::LedgerHistory_test, ripple::LedgerLoad_test, ripple::test::LedgerMaster_test, ripple::test::LedgerReplay_test, ripple::test::LedgerReplayer_test, ripple::test::LedgerReplayerTimeout_test, ripple::test::LedgerReplayerLong_test, ripple::LoadFeeTrack_test, ripple::test::LPTokenTransfer_test, ripple::test::Manifest_test, ripple::test::MPToken_test, ripple::test::MultiSign_test, ripple::test::NetworkID_test, ripple::test::NetworkOPs_test, ripple::NFTokenBaseUtil_test, ripple::NFTokenDisallowIncoming_test, ripple::NFTokenWOMintOffer_test, ripple::NFTokenWOModify_test, ripple::NFTokenAllFeatures_test, ripple::NFTokenAuth_test, ripple::NFTokenBurn_test, ripple::NFTokenDir_test, ripple::test::OfferBaseUtil_test, ripple::test::OfferWOSmallQOffers_test, ripple::test::OfferAllFeatures_test, ripple::test::Offer_manual_test, ripple::OfferStream_test, ripple::test::jtx::oracle::Oracle_test, ripple::test::PlumpBook_test, ripple::test::ThinBook_test, ripple::test::OversizeMeta_test, ripple::test::FindOversizeCross_test, ripple::test::Path_test, ripple::test::PayChan_test, ripple::test::PayStrand_test, ripple::test::PermissionedDEX_test, ripple::test::PermissionedDomains_test, ripple::test::PseudoTx_test, ripple::test::RCLValidations_test, ripple::test::ReducedOffer_test, ripple::test::Regression_test, ripple::test::SetAuth_test, ripple::SetRegularKey_test, ripple::test::SetTrust_test, ripple::test::SHAMapStore_test, ripple::test::TheoreticalQuality_test, ripple::Ticket_test, ripple::test::Transaction_ordering_test, ripple::TrustAndBalance_test, ripple::Apply_test, ripple::test::TxQPosNegFlows_test, ripple::test::TxQMetaInfo_test, ripple::test::ValidatorKeys_test, ripple::test::ValidatorList_test, ripple::test::ValidatorSite_test, ripple::Vault_test, ripple::test::XChain_test, ripple::test::XChainSim_test, ripple::test::base_uint_test, ripple::test::Buffer_test, ripple::test::DetectCrash_test, ripple::test::Expected_test, ripple::FileUtilities_test, ripple::hardened_hash_test, ripple::tests::IntrusiveShared_test, ripple::IOUAmount_test, ripple::test::join_test, ripple::KeyCache_test, ripple::Number_test, ripple::PerfLog_test, ripple::StringUtilities_test, ripple::TaggedCache_test, ripple::test::units_test, ripple::XRPAmount_test, beast::aged_set_test, beast::aged_map_test, beast::aged_multiset_test, beast::aged_multimap_test, beast::aged_unordered_set_test, beast::aged_unordered_map_test, beast::aged_unordered_multiset_test, beast::aged_unordered_multimap_test, beast::abstract_clock_test, beast::basic_seconds_clock_test, ripple::test::CurrentThreadName_test, io_latency_probe_test, beast::Journal_test, beast::PropertyStream_test, beast::Zero_test, beast::unit_test::print_test, beast::IP::IPEndpoint_test, beast::LexicalCast_test, beast::SemanticVersion_test, beast::XXHasher_test, ripple::cryptoconditions::PreimageSha256_test, ripple::test::ByzantineFailureSim_test, ripple::test::Consensus_test, ripple::test::DistributedValidators_test, ripple::test::LedgerTiming_test, ripple::test::LedgerTrie_test, ripple::test::NegativeUNL_test, ripple::test::NegativeUNLNoAmendment_test, ripple::test::NegativeUNLVoteInternal_test, ripple::test::NegativeUNLVoteScoreTable_test, ripple::test::NegativeUNLVoteGoodScore_test, ripple::test::NegativeUNLVoteOffline_test, ripple::test::NegativeUNLVoteMaxListed_test, ripple::test::NegativeUNLVoteRetiredValidator_test, ripple::test::NegativeUNLVoteNewValidator_test, ripple::test::NegativeUNLVoteFilterValidations_test, ripple::test::RCLCensorshipDetector_test, ripple::test::ScaleFreeSim_test, ripple::test::csf::Validations_test, ripple::test::ClosureCounter_test, ripple::Config_test, ripple::test::Coroutine_test, ripple::test::JobQueue_test, ripple::SociDB_test, ripple::Workers_test, ripple::test::BasicNetwork_test, ripple::test::Digraph_test, ripple::test::Histogram_test, ripple::test::Scheduler_test, Json::JsonObject_test, ripple::test::Env_test, ripple::test::WSClient_test, ripple::test::BookDirs_test, ripple::test::Directory_test, ripple::test::PaymentSandbox_test, ripple::test::PendingSaves_test, ripple::test::SkipList_test, ripple::test::View_test, ripple::test::GetAmendments_test, ripple::NodeStore::Backend_test, ripple::NodeStore::NodeStoreBasic_test, ripple::NodeStore::Database_test, ripple::NodeStore::NuDBFactory_test, ripple::NodeStore::Timing_test, ripple::NodeStore::tests::varint_test, ripple::tests::cluster_test, ripple::test::compression_test, ripple::test::handshake_test, ripple::ProtocolVersion_test, ripple::test::reduce_relay_test, ripple::test::reduce_relay_simulate_test, ripple::short_read_test, ripple::test::traffic_count_test, ripple::test::tx_reduce_relay_test, ripple::PeerFinder::Livecache_test, ripple::PeerFinder::PeerFinder_test, ripple::test::ApiVersion_test, ripple::BuildInfo_test, ripple::Hooks_test, ripple::InnerObjectFormatsParsedJSON_test, ripple::Issue_test, ripple::Memo_test, ripple::test::MultiApiJson_test, ripple::PublicKey_test, ripple::Quality_test, ripple::SecretKey_test, ripple::Seed_test, ripple::SeqProxy_test, ripple::Serializer_test, ripple::STAccount_test, ripple::STAmount_test, ripple::STInteger_test, ripple::test::STIssue_test, ripple::STNumber_test, ripple::STObject_test, ripple::STParsedJSON_test, ripple::STTx_test, ripple::InnerObjectFormatsSerializer_test, ripple::STValidation_test, ripple::TER_test, ripple::Resource::ResourceManager_test, ripple::AccountCurrencies_test, ripple::test::AccountInfo_test, ripple::RPC::AccountLines_test, ripple::test::AccountObjects_test, ripple::test::AccountOffers_test, ripple::AccountSet_test, ripple::test::AccountTx_test, ripple::AmendmentBlocked_test, ripple::test::AMMInfo_test, ripple::test::Book_test, ripple::test::BookChanges_test, ripple::Connect_test, ripple::test::DeliveredAmount_test, ripple::test::DepositAuthorized_test, ripple::Feature_test, ripple::test::GatewayBalances_test, ripple::test::jtx::oracle::GetAggregatePrice_test, ripple::GetCounts_test, ripple::test::Handler_test, ripple::RPC::JSONRPC_test, ripple::RPC::WalletPropose_test, ripple::LedgerClosed_test, ripple::LedgerData_test, ripple::test::LedgerEntry_test, ripple::test::LedgerEntry_XChain_test, ripple::LedgerHeader_test, ripple::RPC::LedgerRequestRPC_test, ripple::test::LedgerRPC_test, ripple::test::ManifestRPC_test, ripple::test::NoRipple_test, ripple::NoRippleCheck_test, ripple::NoRippleCheckLimits_test, ripple::OwnerInfo_test, ripple::Peers_test, ripple::test::RobustTransaction_test, ripple::test::Roles_test, ripple::test::RPCCall_test, ripple::test::RPCHelpers_test, ripple::test::RPCOverload_test, ripple::test::ServerDefinitions_test, ripple::test::ServerInfo_test, ripple::test::Simulate_test, ripple::RPC::codeString_test, ripple::RPC::fillJson_test, ripple::test::Subscribe_test, ripple::Transaction_test, ripple::TransactionEntry_test, ripple::TransactionHistory_test, ripple::test::ValidatorInfo_test, ripple::test::ValidatorRPC_test, ripple::Version_test, ripple::test::Server_test, ripple::test::ServerStatus_test, ripple::tests::FetchPack_test, ripple::tests::SHAMap_test, ripple::tests::SHAMapPathProof_test, and ripple::tests::SHAMapSync_test.

run() [2/2]

template<class >

void beast::unit_test::suite::run ( runner &  r )

privateinherited

Definition at line 544 of file suite.h.

propagate_abort()

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

privateinherited

Definition at line 536 of file suite.h.

Member Data Documentation

gw

jtx::Account const ripple::test::jtx::AMMTestBase::gw

protected

Definition at line 56 of file AMMTest.h.

carol

jtx::Account const ripple::test::jtx::AMMTestBase::carol

protected

Definition at line 57 of file AMMTest.h.

alice

jtx::Account const ripple::test::jtx::AMMTestBase::alice

protected

Definition at line 58 of file AMMTest.h.

bob

jtx::Account const ripple::test::jtx::AMMTestBase::bob

protected

Definition at line 59 of file AMMTest.h.

USD

jtx::IOU const ripple::test::jtx::AMMTestBase::USD

protected

Definition at line 60 of file AMMTest.h.

EUR

jtx::IOU const ripple::test::jtx::AMMTestBase::EUR

protected

Definition at line 61 of file AMMTest.h.

GBP

jtx::IOU const ripple::test::jtx::AMMTestBase::GBP

protected

Definition at line 62 of file AMMTest.h.

BTC

jtx::IOU const ripple::test::jtx::AMMTestBase::BTC

protected

Definition at line 63 of file AMMTest.h.

BAD

jtx::IOU const ripple::test::jtx::AMMTestBase::BAD

protected

Definition at line 64 of file AMMTest.h.

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

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

testcase

testcase_t beast::unit_test::suite::testcase

inherited

Memberspace for declaring test cases.

Definition at line 152 of file suite.h.