Merge #6844: backport: bitcoin#19013: test: fixes intermittent failure for backwards compatibility test

25b82ab test: final cleanups for feature_backwards_compatibility.py accordingly linter (Konstantin Akimov)
93902fc test: add v21.1.1 to the list of version to test backwards compatibility (Konstantin Akimov)
1957892 feat: bump version 21.0.1 to 21.1.1 for feature_backwards_compatibility.py (Konstantin Akimov)
d7e382e Merge bitcoin#19013: test: add v0.20.1, v0.21.0 and v22.0 to backwards compatibility test (MarcoFalke)
0f92a66 test: Fix intermittent test failure in feature_backwards_compatibility (MarcoFalke)
556b869 test: backwards compatibility: misc fixes (Sjors Provoost)
3d1c70e test: Remove i686 from test/get_previous_releases.py (Konstantin Akimov)

Pull request description:

  ## Issue being fixed or feature implemented
  Functional test feature_backwards_compatibility.py has ~15% failure rate.

  ## What was done?
  This backport is dashified and heavily modified to fit our codebase.
   - It refactors functional test (as original PR 19013)
   - It fixes intermittent error (as original PR 19013)
   - It drops support of i686 from list of previous releases (as original PR 19013)
   - It adds v21.1.1 and replace v20.0.1 to v21.1.1 while original PR adds version v0.20.1, v0.21.0 and v22.0.

  ## How Has This Been Tested?
  Run multiple time. Failure rate dropped from 15% to 0 failures.

  ## Breaking Changes
  N/A

  ## Checklist:
  - [x] I have performed a self-review of my own code
  - [ ] I have commented my code, particularly in hard-to-understand areas
  - [ ] I have added or updated relevant unit/integration/functional/e2e tests
  - [x] I have made corresponding changes to the documentation
  - [x] I have assigned this pull request to a milestone

ACKs for top commit:
  UdjinM6:
    utACK 25b82ab

Tree-SHA512: 404f45e78326c0b6982fbd969cc16414c066f73c1af3d78e4fd7a64cfb21f83b49c689243caa17fd4f475b3f262bde996eb47efafb3c55c891efdccd46e3eeef

Author: PastaPastaPasta

ci/test/00_setup_env_native_qt5.sh

@@ -14,5 +14,5 @@ export TEST_RUNNER_EXTRA="--previous-releases --coverage --extended --exclude fe
 export RUN_UNIT_TESTS_SEQUENTIAL="true"
 export RUN_UNIT_TESTS="false"
 export GOAL="install"
-export PREVIOUS_RELEASES_TO_DOWNLOAD="v0.12.1.5 v0.15.0.0 v0.16.1.1 v0.17.0.3 v18.2.2 v19.3.0 v20.0.1"
+export PREVIOUS_RELEASES_TO_DOWNLOAD="v0.12.1.5 v0.15.0.0 v0.16.1.1 v0.17.0.3 v18.2.2 v19.3.0 v20.1.1 v21.1.1"
 export BITCOIN_CONFIG="--enable-zmq --with-libs=no --enable-reduce-exports --disable-fuzz-binary LDFLAGS=-static-libstdc++ --with-boost-process"

test/README.md

@@ -103,7 +103,7 @@ test/functional/test_runner.py --extended
 In order to run backwards compatibility tests, download the previous node binaries:
 
 ```
-test/get_previous_releases.py -b v19.3.0 v18.2.2 v0.17.0.3 v0.16.1.1 v0.15.0.0 v0.12.1.5
+test/get_previous_releases.py -b v0.12.1.5 v0.15.0.0 v0.16.1.1 v0.17.0.3 v18.2.2 v19.3.0 v20.1.1 v21.1.1
 ```
 
 By default, up to 4 tests will be run in parallel by test_runner. To specify

test/functional/feature_backwards_compatibility.py

@@ -20,6 +20,7 @@
 import os
 import shutil
 
+from test_framework.blocktools import COINBASE_MATURITY
 from test_framework.descriptors import descsum_create
 from test_framework.test_framework import BitcoinTestFramework
 
@@ -32,16 +33,17 @@
 class BackwardsCompatibilityTest(BitcoinTestFramework):
     def set_test_params(self):
         self.setup_clean_chain = True
