-
Notifications
You must be signed in to change notification settings - Fork 37.7k
test: move remaining rand code from util/setup_common to util/random #27425
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
test: move remaining rand code from util/setup_common to util/random #27425
Conversation
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ReviewsSee the guideline for information on the review process.
If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update. ConflictsReviewers, this pull request conflicts with the following ones:
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first. |
885131b
to
a09d4da
Compare
a09d4da
to
e5ceea2
Compare
e5ceea2
to
87d6815
Compare
Rebased 🧸 |
87d6815
to
bd603b2
Compare
Rebased for #27571 🥈 |
bd603b2
to
37311c5
Compare
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.
37311c5
to
5b3f6a4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK 5b3f6a4
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm ACK 5b3f6a4 🐤
Show signature
Signature:
untrusted comment: signature from minisign secret key on empty file; verify via: minisign -Vm "${path_to_any_empty_file}" -P RWTRmVTMeKV5noAMqVlsMugDDCyyTSbA3Re5AkUrhvLVln0tSaFWglOw -x "${path_to_this_whole_four_line_signature_blob}"
RUTRmVTMeKV5npGrKx1nqXCw5zeVHdtdYURB/KlyA/LMFgpNCs+SkW9a8N95d+U4AP1RJMi+krxU1A3Yux4bpwZNLvVBKy0wLgM=
trusted comment: lgtm ACK 5b3f6a49e6bda9f5a0ec261f3f8900e4978e3a1a 🐤
k4A0LHgzRSaeUvevA32BFKquOk+TGvs29Fj2AaHxo7IZjbAcyB7HCFnFuHrRSndSwn4fOQbjKCqKLJJqlSAEAw==
5b3f6a4
to
26cb565
Compare
Thank you for the reviews @TheCharlatan and @MarcoFalke. Updated the name of the new helper and removed the static annotations per #27425 (comment), should be trivial to re-ACK. |
26cb565
to
1cd45d4
Compare
Dropped the three commits relating to the test helpers per discussion at #27425 (comment). The remaining changes were ACKed above. |
lgtm ACK 1cd45d4 🌂 Show signatureSignature:
|
My suggestion, for future reference: commit bfaa758ca1e690ad6d2ea34b0213f7aedc2645bb
Author: MarcoFalke <*~=`'#}+{/-|&$^_@721217.xyz>
Date: Wed Jul 19 12:41:00 2023 +0200
scripted-diff: Rename global test random context to g_mock_rand
Instead of calling it "insecure", clarify that it is mocked, so that
test failures due to the seed are hopefully more obviously attributed to
it.
-BEGIN VERIFY SCRIPT-
sed -i 's/g_insecure_rand_ctx/g_mock_rand/g' $( git grep -l g_insecure_rand_ctx ./src )
-END VERIFY SCRIPT-
diff --git a/src/test/base58_tests.cpp b/src/test/base58_tests.cpp
index 7f3ca6bf93..0a72c82a59 100644
--- a/src/test/base58_tests.cpp
+++ b/src/test/base58_tests.cpp
@@ -86,7 +86,7 @@ BOOST_AUTO_TEST_CASE(base58_random_encode_decode)
for (int n = 0; n < 1000; ++n) {
unsigned int len = 1 + InsecureRandBits(8);
unsigned int zeroes = InsecureRandBool() ? InsecureRandRange(len + 1) : 0;
- auto data = Cat(std::vector<unsigned char>(zeroes, '\000'), g_insecure_rand_ctx.randbytes(len - zeroes));
+ auto data = Cat(std::vector<unsigned char>(zeroes, '\000'), g_mock_rand.randbytes(len - zeroes));
auto encoded = EncodeBase58Check(data);
std::vector<unsigned char> decoded;
auto ok_too_small = DecodeBase58Check(encoded, decoded, InsecureRandRange(len));
diff --git a/src/test/crypto_tests.cpp b/src/test/crypto_tests.cpp
index 8332f54591..dc19252d3b 100644
--- a/src/test/crypto_tests.cpp
+++ b/src/test/crypto_tests.cpp
@@ -1119,7 +1119,7 @@ BOOST_AUTO_TEST_CASE(muhash_tests)
uint256 res;
int table[4];
for (int i = 0; i < 4; ++i) {
- table[i] = g_insecure_rand_ctx.randbits(3);
+ table[i] = g_mock_rand.randbits(3);
}
for (int order = 0; order < 4; ++order) {
MuHash3072 acc;
@@ -1139,8 +1139,8 @@ BOOST_AUTO_TEST_CASE(muhash_tests)
}
}
- MuHash3072 x = FromInt(g_insecure_rand_ctx.randbits(4)); // x=X
- MuHash3072 y = FromInt(g_insecure_rand_ctx.randbits(4)); // x=X, y=Y
+ MuHash3072 x = FromInt(g_mock_rand.randbits(4)); // x=X
+ MuHash3072 y = FromInt(g_mock_rand.randbits(4)); // x=X, y=Y
MuHash3072 z; // x=X, y=Y, z=1
z *= x; // x=X, y=Y, z=X
z *= y; // x=X, y=Y, z=X*Y
diff --git a/src/test/denialofservice_tests.cpp b/src/test/denialofservice_tests.cpp
index 13349329ff..3052bd65f4 100644
--- a/src/test/denialofservice_tests.cpp
+++ b/src/test/denialofservice_tests.cpp
@@ -109,7 +109,7 @@ BOOST_AUTO_TEST_CASE(outbound_slow_chain_eviction)
static void AddRandomOutboundPeer(NodeId& id, std::vector<CNode*>& vNodes, PeerManager& peerLogic, ConnmanTestMsg& connman, ConnectionType connType)
{
- CAddress addr(ip(g_insecure_rand_ctx.randbits(32)), NODE_NONE);
+ CAddress addr(ip(g_mock_rand.randbits(32)), NODE_NONE);
vNodes.emplace_back(new CNode{id++,
/*sock=*/nullptr,
addr,
diff --git a/src/test/miniscript_tests.cpp b/src/test/miniscript_tests.cpp
index 9c811db3e9..561ba4f2ce 100644
--- a/src/test/miniscript_tests.cpp
+++ b/src/test/miniscript_tests.cpp
@@ -277,7 +277,7 @@ void TestSatisfy(const std::string& testcase, const NodeRef& node) {
auto challenges = FindChallenges(node); // Find all challenges in the generated miniscript.
std::vector<Challenge> challist(challenges.begin(), challenges.end());
for (int iter = 0; iter < 3; ++iter) {
- Shuffle(challist.begin(), challist.end(), g_insecure_rand_ctx);
+ Shuffle(challist.begin(), challist.end(), g_mock_rand);
Satisfier satisfier;
TestSignatureChecker checker(satisfier);
bool prev_mal_success = false, prev_nonmal_success = false;
diff --git a/src/test/orphanage_tests.cpp b/src/test/orphanage_tests.cpp
index a2c4774338..ce406592a0 100644
--- a/src/test/orphanage_tests.cpp
+++ b/src/test/orphanage_tests.cpp
@@ -41,7 +41,7 @@ public:
static void MakeNewKeyWithFastRandomContext(CKey& key)
{
std::vector<unsigned char> keydata;
- keydata = g_insecure_rand_ctx.randbytes(32);
+ keydata = g_mock_rand.randbytes(32);
key.Set(keydata.data(), keydata.data() + keydata.size(), /*fCompressedIn=*/true);
assert(key.IsValid());
}
@@ -54,7 +54,7 @@ BOOST_AUTO_TEST_CASE(DoS_mapOrphans)
// ecdsa_signature_parse_der_lax are executed during this test.
// Specifically branches that run only when an ECDSA
// signature's R and S values have leading zeros.
- g_insecure_rand_ctx = FastRandomContext{uint256{33}};
+ g_mock_rand = FastRandomContext{uint256{33}};
TxOrphanageTest orphanage;
CKey key;
diff --git a/src/test/txrequest_tests.cpp b/src/test/txrequest_tests.cpp
index dc257a0d51..e946e8675c 100644
--- a/src/test/txrequest_tests.cpp
+++ b/src/test/txrequest_tests.cpp
@@ -392,7 +392,7 @@ void BuildBigPriorityTest(Scenario& scenario, int peers)
// Determine the announcement order randomly.
std::vector<NodeId> announce_order = request_order;
- Shuffle(announce_order.begin(), announce_order.end(), g_insecure_rand_ctx);
+ Shuffle(announce_order.begin(), announce_order.end(), g_mock_rand);
// Find a gtxid whose txhash prioritization is consistent with the required ordering within pref_peers and
// within npref_peers.
@@ -697,7 +697,7 @@ void TestInterleavedScenarios()
builders.emplace_back([](Scenario& scenario){ BuildWeirdRequestsTest(scenario); });
}
// Randomly shuffle all those functions.
- Shuffle(builders.begin(), builders.end(), g_insecure_rand_ctx);
+ Shuffle(builders.begin(), builders.end(), g_mock_rand);
Runner runner;
auto starttime = RandomTime1y();
diff --git a/src/test/util/random.cpp b/src/test/util/random.cpp
index 4c87ab8df8..fbc0a75c37 100644
--- a/src/test/util/random.cpp
+++ b/src/test/util/random.cpp
@@ -11,7 +11,7 @@
#include <cstdlib>
#include <string>
-FastRandomContext g_insecure_rand_ctx;
+FastRandomContext g_mock_rand;
/** Return the unsigned from the environment var if available, otherwise 0 */
static uint256 GetUintFromEnv(const std::string& env_name)
diff --git a/src/test/util/random.h b/src/test/util/random.h
index c910bd6a3a..25871101c5 100644
--- a/src/test/util/random.h
+++ b/src/test/util/random.h
@@ -18,7 +18,7 @@
* 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;
+extern FastRandomContext g_mock_rand;
/**
* Flag to make GetRand in random.h return the same number
@@ -36,35 +36,35 @@ void Seed(FastRandomContext& ctx);
static inline void SeedInsecureRand(SeedRand seed = SeedRand::SEED)
{
if (seed == SeedRand::ZEROS) {
- g_insecure_rand_ctx = FastRandomContext(/*fDeterministic=*/true);
+ g_mock_rand = FastRandomContext(/*fDeterministic=*/true);
} else {
- Seed(g_insecure_rand_ctx);
+ Seed(g_mock_rand);
}
}
static inline uint32_t InsecureRand32()
{
- return g_insecure_rand_ctx.rand32();
+ return g_mock_rand.rand32();
}
static inline uint256 InsecureRand256()
{
- return g_insecure_rand_ctx.rand256();
+ return g_mock_rand.rand256();
}
static inline uint64_t InsecureRandBits(int bits)
{
- return g_insecure_rand_ctx.randbits(bits);
+ return g_mock_rand.randbits(bits);
}
static inline uint64_t InsecureRandRange(uint64_t range)
{
- return g_insecure_rand_ctx.randrange(range);
+ return g_mock_rand.randrange(range);
}
static inline bool InsecureRandBool()
{
- return g_insecure_rand_ctx.randbool();
+ return g_mock_rand.randbool();
}
static inline CAmount InsecureRandMoneyAmount()
diff --git a/src/test/util/setup_common.cpp b/src/test/util/setup_common.cpp
index 6ae2187974..8603ab2554 100644
--- a/src/test/util/setup_common.cpp
+++ b/src/test/util/setup_common.cpp
@@ -75,8 +75,8 @@ using node::VerifyLoadedChainstate;
const std::function<std::string(const char*)> G_TRANSLATION_FUN = nullptr;
UrlDecodeFn* const URL_DECODE = nullptr;
-/** Random context to get unique temp data dirs. Separate from g_insecure_rand_ctx, which can be seeded from a const env var */
-static FastRandomContext g_insecure_rand_ctx_temp_path;
+/** Random context to get unique temp data dirs. Separate from g_mock_rand, which can be seeded from a const env var */
+static FastRandomContext g_mock_rand_temp_path;
std::ostream& operator<<(std::ostream& os, const uint256& num)
{
@@ -85,7 +85,7 @@ std::ostream& operator<<(std::ostream& os, const uint256& num)
}
BasicTestingSetup::BasicTestingSetup(const ChainType chainType, const std::vector<const char*>& extra_args)
- : m_path_root{fs::temp_directory_path() / "test_common_" PACKAGE_NAME / g_insecure_rand_ctx_temp_path.rand256().ToString()},
+ : m_path_root{fs::temp_directory_path() / "test_common_" PACKAGE_NAME / g_mock_rand_temp_path.rand256().ToString()},
m_args{}
{
m_node.args = &gArgs;
@@ -441,7 +441,7 @@ void TestChain100Setup::MockMempoolMinFee(const CFeeRate& target_feerate)
// Manually create an invalid transaction. Manually set the fee in the CTxMemPoolEntry to
// achieve the exact target feerate.
CMutableTransaction mtx = CMutableTransaction();
- mtx.vin.push_back(CTxIn{COutPoint{g_insecure_rand_ctx.rand256(), 0}});
+ mtx.vin.push_back(CTxIn{COutPoint{g_mock_rand.rand256(), 0}});
mtx.vout.push_back(CTxOut(1 * COIN, GetScriptForDestination(WitnessV0ScriptHash(CScript() << OP_TRUE))));
const auto tx{MakeTransactionRef(mtx)};
LockPoints lp;
diff --git a/src/wallet/test/wallet_tests.cpp b/src/wallet/test/wallet_tests.cpp
index dd914f159c..aeed8f7814 100644
--- a/src/wallet/test/wallet_tests.cpp
+++ b/src/wallet/test/wallet_tests.cpp
@@ -943,7 +943,7 @@ BOOST_FIXTURE_TEST_CASE(wallet_sync_tx_invalid_state_test, TestingSetup)
CMutableTransaction mtx;
mtx.vout.push_back({COIN, GetScriptForDestination(op_dest)});
- mtx.vin.push_back(CTxIn(g_insecure_rand_ctx.rand256(), 0));
+ mtx.vin.push_back(CTxIn(g_mock_rand.rand256(), 0));
const auto& tx_id_to_spend = wallet.AddToWallet(MakeTransactionRef(mtx), TxStateInMempool{})->GetHash();
{ |
Thank you, will have a look. |
Summary: as many of the unit tests don't use this code This is a backport of [[bitcoin/bitcoin#26940 | core#26940]] (partial) and [[bitcoin/bitcoin#27425 | core#27425]] bitcoin/bitcoin@81f5ade This is a depency of [[bitcoin/bitcoin#25325 | core#25325]] Test Plan: `ninja check` Reviewers: #bitcoin_abc, Fabien Reviewed By: #bitcoin_abc, Fabien Differential Revision: https://reviews.bitcoinabc.org/D16155
and drop the
util/random
dependency onutil/setup_common
. This improves code separation and allowsutil/setup_common
to callutil/random
functions without creating a circular dependency, thereby addressing #26940 (comment) by glozow (thanks!)