routing 0.37.1

A secured storage DHT
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
// Copyright 2018 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under The General Public License (GPL), version 3.
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. Please review the Licences for the specific language governing
// permissions and limitations relating to use of the SAFE Network Software.

use super::crust::{
    ConnectionInfoResult, CrustEventSender, CrustUser, Event, PrivConnectionInfo,
    PubConnectionInfo, Uid,
};
use id::PublicId;
use maidsafe_utilities::SeededRng;
use rand::Rng;
use rust_sodium;
use std::cell::RefCell;
use std::collections::btree_map::Entry;
use std::collections::{BTreeMap, HashMap, HashSet, VecDeque};
use std::net::{IpAddr, SocketAddr};
use std::rc::{Rc, Weak};
use CrustEvent;

/// Mock network. Create one before testing with mocks. Use it to create `ServiceHandle`s.
#[derive(Clone)]
pub struct Network<UID: Uid>(Rc<RefCell<NetworkImpl<UID>>>);

pub struct NetworkImpl<UID: Uid> {
    services: HashMap<Endpoint, Weak<RefCell<ServiceImpl<UID>>>>,
    min_section_size: usize,
    queue: BTreeMap<(Endpoint, Endpoint), VecDeque<Packet<UID>>>,
    blocked_connections: HashSet<(Endpoint, Endpoint)>,
    delayed_connections: HashSet<(Endpoint, Endpoint)>,
    rng: SeededRng,
    message_sent: bool,
}

impl<UID: Uid> Network<UID> {
    /// Create new mock Network.
    pub fn new(min_section_size: usize, optional_seed: Option<[u32; 4]>) -> Self {
        let mut rng = if let Some(seed) = optional_seed {
            SeededRng::from_seed(seed)
        } else {
            SeededRng::new()
        };
        unwrap!(rust_sodium::init_with_rng(&mut rng));
        Network(Rc::new(RefCell::new(NetworkImpl {
            services: HashMap::new(),
            min_section_size,
            queue: BTreeMap::new(),
            blocked_connections: HashSet::new(),
            delayed_connections: HashSet::new(),
            // Use `SeededRng::new()` here rather than passing in `rng`
            // so that a fresh one is used in every test, i.e. it will
            // not have been affected by initialising rust_sodium.
            rng: SeededRng::new(),
            message_sent: false,
        })))
    }

    /// Create new ServiceHandle.
    pub fn new_service_handle(
        &self,
        opt_config: Option<Config>,
        opt_endpoint: Option<Endpoint>,
    ) -> ServiceHandle<UID> {
        let config = opt_config.unwrap_or_else(Config::new);
        let endpoint = self.gen_endpoint(opt_endpoint);

        let handle = ServiceHandle::new(self.clone(), config, endpoint);
        assert!(
            self.0
                .borrow_mut()
                .services
                .insert(endpoint, Rc::downgrade(&handle.0))
                .is_none(),
            "Tried to insert duplicate service handle."
        );

        handle
    }

    /// Get min_section_size
    pub fn min_section_size(&self) -> usize {
        self.0.borrow().min_section_size
    }

    /// Generate unique `Endpoint`
    pub fn gen_endpoint(&self, opt_endpoint: Option<Endpoint>) -> Endpoint {
        opt_endpoint.unwrap_or_else(|| {
            let imp = self.0.borrow();
            for i in 0.. {
                if !imp.services.contains_key(&Endpoint(i)) {
                    return Endpoint(i);
                }
            }
            panic!("Unable to produce new Endpoint.");
        })
    }

    /// Generate a unique `Endpoint` which has an IP address of `ip`.  `ip` should be an IPv4
    /// address of the form 127.0.x.x which is the form returned by the `to_socket_addr()` function
    /// in this module.
    pub fn gen_endpoint_with_ip(&self, ip: &IpAddr) -> Endpoint {
        match *ip {
            IpAddr::V4(ipv4) => {
                let imp = self.0.borrow();
                assert_eq!(ipv4.octets()[0], 127);
                assert_eq!(ipv4.octets()[1], 0);
                let initial_value = ((ipv4.octets()[2] as usize) << 8) + ipv4.octets()[3] as usize;
                for i in 0..0xFF {
                    let endpoint = Endpoint(initial_value + (i << 16));
                    if !imp.services.contains_key(&endpoint) {
                        return endpoint;
                    }
                }
                panic!("No available endpoints left which will match {:?}", ip);
            }
            IpAddr::V6(_) => panic!("Expected IPv4 address."),
        }
    }

