Merge cc67e4595af0af2f304494e7811e700f25d48a22 into 5f4422d68dc3530c353af1f87499de1c864b60ad

3301d2cbe8c3b76c97285d75fa59637cb6952d0b qa: Wait for txindex to avoid race condition (Hodlinator)
9bfb0d75ba10591cc6c9620f9fd1ecc0e55e7a48 qa: Remove unnecessary -txindex args (Hodlinator)
7ac281c19cd3d11f316dbbb3308eabf1ad4f26d6 qa: Add missing coverage of corrupt indexes (Hodlinator)

Pull request description:

  - Add synchronization in 3 places where if the Transaction Index happens to be slow, we get rare test failures when querying it for transactions (one such case experienced on Windows, prompting investigation).
  - Remove unnecessary TxIndex initialization in some tests.
  - Add some test coverage where TxIndex aspect could be tested in feature_init.py.

ACKs for top commit:
  fjahr:
    re-ACK 3301d2cbe8c3b76c97285d75fa59637cb6952d0b
  mzumsande:
    Code Review ACK 3301d2cbe8c3b76c97285d75fa59637cb6952d0b
  furszy:
    Code review ACK 3301d2cbe8c3b76c97285d75fa59637cb6952d0b
  Prabhat1308:
    Concept ACK [`3301d2c`](3301d2cbe8)

Tree-SHA512: 7c2019e38455f344856aaf6b381faafbd88d53dc88d13309deb718c1dcfbee4ccca7c7f1b66917395503a6f94c3b216a007ad432cc8b93d0309db9805f38d602

ci/lint_run_all.sh

@@ -6,12 +6,52 @@
 
 export LC_ALL=C.UTF-8
 
-# Only used in .cirrus.yml. Refer to test/lint/README.md on how to run locally.
+set -eo pipefail
 
+if [ -n "$CIRRUS_PR" ]; then
+  # For CI runs
   cp "./ci/retry/retry" "/ci_retry"
   cp "./.python-version" "/.python-version"
   mkdir --parents "/test/lint"
   cp --recursive "./test/lint/test_runner" "/test/lint/"
-set -o errexit; source ./ci/lint/04_install.sh
+  set -o errexit
+  # shellcheck source=/dev/null
+  source ./ci/lint/04_install.sh
   set -o errexit
   ./ci/lint/06_script.sh
+else
+  # For local runs
+  error() {
+    echo "ERROR: $1" >&2
+    exit 1
+  }
+
+
+  echo "Building Docker image..."
+  DOCKER_BUILDKIT=1 docker build \
+      -t bitcoin-linter \
+      --file "./ci/lint_imagefile" \
+      ./ || error "Docker build failed"
+
+  echo "Running linter..."
+  DOCKER_ARGS=(
+    --rm
+    -v "$(pwd):/bitcoin"
+    -it
+  )
+
+  # Check if we are working in a worktree
+  GIT_DIR=$(git rev-parse --git-dir)
+  if [[ "$GIT_DIR" == *".git/worktrees/"* ]]; then
+    # If we are, mount the git toplevel dir to the expected location.
+    # This is required both so the linter knows which dir to run lint tests from.
+    # A writeable mount is required so test/lint/commit-script-check.sh can
+    # write to the index.
+    echo "Detected git worktree..."
+    WORKTREE_ROOT=$(echo "$GIT_DIR" | sed 's/\.git\/worktrees\/.*/\.git/')
+    echo "Worktree root: $WORKTREE_ROOT"
+    DOCKER_ARGS+=(--mount "type=bind,src=$WORKTREE_ROOT,dst=$WORKTREE_ROOT")
+  fi
+
+  RUST_BACKTRACE=1 docker run "${DOCKER_ARGS[@]}" bitcoin-linter
+fi

ci/test/02_run_container.sh

@@ -118,21 +118,51 @@ if [ -z "$DANGER_RUN_CI_ON_HOST" ]; then
   # When detecting podman-docker, `--external` should be added.
   docker image prune --force --filter "label=$CI_IMAGE_LABEL"
 
