rust-libp2p/swarm/tests/swarm_derive.rs

// Copyright 2018 Parity Technologies (UK) Ltd.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

use futures::StreamExt;
use libp2p_core::{Endpoint, Multiaddr};
use libp2p_identify as identify;
use libp2p_ping as ping;
use libp2p_swarm::{
    behaviour::FromSwarm, dummy, ConnectionDenied, NetworkBehaviour, SwarmEvent, THandler,
    THandlerInEvent, THandlerOutEvent,
};
use std::fmt::Debug;

/// Small utility to check that a type implements `NetworkBehaviour`.
#[allow(dead_code)]
fn require_net_behaviour<T: libp2p_swarm::NetworkBehaviour>() {}

// TODO: doesn't compile
/*#[test]
fn empty() {
    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    struct Foo {}
}*/

#[test]
fn one_field() {
    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(prelude = "libp2p_swarm::derive_prelude")]
    struct Foo {
        ping: ping::Behaviour,
    }

    #[allow(
        dead_code,
        unreachable_code,
        clippy::diverging_sub_expression,
        clippy::used_underscore_binding
    )]
    fn foo() {
        let _out_event: <Foo as NetworkBehaviour>::OutEvent = unimplemented!();
        match _out_event {
            FooEvent::Ping(ping::Event { .. }) => {}
        }
    }
}

#[test]
fn two_fields() {
    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(prelude = "libp2p_swarm::derive_prelude")]
    struct Foo {
        ping: ping::Behaviour,
        identify: identify::Behaviour,
    }

    #[allow(
        dead_code,
        unreachable_code,
        clippy::diverging_sub_expression,
        clippy::used_underscore_binding
    )]
    fn foo() {
        let _out_event: <Foo as NetworkBehaviour>::OutEvent = unimplemented!();
        match _out_event {
            FooEvent::Ping(ping::Event { .. }) => {}
            FooEvent::Identify(event) => {
                let _: identify::Event = event;
            }
        }
    }
}

#[test]
fn three_fields() {
    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(prelude = "libp2p_swarm::derive_prelude")]
    struct Foo {
        ping: ping::Behaviour,
        identify: identify::Behaviour,
        kad: libp2p_kad::Kademlia<libp2p_kad::record::store::MemoryStore>,
    }

    #[allow(
        dead_code,
        unreachable_code,
        clippy::diverging_sub_expression,
        clippy::used_underscore_binding
    )]
    fn foo() {
        let _out_event: <Foo as NetworkBehaviour>::OutEvent = unimplemented!();
        match _out_event {
            FooEvent::Ping(ping::Event { .. }) => {}
            FooEvent::Identify(event) => {
                let _: identify::Event = event;
            }
            FooEvent::Kad(event) => {
                let _: libp2p_kad::KademliaEvent = event;
            }
        }
    }
}

#[test]
fn custom_event() {
    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(out_event = "MyEvent", prelude = "libp2p_swarm::derive_prelude")]
    struct Foo {
        ping: ping::Behaviour,
        identify: identify::Behaviour,
    }

    #[allow(clippy::large_enum_variant)]
    enum MyEvent {
        Ping(ping::Event),
        Identify(identify::Event),
    }

    impl From<ping::Event> for MyEvent {
        fn from(event: ping::Event) -> Self {
            MyEvent::Ping(event)
        }
    }

    impl From<identify::Event> for MyEvent {
        fn from(event: identify::Event) -> Self {
            MyEvent::Identify(event)
        }
    }

    #[allow(dead_code)]
    fn foo() {
        require_net_behaviour::<Foo>();
    }
}

#[test]
fn custom_event_mismatching_field_names() {
    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(out_event = "MyEvent", prelude = "libp2p_swarm::derive_prelude")]
    struct Foo {
        a: ping::Behaviour,
        b: identify::Behaviour,
    }

    #[allow(clippy::large_enum_variant)]
    enum MyEvent {
        Ping(ping::Event),
        Identify(identify::Event),
    }

    impl From<ping::Event> for MyEvent {
        fn from(event: ping::Event) -> Self {
            MyEvent::Ping(event)
        }
    }

    impl From<identify::Event> for MyEvent {
        fn from(event: identify::Event) -> Self {
            MyEvent::Identify(event)
        }
    }

    #[allow(dead_code)]
    fn foo() {
        require_net_behaviour::<Foo>();
    }
}

#[test]
fn bound() {
    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(prelude = "libp2p_swarm::derive_prelude")]
    struct Foo<T: Copy + NetworkBehaviour>
    where
        <T as NetworkBehaviour>::OutEvent: Debug,
    {
        ping: ping::Behaviour,
        bar: T,
    }
}

