nardol 0.0.3

Simple framework that provides structure to data sent and received from network.
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
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
use std::net::*;

use rand::Rng;

use nardol::Bytes;
use nardol::{Packet, PacketKind};

/// This checks only if size of Packet was calculated correctly.
#[test]
fn new() {
    let packet = Packet::new(PacketKind::Empty, Bytes::from([1_u8, 2_u8, 3_u8, 4_u8])).unwrap();
    assert_eq!(packet.size(), 8_u16);
}

/// Checks if FromBytes::from_buff implementation for Packet correctly returns an error if buffer is to small.
#[test]
fn from_buff_size_test() {
    let too_short_buff = [1_u8, 2_u8, 3_u8];

    let mut returns_error = false;

    if Packet::try_from(too_short_buff.as_slice()).is_err() {
        returns_error = true;
    }

    assert!(returns_error);
}

/// Checks if FromBytes::from_buff implementation for Packet correctly builds a packet from_buff.
#[test]
fn from_buff_correctness_test() {
    // This should create a Packet with size 6, kind Unit and two bytes in its content.
    let buff = vec![0_u8, 6_u8, 4_u8, 0_u8, 1_u8, 2_u8];

    let packet = Packet::new(PacketKind::Unit, Bytes::from([1_u8, 2_u8])).unwrap();

    let packet_from_buff = Packet::try_from(buff.as_slice()).unwrap();

    assert_eq!(packet, packet_from_buff);
}

/// Checks if IntoBytes::into_Bytes creates a correct buff from a Packet.
#[test]
#[allow(non_snake_case)]
fn into_Bytes() {
    let packet = Packet::new(PacketKind::Unit, Bytes::from([1_u8, 2_u8])).unwrap();

    let buff = vec![0_u8, 6_u8, 4_u8, 0_u8, 1_u8, 2_u8];

    let buff_from_packet = Bytes::from(packet).into_vec();

    assert_eq!(buff, buff_from_packet);
}

/// Tests if Packet::receive works and returns the same data for successive calls.
/// Also tests Packet::send if correct data are sent.
#[test]
fn receive() {
    let addrs = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8000);
    let listener = TcpListener::bind(addrs).unwrap();

    let created_packet = Packet::new(PacketKind::Unit, Bytes::from([0, 1, 2, 3, 4, 5])).unwrap();
    let created_packet_in_thread = created_packet.clone();

    std::thread::spawn(move || {
        std::thread::sleep(std::time::Duration::from_secs(1));

        let packet = created_packet_in_thread;

        let mut stream = TcpStream::connect(addrs).unwrap();
        packet.send(&mut stream).unwrap();
    });

    let (mut stream, _) = listener.accept().unwrap();

    let packet = Packet::receive(&mut stream).unwrap();

    assert_eq!(created_packet, packet);
}

/// Tests if Packet::receive_from works and returns the same data for successive calls.
/// Also tests Packet::send_to if correct data are sent.
#[test]
fn receive_from() {
    let addrs1 = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8001);
    let addrs2 = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8002);

    let socket1 = UdpSocket::bind(addrs1).unwrap();
    let socket2 = UdpSocket::bind(addrs2).unwrap();

    let created_packet = Packet::new(PacketKind::Unit, Bytes::from([0, 1, 2, 3, 4, 5])).unwrap();

    created_packet.clone().send_to(socket1, addrs2).unwrap();

    let (packet, _) = Packet::receive_from(socket2.try_clone().unwrap()).unwrap();

    assert_eq!(created_packet, packet);
}

/// Tests if Packet::peek_from_connected works and returns the same data for successive calls.
/// Also tests Packet::send_to_connected if correct data are sent.
#[test]
fn receive_from_connected() {
    let addrs1 = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8003);
    let addrs2 = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8004);

    let socket1 = UdpSocket::bind(addrs1).unwrap();
    let socket2 = UdpSocket::bind(addrs2).unwrap();

    socket1.connect(addrs2).unwrap();

    let created_packet = Packet::new(PacketKind::Unit, Bytes::from([0, 1, 2, 3, 4, 5])).unwrap();

    created_packet.clone().send_to_connected(socket1).unwrap();

    let packet = Packet::receive_from_connected(socket2.try_clone().unwrap()).unwrap();

    assert_eq!(created_packet, packet);
}