    /// Poll and process all queued Packets.
    pub fn deliver_messages(&self) {
        while let Some((sender, receiver, packet)) = self.pop_packet() {
            self.process_packet(sender, receiver, packet);
        }
    }

    /// Causes all packets from `sender` to `receiver` to fail.
    pub fn block_connection(&self, sender: Endpoint, receiver: Endpoint) {
        let mut imp = self.0.borrow_mut();
        let _ = imp.blocked_connections.insert((sender, receiver));
    }

    /// Make all packets from `sender` to `receiver` succeed.
    pub fn unblock_connection(&self, sender: Endpoint, receiver: Endpoint) {
        let mut imp = self.0.borrow_mut();
        let _ = imp.blocked_connections.remove(&(sender, receiver));
    }

    /// Delay the processing of packets from `sender` to `receiver`.
    pub fn delay_connection(&self, sender: Endpoint, receiver: Endpoint) {
        let mut imp = self.0.borrow_mut();
        let _ = imp.delayed_connections.insert((sender, receiver));
    }

    /// Simulates the loss of a connection.
    pub fn lost_connection(&self, node_1: Endpoint, node_2: Endpoint) {
        let service_1 = unwrap!(
            self.find_service(node_1),
            "Cannot fetch service of {:?}.",
            node_1
        );
        if service_1
            .borrow_mut()
            .remove_connection_by_endpoint(node_2)
            .is_none()
        {
            return;
        }
        let service_2 = unwrap!(
            self.find_service(node_2),
            "Cannot fetch service of {:?}.",
            node_2
        );
        let _ = service_2.borrow_mut().remove_connection_by_endpoint(node_1);

        service_1
            .borrow_mut()
            .send_event(CrustEvent::LostPeer(unwrap!(service_2.borrow().uid)));
        service_2
            .borrow_mut()
            .send_event(CrustEvent::LostPeer(unwrap!(service_1.borrow().uid)));
    }

    /// Simulates a crust event being sent to the node.
    pub fn send_crust_event(&self, node: Endpoint, crust_event: CrustEvent<UID>) {
        let service = unwrap!(
            self.find_service(node),
            "Cannot fetch service of {:?}.",
            node
        );
        service.borrow_mut().send_event(crust_event);
    }

    /// Construct a new [`SeededRng`][1] using a seed generated from random data provided by `self`.
    /// [1]: https://docs.rs/maidsafe_utilities/0.10.2/maidsafe_utilities/struct.SeededRng.html
    pub fn new_rng(&self) -> SeededRng {
        self.0.borrow_mut().rng.new_rng()
    }

    /// Return whether sent any message since previous query and reset the flag.
    pub fn reset_message_sent(&self) -> bool {
        let message_sent = self.0.borrow().message_sent;
        self.0.borrow_mut().message_sent = false;
        message_sent
    }

    fn connection_blocked(&self, sender: Endpoint, receiver: Endpoint) -> bool {
        self.0
            .borrow()
            .blocked_connections
            .contains(&(sender, receiver))
    }

    fn send(&self, sender: Endpoint, receiver: Endpoint, packet: Packet<UID>) {
        let mut network_impl = self.0.borrow_mut();
        network_impl.message_sent = true;
        network_impl
            .queue
            .entry((sender, receiver))
            .or_insert_with(VecDeque::new)
            .push_back(packet);
    }

    // Drops any pending messages on a specific route (does not automatically
    // drop packets going the other way).
    fn drop_pending(&self, sender: Endpoint, receiver: Endpoint) {
        let _ = self.0.borrow_mut().queue.remove(&(sender, receiver));
    }

