Tests: Use self.chain instead of 'regtest' in all current tests

Summary:
This is a backport of Core [[bitcoin/bitcoin#16681 | PR16681]] and [[bitcoin/bitcoin#18069 | PR18069]]

I also replaced one occurence of 'regtest' in test_framework.py, that was missed in the backport of [[bitcoin/bitcoin#16509 | PR16509]] (D5942)

Test Plan: `ninja && ninja check-functional-extended`

Reviewers: #bitcoin_abc, Fabien

Reviewed By: #bitcoin_abc, Fabien

Differential Revision: https://reviews.bitcoinabc.org/D8738

Author: jtimon

test/functional/feature_abortnode.py

@@ -31,7 +31,7 @@ def run_test(self):
         datadir = get_datadir_path(self.options.tmpdir, 0)
 
         # Deleting the undo file will result in reorg failure
-        os.unlink(os.path.join(datadir, 'regtest', 'blocks', 'rev00000.dat'))
+        os.unlink(os.path.join(datadir, self.chain, 'blocks', 'rev00000.dat'))
 
         # Connecting to a node with a more work chain will trigger a reorg
         # attempt.

test/functional/feature_config_args.py

@@ -41,7 +41,7 @@ def test_config_file_parser(self):
             with open(inc_conf_file_path, 'w', encoding='utf8') as conf:
                 conf.write("wallet=foo\n")
             self.nodes[0].assert_start_raises_init_error(
-                expected_msg='Error: Config setting for -wallet only applied on regtest network when in [regtest] section.')
+                expected_msg='Error: Config setting for -wallet only applied on {} network when in [{}] section.'.format(self.chain, self.chain))
 
         with open(inc_conf_file_path, 'w', encoding='utf-8') as conf:
             conf.write('regtest=0\n')  # mainnet
@@ -108,8 +108,8 @@ def test_args_log(self):
                     'Command-line arg: rpcpassword=****',
                     'Command-line arg: rpcuser=****',
                     'Command-line arg: torpassword=****',
-                    'Config file arg: regtest="1"',
-                    'Config file arg: [regtest] server="1"',
+                    'Config file arg: {}="1"'.format(self.chain),
+                    'Config file arg: [{}] server="1"'.format(self.chain),
                 ],
                 unexpected_msgs=[
                     'alice:f7efda5c189b999524f151318c0c86$d5b51b3beffbc0',
@@ -150,7 +150,7 @@ def run_test(self):
         # Check that using non-existent datadir in conf file fails
         conf_file = os.path.join(default_data_dir, "bitcoin.conf")
 
-        # datadir needs to be set before [regtest] section
+        # datadir needs to be set before [chain] section
         conf_file_contents = open(conf_file, encoding='utf8').read()
         with open(conf_file, 'w', encoding='utf8') as f:
             f.write("datadir=" + new_data_dir + "\n")
@@ -163,10 +163,10 @@ def run_test(self):
         os.mkdir(new_data_dir)
         self.start_node(0, ['-conf=' + conf_file, '-wallet=w1'])
         self.stop_node(0)
-        assert os.path.exists(os.path.join(new_data_dir, 'regtest', 'blocks'))
+        assert os.path.exists(os.path.join(new_data_dir, self.chain, 'blocks'))
         if self.is_wallet_compiled():
             assert os.path.exists(os.path.join(
-                new_data_dir, 'regtest', 'wallets', 'w1'))
+                new_data_dir, self.chain, 'wallets', 'w1'))
 
         # Ensure command line argument overrides datadir in conf
         os.mkdir(new_data_dir_2)
@@ -176,13 +176,13 @@ def run_test(self):
         assert os.path.exists(
             os.path.join(
                 new_data_dir_2,
-                'regtest',
+                self.chain,
                 'blocks'))
         if self.is_wallet_compiled():
             assert os.path.exists(
                 os.path.join(
                     new_data_dir_2,
-                    'regtest',
+                    self.chain,
                     'wallets',
                     'w2'))
 

test/functional/feature_filelock.py

@@ -20,7 +20,7 @@ def setup_network(self):
         self.nodes[0].wait_for_rpc_connection()
 
     def run_test(self):
-        datadir = os.path.join(self.nodes[0].datadir, 'regtest')
+        datadir = os.path.join(self.nodes[0].datadir, self.chain)
         self.log.info("Using datadir {}".format(datadir))
 
         self.log.info(

test/functional/feature_loadblock.py

@@ -36,7 +36,7 @@ def run_test(self):
         cfg_file = os.path.join(data_dir, "linearize.cfg")
         bootstrap_file = os.path.join(self.options.tmpdir, "bootstrap.dat")
         genesis_block = self.nodes[0].getblockhash(0)
-        blocks_dir = os.path.join(data_dir, "regtest", "blocks")
+        blocks_dir = os.path.join(data_dir, self.chain, "blocks")
         hash_list = tempfile.NamedTemporaryFile(dir=data_dir,
                                                 mode='w',
                                                 delete=False,

test/functional/feature_logging.py

@@ -16,7 +16,7 @@ def set_test_params(self):
         self.setup_clean_chain = True
 
     def relative_log_path(self, name):
-        return os.path.join(self.nodes[0].datadir, "regtest", name)
+        return os.path.join(self.nodes[0].datadir, self.chain, name)
 
     def run_test(self):
         # test default log file name

test/functional/feature_pruning.py

@@ -110,7 +110,7 @@ def setup_network(self):
         self.setup_nodes()
 
         self.prunedir = os.path.join(
-            self.nodes[2].datadir, 'regtest', 'blocks', '')
+            self.nodes[2].datadir, self.chain, 'blocks', '')
 
         connect_nodes(self.nodes[0], self.nodes[1])
         connect_nodes(self.nodes[1], self.nodes[2])
@@ -319,7 +319,7 @@ def prune(index):
 
         def has_block(index):
             return os.path.isfile(os.path.join(
-                self.nodes[node_number].datadir, "regtest", "blocks", "blk{:05}.dat".format(index)))
+                self.nodes[node_number].datadir, self.chain, "blocks", "blk{:05}.dat".format(index)))
 
         # should not prune because chain tip of node 3 (995) < PruneAfterHeight
         # (1000)