/// Tests if Packet::peek works and returns the same data for successive calls.
/// Also tests Packet::send if correct data are sent.
#[test]
fn peek() {
    let addrs = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8005);
    let listener = TcpListener::bind(addrs).unwrap();

    let created_packet = Packet::new(PacketKind::Unit, Bytes::from([0, 1, 2, 3, 4, 5])).unwrap();
    let created_packet_in_thread = created_packet.clone();

    std::thread::spawn(move || {
        std::thread::sleep(std::time::Duration::from_secs(1));

        let packet = created_packet_in_thread;

        let mut stream = TcpStream::connect(addrs).unwrap();
        packet.send(&mut stream).unwrap();
    });

    let mut received = Vec::new();

    let (mut stream, _) = listener.accept().unwrap();

    for _ in 0..10 {
        let packet = Packet::peek(&mut stream);
        received.push(packet);
    }

    assert!(received
        .into_iter()
        .map(|recv| recv.unwrap())
        .collect::<Vec<Packet>>()
        .into_iter()
        .all(|packet| packet == created_packet))
}

/// Tests if Packet::peek_from a works and returns the same data for successive calls.
/// Also tests Packet::send_to if correct data are sent.
#[test]
fn peek_from_and_send_to() {
    let addrs1 = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8006);
    let addrs2 = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8007);

    let socket1 = UdpSocket::bind(addrs1).unwrap();
    let socket2 = UdpSocket::bind(addrs2).unwrap();

    let created_packet = Packet::new(PacketKind::Unit, Bytes::from([0, 1, 2, 3, 4, 5])).unwrap();

    created_packet.clone().send_to(socket1, addrs2).unwrap();

    let mut received = Vec::new();

    for _ in 0..10 {
        let packet = Packet::peek_from(socket2.try_clone().unwrap());
        received.push(packet);
    }

    assert!(received
        .into_iter()
        .map(|recv| {
            let (packet, _) = recv.unwrap();
            packet
        })
        .collect::<Vec<Packet>>()
        .into_iter()
        .all(|packet| packet == created_packet))
}

/// Tests if Packet::peek_from_connected works and returns the same data for successive calls.
/// Also tests Packet::send_to_connected if correct data are sent.
#[test]
fn peek_from_and_send_to_connected() {
    let addrs1 = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8008);
    let addrs2 = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8009);

    let socket1 = UdpSocket::bind(addrs1).unwrap();
    let socket2 = UdpSocket::bind(addrs2).unwrap();

    socket1.connect(addrs2).unwrap();

    let created_packet = Packet::new(PacketKind::Unit, Bytes::from([0, 1, 2, 3, 4, 5])).unwrap();

    created_packet.clone().send_to_connected(socket1).unwrap();

    let mut received = Vec::new();

    for _ in 0..10 {
        let packet = Packet::peek_from_connected(socket2.try_clone().unwrap());
        received.push(packet);
    }

    assert!(received
        .into_iter()
        .map(|recv| recv.unwrap())
        .collect::<Vec<Packet>>()
        .into_iter()
        .all(|packet| packet == created_packet))
}

/// Tests if Packet::number_of_packets returns a correct number of packets.
#[test]
fn number_of_packets() {
    assert_eq!(5, Packet::number_of_packets(5000));
}

/// Tests if Packet::split_to_max_packet_size splits given buffer to correctly sized packets.
///
/// This test might fail if Packet::max_size is changed between setting it in this test and call of
/// Packet::split_to_max_packet_size by other test which makes it to created differently sized buffers than
/// those against it is checked.
///
/// It is not a design problem of the function, it actually shows that the function
/// works correctly, but the test itself is poorly written.
///
/// The simplest solutions is to run it by itself or run all tests limited to one thread, so there is no call that
/// would change the maximum size of the Packet.
#[test]
fn split_to_max_packet_size() {
    let buff: Bytes = vec![0_u8; 9].into();

    Packet::set_max_size(6);
    let packets = Packet::split_to_max_packet_size(buff);

    let manual_packets: Vec<Bytes> = vec![
        vec![0_u8; 2].into(),
        vec![0_u8; 2].into(),
        vec![0_u8; 2].into(),
        vec![0_u8; 2].into(),
        vec![0_u8; 1].into(),
    ];

    assert_eq!(
        manual_packets, packets,
        "Check the test description, this might be a false failure."
    );
}