    fn pop_packet(&self) -> Option<(Endpoint, Endpoint, Packet<UID>)> {
        let mut network_impl = self.0.borrow_mut();
        let keys: Vec<_> = {
            let checker = |&(s, r)| network_impl.delayed_connections.contains(&(s, r));
            if network_impl.queue.keys().all(checker) {
                network_impl.queue.keys().cloned().collect()
            } else {
                network_impl
                    .queue
                    .keys()
                    .filter(|&&(ref s, ref r)| {
                        !network_impl.delayed_connections.contains(&(*s, *r))
                    }).cloned()
                    .collect()
            }
        };

        let (sender, receiver) = if let Some(key) = network_impl.rng.choose(&keys) {
            *key
        } else {
            return None;
        };
        let result = network_impl
            .queue
            .get_mut(&(sender, receiver))
            .and_then(|packets| packets.pop_front().map(|packet| (sender, receiver, packet)));
        if result.is_some() {
            if let Entry::Occupied(entry) = network_impl.queue.entry((sender, receiver)) {
                if entry.get().is_empty() {
                    let (_key, _value) = entry.remove_entry();
                }
            }
        }
        result
    }

    fn process_packet(&self, sender: Endpoint, receiver: Endpoint, packet: Packet<UID>) {
        if self.connection_blocked(sender, receiver) {
            if let Some(failure) = packet.to_failure() {
                self.send(receiver, sender, failure);
                return;
            }
        }

        if let Some(service) = self.find_service(receiver) {
            service.borrow_mut().receive_packet(sender, packet);
        } else if let Some(failure) = packet.to_failure() {
            // Packet was sent to a non-existing receiver.
            self.send(receiver, sender, failure);
        }
    }

    fn find_service(&self, endpoint: Endpoint) -> Option<Rc<RefCell<ServiceImpl<UID>>>> {
        self.0
            .borrow()
            .services
            .get(&endpoint)
            .and_then(|s| s.upgrade())
    }
}

/// `ServiceHandle` is associated with the mock `Service` and allows to configure
/// and instrument it.
#[derive(Clone)]
pub struct ServiceHandle<UID: Uid>(pub Rc<RefCell<ServiceImpl<UID>>>);

impl<UID: Uid> ServiceHandle<UID> {
    fn new(network: Network<UID>, config: Config, endpoint: Endpoint) -> Self {
        ServiceHandle(Rc::new(RefCell::new(ServiceImpl::new(
            network, config, endpoint,
        ))))
    }

    /// Endpoint of the `Service` bound to this handle.
    pub fn endpoint(&self) -> Endpoint {
        self.0.borrow().endpoint
    }

    /// Returns `true` if this service is connected to the given one.
    pub fn is_connected(&self, handle: &Self) -> bool {
        self.0
            .borrow()
            .is_peer_connected(&unwrap!(handle.0.borrow().uid))
    }

    /// Delivers all messages that are queued in the network.
    pub fn deliver_messages(&self) {
        let network = self.0.borrow().network.clone();
        network.deliver_messages();
    }

    /// Returns whether sent any message across the network since previous query and reset the flag.
    pub fn reset_message_sent(&self) -> bool {
        self.0.borrow().network.reset_message_sent()
    }
}

pub struct ServiceImpl<UID: Uid> {
    pub network: Network<UID>,
    endpoint: Endpoint,
    pub uid: Option<UID>,
    config: Config,
    pub accept_bootstrap: bool,
    pub listening_tcp: bool,
    event_sender: Option<CrustEventSender<UID>>,
    pending_bootstraps: u64,
    connections: Vec<(UID, Endpoint, CrustUser)>,
}

impl<UID: Uid> ServiceImpl<UID> {
    fn new(network: Network<UID>, config: Config, endpoint: Endpoint) -> Self {
        ServiceImpl {
            network,
            endpoint,
            uid: None,
            config,
            accept_bootstrap: false,
            listening_tcp: false,
            event_sender: None,
            pending_bootstraps: 0,
            connections: Vec::new(),
        }
    }

    pub fn start(&mut self, event_sender: CrustEventSender<UID>, uid: UID) {
        self.uid = Some(uid);
        self.event_sender = Some(event_sender);
    }

    pub fn restart(&mut self, event_sender: CrustEventSender<UID>, uid: UID) {
        trace!("{:?} restart", self.endpoint);

        self.disconnect_all();

        self.uid = Some(uid);
        self.listening_tcp = false;

        self.start(event_sender, uid)
    }