-        self.num_nodes = 7
+        self.num_nodes = 8
         # Add new version after each release:
         self.extra_args = [
-            [], # Pre-release: use to mine blocks
-            ["-nowallet"], # Pre-release: use to receive coins, swap wallets, etc
-            ["-nowallet"], # v20.0.1
-            ["-nowallet"], # v19.3.0
-            ["-nowallet"], # v18.2.2
-            ["-nowallet"], # v0.17.0.3
-            ["-nowallet"], # v0.16.1.1
+            ["-whitelist=noban@127.0.0.1"], # Pre-release: use to mine blocks
+            ["-nowallet", "-whitelist=noban@127.0.0.1"], # Pre-release: use to receive coins, swap wallets, etc
+            ["-nowallet", "-whitelist=noban@127.0.0.1"], # v21.1.1 - supports descriptor wallets
+            ["-nowallet", "-whitelist=noban@127.0.0.1"], # v20.1.1 - last legacy-only version, no descriptor wallets
+            ["-nowallet", "-whitelist=noban@127.0.0.1"], # v19.3.0
+            ["-nowallet", "-whitelist=noban@127.0.0.1"], # v18.2.2
+            ["-nowallet", "-whitelist=127.0.0.1"], # v0.17.0.3
+            ["-nowallet", "-whitelist=127.0.0.1"], # v0.16.1.1
         ]
         self.wallet_names = [self.default_wallet_name]
 
