/
WebSocketResponseHandlerTest.java
319 lines (276 loc) · 11.4 KB
/
WebSocketResponseHandlerTest.java
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
package org.nanohttpd.junit.protocols.websockets;
/*
* #%L
* NanoHttpd-Websocket
* %%
* Copyright (C) 2012 - 2015 nanohttpd
* %%
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. Neither the name of the nanohttpd nor the names of its contributors
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
import static junit.framework.Assert.assertEquals;
import static junit.framework.Assert.assertNotNull;
import static junit.framework.Assert.assertNull;
import static org.mockito.Mockito.when;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.runners.MockitoJUnitRunner;
import org.nanohttpd.protocols.http.IHTTPSession;
import org.nanohttpd.protocols.http.response.Response;
import org.nanohttpd.protocols.http.response.Status;
import org.nanohttpd.protocols.websockets.CloseCode;
import org.nanohttpd.protocols.websockets.NanoWSD;
import org.nanohttpd.protocols.websockets.OpCode;
import org.nanohttpd.protocols.websockets.WebSocket;
import org.nanohttpd.protocols.websockets.WebSocketFrame;
@RunWith(MockitoJUnitRunner.class)
public class WebSocketResponseHandlerTest {
@Mock
private IHTTPSession session;
private NanoWSD nanoWebSocketServer;
private Map<String, String> headers;
private static class MockedWSD extends NanoWSD {
public MockedWSD(int port) {
super(port);
}
public MockedWSD(String hostname, int port) {
super(hostname, port);
}
@Override
protected WebSocket openWebSocket(IHTTPSession handshake) {
return new WebSocket(handshake) { // Dummy websocket inner class.
@Override
protected void onPong(WebSocketFrame pong) {
}
@Override
protected void onOpen() {
}
@Override
protected void onMessage(WebSocketFrame message) {
}
@Override
protected void onException(IOException exception) {
}
@Override
protected void onClose(CloseCode code, String reason, boolean initiatedByRemote) {
}
};
}
}
@Before
public void setUp() {
this.nanoWebSocketServer = Mockito.mock(MockedWSD.class, Mockito.CALLS_REAL_METHODS);
this.headers = new HashMap<String, String>();
this.headers.put("upgrade", "websocket");
this.headers.put("connection", "Upgrade");
this.headers.put("sec-websocket-key", "x3JJHMbDL1EzLkh9GBhXDw==");
this.headers.put("sec-websocket-protocol", "chat, superchat");
this.headers.put("sec-websocket-version", "13");
when(this.session.getHeaders()).thenReturn(this.headers);
}
@Test
public void testConnectionHeaderHandlesKeepAlive_FixingFirefoxConnectIssue() {
this.headers.put("connection", "keep-alive, Upgrade");
Response handshakeResponse = this.nanoWebSocketServer.serve(this.session);
assertNotNull(handshakeResponse);
}
@Test
public void testHandshakeReturnsResponseWithExpectedHeaders() {
Response handshakeResponse = this.nanoWebSocketServer.serve(this.session);
assertNotNull(handshakeResponse);
assertEquals(handshakeResponse.getHeader(NanoWSD.HEADER_WEBSOCKET_ACCEPT), "HSmrc0sMlYUkAGmm5OPpG2HaGWk=");
assertEquals(handshakeResponse.getHeader(NanoWSD.HEADER_WEBSOCKET_PROTOCOL), "chat");
}
@Test
public void testMissingKeyReturnsErrorResponse() {
this.headers.remove("sec-websocket-key");
Response handshakeResponse = this.nanoWebSocketServer.serve(this.session);
assertNotNull(handshakeResponse);
assertEquals(Status.BAD_REQUEST, handshakeResponse.getStatus());
}
@Test
public void testWrongConnectionHeaderReturnsNullResponse() {
this.headers.put("connection", "Junk");
Response handshakeResponse = this.nanoWebSocketServer.serve(this.session);
assertNull(handshakeResponse.getHeader(NanoWSD.HEADER_UPGRADE));
}
@Test
public void testWrongUpgradeHeaderReturnsNullResponse() {
this.headers.put("upgrade", "not a websocket");
Response handshakeResponse = this.nanoWebSocketServer.serve(this.session);
assertNull(handshakeResponse.getHeader(NanoWSD.HEADER_UPGRADE));
}
@Test
public void testWrongWebsocketVersionReturnsErrorResponse() {
this.headers.put("sec-websocket-version", "12");
Response handshakeResponse = this.nanoWebSocketServer.serve(this.session);
assertNotNull(handshakeResponse);
assertEquals(Status.BAD_REQUEST, handshakeResponse.getStatus());
}
@Test
public void testSetMaskingKeyThrowsExceptionMaskingKeyLengthIsNotFour() {
WebSocketFrame webSocketFrame = new WebSocketFrame(OpCode.Text, true, new byte[0]);
for (int maskingKeyLength = 0; maskingKeyLength < 10; maskingKeyLength++) {
if (maskingKeyLength == 4)
continue;
try {
webSocketFrame.setMaskingKey(new byte[maskingKeyLength]);
Assert.fail("IllegalArgumentException expected but not thrown");
} catch (IllegalArgumentException e) {
}
}
}
@Test
public void testIsMasked() {
WebSocketFrame webSocketFrame = new WebSocketFrame(OpCode.Text, true, new byte[0]);
Assert.assertFalse("isMasked should return true if masking key is not set.", webSocketFrame.isMasked());
webSocketFrame.setMaskingKey(new byte[4]);
Assert.assertTrue("isMasked should return true if correct masking key is set.", webSocketFrame.isMasked());
}
@Test
public void testWriteWhenNotMasked() throws IOException {
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
WebSocketFrame webSocketFrame = new WebSocketFrame(OpCode.Text, true, "payload".getBytes());
webSocketFrame.write(byteArrayOutputStream);
byte[] writtenBytes = byteArrayOutputStream.toByteArray();
Assert.assertEquals(9, writtenBytes.length);
Assert.assertEquals("Header byte incorrect.", -127, writtenBytes[0]);
Assert.assertEquals("Payload length byte incorrect.", 7, writtenBytes[1]);
Assert.assertArrayEquals(new byte[]{
-127,
7,
112,
97,
121,
108,
111,
97,
100
}, writtenBytes);
}
@Test
public void testWriteWhenMasked() throws IOException {
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
WebSocketFrame webSocketFrame = new WebSocketFrame(OpCode.Binary, true, "payload".getBytes());
webSocketFrame.setMaskingKey(new byte[]{
12,
45,
33,
32
});
webSocketFrame.write(byteArrayOutputStream);
byte[] writtenBytes = byteArrayOutputStream.toByteArray();
Assert.assertEquals(13, writtenBytes.length);
Assert.assertEquals("Header byte incorrect.", -126, writtenBytes[0]);
Assert.assertEquals("Payload length byte incorrect.", -121, writtenBytes[1]);
Assert.assertArrayEquals(new byte[]{
-126,
-121,
12,
45,
33,
32,
124,
76,
88,
76,
99,
76,
69
}, writtenBytes);
}
@Test
public void testWriteWhenNotMaskedPayloadLengthGreaterThan125() throws IOException {
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
WebSocketFrame webSocketFrame = new WebSocketFrame(OpCode.Ping, true, new byte[257]);
webSocketFrame.write(byteArrayOutputStream);
byte[] writtenBytes = byteArrayOutputStream.toByteArray();
Assert.assertEquals(261, writtenBytes.length);
Assert.assertEquals("Header byte incorrect.", -119, writtenBytes[0]);
Assert.assertArrayEquals("Payload length bytes incorrect.", new byte[]{
126,
1,
1
}, new byte[]{
writtenBytes[1],
writtenBytes[2],
writtenBytes[3]
});
}
@Test
public void testWriteWhenMaskedPayloadLengthGreaterThan125() throws IOException {
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
WebSocketFrame webSocketFrame = new WebSocketFrame(OpCode.Ping, false, new byte[257]);
webSocketFrame.setMaskingKey(new byte[]{
19,
25,
79,
11
});
webSocketFrame.write(byteArrayOutputStream);
byte[] writtenBytes = byteArrayOutputStream.toByteArray();
Assert.assertEquals(265, writtenBytes.length);
Assert.assertEquals("Header byte incorrect.", 9, writtenBytes[0]);
Assert.assertArrayEquals("Payload length bytes incorrect.", new byte[]{
-2,
1,
1
}, new byte[]{
writtenBytes[1],
writtenBytes[2],
writtenBytes[3]
});
}
@Test
public void testWriteWhenNotMaskedPayloadLengthGreaterThan65535() throws IOException {
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
WebSocketFrame webSocketFrame = new WebSocketFrame(OpCode.Ping, true, new byte[65536]);
webSocketFrame.write(byteArrayOutputStream);
byte[] writtenBytes = byteArrayOutputStream.toByteArray();
Assert.assertEquals(65546, writtenBytes.length);
Assert.assertEquals("Header byte incorrect.", -119, writtenBytes[0]);
Assert.assertArrayEquals("Payload length bytes incorrect.", new byte[]{
127,
0,
0,
0,
0,
0,
1,
0,
0
}, Arrays.copyOfRange(writtenBytes, 1, 10));
}
}