/// Tests if Packet::max_size works correctly in single threaded context.
#[test]
fn max_size_single_threaded_access() {
    Packet::set_max_size(1024);

    assert_eq!(1024, Packet::max_size())
}

/// Tests if Packet::max_size works correctly in multi threaded context.
#[test]
fn max_size_multiple_threads_access() {
    Packet::set_max_size(1024);

    let mut receivers = Vec::new();

    for _ in 0..10 {
        let (p, c) = std::sync::mpsc::channel();

        receivers.push(c);

        std::thread::spawn(move || {
            let mut is_correct = true;

            for _ in 0..100 {
                if Packet::max_size() != 1024 {
                    is_correct = false;
                }

                std::thread::sleep(std::time::Duration::new(0, 0));
            }

            p.send(is_correct).unwrap();
        });
    }

    assert!(
        receivers
            .iter()
            .map(|recv| recv.recv().unwrap())
            .collect::<Vec<bool>>()
            .into_iter()
            .all(|v| v),
        "This might be a false failure if tests are run in parallel."
    );
}

/// Tests if Packet::set_max_size works correctly in multi threaded context by creating multiple threads
/// and successively setting MAX_SIZE to randomly generated number.
#[test]
fn set_max_size_multiple_threads_access() {
    let (p, c) = std::sync::mpsc::sync_channel(1000);

    for _ in 0..10 {
        let p_into_thread = p.clone();

        std::thread::spawn(move || {
            let mut rng = rand::thread_rng();

            for _ in 0..100 {
                let x: u16 = rng.gen();

                Packet::set_max_size(x);

                p_into_thread.send(x).unwrap();
            }
        });
    }

    // Drop producer in main thread, so last value can be recognized.
    drop(p);

    let mut last = None;

    loop {
        match c.recv() {
            Ok(v) => last = Some(v),
            Err(_) => {
                // Just a safe check if there is any slowdown from some reason.
                std::thread::sleep(std::time::Duration::from_secs(1));
                match c.recv() {
                    Ok(v) => last = Some(v),
                    Err(_) => {
                        if last.is_none() {
                            panic!();
                        }
                        break;
                    }
                }
            }
        }
    }

    assert_eq!(Packet::max_size(), last.unwrap());
}

/// Tests if Packet::max_description_size works correctly in single threaded context.
#[test]
fn description_size_single_threaded_access() {
    assert_eq!(4, Packet::description_size())
}

/// Tests if Packet::max_size works correctly in multi threaded context.
#[test]
fn description_size_multiple_threads_access() {
    let mut receivers = Vec::new();

    for _ in 0..10 {
        let (p, c) = std::sync::mpsc::channel();

        receivers.push(c);

        std::thread::spawn(move || {
            let mut is_correct = true;

            for _ in 0..100 {
                if Packet::description_size() != 4 {
                    is_correct = false;
                }

                std::thread::sleep(std::time::Duration::new(0, 0));
            }

            p.send(is_correct).unwrap();
        });
    }

    assert!(receivers
        .iter()
        .map(|recv| recv.recv().unwrap())
        .collect::<Vec<bool>>()
        .into_iter()
        .all(|v| v));
}

/// Tests if Packet::max_content_size returns correct value.
///
/// This test might fail if Packet::max_size is changed between setting it in this test and call of
/// Packet::max_content_size by other test which makes it to created differently sized buffers than
/// those against it is checked.
///
/// The simplest solutions is to run it by itself or run all tests limited to one thread, so there is no call that
/// would change the maximum size of the Packet.
#[test]
fn max_content_size() {
    Packet::set_max_size(1024);

    if (Packet::max_size() == 1024) && (Packet::description_size() == 4) {
        assert_eq!(
            1020,
            Packet::max_content_size(),
            "Check test description, might be false failure."
        );
    }
}