+  # Compile the docker run arguments into an array
+  docker_args=(
+    --cap-add LINUX_IMMUTABLE
+  )
+  # Filter these optional vars out, which, if empty are passed through the bash
+  # array incorrectly as empty strings
+  if [[ -n "$CI_CONTAINER_CAP" ]]; then
+    read -ra cap_args <<< "$CI_CONTAINER_CAP"
+    docker_args+=("${cap_args[@]}")
+  fi
+  if [[ -n "$CI_BUILD_MOUNT" ]]; then
+    read -ra build_args <<< "$CI_BUILD_MOUNT"
+    docker_args+=("${build_args[@]}")
+  fi
+  # Main args
+  docker_args+=(
+    --rm
+    --interactive
+    --detach
+    --tty
+    --mount "type=bind,src=$BASE_READ_ONLY_DIR,dst=$BASE_READ_ONLY_DIR,readonly"
+    --mount "${CI_CCACHE_MOUNT}"
+    --mount "${CI_DEPENDS_MOUNT}"
+    --mount "${CI_DEPENDS_SOURCES_MOUNT}"
+    --mount "${CI_PREVIOUS_RELEASES_MOUNT}"
+  )
+  # Add worktree root mount, if needed
+  GIT_DIR=$(git rev-parse --git-dir)
+  if [[ "$GIT_DIR" == *".git/worktrees/"* ]]; then
+    WORKTREE_ROOT=$(echo "$GIT_DIR" | sed 's/\.git\/worktrees\/.*/\.git/')
+    docker_args+=(--mount "type=bind,src=$WORKTREE_ROOT,dst=$WORKTREE_ROOT,readonly")
+  fi
   # Append $USER to /tmp/env to support multi-user systems and $CONTAINER_NAME
   # to allow support starting multiple runs simultaneously by the same user.
-  # shellcheck disable=SC2086
-  CI_CONTAINER_ID=$(docker run --cap-add LINUX_IMMUTABLE $CI_CONTAINER_CAP --rm --interactive --detach --tty \
-                  --mount "type=bind,src=$BASE_READ_ONLY_DIR,dst=$BASE_READ_ONLY_DIR,readonly" \
-                  --mount "${CI_CCACHE_MOUNT}" \
-                  --mount "${CI_DEPENDS_MOUNT}" \
-                  --mount "${CI_DEPENDS_SOURCES_MOUNT}" \
-                  --mount "${CI_PREVIOUS_RELEASES_MOUNT}" \
-                  ${CI_BUILD_MOUNT} \
-                  --env-file /tmp/env-$USER-$CONTAINER_NAME \
-                  --name "$CONTAINER_NAME" \
-                  --network ci-ip6net \
-                  --platform="${CI_IMAGE_PLATFORM}" \
-                  "$CONTAINER_NAME")
+  docker_args+=(
+    --env-file "/tmp/env-$USER-$CONTAINER_NAME"
+    --name "$CONTAINER_NAME"
+    --network ci-ip6net
+    --platform="${CI_IMAGE_PLATFORM}"
+  )
+
+  docker_args+=("$CONTAINER_NAME")
+  # Execute command
+  CI_CONTAINER_ID=$(docker run "${docker_args[@]}")
+
   export CI_CONTAINER_ID
   export CI_EXEC_CMD_PREFIX="docker exec ${CI_CONTAINER_ID}"
 else

test/functional/feature_init.py

@@ -88,7 +88,7 @@ class InitTest(BitcoinTestFramework):
 
         args = ['-txindex=1', '-blockfilterindex=1', '-coinstatsindex=1']
         for terminate_line in lines_to_terminate_after:
-            self.log.info(f"Starting node and will exit after line {terminate_line}")
+            self.log.info(f"Starting node and will terminate after line {terminate_line}")
             with node.busy_wait_for_debug_log([terminate_line]):
                 if platform.system() == 'Windows':
                     # CREATE_NEW_PROCESS_GROUP is required in order to be able
@@ -108,12 +108,22 @@ class InitTest(BitcoinTestFramework):
             'blocks/index/*.ldb': 'Error opening block database.',
             'chainstate/*.ldb': 'Error opening coins database.',
             'blocks/blk*.dat': 'Error loading block database.',