test/functional/interface_rpc.py

@@ -40,7 +40,7 @@ def test_getrpcinfo(self):
             info['logpath'],
             os.path.join(
                 self.nodes[0].datadir,
-                'regtest',
+                self.chain,
                 'debug.log'))
 
     def test_batch_request(self):

test/functional/mempool_persist.py

@@ -132,9 +132,9 @@ def run_test(self):
         assert_equal(len(self.nodes[0].getrawmempool()), 5)
 
         mempooldat0 = os.path.join(
-            self.nodes[0].datadir, 'regtest', 'mempool.dat')
+            self.nodes[0].datadir, self.chain, 'mempool.dat')
         mempooldat1 = os.path.join(
-            self.nodes[1].datadir, 'regtest', 'mempool.dat')
+            self.nodes[1].datadir, self.chain, 'mempool.dat')
         self.log.debug(
             "Remove the mempool.dat file. Verify that savemempool to disk via RPC re-creates it")
         os.remove(mempooldat0)

test/functional/mining_basic.py

@@ -78,7 +78,7 @@ def assert_submitblock(block, result_str_1, result_str_2=None):
         self.log.info('getmininginfo')
         mining_info = node.getmininginfo()
         assert_equal(mining_info['blocks'], 200)
-        assert_equal(mining_info['chain'], 'regtest')
+        assert_equal(mining_info['chain'], self.chain)
         assert 'currentblocktx' not in mining_info
         assert 'currentblocksize' not in mining_info
         assert_equal(mining_info['difficulty'],

test/functional/rpc_dumptxoutset.py

@@ -25,7 +25,7 @@ def run_test(self):
 
         FILENAME = 'txoutset.dat'
         out = node.dumptxoutset(FILENAME)
-        expected_path = Path(node.datadir) / 'regtest' / FILENAME
+        expected_path = Path(node.datadir) / self.chain / FILENAME
 
         assert expected_path.is_file()
 

test/functional/rpc_scantxoutset.py

@@ -74,7 +74,7 @@ def run_test(self):
         self.log.info("Stop node, remove wallet, mine again some blocks...")
         self.stop_node(0)
         shutil.rmtree(os.path.join(
-            self.nodes[0].datadir, "regtest", 'wallets'))
+            self.nodes[0].datadir, self.chain, 'wallets'))
         self.start_node(0)
         self.nodes[0].generate(110)
 

test/functional/test_framework/test_framework.py

@@ -616,7 +616,7 @@ def _initialize_chain(self):
             self.nodes = []
 
             def cache_path(*paths):
