rama-net 0.3.0

rama network types and utilities
Documentation 
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

use core::convert::Infallible;

use crate::{address::SocketAddress, client::EstablishedClientConnection, stream::Socket};

use rama_core::{
    Service,
    error::BoxError,
    extensions::{Extensions, ExtensionsRef},
    rt::Executor,
};

use tokio::io::{AsyncRead, AsyncWrite, DuplexStream, duplex};

#[derive(Debug, Clone)]
/// Mock connector can be used in tests to simulate connectors so we can test client and servers
/// without opening actuall connections
pub struct MockConnectorService<S> {
    create_server: S,
    max_buffer_size: usize,
    executor: Option<Executor>,
}

impl<S> MockConnectorService<S> {
    pub fn new(create_server: S) -> Self {
        Self {
            create_server,
            max_buffer_size: 1024,
            executor: None,
        }
    }

    rama_utils::macros::generate_set_and_with! {
        /// Set `max_buffer_size` that will be used when creating DuplexStream
        pub fn max_buffer_size(mut self, size: usize) -> Self {
            self.max_buffer_size = size;
            self
        }
    }

    rama_utils::macros::generate_set_and_with! {
        /// Set `Executor` used for child tasks.
        pub fn executor(mut self, executor: Option<Executor>) -> Self {
            self.executor = executor;
            self
        }
    }
}

impl<S, Input, Server> Service<Input> for MockConnectorService<S>
where
    S: Fn() -> Server + Send + Sync + 'static,
    Server: Service<MockSocket, Error: Into<BoxError>>,
    Input: Send + 'static,
{
    type Error = Infallible;
    type Output = EstablishedClientConnection<MockSocket, Input>;

    async fn serve(&self, input: Input) -> Result<Self::Output, Self::Error> {
        let (client, server) = duplex(self.max_buffer_size);
        let client_socket = MockSocket::new(client);
        let server_socket = MockSocket::new(server);

        let server = (self.create_server)();

        self.executor
            .clone()
            .unwrap_or_default()
            .into_spawn_task(async move {
                #[expect(
                    clippy::panic,
                    reason = "test helper: failures must surface loudly to invalidate the test run"
                )]
                if let Err(err) = server.serve(server_socket).await {
                    panic!("created mock server failed: {}", err.into())
                }
            });

        Ok(EstablishedClientConnection {
            input,
            conn: client_socket,
        })
    }
}

#[derive(Debug)]
pub struct MockSocket {
    stream: DuplexStream,
    extensions: Extensions,
}

impl MockSocket {
    #[must_use]
    pub fn new(stream: DuplexStream) -> Self {
        Self {
            stream,
            extensions: Extensions::new(),
        }
    }
}

impl ExtensionsRef for MockSocket {
    fn extensions(&self) -> &Extensions {
        &self.extensions
    }
}

#[warn(clippy::missing_trait_methods)]
impl AsyncRead for MockSocket {
    fn poll_read(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
        buf: &mut tokio::io::ReadBuf<'_>,
    ) -> std::task::Poll<std::io::Result<()>> {
        std::pin::Pin::new(&mut self.stream).poll_read(cx, buf)
    }
}

#[warn(clippy::missing_trait_methods)]
impl AsyncWrite for MockSocket {
    fn poll_write(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
        buf: &[u8],
    ) -> std::task::Poll<std::io::Result<usize>> {
        std::pin::Pin::new(&mut self.stream).poll_write(cx, buf)
    }

    fn poll_flush(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<std::io::Result<()>> {
        std::pin::Pin::new(&mut self.stream).poll_flush(cx)
    }

    fn poll_shutdown(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<std::io::Result<()>> {
        std::pin::Pin::new(&mut self.stream).poll_shutdown(cx)
    }

    fn is_write_vectored(&self) -> bool {
        self.stream.is_write_vectored()
    }

    fn poll_write_vectored(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
        bufs: &[std::io::IoSlice<'_>],
    ) -> std::task::Poll<Result<usize, std::io::Error>> {
        std::pin::Pin::new(&mut self.stream).poll_write_vectored(cx, bufs)
    }
}

impl Socket for MockSocket {
    fn local_addr(&self) -> std::io::Result<SocketAddress> {
        Ok(SocketAddress::local_ipv4(0))
    }

    fn peer_addr(&self) -> std::io::Result<SocketAddress> {
        Ok(SocketAddress::local_ipv4(0))
    }
}