+            'indexes/txindex/MANIFEST*': 'LevelDB error: Corruption: CURRENT points to a non-existent file',
+            # Removing these files does not result in a startup error:
+            # 'indexes/blockfilter/basic/*.dat', 'indexes/blockfilter/basic/db/*.*', 'indexes/coinstats/db/*.*',
+            # 'indexes/txindex/*.log', 'indexes/txindex/CURRENT', 'indexes/txindex/LOCK'
         }
 
         files_to_perturb = {
             'blocks/index/*.ldb': 'Error loading block database.',
             'chainstate/*.ldb': 'Error opening coins database.',
             'blocks/blk*.dat': 'Corrupted block database detected.',
+            'indexes/blockfilter/basic/db/*.*': 'LevelDB error: Corruption',
+            'indexes/coinstats/db/*.*': 'LevelDB error: Corruption',
+            'indexes/txindex/*.log': 'LevelDB error: Corruption',
+            'indexes/txindex/CURRENT': 'LevelDB error: Corruption',
+            # Perturbing these files does not result in a startup error:
+            # 'indexes/blockfilter/basic/*.dat', 'indexes/txindex/MANIFEST*', 'indexes/txindex/LOCK'
         }
 
         for file_patt, err_fragment in files_to_delete.items():
@@ -135,9 +145,10 @@ class InitTest(BitcoinTestFramework):
             self.stop_node(0)
 
         self.log.info("Test startup errors after perturbing certain essential files")
+        dirs = ["blocks", "chainstate", "indexes"]
         for file_patt, err_fragment in files_to_perturb.items():
-            shutil.copytree(node.chain_path / "blocks", node.chain_path / "blocks_bak")
-            shutil.copytree(node.chain_path / "chainstate", node.chain_path / "chainstate_bak")
+            for dir in dirs:
+                shutil.copytree(node.chain_path / dir, node.chain_path / f"{dir}_bak")
             target_files = list(node.chain_path.glob(file_patt))
 
             for target_file in target_files:
@@ -151,10 +162,9 @@ class InitTest(BitcoinTestFramework):
 
             start_expecting_error(err_fragment)
 
-            shutil.rmtree(node.chain_path / "blocks")
-            shutil.rmtree(node.chain_path / "chainstate")
-            shutil.move(node.chain_path / "blocks_bak", node.chain_path / "blocks")
-            shutil.move(node.chain_path / "chainstate_bak", node.chain_path / "chainstate")
+            for dir in dirs:
+                shutil.rmtree(node.chain_path / dir)
+                shutil.move(node.chain_path / f"{dir}_bak", node.chain_path / dir)
 
     def init_pid_test(self):
         BITCOIN_PID_FILENAME_CUSTOM = "my_fancy_bitcoin_pid_file.foobar"

test/functional/mempool_accept.py

@@ -45,6 +45,7 @@ from test_framework.util import (
     assert_equal,
     assert_greater_than,
     assert_raises_rpc_error,
+    sync_txindex,
 )
 from test_framework.wallet import MiniWallet
 from test_framework.wallet_util import generate_keypair
@@ -270,6 +271,7 @@ class MempoolAcceptanceTest(BitcoinTestFramework):
 
         self.log.info('A coinbase transaction')
         # Pick the input of the first tx we created, so it has to be a coinbase tx