-                return os.path.join(cache_node_dir, "regtest", *paths)
+                return os.path.join(cache_node_dir, self.chain, *paths)
 
             # Remove empty wallets dir
             os.rmdir(cache_path('wallets'))

test/functional/tool_wallet.py

@@ -30,7 +30,7 @@ def bitcoin_wallet_process(self, *args):
         binary = self.config["environment"]["BUILDDIR"] + \
             '/src/bitcoin-wallet' + self.config["environment"]["EXEEXT"]
         args = ['-datadir={}'.format(self.nodes[0].datadir),
-                '-regtest'] + list(args)
+                '-chain={}'.format(self.chain)] + list(args)
 
         command_line = [binary] + args
         if self.config["environment"]["EMULATOR"]:
@@ -243,7 +243,7 @@ def test_salvage(self):
 
     def run_test(self):
         self.wallet_path = os.path.join(
-            self.nodes[0].datadir, 'regtest', 'wallets', 'wallet.dat')
+            self.nodes[0].datadir, self.chain, 'wallets', 'wallet.dat')
         self.test_invalid_tool_commands_and_args()
         # Warning: The following tests are order-dependent.
         self.test_tool_wallet_info()

test/functional/wallet_backup.py

@@ -108,11 +108,11 @@ def stop_three(self):
 
     def erase_three(self):
         os.remove(os.path.join(
-            self.nodes[0].datadir, 'regtest', 'wallets', 'wallet.dat'))
+            self.nodes[0].datadir, self.chain, 'wallets', 'wallet.dat'))
         os.remove(os.path.join(
-            self.nodes[1].datadir, 'regtest', 'wallets', 'wallet.dat'))
+            self.nodes[1].datadir, self.chain, 'wallets', 'wallet.dat'))
         os.remove(os.path.join(
-            self.nodes[2].datadir, 'regtest', 'wallets', 'wallet.dat'))
+            self.nodes[2].datadir, self.chain, 'wallets', 'wallet.dat'))
 
     def run_test(self):
         self.log.info("Generating initial blockchain")
@@ -175,17 +175,21 @@ def run_test(self):
         self.erase_three()
 
         # Start node2 with no chain
-        shutil.rmtree(os.path.join(self.nodes[2].datadir, 'regtest', 'blocks'))
+        shutil.rmtree(
+            os.path.join(
+                self.nodes[2].datadir,
+                self.chain,
+                'blocks'))
         shutil.rmtree(os.path.join(
-            self.nodes[2].datadir, 'regtest', 'chainstate'))
+            self.nodes[2].datadir, self.chain, 'chainstate'))
 
         # Restore wallets from backup
         shutil.copyfile(os.path.join(self.nodes[0].datadir, 'wallet.bak'), os.path.join(
-            self.nodes[0].datadir, 'regtest', 'wallets', 'wallet.dat'))
+            self.nodes[0].datadir, self.chain, 'wallets', 'wallet.dat'))
         shutil.copyfile(os.path.join(self.nodes[1].datadir, 'wallet.bak'), os.path.join(
-            self.nodes[1].datadir, 'regtest', 'wallets', 'wallet.dat'))
+            self.nodes[1].datadir, self.chain, 'wallets', 'wallet.dat'))
         shutil.copyfile(os.path.join(self.nodes[2].datadir, 'wallet.bak'), os.path.join(
-            self.nodes[2].datadir, 'regtest', 'wallets', 'wallet.dat'))
+            self.nodes[2].datadir, self.chain, 'wallets', 'wallet.dat'))
 
         self.log.info("Re-starting nodes")
         self.start_three()
@@ -200,9 +204,13 @@ def run_test(self):
         self.erase_three()
 
         # start node2 with no chain
-        shutil.rmtree(os.path.join(self.nodes[2].datadir, 'regtest', 'blocks'))
+        shutil.rmtree(
+            os.path.join(
+                self.nodes[2].datadir,
+                self.chain,
+                'blocks'))
         shutil.rmtree(os.path.join(
-            self.nodes[2].datadir, 'regtest', 'chainstate'))
+            self.nodes[2].datadir, self.chain, 'chainstate'))
 
         self.start_three()
 