@@ -53,7 +55,8 @@ def setup_nodes(self):
         self.add_nodes(self.num_nodes, extra_args=self.extra_args, versions=[
             None,
             None,
-            19030000,
+            21010100,
+            20010100,
             19030000,
             18020200,
             170003,
@@ -63,20 +66,28 @@ def setup_nodes(self):
         self.start_nodes()
         self.import_deterministic_coinbase_privkeys()
 
-    def run_test(self):
-        self.generatetoaddress(self.nodes[0], 101, self.nodes[0].getnewaddress())
-
-        # Sanity check the test framework:
-        res = self.nodes[self.num_nodes - 1].getblockchaininfo()
-        assert_equal(res['blocks'], 101)
+    def nodes_wallet_dir(self, node):
+        if node.version < 160000:
+            return os.path.join(node.datadir, "regtest")
+        return os.path.join(node.datadir, "regtest/wallets")
 
-        node_master = self.nodes[self.num_nodes - 6]
+    def run_test(self):
+        node_miner = self.nodes[0]
+        node_master = self.nodes[1]
         node_v20 = self.nodes[self.num_nodes - 5]
         node_v19 = self.nodes[self.num_nodes - 4]
         node_v18 = self.nodes[self.num_nodes - 3]
         node_v17 = self.nodes[self.num_nodes - 2]
         node_v16 = self.nodes[self.num_nodes - 1]
 
+        legacy_nodes = self.nodes[3:]
+
+        self.generatetoaddress(node_miner, COINBASE_MATURITY + 1, node_miner.getnewaddress())
+
+        # Sanity check the test framework:
+        res = node_v16.getblockchaininfo()
+        assert_equal(res['blocks'], COINBASE_MATURITY + 1)
+
         self.log.info("Test wallet backwards compatibility...")
         # Create a number of wallets and open them in older versions:
 
@@ -89,9 +100,9 @@ def run_test(self):
         assert info['keypoolsize'] > 0
         # Create a confirmed transaction, receiving coins
         address = wallet.getnewaddress()
-        self.nodes[0].sendtoaddress(address, 1)
+        node_miner.sendtoaddress(address, 1)
         self.sync_mempools()
-        self.generate(self.nodes[0], 1)
+        self.generate(node_miner, 1)
 
         # w1_v19: regular wallet, created with v0.19
         node_v19.rpc.createwallet(wallet_name="w1_v19")
@@ -102,6 +113,7 @@ def run_test(self):
         # Use addmultisigaddress (see #18075)
         address_18075 = wallet.addmultisigaddress(1, ["0296b538e853519c726a2c91e61ec11600ae1390813a627c66fb8be7947be63c52", "037211a824f55b505228e4c3d5194c1fcfaa15a456abdf37f9b9d97a4040afc073"], "")["address"]
         assert wallet.getaddressinfo(address_18075)["solvable"]
+        node_v19.unloadwallet("w1_v19")
 
         # w1_v18: regular wallet, created with v0.18
         node_v18.rpc.createwallet(wallet_name="w1_v18")
@@ -148,198 +160,78 @@ def run_test(self):
         assert info['private_keys_enabled']
         assert info['keypoolsize'] == 0
 
-        # w3_v19: blank wallet, created with v0.19
-        node_v19.rpc.createwallet(wallet_name="w3_v19", blank=True)
-        wallet = node_v19.get_wallet_rpc("w3_v19")
-        info = wallet.getwalletinfo()
-        assert info['private_keys_enabled']
-        assert info['keypoolsize'] == 0
-
-        # w3_v18: blank wallet, created with v0.18
-        node_v18.rpc.createwallet(wallet_name="w3_v18", blank=True)
-        wallet = node_v18.get_wallet_rpc("w3_v18")
-        info = wallet.getwalletinfo()
-        assert info['private_keys_enabled']
-        assert info['keypoolsize'] == 0
-
-        # Copy the wallets to older nodes:
+        # Unload wallets and copy to older nodes:
         node_master_wallets_dir = os.path.join(node_master.datadir, "regtest/wallets")
-        node_v20_wallets_dir = os.path.join(node_v20.datadir, "regtest/wallets")
         node_v19_wallets_dir = os.path.join(node_v19.datadir, "regtest/wallets")
-        node_v18_wallets_dir = os.path.join(node_v18.datadir, "regtest/wallets")
         node_v17_wallets_dir = os.path.join(node_v17.datadir, "regtest/wallets")
-        node_v16_wallets_dir = os.path.join(node_v16.datadir, "regtest")
         node_master.unloadwallet("w1")
         node_master.unloadwallet("w2")
-        node_v19.unloadwallet("w1_v19")
-        node_v19.unloadwallet("w2_v19")
-        node_v18.unloadwallet("w1_v18")
-        node_v18.unloadwallet("w2_v18")
-
-        # Copy wallets to v0.16
-        for wallet in os.listdir(node_master_wallets_dir):
-            shutil.copytree(
-                os.path.join(node_master_wallets_dir, wallet),
-                os.path.join(node_v16_wallets_dir, wallet)
-            )
-
-        # Copy wallets to v0.17
-        for wallet in os.listdir(node_master_wallets_dir):
-            shutil.copytree(
-                os.path.join(node_master_wallets_dir, wallet),
-                os.path.join(node_v17_wallets_dir, wallet)
-            )
-        for wallet in os.listdir(node_v18_wallets_dir):
-            shutil.copytree(
-                os.path.join(node_v18_wallets_dir, wallet),
-                os.path.join(node_v17_wallets_dir, wallet)
-            )
-
-        # Copy wallets to v0.18
-        for wallet in os.listdir(node_master_wallets_dir):
-            shutil.copytree(
-                os.path.join(node_master_wallets_dir, wallet),
-                os.path.join(node_v18_wallets_dir, wallet)
-            )
-
-        # Copy wallets to v0.19
-        for wallet in os.listdir(node_master_wallets_dir):
-            shutil.copytree(
-                os.path.join(node_master_wallets_dir, wallet),
-                os.path.join(node_v19_wallets_dir, wallet)
-            )
+        node_master.unloadwallet("w3")
 
-        # Copy wallets to v0.20
-        for wallet in os.listdir(node_master_wallets_dir):
-            shutil.copytree(
-                os.path.join(node_master_wallets_dir, wallet),
-                os.path.join(node_v20_wallets_dir, wallet)
-            )
+        for node in legacy_nodes:
+            # Copy wallets to previous version
+            for wallet in os.listdir(node_master_wallets_dir):
+                shutil.copytree(
+                    os.path.join(node_master_wallets_dir, wallet),
+                    os.path.join(self.nodes_wallet_dir(node), wallet)
+                )
 
         if not self.options.descriptors:
             # Descriptor wallets break compatibility, only run this test for legacy wallet
-            # Open the wallets in v0.20
-            node_v20.loadwallet("w1")
-            wallet = node_v20.get_wallet_rpc("w1")
-            info = wallet.getwalletinfo()
-            assert info['private_keys_enabled']
-            assert info['keypoolsize'] > 0
-            txs = wallet.listtransactions()
-            assert_equal(len(txs), 1)
-
-            node_v20.loadwallet("w2")
-            wallet = node_v20.get_wallet_rpc("w2")
-            info = wallet.getwalletinfo()
-            assert info['private_keys_enabled'] == False
-            assert info['keypoolsize'] == 0
-
-            node_v20.loadwallet("w3")
-            wallet = node_v20.get_wallet_rpc("w3")
-            info = wallet.getwalletinfo()
-            assert info['private_keys_enabled']
-            assert info['keypoolsize'] == 0
-
-            # Open the wallets in v0.19
-            node_v19.loadwallet("w1")
-            wallet = node_v19.get_wallet_rpc("w1")
-            info = wallet.getwalletinfo()
-            assert info['private_keys_enabled']
-            assert info['keypoolsize'] > 0
-            txs = wallet.listtransactions()
-            assert_equal(len(txs), 1)
-
-            node_v19.loadwallet("w2")
-            wallet = node_v19.get_wallet_rpc("w2")
-            info = wallet.getwalletinfo()
-            assert info['private_keys_enabled'] == False
-            assert info['keypoolsize'] == 0
-
-            node_v19.loadwallet("w3")
-            wallet = node_v19.get_wallet_rpc("w3")
-            info = wallet.getwalletinfo()
-            assert info['private_keys_enabled']
-            assert info['keypoolsize'] == 0
-
-            # Open the wallets in v0.18
-            node_v18.loadwallet("w1")
-            wallet = node_v18.get_wallet_rpc("w1")
-            info = wallet.getwalletinfo()
-            assert info['private_keys_enabled']
-            assert info['keypoolsize'] > 0
-            txs = wallet.listtransactions()
-            assert_equal(len(txs), 1)
-
-            node_v18.loadwallet("w2")
-            wallet = node_v18.get_wallet_rpc("w2")
-            info = wallet.getwalletinfo()
-            assert info['private_keys_enabled'] == False
-            assert info['keypoolsize'] == 0
-
-            node_v18.loadwallet("w3")
-            wallet = node_v18.get_wallet_rpc("w3")
-            info = wallet.getwalletinfo()
-            assert info['private_keys_enabled']
-            assert info['keypoolsize'] == 0
-
-            node_v17.loadwallet("w1")
-            wallet = node_v17.get_wallet_rpc("w1")
-            info = wallet.getwalletinfo()
-            # doesn't have WALLET_FLAG_DISABLE_PRIVATE_KEYS in v17
-            assert 'private_keys_enabled' not in info
-            assert info['keypoolsize'] > 0
-
-            node_v17.loadwallet("w2")
-            wallet = node_v17.get_wallet_rpc("w2")
-            info = wallet.getwalletinfo()
-            # doesn't have WALLET_FLAG_DISABLE_PRIVATE_KEYS in v17
-            assert 'private_keys_enabled' not in info
-            assert info['keypoolsize'] > 0
+            # Load modern wallet with older nodes
+            for node in legacy_nodes:
+                for wallet_name in ["w1", "w2", "w3"]:
+                    if node.version < 180000:
+                        # doesn't have WALLET_FLAG_DISABLE_PRIVATE_KEYS in v17
+                        continue
+                    self.log.info(f"Test wallet wallet: {wallet_name} on node {node.index} version: {node.version}")
+                    node.loadwallet(wallet_name)
+                    wallet = node.get_wallet_rpc(wallet_name)
+                    info = wallet.getwalletinfo()
+                    if wallet_name == "w1":
+                        assert info['private_keys_enabled'] == True
+                        assert info['keypoolsize'] > 0
+                        txs = wallet.listtransactions()
+                        assert_equal(len(txs), 1)
+                    elif wallet_name == "w2":
+                        assert(info['private_keys_enabled'] == False)
+                        if node.version > 20999999:
+                            assert info['keypoolsize'] > 0
+                    elif wallet_name == "w3":
+                        assert(info['private_keys_enabled'] == True)
+                        assert 'keypoolsize' not in info or info['keypoolsize'] == 0
+                    else:
+                        assert False
         else:
-            # Descriptor wallets appear to be corrupted wallets to old software
-            assert_raises_rpc_error(-4, "Wallet requires newer version of Dash Core", node_v19.loadwallet, "w1")
-            assert_raises_rpc_error(-4, "Wallet requires newer version of Dash Core", node_v19.loadwallet, "w2")
-            assert_raises_rpc_error(-4, "Wallet requires newer version of Dash Core", node_v19.loadwallet, "w3")
-            assert_raises_rpc_error(-18, "Data is not in recognized format", node_v18.loadwallet, "w1")
-            assert_raises_rpc_error(-18, "Data is not in recognized format", node_v18.loadwallet, "w2")
-            assert_raises_rpc_error(-18, "Data is not in recognized format", node_v18.loadwallet, "w3")
-
-        # Open the wallets in v0.17
-        node_v17.loadwallet("w1_v18")
-        wallet = node_v17.get_wallet_rpc("w1_v18")
-        info = wallet.getwalletinfo()
-        # doesn't have WALLET_FLAG_DISABLE_PRIVATE_KEYS in v17
-        assert 'private_keys_enabled' not in info
-        assert info['keypoolsize'] > 0
-
-        node_v17.loadwallet("w2_v18")
-        wallet = node_v17.get_wallet_rpc("w2_v18")
-        info = wallet.getwalletinfo()
-        # doesn't have WALLET_FLAG_DISABLE_PRIVATE_KEYS in v17
-        assert 'private_keys_enabled' not in info
-        assert info['keypoolsize'] > 0
+            for node in legacy_nodes:
+                # Descriptor wallets appear to be corrupted wallets to old software
+                if node.version < 210000:
+                    for wallet_name in ["w1", "w2", "w3"]:
+                        assert_raises_rpc_error(-4, "Wallet file verification failed: wallet.dat corrupt, salvage failed", node.loadwallet, wallet_name)
 
         # RPC loadwallet failure causes bitcoind to exit, in addition to the RPC
         # call failure, so the following test won't work:
-        # assert_raises_rpc_error(-4, "Wallet loading failed.", node_v17.loadwallet, 'w3_v18')
+        # assert_raises_rpc_error(-4, "Wallet loading failed.", node_v17.loadwallet, 'w3')
 
         # Instead, we stop node and try to launch it with the wallet:
-        self.stop_node(5)
+        self.stop_node(node_v17.index)
         # it expected to fail with error 'DBErrors::TOO_NEW' but Dash Core can open v18 by version 17
         # can be implemented in future if there's any incompatible versions
         #node_v17.assert_start_raises_init_error(["-wallet=w3_v18"], "Error: Error loading w3_v18: Wallet requires newer version of Dash Core")
         #node_v17.assert_start_raises_init_error(["-wallet=w3"], "Error: Error loading w3: Wallet requires newer version of Dash Core")
-        self.start_node(5)
+        self.start_node(node_v17.index)
 
-        # Open most recent wallet in v0.16 (no loadwallet RPC)
-        self.restart_node(6, extra_args=["-wallet=w2"])
-        wallet = node_v16.get_wallet_rpc("w2")
-        info = wallet.getwalletinfo()
-        assert info['keypoolsize'] == 1
+        if not self.options.descriptors:
+            # Open most recent wallet in v0.16 (no loadwallet RPC)
+            self.restart_node(node_v16.index, extra_args=["-wallet=w2"])
+            wallet = node_v16.get_wallet_rpc("w2")
+            info = wallet.getwalletinfo()
+            assert info['keypoolsize'] == 1
 
         self.log.info("Test wallet upgrade path...")
         # Bitcoin creates hd wallets by default since v16, but Dash Core v17 does not.
         # enforce it by restarting v17
-        self.restart_node(5, extra_args=["-usehd=1"])
+        self.restart_node(node_v17.index, extra_args=["-usehd=1"])
         # u1: regular wallet, created with v0.17
         node_v17.rpc.createwallet(wallet_name="u1_v17")
         wallet = node_v17.get_wallet_rpc("u1_v17")
@@ -395,7 +287,7 @@ def run_test(self):
             wallet = node_v19.get_wallet_rpc("w1_v19")
             assert wallet.getaddressinfo(address_18075)["solvable"]
 
-            self.stop_node(5, expected_stderr=("Warning: Make sure to encrypt your wallet and delete all non-encrypted backups after you have verified that the wallet works!\n"*3)[:-1])
+            self.stop_node(node_v17.index, expected_stderr=("Warning: Make sure to encrypt your wallet and delete all non-encrypted backups after you have verified that the wallet works!\n"*3)[:-1])
 
 if __name__ == '__main__':
     BackwardsCompatibilityTest().main()