Inside Bitcoin

1001        """Attempt to import the capnp package and skip the test if the import fails."""
1002        try:
1003            import capnp  # type: ignore[import] # noqa: F401
1004        except ImportError:
1005            raise SkipTest("capnp module not available.")
1006
1007    def skip_if_no_python_bcc(self):
1008        """Attempt to import the bcc package and skip the tests if the import fails."""
1009        try:
1010            import bcc  # type: ignore[import] # noqa: F401
1011        except ImportError:
1012            raise SkipTest("bcc python module not available")
1013
1014    def skip_if_no_bitcoind_tracepoints(self):
1015        """Skip the running test if bitcoind has not been compiled with USDT tracepoint support."""
1016        if not self.is_usdt_compiled():
1017            raise SkipTest("bitcoind has not been built with USDT tracepoints enabled.")
1018
1019    def skip_if_no_bpf_permissions(self):
1020        """Skip the running test if we don't have permissions to do BPF syscalls and load BPF maps."""
1021        # check for 'root' permissions
1022        if os.geteuid() != 0:
1023            raise SkipTest("no permissions to use BPF (please review the tests carefully before running them with higher privileges)")
1024
1025    def skip_if_platform_not_linux(self):
1026        """Skip the running test if we are not on a Linux platform"""
1027        if platform.system() != "Linux":
1028            raise SkipTest("not on a Linux system")
1029
1030    def skip_if_no_lsof_on_nonlinux(self):
1031        """Skip the running test if the lsof utility is not available on non-Linux platforms."""
1032        if sys.platform != "linux" and shutil.which("lsof") is None:
1033            raise SkipTest("lsof not available")
1034
1035    def skip_if_platform_not_posix(self):
1036        """Skip the running test if we are not on a POSIX platform"""
1037        if os.name != 'posix':
1038            raise SkipTest("not on a POSIX system")
1039
1040    def skip_if_no_bitcoind_zmq(self):
1041        """Skip the running test if bitcoind has not been compiled with zmq support."""
1042        if not self.is_zmq_compiled():
1043            raise SkipTest("bitcoind has not been built with zmq enabled.")
1044
1045    def skip_if_no_wallet(self):
1046        """Skip the running test if wallet has not been compiled."""
1047        self.uses_wallet = True
1048        if not self.is_wallet_compiled():
1049            raise SkipTest("wallet has not been compiled.")
1050
1051    def skip_if_no_wallet_tool(self):
1052        """Skip the running test if bitcoin-wallet has not been compiled."""
1053        if not self.is_wallet_tool_compiled():
1054            raise SkipTest("bitcoin-wallet has not been compiled")
1055
1056    def skip_if_no_bitcoin_tx(self):
1057        """Skip the running test if bitcoin-tx has not been compiled."""
1058        if not self.is_bitcoin_tx_compiled():
1059            raise SkipTest("bitcoin-tx has not been compiled")
1060
1061    def skip_if_no_bitcoin_util(self):
1062        """Skip the running test if bitcoin-util has not been compiled."""
1063        if not self.is_bitcoin_util_compiled():
1064            raise SkipTest("bitcoin-util has not been compiled")
1065
1066    def skip_if_no_bitcoin_chainstate(self):
1067        """Skip the running test if bitcoin-chainstate has not been compiled."""
1068        if not self.is_bitcoin_chainstate_compiled():
1069            raise SkipTest("bitcoin-chainstate has not been compiled")
1070
1071    def skip_if_no_bitcoin_bench(self):
1072        """Skip the running test if bench_bitcoin has not been compiled."""
1073        if not self.is_bench_compiled():
1074            raise SkipTest("bench_bitcoin has not been compiled")
1075
1076    def skip_if_no_cli(self):
1077        """Skip the running test if bitcoin-cli has not been compiled."""
1078        if not self.is_cli_compiled():
1079            raise SkipTest("bitcoin-cli has not been compiled.")
1080
1081    def skip_if_no_ipc(self):
1082        """Skip the running test if ipc is not compiled."""
1083        if not self.is_ipc_compiled():
1084            raise SkipTest("ipc has not been compiled.")
1085
1086    def skip_if_no_gui(self):
1087        """Skip the running test if the GUI has not been compiled."""
1088        if not self.is_gui_compiled():
1089            raise SkipTest("GUI has not been compiled.")
1090
1091    def skip_if_no_previous_releases(self):
1092        """Skip the running test if previous releases are not available."""
1093        if not self.has_previous_releases():
1094            raise SkipTest("previous releases not available or disabled")
1095
1096    def has_resource_module(self):
1097        """Checks whether the resource module is available."""
1098        return find_spec('resource') is not None
1099
1100    @property
1101    def RLIM_INFINITY(self):
1102        if not self.has_resource_module():
1103            return None
1104        import resource
1105        return resource.RLIM_INFINITY
1106
1107    def has_previous_releases(self):
1108        """Checks whether previous releases are present and enabled."""
1109        if not os.path.isdir(self.options.previous_releases_path):
1110            if self.options.prev_releases:
1111                raise AssertionError(f"Force test of previous releases but releases missing: {self.options.previous_releases_path}\n"
1112                                     "Previous releases binaries can be downloaded via `test/get_previous_releases.py`.")
1113        return self.options.prev_releases
1114
1115    def skip_if_no_external_signer(self):
1116        """Skip the running test if external signer support has not been compiled."""
1117        if not self.is_external_signer_compiled():
1118            raise SkipTest("external signer support has not been compiled.")
1119
1120    def skip_if_running_under_valgrind(self):
1121        """Skip the running test if Valgrind is being used."""
1122        if self.options.valgrind:
1123            raise SkipTest("This test is not compatible with Valgrind.")
1124
1125    def is_bench_compiled(self):
1126        """Checks whether bench_bitcoin was compiled."""
1127        return self.config.getboolean("components", "BUILD_BENCH")
1128
1129    def is_cli_compiled(self):
1130        """Checks whether bitcoin-cli was compiled."""
1131        return self.config.getboolean("components", "ENABLE_CLI")
1132
1133    def is_external_signer_compiled(self):
1134        """Checks whether external signer support was compiled."""
1135        return self.config.getboolean("components", "ENABLE_EXTERNAL_SIGNER")
1136
1137    def is_wallet_compiled(self):
1138        """Checks whether the wallet module was compiled."""
1139        return self.config.getboolean("components", "ENABLE_WALLET")
1140
1141    def is_wallet_tool_compiled(self):
1142        """Checks whether bitcoin-wallet was compiled."""
1143        return self.config.getboolean("components", "ENABLE_WALLET_TOOL")
1144
1145    def is_bitcoin_tx_compiled(self):
1146        """Checks whether bitcoin-tx was compiled."""
1147        return self.config.getboolean("components", "BUILD_BITCOIN_TX")
1148
1149    def is_bitcoin_util_compiled(self):
1150        """Checks whether bitcoin-util was compiled."""
1151        return self.config.getboolean("components", "ENABLE_BITCOIN_UTIL")
1152
1153    def is_bitcoin_chainstate_compiled(self):
1154        """Checks whether bitcoin-chainstate was compiled."""
1155        return self.config.getboolean("components", "ENABLE_BITCOIN_CHAINSTATE")
1156
1157    def is_zmq_compiled(self):
1158        """Checks whether the zmq module was compiled."""
1159        return self.config.getboolean("components", "ENABLE_ZMQ")
1160
1161    def is_embedded_asmap_compiled(self):
1162        """Checks whether ASMap data was embedded during compilation."""
1163        return self.config.getboolean("components", "ENABLE_EMBEDDED_ASMAP")
1164
1165    def is_usdt_compiled(self):
1166        """Checks whether the USDT tracepoints were compiled."""
1167        return self.config.getboolean("components", "ENABLE_USDT_TRACEPOINTS")
1168
1169    def is_ipc_compiled(self):
1170        """Checks whether ipc was compiled."""
1171        return self.config.getboolean("components", "ENABLE_IPC")
1172
1173    def is_gui_compiled(self):
1174        """Checks whether the GUI was compiled."""
1175        return self.config.getboolean("components", "BUILD_GUI")
1176
1177    def has_blockfile(self, node, filenum: str):
1178        return (node.blocks_path/ f"blk{filenum}.dat").is_file()
1179
1180    def inspect_sqlite_db(self, path, fn, *args, **kwargs):
1181        try:
1182            import sqlite3 # type: ignore[import]
1183            conn = sqlite3.connect(path)
1184            with conn:
1185                result = fn(conn, *args, **kwargs)
1186            conn.close()
1187            return result
1188        except ImportError:
1189            self.log.warning("sqlite3 module not available, skipping tests that inspect the database")
1190
1191    def cleanup_folder(self, _path):
1192        path = Path(_path)
1193        if not path.is_relative_to(self.options.tmpdir):
1194            raise AssertionError(f"Trying to delete #{path} outside of #{self.options.tmpdir}")
1195        shutil.rmtree(path)
1196