@@ -226,11 +234,11 @@ def run_test(self):
         # Backup to source wallet file must fail
         sourcePaths = [
             os.path.join(self.nodes[0].datadir,
-                         'regtest', 'wallets', 'wallet.dat'),
-            os.path.join(self.nodes[0].datadir, 'regtest',
+                         self.chain, 'wallets', 'wallet.dat'),
+            os.path.join(self.nodes[0].datadir, self.chain,
                          '.', 'wallets', 'wallet.dat'),
-            os.path.join(self.nodes[0].datadir, 'regtest', 'wallets', ''),
-            os.path.join(self.nodes[0].datadir, 'regtest', 'wallets')]
+            os.path.join(self.nodes[0].datadir, self.chain, 'wallets', ''),
+            os.path.join(self.nodes[0].datadir, self.chain, 'wallets')]
 
         for sourcePath in sourcePaths:
             assert_raises_rpc_error(-4, "backup failed",

test/functional/wallet_hd.py

@@ -74,11 +74,15 @@ def run_test(self):
         # we need to delete the complete regtest directory
         # otherwise node1 would auto-recover all funds in flag the keypool keys
         # as used
-        shutil.rmtree(os.path.join(self.nodes[1].datadir, "regtest", "blocks"))
+        shutil.rmtree(
+            os.path.join(
+                self.nodes[1].datadir,
+                self.chain,
+                "blocks"))
         shutil.rmtree(os.path.join(
-            self.nodes[1].datadir, "regtest", "chainstate"))
+            self.nodes[1].datadir, self.chain, "chainstate"))
         shutil.copyfile(os.path.join(self.nodes[1].datadir, "hd.bak"), os.path.join(
-            self.nodes[1].datadir, "regtest", "wallets", "wallet.dat"))
+            self.nodes[1].datadir, self.chain, "wallets", "wallet.dat"))
         self.start_node(1)
 
         # Assert that derivation is deterministic
@@ -99,11 +103,15 @@ def run_test(self):
 
         # Try a RPC based rescan
         self.stop_node(1)
-        shutil.rmtree(os.path.join(self.nodes[1].datadir, "regtest", "blocks"))
+        shutil.rmtree(
+            os.path.join(
+                self.nodes[1].datadir,
+                self.chain,
+                "blocks"))
         shutil.rmtree(os.path.join(
-            self.nodes[1].datadir, "regtest", "chainstate"))
+            self.nodes[1].datadir, self.chain, "chainstate"))
         shutil.copyfile(os.path.join(self.nodes[1].datadir, "hd.bak"), os.path.join(
-            self.nodes[1].datadir, "regtest", "wallets", "wallet.dat"))
+            self.nodes[1].datadir, self.chain, "wallets", "wallet.dat"))
         self.start_node(1, extra_args=self.extra_args[1])
         connect_nodes(self.nodes[0], self.nodes[1])
         self.sync_all()

test/functional/wallet_keypool_topup.py

@@ -31,7 +31,7 @@ def skip_test_if_missing_module(self):
 
     def run_test(self):
         wallet_path = os.path.join(
-            self.nodes[1].datadir, "regtest", "wallets", "wallet.dat")
+            self.nodes[1].datadir, self.chain, "wallets", "wallet.dat")
         wallet_backup_path = os.path.join(self.nodes[1].datadir, "wallet.bak")
         self.nodes[0].generate(101)
 

test/functional/wallet_multiwallet.py

@@ -41,7 +41,7 @@ def add_options(self, parser):
     def run_test(self):
         node = self.nodes[0]
 
-        def data_dir(*p): return os.path.join(node.datadir, 'regtest', *p)
+        def data_dir(*p): return os.path.join(node.datadir, self.chain, *p)
 
         def wallet_dir(*p): return data_dir('wallets', *p)
 
@@ -223,7 +223,7 @@ def wallet_file(name):
 
         batch = w1.batch([w1.getblockchaininfo.get_request(),
                           w1.getwalletinfo.get_request()])
-        assert_equal(batch[0]["result"]["chain"], "regtest")
+        assert_equal(batch[0]["result"]["chain"], self.chain)
         assert_equal(batch[1]["result"]["walletname"], "w1")
 
         self.log.info('Check for per-wallet settxfee call')

test/functional/wallet_reorgsrestore.py

@@ -109,7 +109,7 @@ def run_test(self):
                 'wallet.bak'),
             os.path.join(
                 self.nodes[1].datadir,
-                'regtest',
+                self.chain,
                 'wallet.dat'))
         self.start_node(1)
         tx_after_reorg = self.nodes[1].gettransaction(txid)