-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
ChunkedOutputTest.java
322 lines (281 loc) · 10 KB
/
ChunkedOutputTest.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
320
321
322
/*
* Copyright (c) 2002-2017 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.bolt.v1.transport.socket;
import io.netty.buffer.ByteBuf;
import io.netty.buffer.UnpooledByteBufAllocator;
import io.netty.channel.Channel;
import io.netty.channel.ChannelPromise;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import java.io.IOException;
import java.net.SocketAddress;
import java.nio.ByteBuffer;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.ThreadLocalRandom;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import org.neo4j.bolt.v1.packstream.PackOutputClosedException;
import org.neo4j.bolt.v1.transport.ChunkedOutput;
import org.neo4j.kernel.impl.util.HexPrinter;
import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.CoreMatchers.equalTo;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.fail;
import static org.mockito.Matchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
public class ChunkedOutputTest
{
private final Channel ch = mock( Channel.class );
private final ByteBuffer writtenData = ByteBuffer.allocate( 1024 );
private ChunkedOutput out;
@Before
public void setUp()
{
when( ch.alloc() ).thenReturn( UnpooledByteBufAllocator.DEFAULT );
this.out = new ChunkedOutput( ch, 16 );
}
@After
public void tearDown()
{
out.close();
}
@Test
public void shouldNotNPE() throws Throwable
{
ExecutorService runner = Executors.newFixedThreadPool( 4 );
// When
runner.execute( () ->
{
try
{
for ( int i = 0; i < 5; i++ )
{
out.writeByte( (byte) 1 ).writeShort( (short) 2 );
out.onMessageComplete();
out.flush();
Thread.sleep( ThreadLocalRandom.current().nextLong( 5 ) );
}
}
catch ( IOException | InterruptedException e )
{
throw new AssertionError( e );
}
} );
for ( int i = 0; i < 9; i++ )
{
runner.execute( () ->
{
try
{
for ( int j = 0; j < 5; j++ )
{
out.flush();
Thread.sleep( ThreadLocalRandom.current().nextLong( 5 ) );
}
}
catch ( IOException | InterruptedException e )
{
throw new AssertionError( e );
}
} );
}
runner.awaitTermination( 2, TimeUnit.SECONDS );
}
@Test
public void shouldChunkSingleMessage() throws Throwable
{
setupWriteAndFlush();
// When
out.writeByte( (byte) 1 ).writeShort( (short) 2 );
out.onMessageComplete();
out.flush();
// Then
assertThat( writtenData.limit(), equalTo( 7 ) );
assertThat( HexPrinter.hex( writtenData, 0, 7 ),
equalTo( "00 03 01 00 02 00 00" ) );
}
@Test
public void shouldChunkMessageSpanningMultipleChunks() throws Throwable
{
setupWriteAndFlush();
// When
out.writeLong( 1 ).writeLong( 2 ).writeLong( 3 );
out.onMessageComplete();
out.flush();
// Then
assertThat( writtenData.limit(), equalTo( 32 ) );
assertThat( HexPrinter.hex( writtenData, 0, 32 ),
equalTo( "00 08 00 00 00 00 00 00 00 01 00 08 00 00 00 00 " +
"00 00 00 02 00 08 00 00 00 00 00 00 00 03 00 00" ) );
}
@Test
public void shouldReserveSpaceForChunkHeaderWhenWriteDataToNewChunk() throws IOException
{
setupWriteAndFlush();
// Given 2 bytes left in buffer + chunk is closed
out.writeBytes( new byte[10], 0, 10 ); // 2 (header) + 10
out.onMessageComplete(); // 2 (ending)
// When write 2 bytes
out.writeShort( (short) 33 ); // 2 (header) + 2
// Then the buffer should auto flash if space left (2) is smaller than new data and chunk header (2 + 2)
assertThat( writtenData.limit(), equalTo( 14 ) );
assertThat( HexPrinter.hex( writtenData, 0, 14 ),
equalTo( "00 0A 00 00 00 00 00 00 00 00 00 00 00 00" ) );
}
@Test
public void shouldChunkDataWhoseSizeIsGreaterThanOutputBufferCapacity() throws IOException
{
setupWriteAndFlush();
// Given
out.writeBytes( new byte[16], 0, 16 ); // 2 + 16 is greater than the default max size 16
out.onMessageComplete();
out.flush();
// When & Then
assertThat( writtenData.limit(), equalTo( 22 ) );
assertThat( HexPrinter.hex( writtenData, 0, 22 ),
equalTo( "00 0E 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 02 00 00 00 00" ) );
}
@Test
public void shouldNotThrowIfOutOfSyncFlush() throws Throwable
{
setupWriteAndFlush();
// When
out.writeLong( 1 ).writeLong( 2 ).writeLong( 3 );
out.onMessageComplete();
out.flush();
out.close();
//this flush comes in to late but should not cause ChunkedOutput to choke.
out.flush();
// Then
assertThat( writtenData.limit(), equalTo( 32 ) );
assertThat( HexPrinter.hex( writtenData, 0, 32 ),
equalTo( "00 08 00 00 00 00 00 00 00 01 00 08 00 00 00 00 " +
"00 00 00 02 00 08 00 00 00 00 00 00 00 03 00 00" ) );
}
@Test
public void shouldQueueWritesMadeWhileFlushing() throws Throwable
{
final CountDownLatch startLatch = new CountDownLatch( 1 );
final CountDownLatch finishLatch = new CountDownLatch( 1 );
final AtomicBoolean parallelException = new AtomicBoolean( false );
when( ch.writeAndFlush( any(), any( ChannelPromise.class ) ) ).thenAnswer( invocation ->
{
startLatch.countDown();
ByteBuf byteBuf = (ByteBuf) invocation.getArguments()[0];
writtenData.limit( writtenData.position() + byteBuf.readableBytes() );
byteBuf.readBytes( writtenData );
return null;
} );
class ParallelWriter extends Thread
{
public void run()
{
try
{
startLatch.await();
out.writeShort( (short) 2 );
out.flush();
}
catch ( Exception e )
{
e.printStackTrace( System.err );
parallelException.set( true );
}
finally
{
finishLatch.countDown();
}
}
}
new ParallelWriter().start();
// When
out.writeShort( (short) 1 );
out.flush();
finishLatch.await();
// Then
assertFalse( parallelException.get() );
assertThat( writtenData.limit(), equalTo( 8 ) );
assertThat( HexPrinter.hex( writtenData, 0, 8 ), equalTo( "00 02 00 01 00 02 00 02" ) );
}
@Test
public void shouldNotBeAbleToWriteAfterClose() throws Throwable
{
// When
out.writeLong( 1 ).writeLong( 2 ).writeLong( 3 );
out.onMessageComplete();
out.flush();
out.close();
try
{
out.writeShort( (short) 42 );
fail( "Should have thrown IOException" );
}
catch ( IOException e )
{
// We've been expecting you Mr Bond.
}
}
@Test
public void shouldFlushOnClose() throws Throwable
{
setupWriteAndFlush();
// When
out.writeLong( 1 ).writeLong( 2 ).writeLong( 3 );
out.onMessageComplete();
out.close();
// Then
assertThat( writtenData.limit(), equalTo( 32 ) );
assertThat( HexPrinter.hex( writtenData, 0, 32 ),
equalTo( "00 08 00 00 00 00 00 00 00 01 00 08 00 00 00 00 " +
"00 00 00 02 00 08 00 00 00 00 00 00 00 03 00 00" ) );
}
@Test
public void shouldThrowErrorWithRemoteAddressWhenClosed() throws Exception
{
SocketAddress remoteAddress = mock( SocketAddress.class );
String remoteAddressString = "client.server.com:7687";
when( remoteAddress.toString() ).thenReturn( remoteAddressString );
when( ch.remoteAddress() ).thenReturn( remoteAddress );
out.close();
try
{
out.writeInt( 42 );
}
catch ( PackOutputClosedException e )
{
assertThat( e.getMessage(), containsString( remoteAddressString ) );
}
}
private void setupWriteAndFlush()
{
when( ch.writeAndFlush( any(), any( ChannelPromise.class ) ) ).thenAnswer( invocation ->
{
ByteBuf byteBuf = (ByteBuf) invocation.getArguments()[0];
writtenData.limit( writtenData.position() + byteBuf.readableBytes() );
byteBuf.readBytes( writtenData );
return null;
} );
}
}