Merge bitcoin/bitcoin#24915: lint: Convert lint-circular-dependencies.sh to Python

79635c79e0533aa7f2e2440515ad766f965343ba lint: Convert lint-circular-dependencies.sh to Python (Smlep)

Pull request description:

  Here is a port of `/test/lint/lint-circular-dependencies.sh` to a Python-script as part of the request of https://github.com/bitcoin/bitcoin/issues/24783.

  It aims to provide the same output as the bash version.

ACKs for top commit:
  laanwj:
    Tested ACK 79635c79e0533aa7f2e2440515ad766f965343ba

Tree-SHA512: f18077018f1229dd933cfe2bf0cfe7dc7d6538961c96a83c7a1f05e0cec4b068ca05502d68410d2aa4b6864523424db386e38233735190525904c2a8e9d2ba13

2 files changed, 86 insertions, 65 deletions

diff --git a/test/lint/lint-circular-dependencies.py b/test/lint/lint-circular-dependencies.py
new file mode 100755
index 0000000000..24163ec787
--- /dev/null
+++ b/test/lint/lint-circular-dependencies.py
@@ -0,0 +1,86 @@
+#!/usr/bin/env python3
+#
+# Copyright (c) 2020-2022 The Bitcoin Core developers
+# Distributed under the MIT software license, see the accompanying
+# file COPYING or http://www.opensource.org/licenses/mit-license.php.
+#
+# Check for circular dependencies
+
+import glob
+import os
+import re
+import subprocess
+import sys
+
+EXPECTED_CIRCULAR_DEPENDENCIES = (
+    "chainparamsbase -> util/system -> chainparamsbase",
+    "node/blockstorage -> validation -> node/blockstorage",
+    "index/blockfilterindex -> node/blockstorage -> validation -> index/blockfilterindex",
+    "index/base -> validation -> index/blockfilterindex -> index/base",
+    "index/coinstatsindex -> node/coinstats -> index/coinstatsindex",
+    "policy/fees -> txmempool -> policy/fees",
+    "qt/addresstablemodel -> qt/walletmodel -> qt/addresstablemodel",
+    "qt/recentrequeststablemodel -> qt/walletmodel -> qt/recentrequeststablemodel",
+    "qt/sendcoinsdialog -> qt/walletmodel -> qt/sendcoinsdialog",
+    "qt/transactiontablemodel -> qt/walletmodel -> qt/transactiontablemodel",
+    "wallet/fees -> wallet/wallet -> wallet/fees",
+    "wallet/wallet -> wallet/walletdb -> wallet/wallet",
+    "node/coinstats -> validation -> node/coinstats",
+)
+
+CODE_DIR = "src"
+
+
+def main():
+    circular_dependencies = []
+    exit_code = 0
+    os.chdir(
+        CODE_DIR
+    )  # We change dir before globbing since glob.glob's root_dir option is only available in Python 3.10
+
+    # Using glob.glob since subprocess.run's globbing won't work without shell=True
+    files = []
+    for path in ["*", "*/*", "*/*/*"]:
+        for extension in ["h", "cpp"]:
+            files.extend(glob.glob(f"{path}.{extension}"))
+
+    command = ["python3", "../contrib/devtools/circular-dependencies.py", *files]
+    dependencies_output = subprocess.run(
+        command,
+        stdout=subprocess.PIPE,
+        universal_newlines=True,
+    )
+
+    for dependency_str in dependencies_output.stdout.rstrip().split("\n"):
+        circular_dependencies.append(
+            re.sub("^Circular dependency: ", "", dependency_str)
+        )
+
+    # Check for an unexpected dependencies
+    for dependency in circular_dependencies:
+        if dependency not in EXPECTED_CIRCULAR_DEPENDENCIES:
+            exit_code = 1
+            print(
+                f'A new circular dependency in the form of "{dependency}" appears to have been introduced.\n',
+                file=sys.stderr,
+            )
+
+    # Check for missing expected dependencies
+    for expected_dependency in EXPECTED_CIRCULAR_DEPENDENCIES:
+        if expected_dependency not in circular_dependencies:
+            exit_code = 1
+            print(
+                f'Good job! The circular dependency "{expected_dependency}" is no longer present.',
+            )
+            print(
+                f"Please remove it from EXPECTED_CIRCULAR_DEPENDENCIES in {__file__}",
+            )
+            print(
+                "to make sure this circular dependency is not accidentally reintroduced.\n",
+            )
+
+    sys.exit(exit_code)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/test/lint/lint-circular-dependencies.sh b/test/lint/lint-circular-dependencies.sh
deleted file mode 100755
index 69185090d1..0000000000
--- a/test/lint/lint-circular-dependencies.sh
+++ /dev/null
@@ -1,65 +0,0 @@
-#!/usr/bin/env bash
-#
-# Copyright (c) 2018-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.
-#
-# Check for circular dependencies
-
-export LC_ALL=C
-
-EXPECTED_CIRCULAR_DEPENDENCIES=(
-    "chainparamsbase -> util/system -> chainparamsbase"
-    "node/blockstorage -> validation -> node/blockstorage"
-    "index/blockfilterindex -> node/blockstorage -> validation -> index/blockfilterindex"
-    "index/base -> validation -> index/blockfilterindex -> index/base"
-    "index/coinstatsindex -> node/coinstats -> index/coinstatsindex"
-    "policy/fees -> txmempool -> policy/fees"
-    "qt/addresstablemodel -> qt/walletmodel -> qt/addresstablemodel"
-    "qt/recentrequeststablemodel -> qt/walletmodel -> qt/recentrequeststablemodel"
-    "qt/sendcoinsdialog -> qt/walletmodel -> qt/sendcoinsdialog"
-    "qt/transactiontablemodel -> qt/walletmodel -> qt/transactiontablemodel"
-    "wallet/fees -> wallet/wallet -> wallet/fees"
-    "wallet/wallet -> wallet/walletdb -> wallet/wallet"
-    "node/coinstats -> validation -> node/coinstats"
-)
-
-EXIT_CODE=0
-
-CIRCULAR_DEPENDENCIES=()
-
-IFS=$'\n'
-for CIRC in $(cd src && ../contrib/devtools/circular-dependencies.py {*,*/*,*/*/*}.{h,cpp} | sed -e 's/^Circular dependency: //'); do
-    CIRCULAR_DEPENDENCIES+=( "$CIRC" )
-    IS_EXPECTED_CIRC=0
-    for EXPECTED_CIRC in "${EXPECTED_CIRCULAR_DEPENDENCIES[@]}"; do
-        if [[ "${CIRC}" == "${EXPECTED_CIRC}" ]]; then
-            IS_EXPECTED_CIRC=1
-            break
-        fi
-    done
-    if [[ ${IS_EXPECTED_CIRC} == 0 ]]; then
-        echo "A new circular dependency in the form of \"${CIRC}\" appears to have been introduced."
-        echo
-        EXIT_CODE=1
-    fi
-done
-
-for EXPECTED_CIRC in "${EXPECTED_CIRCULAR_DEPENDENCIES[@]}"; do
-    IS_PRESENT_EXPECTED_CIRC=0
-    for CIRC in "${CIRCULAR_DEPENDENCIES[@]}"; do
-        if [[ "${CIRC}" == "${EXPECTED_CIRC}" ]]; then
-            IS_PRESENT_EXPECTED_CIRC=1
-            break
-        fi
-    done
-    if [[ ${IS_PRESENT_EXPECTED_CIRC} == 0 ]]; then
-        echo "Good job! The circular dependency \"${EXPECTED_CIRC}\" is no longer present."
-        echo "Please remove it from EXPECTED_CIRCULAR_DEPENDENCIES in $0"
-        echo "to make sure this circular dependency is not accidentally reintroduced."
-        echo
-        EXIT_CODE=1
-    fi
-done
-
-exit ${EXIT_CODE}