py-libp2p/tests/network/test_swarm.py

import asyncio

from multiaddr import Multiaddr
import pytest

from libp2p.network.exceptions import SwarmException
from libp2p.tools.factories import SwarmFactory
from libp2p.tools.utils import connect_swarm


@pytest.mark.asyncio
async def test_swarm_dial_peer(is_host_secure):
    swarms = await SwarmFactory.create_batch_and_listen(is_host_secure, 3)
    # Test: No addr found.
    with pytest.raises(SwarmException):
        await swarms[0].dial_peer(swarms[1].get_peer_id())

    # Test: len(addr) in the peerstore is 0.
    swarms[0].peerstore.add_addrs(swarms[1].get_peer_id(), [], 10000)
    with pytest.raises(SwarmException):
        await swarms[0].dial_peer(swarms[1].get_peer_id())

    # Test: Succeed if addrs of the peer_id are present in the peerstore.
    addrs = tuple(
        addr
        for transport in swarms[1].listeners.values()
        for addr in transport.get_addrs()
    )
    swarms[0].peerstore.add_addrs(swarms[1].get_peer_id(), addrs, 10000)
    await swarms[0].dial_peer(swarms[1].get_peer_id())
    assert swarms[0].get_peer_id() in swarms[1].connections
    assert swarms[1].get_peer_id() in swarms[0].connections

    # Test: Reuse connections when we already have ones with a peer.
    conn_to_1 = swarms[0].connections[swarms[1].get_peer_id()]
    conn = await swarms[0].dial_peer(swarms[1].get_peer_id())
    assert conn is conn_to_1

    # Clean up
    await asyncio.gather(*[swarm.close() for swarm in swarms])


@pytest.mark.asyncio
async def test_swarm_close_peer(is_host_secure):
    swarms = await SwarmFactory.create_batch_and_listen(is_host_secure, 3)
    # 0 <> 1 <> 2
    await connect_swarm(swarms[0], swarms[1])
    await connect_swarm(swarms[1], swarms[2])

    # peer 1 closes peer 0
    await swarms[1].close_peer(swarms[0].get_peer_id())
    await asyncio.sleep(0.01)
    # 0  1 <> 2
    assert len(swarms[0].connections) == 0
    assert (
        len(swarms[1].connections) == 1
        and swarms[2].get_peer_id() in swarms[1].connections
    )

    # peer 1 is closed by peer 2
    await swarms[2].close_peer(swarms[1].get_peer_id())
    await asyncio.sleep(0.01)
    # 0  1  2
    assert len(swarms[1].connections) == 0 and len(swarms[2].connections) == 0

    await connect_swarm(swarms[0], swarms[1])
    # 0 <> 1  2
    assert (
        len(swarms[0].connections) == 1
        and swarms[1].get_peer_id() in swarms[0].connections
    )
    assert (
        len(swarms[1].connections) == 1
        and swarms[0].get_peer_id() in swarms[1].connections
    )
    # peer 0 closes peer 1
    await swarms[0].close_peer(swarms[1].get_peer_id())
    await asyncio.sleep(0.01)
    # 0  1  2
    assert len(swarms[1].connections) == 0 and len(swarms[2].connections) == 0

    # Clean up
    await asyncio.gather(*[swarm.close() for swarm in swarms])


@pytest.mark.asyncio
async def test_swarm_remove_conn(swarm_pair):
    swarm_0, swarm_1 = swarm_pair
    conn_0 = swarm_0.connections[swarm_1.get_peer_id()]
    swarm_0.remove_conn(conn_0)
    assert swarm_1.get_peer_id() not in swarm_0.connections
    # Test: Remove twice. There should not be errors.
    swarm_0.remove_conn(conn_0)
    assert swarm_1.get_peer_id() not in swarm_0.connections


@pytest.mark.asyncio
async def test_swarm_multiaddr(is_host_secure):
    swarms = await SwarmFactory.create_batch_and_listen(is_host_secure, 3)

    def clear():
        swarms[0].peerstore.clear_addrs(swarms[1].get_peer_id())

    clear()
    # No addresses
    with pytest.raises(SwarmException):
        await swarms[0].dial_peer(swarms[1].get_peer_id())

    clear()
    # Wrong addresses
    swarms[0].peerstore.add_addrs(
        swarms[1].get_peer_id(), [Multiaddr("/ip4/0.0.0.0/tcp/9999")], 10000
    )

    with pytest.raises(SwarmException):
        await swarms[0].dial_peer(swarms[1].get_peer_id())

    clear()
    # Multiple wrong addresses
    swarms[0].peerstore.add_addrs(
        swarms[1].get_peer_id(),
        [Multiaddr("/ip4/0.0.0.0/tcp/9999"), Multiaddr("/ip4/0.0.0.0/tcp/9998")],
        10000,
    )

    with pytest.raises(SwarmException):
        await swarms[0].dial_peer(swarms[1].get_peer_id())

    # Test one address
    addrs = tuple(
        addr
        for transport in swarms[1].listeners.values()
        for addr in transport.get_addrs()
    )

    swarms[0].peerstore.add_addrs(swarms[1].get_peer_id(), addrs[:1], 10000)
    await swarms[0].dial_peer(swarms[1].get_peer_id())

    # Test multiple addresses
    addrs = tuple(
        addr
        for transport in swarms[1].listeners.values()
        for addr in transport.get_addrs()
    )

    swarms[0].peerstore.add_addrs(swarms[1].get_peer_id(), addrs + addrs, 10000)
    await swarms[0].dial_peer(swarms[1].get_peer_id())

    for swarm in swarms:
        await swarm.close()