Inside Bitcoin

1#!/usr/bin/env python3
2# Copyright (c) 2020-present The Bitcoin Core developers
3# Distributed under the MIT software license, see the accompanying
4# file COPYING or http://www.opensource.org/licenses/mit-license.php.
5"""
6Test that the proper port is used for -externalip=
7"""
8
9import os
10
11from test_framework.test_framework import BitcoinTestFramework, SkipTest
12from test_framework.test_node import (
13    FailedToStartError,
14)
15from test_framework.util import assert_equal, p2p_port
16
17# We need to bind to a routable address for this test to exercise the relevant
18# code. Those addresses must be on an interface that is UP and is not a loopback
19# interface (IFF_LOOPBACK).
20# To set these routable addresses on the machine, use:
21# Linux:
22# First find your interfaces: ip addr show
23# Then use your actual interface names (replace INTERFACE_NAME with yours):
24# ip addr add 1.1.1.5/32 dev INTERFACE_NAME  # to set up
25# ip addr del 1.1.1.5/32 dev INTERFACE_NAME  # to remove it
26# FreeBSD and MacOS:
27# ifconfig INTERFACE_NAME 1.1.1.5/32 alias  # to set up
28# ifconfig INTERFACE_NAME 1.1.1.5 -alias  # to remove it, after the test
29ADDR = os.getenv("BIND_TEST_ROUTABLE_IPV4", "1.1.1.5")
30
31# array of tuples [arguments, expected port in localaddresses]
32EXPECTED = [
33    [['-externalip=2.2.2.2',       '-port=30001'],                        30001],
34    [['-externalip=2.2.2.2',       '-port=30002', f'-bind={ADDR}'],       30002],
35    [['-externalip=2.2.2.2',                      f'-bind={ADDR}'],       'default_p2p_port'],
36    [['-externalip=2.2.2.2',       '-port=30003', f'-bind={ADDR}:30004'], 30004],
37    [['-externalip=2.2.2.2',                      f'-bind={ADDR}:30005'], 30005],
38    [['-externalip=2.2.2.2:30006', '-port=30007'],                        30006],
39    [['-externalip=2.2.2.2:30008', '-port=30009', f'-bind={ADDR}'],       30008],
40    [['-externalip=2.2.2.2:30010',                f'-bind={ADDR}'],       30010],
41    [['-externalip=2.2.2.2:30011', '-port=30012', f'-bind={ADDR}:30013'], 30011],
42    [['-externalip=2.2.2.2:30014',                f'-bind={ADDR}:30015'], 30014],
43    [['-externalip=2.2.2.2',       '-port=30016', f'-bind={ADDR}:30017',
44                                             f'-whitebind={ADDR}:30018'], 30017],
45    [['-externalip=2.2.2.2',       '-port=30019',
46                                             f'-whitebind={ADDR}:30020'], 30020],
47]
48
49class BindPortExternalIPTest(BitcoinTestFramework):
50    def set_test_params(self):
51        # Avoid any -bind= on the command line. Force the framework to avoid adding -bind=127.0.0.1.
52        self.setup_clean_chain = True
53        self.bind_to_localhost_only = False
54        self.num_nodes = len(EXPECTED)
55        self.extra_args = list(map(lambda e: e[0], EXPECTED))
56
57    def setup_network(self):
58        self.setup_nodes()
59
60    def setup_nodes(self):
61        self.add_nodes(self.num_nodes, self.extra_args)
62        # TestNode.start() will add -bind= to extra_args if has_explicit_bind is
63        # False. We do not want any -bind= thus set has_explicit_bind to True.
64        for node in self.nodes:
65            node.has_explicit_bind = True
66        try:
67            self.start_nodes()
68        except FailedToStartError as e:
69            self.cleanup_partially_started_nodes()
70            if 'Unable to bind to ' in str(e):
71                raise SkipTest(
72                    "To run this test, set BIND_TEST_ROUTABLE_IPV4 to an address "
73                    f"assigned to a non-loopback interface on this machine (currently {ADDR}).")
74            raise
75
76    def run_test(self):
77        self.log.info("Test the proper port is used for -externalip=")
78        for i in range(len(EXPECTED)):
79            expected_port = EXPECTED[i][1]
80            if expected_port == 'default_p2p_port':
81                expected_port = p2p_port(i)
82            found = False
83            for local in self.nodes[i].getnetworkinfo()['localaddresses']:
84                if local['address'] == '2.2.2.2':
85                    assert_equal(local['port'], expected_port)
86                    found = True
87                    break
88            assert found
89
90if __name__ == '__main__':
91    BindPortExternalIPTest(__file__).main()
92