    pub fn start_bootstrap(&mut self, blacklist: HashSet<SocketAddr>, kind: CrustUser) {
        let mut pending_bootstraps = 0;

        for endpoint in &self.config.hard_coded_contacts {
            if *endpoint != self.endpoint && !blacklist.contains(&to_socket_addr(*endpoint)) {
                self.send_packet(*endpoint, Packet::BootstrapRequest(unwrap!(self.uid), kind));
                pending_bootstraps += 1;
            }
        }

        // If we have no contacts in the config, we can fire BootstrapFailed
        // immediately.
        if pending_bootstraps == 0 {
            unwrap!(unwrap!(self.event_sender.as_ref()).send(Event::BootstrapFailed));
        }

        self.pending_bootstraps = pending_bootstraps;
    }

    pub fn get_peer_ip_addr(&self, uid: &UID) -> Option<IpAddr> {
        if let Some(endpoint) = self.find_endpoint_by_uid(uid) {
            Some(to_socket_addr(endpoint).ip())
        } else {
            None
        }
    }

    pub fn send_message(&self, uid: &UID, data: Vec<u8>) -> bool {
        if let Some(endpoint) = self.find_endpoint_by_uid(uid) {
            self.send_packet(endpoint, Packet::Message(data));
            true
        } else {
            false
        }
    }

    pub fn is_peer_connected(&self, uid: &UID) -> bool {
        self.find_endpoint_by_uid(uid).is_some()
    }

    pub fn prepare_connection_info(&self, result_token: u32) {
        // TODO: should we also simulate failure here?
        // TODO: should we simulate asynchrony here?

        let result = ConnectionInfoResult {
            result_token,
            result: Ok(PrivConnectionInfo {
                id: unwrap!(self.uid),
                endpoint: self.endpoint,
            }),
        };

        self.send_event(CrustEvent::ConnectionInfoPrepared(result));
    }

    pub fn connect(&self, _our_info: PrivConnectionInfo<UID>, their_info: PubConnectionInfo<UID>) {
        let packet = Packet::ConnectRequest(unwrap!(self.uid), their_info.id);
        self.send_packet(their_info.endpoint, packet);
    }

    pub fn set_accept_bootstrap(&mut self, accept: bool) {
        self.accept_bootstrap = accept;
    }

    pub fn start_listening_tcp(&mut self, port: u16) {
        self.listening_tcp = true;
        self.send_event(CrustEvent::ListenerStarted(port));
    }

    fn send_packet(&self, receiver: Endpoint, packet: Packet<UID>) {
        self.network.send(self.endpoint, receiver, packet);
    }

    fn receive_packet(&mut self, sender: Endpoint, packet: Packet<UID>) {
        match packet {
            Packet::BootstrapRequest(uid, kind) => self.handle_bootstrap_request(sender, uid, kind),
            Packet::BootstrapSuccess(uid) => self.handle_bootstrap_success(sender, uid),
            Packet::BootstrapFailure => self.handle_bootstrap_failure(sender),
            Packet::ConnectRequest(their_id, _) => self.handle_connect_request(sender, their_id),
            Packet::ConnectSuccess(their_id, _) => self.handle_connect_success(sender, their_id),
            Packet::ConnectFailure(their_id, _) => self.handle_connect_failure(sender, their_id),
            Packet::Message(data) => self.handle_message(sender, data),
            Packet::Disconnect => self.handle_disconnect(sender),
        }
    }

    fn handle_bootstrap_request(&mut self, peer_endpoint: Endpoint, uid: UID, kind: CrustUser) {
        if self.is_listening() && self.accept_bootstrap {
            self.handle_bootstrap_accept(peer_endpoint, uid, kind);
            self.send_packet(peer_endpoint, Packet::BootstrapSuccess(unwrap!(self.uid)));
        } else {
            self.send_packet(peer_endpoint, Packet::BootstrapFailure);
        }
    }

    fn handle_bootstrap_accept(&mut self, peer_endpoint: Endpoint, uid: UID, kind: CrustUser) {
        let _ = self.add_connection(uid, peer_endpoint, kind);
        self.send_event(CrustEvent::BootstrapAccept(uid, kind));
    }

    fn handle_bootstrap_success(&mut self, peer_endpoint: Endpoint, uid: UID) {
        let _ = self.add_connection(uid, peer_endpoint, CrustUser::Node);
        self.send_event(CrustEvent::BootstrapConnect(
            uid,
            to_socket_addr(peer_endpoint),
        ));
        self.decrement_pending_bootstraps();
    }

