openethereum/util/network-devp2p/tests/tests.rs

// Copyright 2015-2020 Parity Technologies (UK) Ltd.
// This file is part of OpenEthereum.

// OpenEthereum is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// OpenEthereum is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.

extern crate env_logger;
extern crate ethcore_io as io;
extern crate ethcore_network;
extern crate ethcore_network_devp2p;
extern crate ethkey;
extern crate parity_bytes;
extern crate parking_lot;

use ethcore_network::*;
use ethcore_network_devp2p::NetworkService;
use ethkey::{Generator, Random};
use io::TimerToken;
use parity_bytes::Bytes;
use parking_lot::Mutex;
use std::{
    sync::{
        atomic::{AtomicBool, Ordering as AtomicOrdering},
        Arc,
    },
    thread,
    time::*,
};

pub struct TestProtocol {
    drop_session: bool,
    pub packet: Mutex<Bytes>,
    pub got_timeout: AtomicBool,
    pub got_disconnect: AtomicBool,
}

impl TestProtocol {
    pub fn new(drop_session: bool) -> Self {
        TestProtocol {
            packet: Mutex::new(Vec::new()),
            got_timeout: AtomicBool::new(false),
            got_disconnect: AtomicBool::new(false),
            drop_session: drop_session,
        }
    }
    /// Creates and register protocol with the network service
    pub fn register(service: &mut NetworkService, drop_session: bool) -> Arc<TestProtocol> {
        let handler = Arc::new(TestProtocol::new(drop_session));
        service
            .register_protocol(handler.clone(), *b"tst", &[(42u8, 1u8), (43u8, 1u8)])
            .expect("Error registering test protocol handler");
        handler
    }

    pub fn got_packet(&self) -> bool {
        self.packet.lock()[..] == b"hello"[..]
    }

    pub fn got_timeout(&self) -> bool {
        self.got_timeout.load(AtomicOrdering::Relaxed)
    }

    pub fn got_disconnect(&self) -> bool {
        self.got_disconnect.load(AtomicOrdering::Relaxed)
    }
}

impl NetworkProtocolHandler for TestProtocol {
    fn initialize(&self, io: &dyn NetworkContext) {
        io.register_timer(0, Duration::from_millis(10)).unwrap();
    }

    fn read(&self, _io: &dyn NetworkContext, _peer: &PeerId, packet_id: u8, data: &[u8]) {
        assert_eq!(packet_id, 33);
        self.packet.lock().extend(data);
    }

    fn connected(&self, io: &dyn NetworkContext, peer: &PeerId) {
        assert!(io.peer_client_version(*peer).to_string().contains("Parity"));
        if self.drop_session {
            io.disconnect_peer(*peer)
        } else {
            io.respond(33, "hello".to_owned().into_bytes()).unwrap();
        }
    }

    fn disconnected(&self, _io: &dyn NetworkContext, _peer: &PeerId) {
        self.got_disconnect.store(true, AtomicOrdering::Relaxed);
    }

    /// Timer function called after a timeout created with `NetworkContext::timeout`.
    fn timeout(&self, _io: &dyn NetworkContext, timer: TimerToken) {
        assert_eq!(timer, 0);
        self.got_timeout.store(true, AtomicOrdering::Relaxed);
    }
}

#[test]
fn net_service() {
    let service = NetworkService::new(NetworkConfiguration::new_local(), None)
        .expect("Error creating network service");
    service.start().unwrap();
    service
        .register_protocol(Arc::new(TestProtocol::new(false)), *b"myp", &[(1u8, 1u8)])
        .unwrap();
}

#[test]
fn net_start_stop() {
    let config = NetworkConfiguration::new_local();
    let service = NetworkService::new(config, None).unwrap();
    service.start().unwrap();
    service.stop();
    service.start().unwrap();
}

#[test]
fn net_disconnect() {
    let key1 = Random.generate().unwrap();
    let mut config1 = NetworkConfiguration::new_local();
    config1.use_secret = Some(key1.secret().clone());
    config1.boot_nodes = vec![];
    let mut service1 = NetworkService::new(config1, None).unwrap();
    service1.start().unwrap();
    let handler1 = TestProtocol::register(&mut service1, false);
    let mut config2 = NetworkConfiguration::new_local();
    config2.boot_nodes = vec![service1.local_url().unwrap()];
    let mut service2 = NetworkService::new(config2, None).unwrap();
    service2.start().unwrap();
    let handler2 = TestProtocol::register(&mut service2, true);
    while !(handler1.got_disconnect() && handler2.got_disconnect()) {
        thread::sleep(Duration::from_millis(50));
    }
    assert!(handler1.got_disconnect());
    assert!(handler2.got_disconnect());
}

#[test]
fn net_timeout() {
    let config = NetworkConfiguration::new_local();
    let mut service = NetworkService::new(config, None).unwrap();
    service.start().unwrap();
    let handler = TestProtocol::register(&mut service, false);
    while !handler.got_timeout() {
        thread::sleep(Duration::from_millis(50));
    }
}