foster/bitcoin-bitcoin-core
0
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-02-24 12:41:41 -05:00
Code Issues Activity
bitcoin-bitcoin-core/src/test/util/random.h

29 lines
871 B
C
Raw Normal View History

test: refactor: Accept any RandomNumberGenerator in RandMoney Accepting any Rng in RandMoney makes tests more flexible to use a different Rng. Also, passing in the Rng clarifies the call sites, so that they all use g_rand_ctx explicitly and consistently.
2024-08-02 12:30:13 +02:00
// Copyright (c) 2023-present The Bitcoin Core developers
Move random test util code from setup_common to random as many of the unit tests don't use this code
2023-01-22 09:57:19 -08:00
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
#ifndef BITCOIN_TEST_UTIL_RANDOM_H
#define BITCOIN_TEST_UTIL_RANDOM_H
Create InsecureRandMoneyAmount() test util helper to generate semi-random CAmounts up to MAX_MONEY rather than only uint32, and use it in the unit tests.
2023-01-20 11:05:09 -08:00
#include <consensus/amount.h>
Move random test util code from setup_common to random as many of the unit tests don't use this code
2023-01-22 09:57:19 -08:00
#include <random.h>
#include <uint256.h>
#include <cstdint>
test: move remaining random test util code from setup_common to random and drop the util/random dependency on util/setup_common. This improves code separation and avoids creating a circular dependency if setup_common needs to call the util/random functions.
2023-01-22 09:57:19 -08:00
enum class SeedRand {
ZEROS, //!< Seed with a compile time constant of zeros
tests: overhaul deterministic test randomness The existing code provides two randomness mechanisms for test purposes: - g_insecure_rand_ctx (with its wrappers InsecureRand*), which during tests is initialized using either zeros (SeedRand::ZEROS), or using environment-provided randomness (SeedRand::SEED). - g_mock_deterministic_tests, which controls some (but not all) of the normal randomness output if set, but then makes it extremely predictable (identical output repeatedly). Replace this with a single mechanism, which retains the SeedRand modes to control all randomness. There is a new internal deterministic PRNG inside the random module, which is used in GetRandBytes() when in test mode, and which is also used to initialize g_insecure_rand_ctx. This means that during tests, all random numbers are made deterministic. There is one exception, GetStrongRandBytes(), which even in test mode still uses the normal PRNG state. This probably opens the door to removing a lot of the ad-hoc "deterministic" mode functions littered through the codebase (by simply running relevant tests in SeedRand::ZEROS mode), but this isn't done yet.
2024-03-10 19:49:42 -04:00
SEED, //!< Use (and report) random seed from environment, or a (truly) random one.
test: move remaining random test util code from setup_common to random and drop the util/random dependency on util/setup_common. This improves code separation and avoids creating a circular dependency if setup_common needs to call the util/random functions.
2023-01-22 09:57:19 -08:00
};
test: refactor: Move g_insecure_rand_ctx.Reseed out of the helper that calls MakeRandDeterministicDANGEROUS The global g_insecure_rand_ctx will be removed in the future, so removing it from this helper is useful. Also, tying the two concepts of the global internal RNGState and the global test-only rng context is a bit confusing, because tests can simply use the m_rng, if it exists. Also, tests may seed more than one random context, or none at all, or a random context of a different type. Fix all issues by moving the Reseed call to the two places where it is used.
2024-08-16 11:02:54 +02:00
/** Seed the global RNG state for testing and log the seed value. This affects all randomness, except GetStrongRandBytes(). */
void SeedRandomStateForTest(SeedRand seed);
test: move remaining random test util code from setup_common to random and drop the util/random dependency on util/setup_common. This improves code separation and avoids creating a circular dependency if setup_common needs to call the util/random functions.
2023-01-22 09:57:19 -08:00
test: refactor: Accept any RandomNumberGenerator in RandMoney Accepting any Rng in RandMoney makes tests more flexible to use a different Rng. Also, passing in the Rng clarifies the call sites, so that they all use g_rand_ctx explicitly and consistently.
2024-08-02 12:30:13 +02:00
template <RandomNumberGenerator Rng>
inline CAmount RandMoney(Rng&& rng)
Create InsecureRandMoneyAmount() test util helper to generate semi-random CAmounts up to MAX_MONEY rather than only uint32, and use it in the unit tests.
2023-01-20 11:05:09 -08:00
{
test: refactor: Accept any RandomNumberGenerator in RandMoney Accepting any Rng in RandMoney makes tests more flexible to use a different Rng. Also, passing in the Rng clarifies the call sites, so that they all use g_rand_ctx explicitly and consistently.
2024-08-02 12:30:13 +02:00
return CAmount{rng.randrange(MAX_MONEY + 1)};
Create InsecureRandMoneyAmount() test util helper to generate semi-random CAmounts up to MAX_MONEY rather than only uint32, and use it in the unit tests.
2023-01-20 11:05:09 -08:00
}
Move random test util code from setup_common to random as many of the unit tests don't use this code
2023-01-22 09:57:19 -08:00
#endif // BITCOIN_TEST_UTIL_RANDOM_H
Copy permalink