#!/usr/bin/env python3
# Copyright (c) 2014-2016 The Bitcoin Core developers
# Distributed under the MIT software license, see the accompanying
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
"""Test node disconnect and ban behavior"""
import time

from test_framework.test_framework import BitcoinTestFramework
from test_framework.util import (
    assert_equal,
    assert_raises_rpc_error,
    connect_nodes_bi,
    wait_until,
)


class DisconnectBanTest(BitcoinTestFramework):
    def set_test_params(self):
        self.num_nodes = 2

    def run_test(self):
        self.log.info("Test setban and listbanned RPCs")

        self.log.info("setban: successfully ban single IP address")
        # node1 should have 2 connections to node0 at this point
        assert_equal(len(self.nodes[1].getpeerinfo()), 2)
        self.nodes[1].setban(subnet="127.0.0.1", command="add")
        wait_until(lambda: len(self.nodes[1].getpeerinfo()) == 0, timeout=10)
        # all nodes must be disconnected at this point
        assert_equal(len(self.nodes[1].getpeerinfo()), 0)
        assert_equal(len(self.nodes[1].listbanned()), 1)

        self.log.info("clearbanned: don't clear manual bans but clear automatic bans")
        self.nodes[1].clearbanned(manual=False, automatic=True)
        assert_equal(len(self.nodes[1].listbanned()), 1)
        self.log.info("clearbanned: successfully clear ban list")
        self.nodes[1].clearbanned()
        assert_equal(len(self.nodes[1].listbanned()), 0)
        self.nodes[1].setban("127.0.0.0/24", "add")

        self.log.info("setban: fail to ban an already banned subnet")
        assert_equal(len(self.nodes[1].listbanned()), 1)
        assert_raises_rpc_error(
            -23, "IP/Subnet already banned", self.nodes[1].setban, "127.0.0.1", "add")

        self.log.info("setban: fail to ban an invalid subnet")
        assert_raises_rpc_error(
            -30, "Error: Invalid IP/Subnet", self.nodes[1].setban, "127.0.0.1/42", "add")
        # still only one banned ip because 127.0.0.1 is within the range of
        # 127.0.0.0/24
        assert_equal(len(self.nodes[1].listbanned()), 1)

        self.log.info("setban remove: fail to unban a non-banned subnet")
        assert_raises_rpc_error(
            -30, "Error: Unban failed", self.nodes[1].setban, "127.0.0.1", "remove")
        assert_equal(len(self.nodes[1].listbanned()), 1)

        self.log.info("setban remove: successfully unban subnet")
        self.nodes[1].setban("127.0.0.0/24", "remove")
        assert_equal(len(self.nodes[1].listbanned()), 0)
        self.nodes[1].clearbanned(manual=True, automatic=False)
        assert_equal(len(self.nodes[1].listbanned()), 0)

        self.log.info("setban: test persistence across node restart")
        self.nodes[1].setban("127.0.0.0/32", "add")
        self.nodes[1].setban("127.0.0.0/24", "add")
        # Set the mocktime so we can control when bans expire
        old_time = int(time.time())
        self.nodes[1].setmocktime(old_time)
        # ban for 1 seconds
        self.nodes[1].setban("192.168.0.1", "add", 1)
        # ban for 1000 seconds
        self.nodes[1].setban(
            "2001:4d48:ac57:400:cacf:e9ff:fe1d:9c63/19", "add", 1000)
        listBeforeShutdown = self.nodes[1].listbanned()
        assert_equal("192.168.0.1/32", listBeforeShutdown[2]['address'])
        # Move time forward by 3 seconds so the third ban has expired
        self.nodes[1].setmocktime(old_time + 3)
        assert_equal(len(self.nodes[1].listbanned()), 3)

        self.stop_node(1)
        self.start_node(1)

        listAfterShutdown = self.nodes[1].listbanned()
        assert_equal("127.0.0.0/24", listAfterShutdown[0]['address'])
        assert_equal("127.0.0.0/32", listAfterShutdown[1]['address'])
        assert_equal("/19" in listAfterShutdown[2]['address'], True)

        # Clear ban lists
        self.nodes[1].clearbanned()
        connect_nodes_bi(self.nodes[0], self.nodes[1])

        self.log.info("Test disconnectnode RPCs")

        self.log.info(
            "disconnectnode: fail to disconnect when calling with address and nodeid")
        address1 = self.nodes[0].getpeerinfo()[0]['addr']
        node1 = self.nodes[0].getpeerinfo()[0]['addr']
        assert_raises_rpc_error(
            -32602, "Only one of address and nodeid should be provided.",
            self.nodes[0].disconnectnode, address=address1, nodeid=node1)

        self.log.info(
            "disconnectnode: fail to disconnect when calling with junk address")
        assert_raises_rpc_error(-29, "Node not found in connected nodes",
                                self.nodes[0].disconnectnode, address="221B Baker Street")

        self.log.info(
            "disconnectnode: successfully disconnect node by address")
        address1 = self.nodes[0].getpeerinfo()[0]['addr']
        self.nodes[0].disconnectnode(address=address1)
        wait_until(lambda: len(self.nodes[0].getpeerinfo()) == 1, timeout=10)
        assert not [node for node in self.nodes[0].getpeerinfo()
                    if node['addr'] == address1]

        self.log.info("disconnectnode: successfully reconnect node")
        # reconnect the node
        connect_nodes_bi(self.nodes[0], self.nodes[1])
        assert_equal(len(self.nodes[0].getpeerinfo()), 2)
        assert [node for node in self.nodes[0]
                .getpeerinfo() if node['addr'] == address1]

        self.log.info(
            "disconnectnode: successfully disconnect node by node id")
        id1 = self.nodes[0].getpeerinfo()[0]['id']
        self.nodes[0].disconnectnode(nodeid=id1)
        wait_until(lambda: len(self.nodes[0].getpeerinfo()) == 1, timeout=10)
        assert not [node for node in self.nodes[0].getpeerinfo()
                    if node['id'] == id1]


if __name__ == '__main__':
    DisconnectBanTest().main()