#[test]
fn where_clause() {
    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(prelude = "libp2p_swarm::derive_prelude")]
    struct Foo<T>
    where
        T: Copy + NetworkBehaviour,
        <T as NetworkBehaviour>::OutEvent: Debug,
    {
        ping: ping::Behaviour,
        bar: T,
    }
}

#[test]
fn nested_derives_with_import() {
    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(prelude = "libp2p_swarm::derive_prelude")]
    struct Foo {
        ping: ping::Behaviour,
    }

    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(prelude = "libp2p_swarm::derive_prelude")]
    struct Bar {
        foo: Foo,
    }

    #[allow(
        dead_code,
        unreachable_code,
        clippy::diverging_sub_expression,
        clippy::used_underscore_binding
    )]
    fn foo() {
        let _out_event: <Bar as NetworkBehaviour>::OutEvent = unimplemented!();
        match _out_event {
            BarEvent::Foo(FooEvent::Ping(ping::Event { .. })) => {}
        }
    }
}

#[test]
fn custom_event_emit_event_through_poll() {
    #[allow(clippy::large_enum_variant)]
    enum BehaviourOutEvent {
        Ping(ping::Event),
        Identify(identify::Event),
    }

    impl From<ping::Event> for BehaviourOutEvent {
        fn from(event: ping::Event) -> Self {
            BehaviourOutEvent::Ping(event)
        }
    }

    impl From<identify::Event> for BehaviourOutEvent {
        fn from(event: identify::Event) -> Self {
            BehaviourOutEvent::Identify(event)
        }
    }

    #[allow(dead_code, clippy::large_enum_variant)]
    #[derive(NetworkBehaviour)]
    #[behaviour(
        out_event = "BehaviourOutEvent",
        prelude = "libp2p_swarm::derive_prelude"
    )]
    struct Foo {
        ping: ping::Behaviour,
        identify: identify::Behaviour,
    }

    #[allow(
        dead_code,
        unreachable_code,
        clippy::diverging_sub_expression,
        clippy::used_underscore_binding
    )]
    async fn bar() {
        require_net_behaviour::<Foo>();

        let mut _swarm: libp2p_swarm::Swarm<Foo> = unimplemented!();

        // check that the event is bubbled up all the way to swarm
        loop {
            match _swarm.select_next_some().await {
                SwarmEvent::Behaviour(BehaviourOutEvent::Ping(_)) => break,
                SwarmEvent::Behaviour(BehaviourOutEvent::Identify(_)) => break,
                _ => {}
            }
        }
    }
}

#[test]
fn with_toggle() {
    use libp2p_swarm::behaviour::toggle::Toggle;

    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(prelude = "libp2p_swarm::derive_prelude")]
    struct Foo {
        identify: identify::Behaviour,
        ping: Toggle<ping::Behaviour>,
    }

    #[allow(dead_code)]
    fn foo() {
        require_net_behaviour::<Foo>();
    }
}

#[test]
fn with_either() {
    use either::Either;

    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(prelude = "libp2p_swarm::derive_prelude")]
    struct Foo {
        kad: libp2p_kad::Kademlia<libp2p_kad::record::store::MemoryStore>,
        ping_or_identify: Either<ping::Behaviour, identify::Behaviour>,
    }

    #[allow(dead_code)]
    fn foo() {
        require_net_behaviour::<Foo>();
    }
}

#[test]
fn with_generics() {
    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(prelude = "libp2p_swarm::derive_prelude")]
    struct Foo<A, B> {
        a: A,
        b: B,
    }

    #[allow(dead_code)]
    fn foo() {
        require_net_behaviour::<
            Foo<
                libp2p_kad::Kademlia<libp2p_kad::record::store::MemoryStore>,
                libp2p_ping::Behaviour,
            >,
        >();
    }
}

#[test]
fn with_generics_mixed() {
    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(prelude = "libp2p_swarm::derive_prelude")]
    struct Foo<A> {
        a: A,
        ping: libp2p_ping::Behaviour,
    }

    #[allow(dead_code)]
    fn foo() {
        require_net_behaviour::<Foo<libp2p_kad::Kademlia<libp2p_kad::record::store::MemoryStore>>>(
        );
    }
}