    fn handle_bootstrap_failure(&mut self, _peer_endpoint: Endpoint) {
        self.decrement_pending_bootstraps();
    }

    fn handle_connect_request(&mut self, peer_endpoint: Endpoint, their_id: UID) {
        if self.is_connected(peer_endpoint, &their_id) {
            return;
        }

        self.add_rendezvous_connection(their_id, peer_endpoint);
        self.send_packet(
            peer_endpoint,
            Packet::ConnectSuccess(unwrap!(self.uid), their_id),
        );
    }

    fn handle_connect_success(&mut self, peer_endpoint: Endpoint, their_id: UID) {
        self.add_rendezvous_connection(their_id, peer_endpoint);
    }

    fn handle_connect_failure(&self, _peer_endpoint: Endpoint, their_id: UID) {
        self.send_event(CrustEvent::ConnectFailure(their_id));
    }

    fn handle_message(&self, peer_endpoint: Endpoint, data: Vec<u8>) {
        if let Some((uid, kind)) = self.find_uid_and_kind_by_endpoint(peer_endpoint) {
            self.send_event(CrustEvent::NewMessage(uid, kind, data));
        } else {
            debug!("Received message from non-connected {:?}", peer_endpoint);
        }
    }

    fn handle_disconnect(&mut self, peer_endpoint: Endpoint) {
        if let Some(uid) = self.remove_connection_by_endpoint(peer_endpoint) {
            self.send_event(CrustEvent::LostPeer(uid));
        }
    }

    fn send_event(&self, event: CrustEvent<UID>) {
        let sender = unwrap!(self.event_sender.as_ref(), "Could not get event sender.");
        unwrap!(sender.send(event));
    }

    fn is_listening(&self) -> bool {
        self.listening_tcp
    }

    fn decrement_pending_bootstraps(&mut self) {
        if self.pending_bootstraps == 0 {
            return;
        }

        self.pending_bootstraps -= 1;

        if self.pending_bootstraps == 0 && self.connections.is_empty() {
            self.send_event(CrustEvent::BootstrapFailed);
        }
    }

    fn add_connection(&mut self, uid: UID, peer_endpoint: Endpoint, kind: CrustUser) -> bool {
        let checker = |&(id, ep, _)| id == uid && ep == peer_endpoint;
        if self.connections.iter().any(checker) {
            // Connection already exists
            return false;
        }

        self.connections.push((uid, peer_endpoint, kind));
        true
    }

    fn add_rendezvous_connection(&mut self, uid: UID, peer_endpoint: Endpoint) {
        if self.add_connection(uid, peer_endpoint, CrustUser::Node) {
            self.send_event(CrustEvent::ConnectSuccess(uid));
        }
    }

    // Remove connected peer with the given uid and return its endpoint,
    // or None if no such peer exists.
    fn remove_connection_by_uid(&mut self, uid: &UID) -> Option<Endpoint> {
        if let Some(i) = self.connections.iter().position(|&(id, _, _)| id == *uid) {
            Some(self.connections.swap_remove(i).1)
        } else {
            None
        }
    }

    fn remove_connection_by_endpoint(&mut self, endpoint: Endpoint) -> Option<UID> {
        if let Some(i) = self
            .connections
            .iter()
            .position(|&(_, ep, _)| ep == endpoint)
        {
            Some(self.connections.swap_remove(i).0)
        } else {
            None
        }
    }

    fn find_endpoint_by_uid(&self, uid: &UID) -> Option<Endpoint> {
        self.connections
            .iter()
            .find(|&&(id, _, _)| id == *uid)
            .map(|&(_, ep, _)| ep)
    }

    fn find_uid_and_kind_by_endpoint(&self, endpoint: Endpoint) -> Option<(UID, CrustUser)> {
        self.connections
            .iter()
            .find(|&&(_, ep, _)| ep == endpoint)
            .map(|&(id, _, user)| (id, user))
    }

    fn is_connected(&self, endpoint: Endpoint, uid: &UID) -> bool {
        self.connections
            .iter()
            .any(|&conn| conn.0 == *uid && conn.1 == endpoint)
    }

