websocket-std 0.0.6

Websocket implementation using std support, focus on microcontrollers and interoperability with other languages like C through the ffi.
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

use super::net::read_into_buffer;
use std::io::Write;
use std::net::{TcpStream, TcpListener, Shutdown};
use std::time::Duration;
use std::thread::sleep;
use crate::result::WebSocketError;

// -------------------------------------------------------------------------------------------------------- //
//                                               net.rs
// -------------------------------------------------------------------------------------------------------- //


// Setup server and client socket
// Client socket must be in not_blocking mode
// Test run in parallel so create socket with different ports to avoid errors taken the same address
fn setup() -> (TcpStream, TcpStream) {
    // With port 0 the program will request and available random port
    let listener = TcpListener::bind("localhost:0").unwrap();
    let port = listener.local_addr().unwrap().port();
    let client = TcpStream::connect(format!("localhost:{}", port)).unwrap();
    client.set_nonblocking(true).unwrap();
    let (server, _) = listener.accept().unwrap();

    (server, client)
}

fn before_each(server: TcpStream, client: TcpStream) {
    let _ = server.shutdown(Shutdown::Both);
    let _ = client.shutdown(Shutdown::Both);
}

#[test]
fn no_bytes_ready_to_read () {
    let (server, mut client) = setup();
    let mut buf: [u8; 8] = [0; 8];

    let res = read_into_buffer(&mut client, &mut buf);
    assert!(res.is_ok());
    let amount = res.unwrap();
    assert_eq!(0, amount);

    before_each(server, client);
}

#[test]
fn eof_reached () {
    let (server, mut client) = setup();
    let mut buf: [u8; 8] = [0; 8];

    let _ = server.shutdown(Shutdown::Both);
    sleep(Duration::from_secs(1));

    let res = read_into_buffer(&mut client, &mut buf);
    assert!(res.is_err());
    let error = res.err().unwrap();
    
    match error {
        WebSocketError::ConnectionClose => assert!(true),
        e => panic!("Unreachable: {}", e) // grcov-excl-line 
    }

    let _ = client.shutdown(Shutdown::Both);
}

#[test]
fn read_less_than_buffer_capacity () {
    let (mut server, mut client) = setup();
    let mut buf: [u8; 8] = [0; 8];

    let msg = "hello";
    server.write_all(msg.as_bytes()).unwrap();
    sleep(Duration::from_secs(1));

    let res = read_into_buffer(&mut client, &mut buf);
    assert!(res.is_ok());
    let amount = res.unwrap();
    assert_eq!(msg.len(), amount);

    let res = read_into_buffer(&mut client, &mut buf);
    assert!(res.is_ok());
    let amount = res.unwrap();
    assert_eq!(0, amount);

    before_each(server, client);
}

#[test]
fn read_same_as_buffer_capacity () {
    let (mut server, mut client) = setup();
    let mut buf: [u8; 8] = [0; 8];

    let msg = "hello!!!";
    server.write_all(msg.as_bytes()).unwrap();
    sleep(Duration::from_secs(1));

    let res = read_into_buffer(&mut client, &mut buf);
    assert!(res.is_ok());
    let amount = res.unwrap();
    assert_eq!(msg.len(), amount);
    assert_eq!(msg.len(), buf.len());

    let res = read_into_buffer(&mut client, &mut buf);
    assert!(res.is_ok());
    let amount = res.unwrap();
    assert_eq!(0, amount);

    before_each(server, client);
}

#[test]
fn read_more_than_buffer_capacity () {
    let (mut server, mut client) = setup();
    let mut buf: [u8; 8] = [0; 8];

    let msg = "hello world!";
    server.write_all(msg.as_bytes()).unwrap();
    sleep(Duration::from_secs(1));

    let res = read_into_buffer(&mut client, &mut buf);
    assert!(res.is_ok());
    let amount = res.unwrap();
    assert_eq!(buf.len(), amount);
    assert!(msg.len() > buf.len());

    let res = read_into_buffer(&mut client, &mut buf);
    assert!(res.is_ok());
    let amount = res.unwrap();
    assert_eq!(msg.len() - buf.len(), amount);

    let res = read_into_buffer(&mut client, &mut buf);
    assert!(res.is_ok());
    let amount = res.unwrap();
    assert_eq!(0, amount);

    before_each(server, client);
}

// -------------------------------------------------------------------------------------------------------- //
//                                               binary.rs
// -------------------------------------------------------------------------------------------------------- //
use super::binary::*;

#[test]
fn valid_bytes_to_u16 () {
    let bytes = [67,218];
    let res = bytes_to_u16(bytes.as_slice());
    assert!(res.is_ok());
    let value: u16 = (256u16.pow(1) * 67) + (256u16.pow(0) * 218);
    assert_eq!(res.unwrap(), value);
}

#[test]
fn invalid_bytes_to_u16 () {
    let bytes = [8,0,1];
    let res = bytes_to_u16(bytes.as_slice());
    assert!(res.is_err());
}

#[test]
fn valid_bytes_to_u64 () {
    let bytes = [1,0,0,0,0,0,5,255];
    let res = bytes_to_u64(bytes.as_slice());
    assert!(res.is_ok());
    let value: u64 = (256u64.pow(7) * 1) + (256u64.pow(1) * 5) + (256u64.pow(0) * 255);
    assert_eq!(res.unwrap(), value);
}

#[test]
fn invalid_bytes_to_u64 () {
    let bytes = [8,0,1];
    let res = bytes_to_u64(bytes.as_slice());
    assert!(res.is_err());
}