merge bitcoin#23046: Add txindex migration test

Author: kwvg

test/functional/feature_txindex_compatibility.py

@@ -0,0 +1,97 @@
+#!/usr/bin/env python3
+# Copyright (c) 2021 The Bitcoin Core developers
+# Distributed under the MIT software license, see the accompanying
+# file COPYING or http://www.opensource.org/licenses/mit-license.php.
+"""Test that legacy txindex will be disabled on upgrade.
+
+Previous releases are required by this test, see test/README.md.
+"""
+
+import os
+import shutil
+
+from test_framework.test_framework import BitcoinTestFramework
+from test_framework.wallet import MiniWallet
+
+
+class MempoolCompatibilityTest(BitcoinTestFramework):
+    def set_test_params(self):
+        self.num_nodes = 3
+        self.extra_args = [
+            ["-reindex", "-txindex"],
+            ["-txindex=0"],
+            ["-txindex=0"],
+        ]
+
+    def skip_test_if_missing_module(self):
+        self.skip_if_no_previous_releases()
+
+    def setup_network(self):
+        self.add_nodes(
+            self.num_nodes,
+            self.extra_args,
+            versions=[
+                170003,   # Last release with legacy txindex
+                None,     # For MiniWallet, without migration code
+                18020200, # Any release with migration code (0.18.x - 21.x)
+                          # We are using v18.2.2 to avoid MigrateDBIfNeeded(2) routines as
+                          # they don't handle a no-upgrade case correctly
+            ],
+        )
+        # Delete v18.2.2 cached datadir to avoid making a legacy version try to
+        # make sense of our current database formats
+        shutil.rmtree(os.path.join(self.nodes[2].datadir, self.chain))
+        self.start_nodes()
+        self.connect_nodes(0, 1)
+        self.connect_nodes(1, 2)
+
+    def run_test(self):
+        mini_wallet = MiniWallet(self.nodes[1])
+        mini_wallet.rescan_utxos()
+        spend_utxo = mini_wallet.get_utxo()
+        mini_wallet.send_self_transfer(from_node=self.nodes[1], utxo_to_spend=spend_utxo)
+        self.generate(self.nodes[1], 1)
+
+        self.log.info("Check legacy txindex")
+        self.nodes[0].getrawtransaction(txid=spend_utxo["txid"])  # Requires -txindex
+
+        self.stop_nodes()
+        legacy_chain_dir = os.path.join(self.nodes[0].datadir, self.chain)
+
+        self.log.info("Migrate legacy txindex")
+        migrate_chain_dir = os.path.join(self.nodes[2].datadir, self.chain)
+        shutil.rmtree(migrate_chain_dir)
+        shutil.copytree(legacy_chain_dir, migrate_chain_dir)
+        with self.nodes[2].assert_debug_log([
+                "Upgrading txindex database...",
+                "txindex is enabled at height 200",
+        ]):
+            self.start_node(2, extra_args=["-txindex"])
+        self.nodes[2].getrawtransaction(txid=spend_utxo["txid"])  # Requires -txindex
+
+        self.log.info("Drop legacy txindex")
+        drop_index_chain_dir = os.path.join(self.nodes[1].datadir, self.chain)
+        shutil.rmtree(drop_index_chain_dir)
+        shutil.copytree(legacy_chain_dir, drop_index_chain_dir)
+        self.nodes[1].assert_start_raises_init_error(
+            extra_args=["-txindex"],
+            expected_msg="Error: The block index db contains a legacy 'txindex'. To clear the occupied disk space, run a full -reindex, otherwise ignore this error. This error message will not be displayed again.",
+        )
+        # Build txindex from scratch and check there is no error this time
+        self.start_node(1, extra_args=["-txindex"])
+        self.nodes[2].getrawtransaction(txid=spend_utxo["txid"])  # Requires -txindex
+
+        self.stop_nodes()
+
+        self.log.info("Check migrated txindex can not be read by legacy node")
+        err_msg = f": You need to rebuild the database using -reindex to change -txindex.{os.linesep}Please restart with -reindex or -reindex-chainstate to recover."
+        shutil.rmtree(legacy_chain_dir)
+        shutil.copytree(migrate_chain_dir, legacy_chain_dir)
+        self.nodes[0].assert_start_raises_init_error(extra_args=["-txindex"], expected_msg=err_msg)
+        shutil.rmtree(legacy_chain_dir)
+        shutil.copytree(drop_index_chain_dir, legacy_chain_dir)
+        self.nodes[0].assert_start_raises_init_error(extra_args=["-txindex"], expected_msg=err_msg)
+
+
+if __name__ == "__main__":
+    MempoolCompatibilityTest().main()

test/functional/test_runner.py

@@ -346,6 +346,7 @@
     'rpc_deriveaddresses.py --usecli',
     'p2p_ping.py',
     'rpc_scantxoutset.py',
+    'feature_txindex_compatibility.py',
     'feature_logging.py',
     'feature_anchors.py',
     'feature_coinstatsindex.py',