#[test]
fn custom_event_with_either() {
    use either::Either;

    #[allow(clippy::large_enum_variant)]
    enum BehaviourOutEvent {
        Kad(libp2p_kad::KademliaEvent),
        PingOrIdentify(Either<ping::Event, identify::Event>),
    }

    impl From<libp2p_kad::KademliaEvent> for BehaviourOutEvent {
        fn from(event: libp2p_kad::KademliaEvent) -> Self {
            BehaviourOutEvent::Kad(event)
        }
    }

    impl From<Either<ping::Event, identify::Event>> for BehaviourOutEvent {
        fn from(event: Either<ping::Event, identify::Event>) -> Self {
            BehaviourOutEvent::PingOrIdentify(event)
        }
    }

    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(
        out_event = "BehaviourOutEvent",
        prelude = "libp2p_swarm::derive_prelude"
    )]
    struct Foo {
        kad: libp2p_kad::Kademlia<libp2p_kad::record::store::MemoryStore>,
        ping_or_identify: Either<ping::Behaviour, identify::Behaviour>,
    }

    #[allow(dead_code)]
    fn foo() {
        require_net_behaviour::<Foo>();
    }
}

#[test]
fn generated_out_event_derive_debug() {
    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(prelude = "libp2p_swarm::derive_prelude")]
    struct Foo {
        ping: ping::Behaviour,
    }

    fn require_debug<T>()
    where
        T: NetworkBehaviour,
        <T as NetworkBehaviour>::OutEvent: Debug,
    {
    }

    require_debug::<Foo>();
}

#[test]
fn multiple_behaviour_attributes() {
    #[allow(dead_code)]
    #[derive(NetworkBehaviour)]
    #[behaviour(out_event = "FooEvent")]
    #[behaviour(prelude = "libp2p_swarm::derive_prelude")]
    struct Foo {
        ping: ping::Behaviour,
    }

    require_net_behaviour::<Foo>();

    struct FooEvent;

    impl From<ping::Event> for FooEvent {
        fn from(_: ping::Event) -> Self {
            unimplemented!()
        }
    }
}

#[test]
fn custom_out_event_no_type_parameters() {
    use libp2p_identity::PeerId;
    use libp2p_swarm::{ConnectionId, PollParameters, ToSwarm};
    use std::task::Context;
    use std::task::Poll;

    pub(crate) struct TemplatedBehaviour<T: 'static> {
        _data: T,
    }

    impl<T> NetworkBehaviour for TemplatedBehaviour<T> {
        type ConnectionHandler = dummy::ConnectionHandler;
        type OutEvent = void::Void;

        fn handle_established_inbound_connection(
            &mut self,
            _: ConnectionId,
            _: PeerId,
            _: &Multiaddr,
            _: &Multiaddr,
        ) -> Result<THandler<Self>, ConnectionDenied> {
            Ok(dummy::ConnectionHandler)
        }

        fn handle_established_outbound_connection(
            &mut self,
            _: ConnectionId,
            _: PeerId,
            _: &Multiaddr,
            _: Endpoint,
        ) -> Result<THandler<Self>, ConnectionDenied> {
            Ok(dummy::ConnectionHandler)
        }

        fn on_connection_handler_event(
            &mut self,
            _peer: PeerId,
            _connection: ConnectionId,
            message: THandlerOutEvent<Self>,
        ) {
            void::unreachable(message);
        }

        fn poll(
            &mut self,
            _ctx: &mut Context,
            _: &mut impl PollParameters,
        ) -> Poll<ToSwarm<Self::OutEvent, THandlerInEvent<Self>>> {
            Poll::Pending
        }

        fn on_swarm_event(&mut self, event: FromSwarm<Self::ConnectionHandler>) {
            match event {
                FromSwarm::ConnectionEstablished(_)
                | FromSwarm::ConnectionClosed(_)
                | FromSwarm::AddressChange(_)
                | FromSwarm::DialFailure(_)
                | FromSwarm::ListenFailure(_)
                | FromSwarm::NewListener(_)
                | FromSwarm::NewListenAddr(_)
                | FromSwarm::ExpiredListenAddr(_)
                | FromSwarm::ListenerError(_)
                | FromSwarm::ListenerClosed(_)
                | FromSwarm::NewExternalAddr(_)
                | FromSwarm::ExpiredExternalAddr(_) => {}
            }
        }
    }

    #[derive(NetworkBehaviour)]
    #[behaviour(out_event = "OutEvent", prelude = "libp2p_swarm::derive_prelude")]
    struct Behaviour<T: 'static + Send> {
        custom: TemplatedBehaviour<T>,
    }

    #[derive(Debug)]
    enum OutEvent {
        None,
    }

    impl From<void::Void> for OutEvent {
        fn from(_e: void::Void) -> Self {
            Self::None
        }
    }

    require_net_behaviour::<Behaviour<String>>();
    require_net_behaviour::<Behaviour<()>>();
}