    pub fn disconnect(&mut self, uid: &UID) -> bool {
        if let Some(endpoint) = self.remove_connection_by_uid(uid) {
            // We immediately drop all messages going in both directions. This is
            // possibly not realistic since in the real CRust some of these might
            // have already been sent and still be received by the far end, but
            // this is a worst case for routing to deal with.
            self.network.drop_pending(self.endpoint, endpoint);
            self.network.drop_pending(endpoint, self.endpoint);

            // Now send a new message to tell the other end to disconnect.
            self.send_packet(endpoint, Packet::Disconnect);
            true
        } else {
            false
        }
    }

    pub fn disconnect_all(&mut self) {
        let endpoints = self
            .connections
            .drain(..)
            .map(|(_, ep, _)| ep)
            .collect::<Vec<_>>();

        for endpoint in endpoints {
            self.send_packet(endpoint, Packet::Disconnect);
        }
    }
}

impl<UID: Uid> Drop for ServiceImpl<UID> {
    fn drop(&mut self) {
        self.disconnect_all();
    }
}

/// Creates a `SocketAddr` with the endpoint as its port, so that endpoints and addresses can be
/// easily mapped to each other during testing.
pub fn to_socket_addr(endpoint: Endpoint) -> SocketAddr {
    SocketAddr::new(
        IpAddr::from([127, 0, (endpoint.0 >> 8) as u8, endpoint.0 as u8]),
        endpoint.0 as u16,
    )
}

/// Simulated crust config file.
#[derive(Clone)]
pub struct Config {
    /// Contacts to bootstrap against.
    pub hard_coded_contacts: Vec<Endpoint>,
}

impl Config {
    /// Create default `Config`.
    pub fn new() -> Self {
        Self::with_contacts(&[])
    }

    /// Create `Config` with the given hardcoded contacts.
    pub fn with_contacts(contacts: &[Endpoint]) -> Self {
        Config {
            hard_coded_contacts: contacts.into_iter().cloned().collect(),
        }
    }
}

impl Default for Config {
    fn default() -> Config {
        Config::new()
    }
}

/// Simulated network endpoint (think socket address). This is used to identify
/// and address `Service`s in the mock network.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, Serialize, Deserialize, PartialOrd, Ord)]
pub struct Endpoint(pub usize);

#[derive(Clone, Debug)]
enum Packet<UID: Uid> {
    BootstrapRequest(UID, CrustUser),
    BootstrapSuccess(UID),
    BootstrapFailure,

    ConnectRequest(UID, UID),
    ConnectSuccess(UID, UID),
    ConnectFailure(UID, UID),

    Message(Vec<u8>),
    Disconnect,
}

impl<UID: Uid> Packet<UID> {
    // Given a request packet, returns the corresponding failure packet.
    fn to_failure(&self) -> Option<Packet<UID>> {
        match *self {
            Packet::BootstrapRequest(..) => Some(Packet::BootstrapFailure),
            Packet::ConnectRequest(our_id, their_id) => {
                Some(Packet::ConnectFailure(their_id, our_id))
            }
            _ => None,
        }
    }
}

// The following code facilitates passing ServiceHandles to mock Services, so we
// don't need separate test and non-test version of `routing::Core::new`.
thread_local! {
    static CURRENT: RefCell<Option<ServiceHandle<PublicId>>> = RefCell::new(None)
}

/// Make the `ServiceHandle` current so it can be picked up by mock `Service`s created
/// inside the passed-in lambda.
pub fn make_current<F, R>(handle: &ServiceHandle<PublicId>, f: F) -> R
where
    F: FnOnce() -> R,
{
    CURRENT.with(|current| {
        *current.borrow_mut() = Some(handle.clone());
        let result = f();
        *current.borrow_mut() = None;
        result
    })
}

/// Unsets and returns the `ServiceHandle` set with `make_current`.
pub fn take_current() -> ServiceHandle<PublicId> {
    CURRENT.with(|current| {
        unwrap!(
            current.borrow_mut().take(),
            "Current ServiceHandle is not set."
        )
    })
}

/// Invokes the given lambda with a reference to the `ServiceHandle` set with `make_current`.
pub fn with_current<F, R>(f: F) -> R
where
    F: FnOnce(&ServiceHandle<PublicId>) -> R,
{
    CURRENT.with(|current| {
        f(unwrap!(
            current.borrow_mut().as_ref(),
            "Current ServiceHandle is not set."
        ))
    })
}