diff options
Diffstat (limited to 'src/test/setup_common.h')
-rw-r--r-- | src/test/setup_common.h | 136 |
1 files changed, 136 insertions, 0 deletions
diff --git a/src/test/setup_common.h b/src/test/setup_common.h new file mode 100644 index 0000000000..d902e41124 --- /dev/null +++ b/src/test/setup_common.h @@ -0,0 +1,136 @@ +// Copyright (c) 2015-2018 The Bitcoin Core developers +// Distributed under the MIT software license, see the accompanying +// file COPYING or http://www.opensource.org/licenses/mit-license.php. + +#ifndef BITCOIN_TEST_SETUP_COMMON_H +#define BITCOIN_TEST_SETUP_COMMON_H + +#include <chainparamsbase.h> +#include <fs.h> +#include <key.h> +#include <pubkey.h> +#include <random.h> +#include <scheduler.h> +#include <txdb.h> +#include <txmempool.h> + +#include <memory> +#include <type_traits> + +#include <boost/thread.hpp> + +// Enable BOOST_CHECK_EQUAL for enum class types +template <typename T> +std::ostream& operator<<(typename std::enable_if<std::is_enum<T>::value, std::ostream>::type& stream, const T& e) +{ + return stream << static_cast<typename std::underlying_type<T>::type>(e); +} + +/** + * This global and the helpers that use it are not thread-safe. + * + * If thread-safety is needed, the global could be made thread_local (given + * that thread_local is supported on all architectures we support) or a + * per-thread instance could be used in the multi-threaded test. + */ +extern FastRandomContext g_insecure_rand_ctx; + +/** + * Flag to make GetRand in random.h return the same number + */ +extern bool g_mock_deterministic_tests; + +static inline void SeedInsecureRand(bool deterministic = false) +{ + g_insecure_rand_ctx = FastRandomContext(deterministic); +} + +static inline uint32_t InsecureRand32() { return g_insecure_rand_ctx.rand32(); } +static inline uint256 InsecureRand256() { return g_insecure_rand_ctx.rand256(); } +static inline uint64_t InsecureRandBits(int bits) { return g_insecure_rand_ctx.randbits(bits); } +static inline uint64_t InsecureRandRange(uint64_t range) { return g_insecure_rand_ctx.randrange(range); } +static inline bool InsecureRandBool() { return g_insecure_rand_ctx.randbool(); } + +static constexpr CAmount CENT{1000000}; + +/** Basic testing setup. + * This just configures logging and chain parameters. + */ +struct BasicTestingSetup { + ECCVerifyHandle globalVerifyHandle; + + explicit BasicTestingSetup(const std::string& chainName = CBaseChainParams::MAIN); + ~BasicTestingSetup(); + + fs::path SetDataDir(const std::string& name); + +private: + const fs::path m_path_root; +}; + +/** Testing setup that configures a complete environment. + * Included are data directory, coins database, script check threads setup. + */ +struct TestingSetup : public BasicTestingSetup { + boost::thread_group threadGroup; + CScheduler scheduler; + + explicit TestingSetup(const std::string& chainName = CBaseChainParams::MAIN); + ~TestingSetup(); +}; + +class CBlock; +struct CMutableTransaction; +class CScript; + +// +// Testing fixture that pre-creates a +// 100-block REGTEST-mode block chain +// +struct TestChain100Setup : public TestingSetup { + TestChain100Setup(); + + // Create a new block with just given transactions, coinbase paying to + // scriptPubKey, and try to add it to the current chain. + CBlock CreateAndProcessBlock(const std::vector<CMutableTransaction>& txns, + const CScript& scriptPubKey); + + ~TestChain100Setup(); + + std::vector<CTransactionRef> m_coinbase_txns; // For convenience, coinbase transactions + CKey coinbaseKey; // private/public key needed to spend coinbase transactions +}; + +class CTxMemPoolEntry; + +struct TestMemPoolEntryHelper +{ + // Default values + CAmount nFee; + int64_t nTime; + unsigned int nHeight; + bool spendsCoinbase; + unsigned int sigOpCost; + LockPoints lp; + + TestMemPoolEntryHelper() : + nFee(0), nTime(0), nHeight(1), + spendsCoinbase(false), sigOpCost(4) { } + + CTxMemPoolEntry FromTx(const CMutableTransaction& tx); + CTxMemPoolEntry FromTx(const CTransactionRef& tx); + + // Change the default value + TestMemPoolEntryHelper &Fee(CAmount _fee) { nFee = _fee; return *this; } + TestMemPoolEntryHelper &Time(int64_t _time) { nTime = _time; return *this; } + TestMemPoolEntryHelper &Height(unsigned int _height) { nHeight = _height; return *this; } + TestMemPoolEntryHelper &SpendsCoinbase(bool _flag) { spendsCoinbase = _flag; return *this; } + TestMemPoolEntryHelper &SigOpsCost(unsigned int _sigopsCost) { sigOpCost = _sigopsCost; return *this; } +}; + +CBlock getBlock13b8a(); + +// define an implicit conversion here so that uint256 may be used directly in BOOST_CHECK_* +std::ostream& operator<<(std::ostream& os, const uint256& num); + +#endif |