// 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::prelude::*; use libp2p::swarm::{NetworkBehaviour, SwarmEvent}; use libp2p_swarm_derive::*; use std::fmt::Debug; /// Small utility to check that a type implements `NetworkBehaviour`. #[allow(dead_code)] fn require_net_behaviour() {} // TODO: doesn't compile /*#[test] fn empty() { #[allow(dead_code)] #[derive(NetworkBehaviour)] struct Foo {} }*/ #[test] fn one_field() { #[allow(dead_code)] #[derive(NetworkBehaviour)] struct Foo { ping: libp2p::ping::Ping, } #[allow(dead_code)] #[allow(unreachable_code)] fn foo() { let _out_event: ::OutEvent = unimplemented!(); match _out_event { FooEvent::Ping(libp2p::ping::Event { .. }) => {} } } } #[test] fn two_fields() { #[allow(dead_code)] #[derive(NetworkBehaviour)] struct Foo { ping: libp2p::ping::Ping, identify: libp2p::identify::Identify, } #[allow(dead_code)] #[allow(unreachable_code)] fn foo() { let _out_event: ::OutEvent = unimplemented!(); match _out_event { FooEvent::Ping(libp2p::ping::Event { .. }) => {} FooEvent::Identify(event) => { let _: libp2p::identify::IdentifyEvent = event; } } } } #[test] fn three_fields() { #[allow(dead_code)] #[derive(NetworkBehaviour)] struct Foo { ping: libp2p::ping::Ping, identify: libp2p::identify::Identify, kad: libp2p::kad::Kademlia, } #[allow(dead_code)] #[allow(unreachable_code)] fn foo() { let _out_event: ::OutEvent = unimplemented!(); match _out_event { FooEvent::Ping(libp2p::ping::Event { .. }) => {} FooEvent::Identify(event) => { let _: libp2p::identify::IdentifyEvent = event; } FooEvent::Kad(event) => { let _: libp2p::kad::KademliaEvent = event; } } } } #[test] fn custom_event() { #[allow(dead_code)] #[derive(NetworkBehaviour)] #[behaviour(out_event = "MyEvent")] struct Foo { ping: libp2p::ping::Ping, identify: libp2p::identify::Identify, } enum MyEvent { Ping(libp2p::ping::PingEvent), Identify(libp2p::identify::IdentifyEvent), } impl From for MyEvent { fn from(event: libp2p::ping::PingEvent) -> Self { MyEvent::Ping(event) } } impl From for MyEvent { fn from(event: libp2p::identify::IdentifyEvent) -> Self { MyEvent::Identify(event) } } #[allow(dead_code)] fn foo() { require_net_behaviour::(); } } #[test] fn custom_event_mismatching_field_names() { #[allow(dead_code)] #[derive(NetworkBehaviour)] #[behaviour(out_event = "MyEvent")] struct Foo { a: libp2p::ping::Ping, b: libp2p::identify::Identify, } enum MyEvent { Ping(libp2p::ping::PingEvent), Identify(libp2p::identify::IdentifyEvent), } impl From for MyEvent { fn from(event: libp2p::ping::PingEvent) -> Self { MyEvent::Ping(event) } } impl From for MyEvent { fn from(event: libp2p::identify::IdentifyEvent) -> Self { MyEvent::Identify(event) } } #[allow(dead_code)] fn foo() { require_net_behaviour::(); } } #[test] fn bound() { #[allow(dead_code)] #[derive(NetworkBehaviour)] struct Foo where ::OutEvent: Debug, { ping: libp2p::ping::Ping, bar: T, } } #[test] fn where_clause() { #[allow(dead_code)] #[derive(NetworkBehaviour)] struct Foo where T: Copy + NetworkBehaviour, ::OutEvent: Debug, { ping: libp2p::ping::Ping, bar: T, } } #[test] fn nested_derives_with_import() { #[allow(dead_code)] #[derive(NetworkBehaviour)] struct Foo { ping: libp2p::ping::Ping, } #[allow(dead_code)] #[derive(NetworkBehaviour)] struct Bar { foo: Foo, } #[allow(dead_code)] #[allow(unreachable_code)] fn foo() { let _out_event: ::OutEvent = unimplemented!(); match _out_event { BarEvent::Foo(FooEvent::Ping(libp2p::ping::Event { .. })) => {} } } } #[test] fn custom_event_emit_event_through_poll() { enum BehaviourOutEvent { Ping(libp2p::ping::PingEvent), Identify(libp2p::identify::IdentifyEvent), } impl From for BehaviourOutEvent { fn from(event: libp2p::ping::PingEvent) -> Self { BehaviourOutEvent::Ping(event) } } impl From for BehaviourOutEvent { fn from(event: libp2p::identify::IdentifyEvent) -> Self { BehaviourOutEvent::Identify(event) } } #[allow(dead_code)] #[derive(NetworkBehaviour)] #[behaviour(out_event = "BehaviourOutEvent")] struct Foo { ping: libp2p::ping::Ping, identify: libp2p::identify::Identify, } #[allow(dead_code, unreachable_code)] fn bar() { require_net_behaviour::(); let mut _swarm: libp2p::Swarm = unimplemented!(); // check that the event is bubbled up all the way to swarm let _ = async { 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)] struct Foo { identify: libp2p::identify::Identify, ping: Toggle, } #[allow(dead_code)] fn foo() { require_net_behaviour::(); } } #[test] fn with_either() { use either::Either; #[allow(dead_code)] #[derive(NetworkBehaviour)] struct Foo { kad: libp2p::kad::Kademlia, ping_or_identify: Either, } #[allow(dead_code)] fn foo() { require_net_behaviour::(); } } #[test] fn custom_event_with_either() { use either::Either; enum BehaviourOutEvent { Kad(libp2p::kad::KademliaEvent), PingOrIdentify(Either), } impl From for BehaviourOutEvent { fn from(event: libp2p::kad::KademliaEvent) -> Self { BehaviourOutEvent::Kad(event) } } impl From> for BehaviourOutEvent { fn from(event: Either) -> Self { BehaviourOutEvent::PingOrIdentify(event) } } #[allow(dead_code)] #[derive(NetworkBehaviour)] #[behaviour(out_event = "BehaviourOutEvent")] struct Foo { kad: libp2p::kad::Kademlia, ping_or_identify: Either, } #[allow(dead_code)] fn foo() { require_net_behaviour::(); } } #[test] fn generated_out_event_derive_debug() { #[allow(dead_code)] #[derive(NetworkBehaviour)] struct Foo { ping: libp2p::ping::Ping, } fn require_debug() where T: NetworkBehaviour, ::OutEvent: Debug, { } require_debug::(); } #[test] fn custom_out_event_no_type_parameters() { use libp2p::core::connection::ConnectionId; use libp2p::swarm::handler::DummyConnectionHandler; use libp2p::swarm::{ ConnectionHandler, IntoConnectionHandler, NetworkBehaviourAction, PollParameters, }; use libp2p::PeerId; use std::task::Context; use std::task::Poll; pub struct TemplatedBehaviour { _data: T, } impl NetworkBehaviour for TemplatedBehaviour { type ConnectionHandler = DummyConnectionHandler; type OutEvent = void::Void; fn new_handler(&mut self) -> Self::ConnectionHandler { DummyConnectionHandler::default() } fn inject_event( &mut self, _peer: PeerId, _connection: ConnectionId, message: <::Handler as ConnectionHandler>::OutEvent, ) { void::unreachable(message); } fn poll( &mut self, _ctx: &mut Context, _: &mut impl PollParameters, ) -> Poll> { Poll::Pending } } #[derive(NetworkBehaviour)] #[behaviour(out_event = "OutEvent")] struct Behaviour { custom: TemplatedBehaviour, } #[derive(Debug)] enum OutEvent { None, } impl From for OutEvent { fn from(_e: void::Void) -> Self { Self::None } } require_net_behaviour::>(); require_net_behaviour::>(); }