dash/test/lint/lint-circular-dependencies.sh

#!/usr/bin/env bash
#
# Copyright (c) 2018-2020 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/transactiontablemodel -> qt/walletmodel -> qt/transactiontablemodel"
    "txmempool -> validation -> txmempool"
    "wallet/fees -> wallet/wallet -> wallet/fees"
    "wallet/wallet -> wallet/walletdb -> wallet/wallet"
    "node/coinstats -> validation -> node/coinstats"
    # Dash
    "dsnotificationinterface -> llmq/chainlocks -> node/blockstorage -> dsnotificationinterface"
    "evo/cbtx -> evo/simplifiedmns -> evo/cbtx"
    "evo/deterministicmns -> llmq/commitment -> evo/deterministicmns"
    "evo/deterministicmns -> llmq/utils -> evo/deterministicmns"
    "governance/classes -> governance/governance -> governance/classes"
    "governance/governance -> governance/object -> governance/governance"
    "governance/governance -> masternode/sync -> governance/governance"
    "llmq/chainlocks -> llmq/instantsend -> llmq/chainlocks"
    "llmq/dkgsessionhandler -> net_processing -> llmq/dkgsessionmgr -> llmq/dkgsessionhandler"
    "llmq/instantsend -> net_processing -> llmq/instantsend"
    "llmq/instantsend -> txmempool -> llmq/instantsend"
    "llmq/instantsend -> validation -> llmq/instantsend"
    "llmq/signing -> llmq/signing_shares -> llmq/signing"
    "llmq/signing -> net_processing -> llmq/signing"
    "llmq/signing_shares -> net_processing -> llmq/signing_shares"
    "logging -> util/system -> logging"
    "masternode/payments -> validation -> masternode/payments"
    "masternode/sync -> validation -> masternode/sync"
    "net -> netmessagemaker -> net"
    "netaddress -> netbase -> netaddress"
    "qt/appearancewidget -> qt/guiutil -> qt/appearancewidget"
    "qt/bitcoinaddressvalidator -> qt/guiutil -> qt/bitcoinaddressvalidator"
    "qt/bitcoingui -> qt/guiutil -> qt/bitcoingui"
    "qt/guiutil -> qt/optionsdialog -> qt/guiutil"
    "qt/guiutil -> qt/qvalidatedlineedit -> qt/guiutil"
    "core_io -> evo/cbtx -> evo/simplifiedmns -> core_io"
    "llmq/dkgsession -> llmq/dkgsessionmgr -> llmq/dkgsessionhandler -> llmq/dkgsession"
    "logging -> util/system -> sync -> logging"
    "logging -> util/system -> stacktraces -> logging"
    "logging -> util/system -> util/getuniquepath -> random -> logging"
    "qt/appearancewidget -> qt/guiutil -> qt/optionsdialog -> qt/appearancewidget"
    "qt/guiutil -> qt/optionsdialog -> qt/optionsmodel -> qt/guiutil"

    "bloom -> evo/assetlocktx -> llmq/quorums -> net -> bloom"
    "bloom -> evo/assetlocktx -> llmq/signing -> net_processing -> merkleblock -> bloom"
    "banman -> bloom -> evo/assetlocktx -> llmq/quorums -> net -> banman"
    "banman -> bloom -> evo/assetlocktx -> llmq/signing -> net_processing -> banman"

    "llmq/chainlocks -> validation -> llmq/chainlocks"
    "coinjoin/coinjoin -> llmq/chainlocks -> net -> coinjoin/coinjoin"
    "evo/deterministicmns -> llmq/utils -> llmq/snapshot -> evo/simplifiedmns -> evo/deterministicmns"
    "evo/deterministicmns -> llmq/utils -> net -> evo/deterministicmns"
    "policy/policy -> policy/settings -> policy/policy"
    "consensus/tx_verify -> evo/assetlocktx -> validation -> consensus/tx_verify"
    "consensus/tx_verify -> evo/assetlocktx -> llmq/signing -> net_processing -> txmempool -> consensus/tx_verify"
    "evo/assetlocktx -> llmq/signing -> net_processing -> txmempool -> evo/assetlocktx"

    "evo/simplifiedmns -> llmq/blockprocessor -> llmq/utils -> llmq/snapshot -> evo/simplifiedmns"
    "llmq/blockprocessor -> llmq/utils -> llmq/snapshot -> llmq/blockprocessor"
    "llmq/commitment -> llmq/utils -> llmq/snapshot -> llmq/commitment"
    "spork -> validation -> spork"
    "governance/governance -> validation -> governance/governance"
    "evo/deterministicmns -> validationinterface -> governance/vote -> evo/deterministicmns"
    "governance/vote -> masternode/node -> validationinterface -> governance/vote"
    "llmq/signing -> masternode/node -> validationinterface -> llmq/signing"
    "evo/mnhftx -> validation -> evo/mnhftx"
    "evo/deterministicmns -> validation -> evo/deterministicmns"
    "evo/specialtxman -> validation -> evo/specialtxman"
    "evo/chainhelper -> evo/specialtxman -> validation -> evo/chainhelper"
    "evo/deterministicmns -> validationinterface -> evo/deterministicmns"
    "logging -> util/system -> sync -> logging/timer -> logging"

    "coinjoin/client -> net_processing -> coinjoin/client"
    "coinjoin/client -> net_processing -> coinjoin/context -> coinjoin/client"
    "coinjoin/context -> coinjoin/server -> net_processing -> coinjoin/context"
    "coinjoin/server -> net_processing -> coinjoin/server"
    "llmq/context -> llmq/ehf_signals -> net_processing -> llmq/context"
    "llmq/blockprocessor -> net_processing -> llmq/blockprocessor"
    "llmq/chainlocks -> net_processing -> llmq/chainlocks"
    "net_processing -> spork -> net_processing"
    "evo/simplifiedmns -> llmq/blockprocessor -> net_processing -> evo/simplifiedmns"
    "governance/governance -> net_processing -> governance/governance"
    "llmq/blockprocessor -> net_processing -> llmq/context -> llmq/blockprocessor"
    "llmq/blockprocessor -> net_processing -> llmq/quorums -> llmq/blockprocessor"
    "llmq/chainlocks -> net_processing -> llmq/context -> llmq/chainlocks"
    "rpc/blockchain -> rpc/server -> rpc/blockchain"
)

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}