1#!/usr/bin/env python3
2# Copyright (c) The Bitcoin Core developers
3# Distributed under the MIT software license, see the accompanying
4# file COPYING or https://opensource.org/license/mit/.
5
6import argparse
7import os
8import re
9import shlex
10import subprocess
11import sys
12from pathlib import Path
13
14sys.path.append(str(Path(__file__).resolve().parent.parent / "test"))
15from download_utils import download_script_assets
16
17
18def run(cmd, **kwargs):
19    print("+ " + shlex.join(cmd), flush=True)
20    kwargs.setdefault("check", True)
21    try:
22        return subprocess.run(cmd, **kwargs)
23    except Exception as e:
24        sys.exit(str(e))
25
26
27def print_version():
28    bitcoind = Path.cwd() / "bin" / "bitcoind.exe"
29    run([str(bitcoind), "-version"])
30
31
32def check_imports():
33    bitcoind = Path.cwd() / "bin" / "bitcoind.exe"
34    output = run(
35        ["dumpbin.exe", "/imports", str(bitcoind)],
36        capture_output=True,
37        text=True,
38    ).stdout
39    dlls = re.findall(r"^\s*(\S+\.dll)\s*$", output, re.IGNORECASE | re.MULTILINE)
40    print("\n".join(dlls))
41
42    # Ensure the executable is linked against the expected C runtime.
43    dlls = {name.lower() for name in dlls}
44    uses_msvcrt = "msvcrt.dll" in dlls
45    uses_ucrt = any(name.startswith("api-ms-win-crt-") for name in dlls)
46    crt = os.environ["CRT"]
47    if crt == "msvcrt":
48        crt_ok = uses_msvcrt and not uses_ucrt
49    elif crt == "ucrt":
50        crt_ok = uses_ucrt and not uses_msvcrt
51    else:
52        sys.exit(f"Unexpected CRT value: {crt!r}")
53    if not crt_ok:
54        sys.exit(f"Imported DLLs do not match the expected {crt!r} C runtime.")
55
56
57def check_manifests():
58    release_dir = Path.cwd() / "bin"
59    manifest_path = release_dir / "bitcoind.manifest"
60
61    cmd_bitcoind_manifest = [
62        "mt.exe",
63        "-nologo",
64        f"-inputresource:{release_dir / 'bitcoind.exe'}",
65        f"-out:{manifest_path}",
66    ]
67    run(cmd_bitcoind_manifest)
68    print(manifest_path.read_text())
69
70    skipped = {  # Skip as they currently do not have manifests
71        "fuzz.exe",
72        "bench_bitcoin.exe",
73    }
74    for entry in release_dir.iterdir():
75        if entry.suffix.lower() != ".exe":
76            continue
77        if entry.name in skipped:
78            print(f"Skipping {entry.name} (no manifest present)")
79            continue
80        print(f"Checking {entry.name}")
81        run(["mt.exe", "-nologo", f"-inputresource:{entry}", "-validate_manifest"])
82
83
84def prepare_tests():
85    workspace = Path.cwd()
86    config_path = workspace / "test" / "config.ini"
87    rpcauth_path = workspace / "share" / "rpcauth" / "rpcauth.py"
88    replacements = {
89        "SRCDIR=": f"SRCDIR={workspace}",
90        "BUILDDIR=": f"BUILDDIR={workspace}",
91        "RPCAUTH=": f"RPCAUTH={rpcauth_path}",
92    }
93    lines = config_path.read_text().splitlines()
94    for index, line in enumerate(lines):
95        for prefix, new_value in replacements.items():
96            if line.startswith(prefix):
97                lines[index] = new_value
98                break
99    content = "\n".join(lines) + "\n"
100    config_path.write_text(content)
101    print(content)
102    cmd_download_prev_rel = [
103        sys.executable,
104        str(workspace / "test" / "get_previous_releases.py"),
105    ]
106    run(cmd_download_prev_rel)
107    run([sys.executable, "-m", "pip", "install", "pyzmq"])
108
109    dest = workspace / "unit_test_data"
110    download_script_assets(dest)
111
112
113def run_functional_tests():
114    workspace = Path.cwd()
115    num_procs = str(os.process_cpu_count())
116    test_runner_cmd = [
117        sys.executable,
118        str(workspace / "test" / "functional" / "test_runner.py"),
119        "--jobs",
120        num_procs,
121        "--quiet",
122        f"--tmpdirprefix={workspace / '_ _'}",
123        "--combinedlogslen=99999999",
124        *shlex.split(os.environ.get("TEST_RUNNER_EXTRA", "").strip()),
125        # Tests using ancient releases fail on Windows because of emojis in the test data directory.
126        "--exclude",
127        "feature_unsupported_utxo_db.py",
128        "--exclude",
129        "wallet_ancient_migration.py",
130    ]
131    run(test_runner_cmd)
132
133    # Run ancient release tests sequentially in ASCII-only tmp dir,
134    # because they are excluded above due to lack of UTF-8 support in the
135    # ancient release.
136    for test_name in ["feature_unsupported_utxo_db", "wallet_ancient_migration"]:
137        cmd = [
138            sys.executable,
139            str(workspace / "test" / "functional" / f"{test_name}.py"),
140            "--previous-releases",
141            "--tmpdir",
142            str(workspace / f"test_{test_name}"),
143        ]
144        run(cmd)
145
146
147def run_unit_tests():
148    workspace = Path.cwd()
149    os.environ["DIR_UNIT_TEST_DATA"] = str(workspace / "unit_test_data")
150    # Can't use ctest here like other jobs as we don't have a CMake build tree.
151    commands = [
152        ["./bin/test_bitcoin-qt.exe"],
153        # Intentionally run sequentially here, to catch test case failures caused by dirty global state from prior test cases:
154        ["./bin/test_bitcoin.exe", "-l", "test_suite"],
155        ["./src/secp256k1/bin/exhaustive_tests.exe"],
156        ["./src/secp256k1/bin/noverify_tests.exe"],
157        ["./src/secp256k1/bin/tests.exe"],
158        ["./src/univalue/object.exe"],
159        ["./src/univalue/unitester.exe"],
160    ]
161    for cmd in commands:
162        run(cmd)
163
164
165def main():
166    parser = argparse.ArgumentParser(description="Utility to run Windows CI steps.")
167    steps = list(map(lambda f: f.__name__, [
168        print_version,
169        check_imports,
170        check_manifests,
171        prepare_tests,
172        run_unit_tests,
173        run_functional_tests,
174    ]))
175    parser.add_argument("step", choices=steps, help="CI step to perform.")
176    args = parser.parse_args()
177
178    os.environ.setdefault(
179        "PREVIOUS_RELEASES_DIR",
180        str(Path.cwd() / "previous_releases"),
181    )
182
183    exec(f'{args.step}()')
184
185
186if __name__ == "__main__":
187    main()
188