tor_netdir/
testprovider.rs

Help
1//! A testing implementation of [`NetDirProvider`].
2
3use std::sync::{Arc, Mutex};
4
5use crate::{DirEvent, Error, NetDir, NetDirProvider, Result};
6
7use postage::broadcast::{self, Receiver, Sender};
8use postage::sink::Sink as _;
9
10/// Helper implementation of a [`NetDirProvider`].
11///
12/// A [`TestNetDirProvider`] can be used to provide a netdir in a single
13/// situation that requires a [`NetDirProvider`].
14///
15/// It notifies its owner of changes
16/// by firing a [`NewConsensus`](DirEvent::NewConsensus) event
17/// each time [`TestNetDirProvider::set_netdir_and_notify`] is called.
18///
19/// Calling [`TestNetDirProvider::set_netdir`] will **not** trigger a notification.
20#[derive(Debug)]
21pub struct TestNetDirProvider {
22    /// The mutable inner state.
23    inner: Mutex<Inner>,
24}
25
26/// The inner part of a TestNetDirProvider.
27#[derive(Debug)]
28struct Inner {
29    /// The latest netdir that this will return.
30    current: Option<Arc<NetDir>>,
31    /// The event sender, which fires every time the netdir is updated.
32    event_tx: Sender<DirEvent>,
33    /// The event receiver.
34    _event_rx: Receiver<DirEvent>,
35}
36
37#[allow(clippy::new_without_default)]
38impl TestNetDirProvider {
39    /// Create a new [`TestNetDirProvider`] with no netdir available.
40    pub fn new() -> Self {
41        let (event_tx, _event_rx) = broadcast::channel(128);
42        let inner = Inner {
43            current: None,
44            event_tx,
45            _event_rx,
46        };
47
48        Self {
49            inner: Mutex::new(inner),
50        }
51    }
52
53    /// Replace the `NetDir` in this [`TestNetDirProvider`].
54    pub fn set_netdir(&self, dir: impl Into<Arc<NetDir>>) {
55        let mut inner = self.inner.lock().expect("lock poisoned");
56        inner.current = Some(dir.into());
57    }
58
59    /// Replace the `NetDir` in this [`TestNetDirProvider`],
60    /// firing a [`NewConsensus`](DirEvent::NewConsensus) event.
61    pub async fn set_netdir_and_notify(&self, dir: impl Into<Arc<NetDir>>) {
62        let mut event_tx = {
63            let mut inner = self.inner.lock().expect("lock poisoned");
64            inner.current = Some(dir.into());
65            inner.event_tx.clone()
66        };
67        event_tx
68            .send(DirEvent::NewConsensus)
69            .await
70            .expect("receivers were dropped");
71    }
72}
73
74impl From<NetDir> for TestNetDirProvider {
75    fn from(nd: NetDir) -> Self {
76        let rv = Self::new();
77        rv.set_netdir(nd);
78        rv
79    }
80}
81
82impl NetDirProvider for TestNetDirProvider {
83    fn netdir(&self, _timeliness: crate::Timeliness) -> Result<Arc<NetDir>> {
84        match self.inner.lock().expect("lock poisoned").current.as_ref() {
85            Some(netdir) => Ok(Arc::clone(netdir)),
86            None => Err(Error::NoInfo),
87        }
88    }
89
90    fn events(&self) -> futures::stream::BoxStream<'static, DirEvent> {
91        let inner = self.inner.lock().expect("lock poisoned");
92        let events = inner.event_tx.subscribe();
93        Box::pin(events)
94    }
95
96    fn params(&self) -> Arc<dyn AsRef<crate::params::NetParameters>> {
97        if let Ok(nd) = self.netdir(crate::Timeliness::Unchecked) {
98            nd
99        } else {
100            Arc::new(crate::params::NetParameters::default())
101        }
102    }
103
104    fn protocol_statuses(
105        &self,
106    ) -> Option<(
107        std::time::SystemTime,
108        Arc<tor_netdoc::doc::netstatus::ProtoStatuses>,
109    )> {
110        None
111    }
112}
tor_netdir/testprovider.rs

tor_netdir/
testprovider.rs
