[Refactoring][BUG] Never change chain-params after setup in unit tests

random-zebra · random-zebra · commit b19bee9885b1 · 2021-05-13T15:23:30.000+02:00
Otherwise the block index would be no longer valid, should be discarded,
and a new genesis block reloaded.
diff --git a/src/test/librust/sapling_test_fixture.cpp b/src/test/librust/sapling_test_fixture.cpp
@@ -5,7 +5,7 @@
 #include "test/librust/sapling_test_fixture.h"
 #include "sapling/sapling_util.h"
 
-SaplingTestingSetup::SaplingTestingSetup() : TestingSetup()
+SaplingTestingSetup::SaplingTestingSetup(const std::string& chainName) : TestingSetup(chainName)
 {
     initZKSNARKS(); // init zk-snarks lib
 }
diff --git a/src/test/librust/sapling_test_fixture.h b/src/test/librust/sapling_test_fixture.h
@@ -10,8 +10,9 @@
 /**
  * Testing setup that configures a complete environment for Sapling testing.
  */
-struct SaplingTestingSetup : public TestingSetup {
-    SaplingTestingSetup();
+struct SaplingTestingSetup : public TestingSetup
+{
+    SaplingTestingSetup(const std::string& chainName = CBaseChainParams::MAIN);
     ~SaplingTestingSetup();
 };
 
diff --git a/src/test/miner_tests.cpp b/src/test/miner_tests.cpp
@@ -17,7 +17,8 @@
 
 #include <boost/test/unit_test.hpp>
 
-BOOST_FIXTURE_TEST_SUITE(miner_tests, WalletTestingSetup)
+// future: this should be MAINNET.
+BOOST_FIXTURE_TEST_SUITE(miner_tests, WalletRegTestingSetup)
 
 // BOOST_CHECK_EXCEPTION predicates to check the specific validation error
 class HasReason {
@@ -73,7 +74,6 @@ struct {
 BOOST_AUTO_TEST_CASE(CreateNewBlock_validity)
 {
     // Note that by default, these tests run with size accounting enabled.
-    SelectParams(CBaseChainParams::REGTEST); // future: this should be MAINNET.
     const CChainParams& chainparams = Params();
     CScript scriptPubKey = CScript() << OP_DUP << OP_HASH160 << ParseHex("8d5b4f83212214d6ef693e02e6d71969fddad976") << OP_EQUALVERIFY << OP_CHECKSIG;
 
diff --git a/src/test/test_pivx.h b/src/test/test_pivx.h
@@ -45,7 +45,8 @@ struct BasicTestingSetup {
  * and wallet (if enabled) setup.
  */
 class CConnman;
-struct TestingSetup: public BasicTestingSetup {
+struct TestingSetup: public BasicTestingSetup
+{
     CCoinsViewDB *pcoinsdbview;
     fs::path pathTemp;
     boost::thread_group threadGroup;
@@ -56,6 +57,11 @@ struct TestingSetup: public BasicTestingSetup {
     ~TestingSetup();
 };
 
+struct RegTestingSetup : public TestingSetup
+{
+    RegTestingSetup() : TestingSetup(CBaseChainParams::REGTEST) {}
+};
+
 class CBlock;
 struct CMutableTransaction;
 class CScript;
@@ -78,13 +84,15 @@ struct TestChainSetup : public TestingSetup
 };
 
 // Testing fixture that pre-creates a 100-block REGTEST-mode blockchain
-struct TestChain100Setup : public TestChainSetup {
+struct TestChain100Setup : public TestChainSetup
+{
     TestChain100Setup() : TestChainSetup(100) {}
 };
 
 // Testing fixture that pre-creates a 400-block REGTEST-mode blockchain
 // all 400 blocks are PoW. PoS starts at height 500
-struct TestChain400Setup : public TestChainSetup {
+struct TestChain400Setup : public TestChainSetup
+{
     TestChain400Setup() : TestChainSetup(400) {}
 };
 
diff --git a/src/test/validation_block_tests.cpp b/src/test/validation_block_tests.cpp
@@ -14,13 +14,11 @@
 #include "validation.h"
 #include "validationinterface.h"
 
+
 #define ASSERT_WITH_MSG(cond, msg) if (!cond) { BOOST_ERROR(msg); }
 
-struct RegtestingSetup : public TestingSetup {
-    RegtestingSetup() : TestingSetup(CBaseChainParams::REGTEST) {}
-};
 
-BOOST_FIXTURE_TEST_SUITE(validation_block_tests, RegtestingSetup)
+BOOST_FIXTURE_TEST_SUITE(validation_block_tests, RegTestingSetup)
 
 struct TestSubscriber : public CValidationInterface {
     uint256 m_expected_tip;
diff --git a/src/test/validation_tests.cpp b/src/test/validation_tests.cpp
@@ -11,9 +11,9 @@
 
 #include <boost/test/unit_test.hpp>
 
-BOOST_FIXTURE_TEST_SUITE(validation_tests, TestingSetup)
+BOOST_AUTO_TEST_SUITE(validation_tests)
 
-BOOST_AUTO_TEST_CASE(test_simple_shielded_invalid)
+BOOST_FIXTURE_TEST_CASE(test_simple_shielded_invalid, TestingSetup)
 {
     CMutableTransaction tx;
     tx.nVersion = CTransaction::TxVersion::SAPLING;
@@ -113,10 +113,11 @@ void CheckMempoolZcRejection(CMutableTransaction& mtx)
     BOOST_CHECK_EQUAL(state.GetRejectReason(), "bad-tx-with-zc");
 }
 
-BOOST_AUTO_TEST_CASE(zerocoin_rejection_tests)
+/*
+ * Running on regtest to have v5 upgrade enforced at block 1 and test in-block zc rejection
+ */
+BOOST_FIXTURE_TEST_CASE(zerocoin_rejection_tests, RegTestingSetup)
 {
-    // !TODO: fix me
-    SelectParams(CBaseChainParams::REGTEST);
     UpdateNetworkUpgradeParameters(Consensus::UPGRADE_V5_0, Consensus::NetworkUpgrade::ALWAYS_ACTIVE);
     const CChainParams& chainparams = Params();
 
diff --git a/src/wallet/test/wallet_test_fixture.cpp b/src/wallet/test/wallet_test_fixture.cpp
@@ -19,7 +19,8 @@ void clean()
     bitdb.Reset();
 }
 
-WalletTestingSetup::WalletTestingSetup(): SaplingTestingSetup()
+WalletTestingSetup::WalletTestingSetup(const std::string& chainName):
+        SaplingTestingSetup(chainName)
 {
     clean(); // todo: research why we have an initialized bitdb here.
     bitdb.MakeMock();
diff --git a/src/wallet/test/wallet_test_fixture.h b/src/wallet/test/wallet_test_fixture.h
@@ -9,10 +9,16 @@
 
 /** Testing setup and teardown for wallet.
  */
-struct WalletTestingSetup : public SaplingTestingSetup {
-    WalletTestingSetup();
+struct WalletTestingSetup : public SaplingTestingSetup
+{
+    WalletTestingSetup(const std::string& chainName = CBaseChainParams::MAIN);
     ~WalletTestingSetup();
 };
 
+struct WalletRegTestingSetup : public WalletTestingSetup
+{
+    WalletRegTestingSetup() : WalletTestingSetup(CBaseChainParams::REGTEST) {}
+};
+
 #endif
 

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`#include "test/librust/sapling_test_fixture.h"`
`6`	`6`	`#include "sapling/sapling_util.h"`
`7`	`7`
`8`		`-SaplingTestingSetup::SaplingTestingSetup() : TestingSetup()`
	`8`	`+SaplingTestingSetup::SaplingTestingSetup(const std::string& chainName) : TestingSetup(chainName)`
`9`	`9`	`{`
`10`	`10`	`initZKSNARKS(); // init zk-snarks lib`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,8 @@ void clean()`
`19`	`19`	`bitdb.Reset();`
`20`	`20`	`}`
`21`	`21`
`22`		`-WalletTestingSetup::WalletTestingSetup(): SaplingTestingSetup()`
	`22`	`+WalletTestingSetup::WalletTestingSetup(const std::string& chainName):`
	`23`	`+ SaplingTestingSetup(chainName)`
`23`	`24`	`{`
`24`	`25`	`clean(); // todo: research why we have an initialized bitdb here.`
`25`	`26`	`bitdb.MakeMock();`