ci, iwyu: Treat warnings as errors for specific directories

[hebasto]

This PR is the first step towards treating IWYU warnings as errors. At this stage, it applies only to the crypto and index directories.

[DrahtBot]

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage & Benchmarks

For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/31308.

Reviews

See the guideline for information on the review process.

Type	Reviewers
ACK	ryanofsky, maflcko, willcl-ark
Concept ACK	jonatack, l0rinc, sipa

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

Conflicts

Reviewers, this pull request conflicts with the following ones:

• #26966 (index: initial sync speedup, parallelize process by furszy)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

[hebasto]

Rebased.

[ryanofsky]

Code review ACK d03d861. Just fixing up comment and changing variable name since last review. Thanks for the updates!

[hebasto]

Rebased due to a conflict with #30469.

[sipa]

Concept ACK

[ryanofsky]

Code review ACK 02d2b5a. Just rebased and update tidy patch comment again since last review

[maflcko]

Only small changes:

• Rebase
• one minimal doc fixup
• one minimal symbol rename in the ci script

re-ACK 02d2b5a 💮

Show signature

Signature:

untrusted comment: signature from minisign secret key on empty file; verify via: minisign -Vm "${path_to_any_empty_file}" -P RWTRmVTMeKV5noAMqVlsMugDDCyyTSbA3Re5AkUrhvLVln0tSaFWglOw -x "${path_to_this_whole_four_line_signature_blob}"
RUTRmVTMeKV5npGrKx1nqXCw5zeVHdtdYURB/KlyA/LMFgpNCs+SkW9a8N95d+U4AP1RJMi+krxU1A3Yux4bpwZNLvVBKy0wLgM=
trusted comment: re-ACK 02d2b5a11c921ef71c971ee80eb3dfbc75c8cb0d 💮
i6k+tDtPP9iRHFh7vqSwsKvwZGIQPp3PvB3+nmXymPC4FluFds6Qg6B9l4gWYCS6MeOr/J1S2JKTnHlyd54bAg==

[maflcko]

Looks like the CI re-run passed after one month, so it seems reasonable stable

[maflcko]

rfm?

[willcl-ark]

ACK 02d2b5a

I like the approach here of enforcing as-we-go through the codebase. Something similar was done recently in nixpkgs with their treefmt formatter.

Tested that this worked locally by modifying the test script and running.

Details

#!/usr/bin/env bash
set -x

BASE_ROOT_DIR="$HOME/src/core/bitcoin"
BASE_BUILD_DIR="$BASE_ROOT_DIR/build"
FILES_WITH_ENFORCED_IWYU="$HOME/src/core/bitcoin/src/(crypto|index)/.*\\.cpp"

jq --arg patterns "$FILES_WITH_ENFORCED_IWYU" 'map(select(.file | test($patterns)))' "${BASE_BUILD_DIR}/compile_commands.json" > "${BASE_BUILD_DIR}/compile_commands_iwyu_errors.json"
jq --arg patterns "$FILES_WITH_ENFORCED_IWYU" 'map(select(.file | test($patterns) | not))' "${BASE_BUILD_DIR}/compile_commands.json" > "${BASE_BUILD_DIR}/compile_commands_iwyu_warnings.json"

cd "${BASE_ROOT_DIR}" || exit

run_iwyu() {
    mv "${BASE_BUILD_DIR}/$1" "${BASE_BUILD_DIR}/compile_commands.json"
    "$(command -v iwyu_tool.py)" \
         -p "${BASE_BUILD_DIR}" "${MAKEJOBS}" \
         -- -Xiwyu --cxx17ns -Xiwyu --mapping_file="${BASE_ROOT_DIR}/contrib/devtools/iwyu/bitcoin.core.imp" \
         -Xiwyu --max_line_length=160 \
         2>&1 | tee /tmp/iwyu_ci.out
    "$(command -v fix_includes.py)" --nosafe_headers < /tmp/iwyu_ci.out
}

run_iwyu "compile_commands_iwyu_errors.json"
if ! ( git --no-pager diff --exit-code ); then
    echo "^^^ ⚠️ Failure generated from IWYU"
    false
fi

run_iwyu "compile_commands_iwyu_warnings.json"
git --no-pager diff