+        sync_txindex(self, node)
         raw_tx_coinbase_spent = node.getrawtransaction(txid=node.decoderawtransaction(hexstring=raw_tx_in_block)['vin'][0]['txid'])
         tx = tx_from_hex(raw_tx_coinbase_spent)
         self.check_mempool_result(

test/functional/rpc_rawtransaction.py

@@ -34,6 +34,7 @@ from test_framework.util import (
     assert_equal,
     assert_greater_than,
     assert_raises_rpc_error,
+    sync_txindex,
 )
 from test_framework.wallet import (
     getnewdestination,
@@ -70,7 +71,7 @@ class RawTransactionsTest(BitcoinTestFramework):
         self.num_nodes = 3
         self.extra_args = [
             ["-txindex"],
-            ["-txindex"],
+            [],
             ["-fastprune", "-prune=1"],
         ]
         # whitelist peers to speed up tx relay / mempool sync
@@ -109,6 +110,7 @@ class RawTransactionsTest(BitcoinTestFramework):
             self.log.info(f"Test getrawtransaction {'with' if n == 0 else 'without'} -txindex")
 
             if n == 0:
+                sync_txindex(self, self.nodes[n])
                 # With -txindex.
                 # 1. valid parameters - only supply txid
                 assert_equal(self.nodes[n].getrawtransaction(txId), tx['hex'])

test/functional/rpc_txoutproof.py

@@ -12,6 +12,7 @@ from test_framework.test_framework import BitcoinTestFramework
 from test_framework.util import (
     assert_equal,
     assert_raises_rpc_error,
+    sync_txindex,
 )
 from test_framework.wallet import MiniWallet
 
@@ -77,6 +78,7 @@ class MerkleBlockTest(BitcoinTestFramework):
         assert_equal(sorted(self.nodes[0].verifytxoutproof(self.nodes[0].gettxoutproof([txid1, txid2]))), sorted(txlist))
         assert_equal(sorted(self.nodes[0].verifytxoutproof(self.nodes[0].gettxoutproof([txid2, txid1]))), sorted(txlist))
         # We can always get a proof if we have a -txindex
+        sync_txindex(self, self.nodes[1])
         assert_equal(self.nodes[0].verifytxoutproof(self.nodes[1].gettxoutproof([txid_spent])), [txid_spent])
         # We can't get a proof if we specify transactions from different blocks
         assert_raises_rpc_error(-5, "Not all transactions found in specified or retrieved block", self.nodes[0].gettxoutproof, [txid1, txid3])

test/functional/test_framework/util.py

@@ -592,3 +592,10 @@ def find_vout_for_address(node, txid, addr):
         if addr == tx["vout"][i]["scriptPubKey"]["address"]:
             return i
     raise RuntimeError("Vout not found for address: txid=%s, addr=%s" % (txid, addr))
+
+
+def sync_txindex(test_framework, node):
+    test_framework.log.debug("Waiting for node txindex to sync")
+    sync_start = int(time.time())
+    test_framework.wait_until(lambda: node.getindexinfo("txindex")["txindex"]["synced"])
+    test_framework.log.debug(f"Synced in {time.time() - sync_start} seconds")

test/functional/wallet_avoid_mixing_output_types.py

@@ -117,7 +117,6 @@ class AddressInputTypeGrouping(BitcoinTestFramework):
         self.extra_args = [
             [
                 "-addresstype=bech32",
-                "-txindex",
             ],
             [
                 "-addresstype=p2sh-segwit",

test/lint/README.md

@@ -4,10 +4,10 @@ Running locally
 ===============
 
 To run linters locally with the same versions as the CI environment, use the included
-Dockerfile:
+Dockerfile run via helper script to manage worktree workflows:
 
 ```sh
-DOCKER_BUILDKIT=1 docker build -t bitcoin-linter --file "./ci/lint_imagefile" ./ && docker run --rm -v $(pwd):/bitcoin -it bitcoin-linter
+./ci/lint_run_all.sh
 ```
 
 Building the container can be done every time, because it is fast when the

test/lint/test_runner/src/main.rs

@@ -178,8 +178,8 @@ fn check_output(cmd: &mut std::process::Command) -> Result<String, LintError> {
         .to_string())
 }
 
-/// Return the git root as utf8, or panic
-fn get_git_root() -> PathBuf {
+/// Return the git toplevel directory as utf8, or panic
+fn get_git_toplevel() -> PathBuf {
     PathBuf::from(check_output(git().args(["rev-parse", "--show-toplevel"])).unwrap())
 }
 
@@ -691,7 +691,7 @@ Markdown link errors found:
 
 fn run_all_python_linters() -> LintResult {
     let mut good = true;
-    let lint_dir = get_git_root().join("test/lint");
+    let lint_dir = get_git_toplevel().join("test/lint");
     for entry in fs::read_dir(lint_dir).unwrap() {
         let entry = entry.unwrap();
         let entry_fn = entry.file_name().into_string().unwrap();
@@ -723,7 +723,7 @@ fn main() -> ExitCode {
         get_linter_list()
     };
 
-    let git_root = get_git_root();
+    let git_toplevel = get_git_toplevel();
     let commit_range = commit_range();
     let commit_log = check_output(git().args(["log", "--no-merges", "--oneline", &commit_range]))
         .expect("check_output failed");
@@ -731,8 +731,8 @@ fn main() -> ExitCode {
 
     let mut test_failed = false;
     for linter in linters_to_run {
-        // chdir to root before each lint test
-        env::set_current_dir(&git_root).unwrap();
+        // chdir to git toplevel before each lint test
+        env::set_current_dir(&git_toplevel).unwrap();
         if let Err(err) = (linter.lint_fn)() {
             println!(
                 "^^^\n{err}\n^---- ⚠️ Failure generated from lint check '{}' ({})!\n\n",