Branch data Line data Source code
1 : : // Copyright (c) 2015-present The Bitcoin Core developers
2 : : // Distributed under the MIT software license, see the accompanying
3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 : :
5 : : #ifndef BITCOIN_TEST_UTIL_SETUP_COMMON_H
6 : : #define BITCOIN_TEST_UTIL_SETUP_COMMON_H
7 : :
8 : : #include <common/args.h> // IWYU pragma: export
9 : : #include <kernel/caches.h>
10 : : #include <kernel/context.h>
11 : : #include <key.h>
12 : : #include <node/caches.h>
13 : : #include <node/context.h> // IWYU pragma: export
14 : : #include <optional>
15 : : #include <ostream>
16 : : #include <primitives/transaction.h>
17 : : #include <pubkey.h>
18 : : #include <stdexcept>
19 : : #include <test/util/random.h>
20 : : #include <util/chaintype.h> // IWYU pragma: export
21 : : #include <util/check.h>
22 : : #include <util/fs.h>
23 : : #include <util/signalinterrupt.h>
24 : : #include <util/string.h>
25 : : #include <util/vector.h>
26 : :
27 : : #include <functional>
28 : : #include <type_traits>
29 : : #include <vector>
30 : :
31 : : class arith_uint256;
32 : : class CFeeRate;
33 : : class Chainstate;
34 : : class FastRandomContext;
35 : : class uint160;
36 : : class uint256;
37 : :
38 : : /** This is connected to the logger. Can be used to redirect logs to any other log */
39 : : extern const std::function<void(const std::string&)> G_TEST_LOG_FUN;
40 : :
41 : : /** Retrieve the command line arguments. */
42 : : extern const std::function<std::vector<const char*>()> G_TEST_COMMAND_LINE_ARGUMENTS;
43 : :
44 : : /** Retrieve the unit test name. */
45 : : extern const std::function<std::string()> G_TEST_GET_FULL_NAME;
46 : :
47 : : static constexpr CAmount CENT{1000000};
48 : :
49 : : /** Register common test args. Shared across binaries that rely on the test framework. */
50 : : void SetupCommonTestArgs(ArgsManager& argsman);
51 : :
52 [ + - + - : 833 : struct TestOpts {
+ - + - ]
[ + - ]
53 : : std::vector<const char*> extra_args{};
54 : : bool coins_db_in_memory{true};
55 : : bool block_tree_db_in_memory{true};
56 : : bool setup_net{true};
57 : : bool setup_validation_interface{true};
58 : : bool min_validation_cache{false}; // Equivalent of -maxsigcachebytes=0
59 : : };
60 : :
61 : : /** Basic testing setup.
62 : : * This just configures logging, data dir and chain parameters.
63 : : */
64 : : struct BasicTestingSetup {
65 : : util::SignalInterrupt m_interrupt;
66 : : node::NodeContext m_node; // keep as first member to be destructed last
67 : :
68 : : FastRandomContext m_rng;
69 : : /** Seed the global RNG state and m_rng for testing and log the seed value. This affects all randomness, except GetStrongRandBytes(). */
70 : 621 : void SeedRandomForTest(SeedRand seed)
71 : : {
72 : 621 : SeedRandomStateForTest(seed);
73 : 621 : m_rng.Reseed(GetRandHash());
74 : 621 : }
75 : :
76 : : explicit BasicTestingSetup(const ChainType chainType = ChainType::MAIN, TestOpts = {});
77 : : ~BasicTestingSetup();
78 : :
79 : : fs::path m_path_root;
80 : : fs::path m_path_lock;
81 : : bool m_has_custom_datadir{false};
82 : : /** @brief Test-specific arguments and settings.
83 : : *
84 : : * This member is intended to be the primary source of settings for code
85 : : * being tested by unit tests. It exists to make tests more self-contained
86 : : * and reduce reliance on global state.
87 : : *
88 : : * Usage guidelines:
89 : : * 1. Prefer using m_args where possible in test code.
90 : : * 2. If m_args is not accessible, use m_node.args as a fallback.
91 : : * 3. Avoid direct references to gArgs in test code.
92 : : *
93 : : * Note: Currently, m_node.args points to gArgs for backwards
94 : : * compatibility. In the future, it will point to m_args to further isolate
95 : : * test environments.
96 : : *
97 : : * @see https://github.com/bitcoin/bitcoin/issues/25055 for additional context.
98 : : */
99 : : ArgsManager m_args;
100 : : };
101 : :
102 : : /** Testing setup that performs all steps up until right before
103 : : * ChainstateManager gets initialized. Meant for testing ChainstateManager
104 : : * initialization behaviour.
105 : : */
106 : : struct ChainTestingSetup : public BasicTestingSetup {
107 : : kernel::CacheSizes m_kernel_cache_sizes{node::CalculateCacheSizes(m_args).kernel};
108 : : bool m_coins_db_in_memory{true};
109 : : bool m_block_tree_db_in_memory{true};
110 : : std::function<void()> m_make_chainman{};
111 : :
112 : : explicit ChainTestingSetup(const ChainType chainType = ChainType::MAIN, TestOpts = {});
113 : : ~ChainTestingSetup();
114 : :
115 : : // Supplies a chainstate, if one is needed
116 : : void LoadVerifyActivateChainstate();
117 : : };
118 : :
119 : : /** Testing setup that configures a complete environment.
120 : : */
121 : 144 : struct TestingSetup : public ChainTestingSetup {
122 : : explicit TestingSetup(
123 : : const ChainType chainType = ChainType::MAIN,
124 : : TestOpts = {});
125 : : };
126 : :
127 : : /** Identical to TestingSetup, but chain set to regtest */
128 : 31 : struct RegTestingSetup : public TestingSetup {
129 : 31 : RegTestingSetup()
130 [ + - ]: 62 : : TestingSetup{ChainType::REGTEST} {}
131 : : };
132 : :
133 : : class CBlock;
134 : : struct CMutableTransaction;
135 : : class CScript;
136 : :
137 : : /**
138 : : * Testing fixture that pre-creates a 100-block REGTEST-mode block chain
139 : : */
140 : : struct TestChain100Setup : public TestingSetup {
141 : : TestChain100Setup(
142 : : const ChainType chain_type = ChainType::REGTEST,
143 : : TestOpts = {});
144 : :
145 : : /**
146 : : * Create a new block with just given transactions, coinbase paying to
147 : : * scriptPubKey, and try to add it to the current chain.
148 : : * If no chainstate is specified, default to the active.
149 : : */
150 : : CBlock CreateAndProcessBlock(const std::vector<CMutableTransaction>& txns,
151 : : const CScript& scriptPubKey,
152 : : Chainstate* chainstate = nullptr);
153 : :
154 : : /**
155 : : * Create a new block with just given transactions, coinbase paying to
156 : : * scriptPubKey.
157 : : */
158 : : CBlock CreateBlock(
159 : : const std::vector<CMutableTransaction>& txns,
160 : : const CScript& scriptPubKey,
161 : : Chainstate& chainstate);
162 : :
163 : : //! Mine a series of new blocks on the active chain.
164 : : void mineBlocks(int num_blocks);
165 : :
166 : : /**
167 : : * Create a transaction, optionally setting the fee based on the feerate.
168 : : * Note: The feerate may not be met exactly depending on whether the signatures can have different sizes.
169 : : *
170 : : * @param input_transactions The transactions to spend
171 : : * @param inputs Outpoints with which to construct transaction vin.
172 : : * @param input_height The height of the block that included the input transactions.
173 : : * @param input_signing_keys The keys to spend the input transactions.
174 : : * @param outputs Transaction vout.
175 : : * @param feerate The feerate the transaction should pay.
176 : : * @param fee_output The index of the output to take the fee from.
177 : : * @return The transaction and the fee it pays
178 : : */
179 : : std::pair<CMutableTransaction, CAmount> CreateValidTransaction(const std::vector<CTransactionRef>& input_transactions,
180 : : const std::vector<COutPoint>& inputs,
181 : : int input_height,
182 : : const std::vector<CKey>& input_signing_keys,
183 : : const std::vector<CTxOut>& outputs,
184 : : const std::optional<CFeeRate>& feerate,
185 : : const std::optional<uint32_t>& fee_output);
186 : : /**
187 : : * Create a transaction and, optionally, submit to the mempool.
188 : : *
189 : : * @param input_transactions The transactions to spend
190 : : * @param inputs Outpoints with which to construct transaction vin.
191 : : * @param input_height The height of the block that included the input transaction(s).
192 : : * @param input_signing_keys The keys to spend inputs.
193 : : * @param outputs Transaction vout.
194 : : * @param submit Whether or not to submit to mempool
195 : : */
196 : : CMutableTransaction CreateValidMempoolTransaction(const std::vector<CTransactionRef>& input_transactions,
197 : : const std::vector<COutPoint>& inputs,
198 : : int input_height,
199 : : const std::vector<CKey>& input_signing_keys,
200 : : const std::vector<CTxOut>& outputs,
201 : : bool submit = true);
202 : :
203 : : /**
204 : : * Create a 1-in-1-out transaction and, optionally, submit to the mempool.
205 : : *
206 : : * @param input_transaction The transaction to spend
207 : : * @param input_vout The vout to spend from the input_transaction
208 : : * @param input_height The height of the block that included the input_transaction
209 : : * @param input_signing_key The key to spend the input_transaction
210 : : * @param output_destination Where to send the output
211 : : * @param output_amount How much to send
212 : : * @param submit Whether or not to submit to mempool
213 : : */
214 : : CMutableTransaction CreateValidMempoolTransaction(CTransactionRef input_transaction,
215 : : uint32_t input_vout,
216 : : int input_height,
217 : : CKey input_signing_key,
218 : : CScript output_destination,
219 : : CAmount output_amount = CAmount(1 * COIN),
220 : : bool submit = true);
221 : :
222 : : /** Create transactions spending from m_coinbase_txns. These transactions will only spend coins
223 : : * that exist in the current chain, but may be premature coinbase spends, have missing
224 : : * signatures, or violate some other consensus rules. They should only be used for testing
225 : : * mempool consistency. All transactions will have some random number of inputs and outputs
226 : : * (between 1 and 24). Transactions may or may not be dependent upon each other; if dependencies
227 : : * exit, every parent will always be somewhere in the list before the child so each transaction
228 : : * can be submitted in the same order they appear in the list.
229 : : * @param[in] submit When true, submit transactions to the mempool.
230 : : * When false, return them but don't submit them.
231 : : * @returns A vector of transactions that can be submitted to the mempool.
232 : : */
233 : : std::vector<CTransactionRef> PopulateMempool(FastRandomContext& det_rand, size_t num_transactions, bool submit);
234 : :
235 : : /** Mock the mempool minimum feerate by adding a transaction and calling TrimToSize(0),
236 : : * simulating the mempool "reaching capacity" and evicting by descendant feerate. Note that
237 : : * this clears the mempool, and the new minimum feerate will depend on the maximum feerate of
238 : : * transactions removed, so this must be called while the mempool is empty.
239 : : *
240 : : * @param target_feerate The new mempool minimum feerate after this function returns.
241 : : * Must be above max(incremental feerate, min relay feerate),
242 : : * or 1sat/vB with default settings.
243 : : */
244 : : void MockMempoolMinFee(const CFeeRate& target_feerate);
245 : :
246 : : std::vector<CTransactionRef> m_coinbase_txns; // For convenience, coinbase transactions
247 : : CKey coinbaseKey; // private/public key needed to spend coinbase transactions
248 : : };
249 : :
250 : : /**
251 : : * Make a test setup that has disk access to the debug.log file disabled. Can
252 : : * be used in "hot loops", for example fuzzing or benchmarking.
253 : : */
254 : : template <class T = const BasicTestingSetup>
255 : : std::unique_ptr<T> MakeNoLogFileContext(const ChainType chain_type = ChainType::REGTEST, TestOpts opts = {})
256 : : {
257 : : opts.extra_args = Cat(
258 : : {
259 : : "-nodebuglogfile",
260 : : "-nodebug",
261 : : },
262 : : opts.extra_args);
263 : :
264 : : return std::make_unique<T>(chain_type, opts);
265 : : }
266 : :
267 : : CBlock getBlock13b8a();
268 : :
269 : : // Make types usable in BOOST_CHECK_* @{
270 : : namespace std {
271 : : template <typename T> requires std::is_enum_v<T>
272 : 50 : inline std::ostream& operator<<(std::ostream& os, const T& e)
273 : : {
274 [ - - ]: 50 : return os << static_cast<std::underlying_type_t<T>>(e);
275 : : }
276 : :
277 : : template <typename T>
278 [ # # ]: 0 : inline std::ostream& operator<<(std::ostream& os, const std::optional<T>& v)
279 : : {
280 [ # # ]: 0 : return v ? os << *v
281 [ # # ]: 0 : : os << "std::nullopt";
282 : : }
283 : : } // namespace std
284 : :
285 : : std::ostream& operator<<(std::ostream& os, const arith_uint256& num);
286 : : std::ostream& operator<<(std::ostream& os, const uint160& num);
287 : : std::ostream& operator<<(std::ostream& os, const uint256& num);
288 : : // @}
289 : :
290 : : /**
291 : : * BOOST_CHECK_EXCEPTION predicates to check the specific validation error.
292 : : * Use as
293 : : * BOOST_CHECK_EXCEPTION(code that throws, exception type, HasReason("foo"));
294 : : */
295 : 86 : class HasReason
296 : : {
297 : : public:
298 [ + - ][ + - : 86 : explicit HasReason(std::string_view reason) : m_reason(reason) {}
+ - + - +
- + - + -
+ - + - +
- ][ + - +
- - - - -
- - ][ + -
+ - + - +
- + - - -
- - - - -
- ][ + - +
- + - + -
+ - + - +
- + - ][ +
- + - +
- ][ + - +
- + - + -
+ - + - +
- - - ]
299 : 86 : bool operator()(std::string_view s) const { return s.find(m_reason) != std::string_view::npos; }
300 : 54 : bool operator()(const std::exception& e) const { return (*this)(e.what()); }
301 : :
302 : : private:
303 : : const std::string m_reason;
304 : : };
305 : :
306 : : #endif // BITCOIN_TEST_UTIL_SETUP_COMMON_H
|
