-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
DynamicTaskExecutorTest.java
426 lines (374 loc) · 13.7 KB
/
DynamicTaskExecutorTest.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
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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
/*
* 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.unsafe.impl.batchimport.executor;
import org.junit.Rule;
import org.junit.Test;
import java.io.IOException;
import java.util.concurrent.Future;
import org.neo4j.helpers.Exceptions;
import org.neo4j.test.Barrier;
import org.neo4j.test.DoubleLatch;
import org.neo4j.test.OtherThreadExecutor;
import org.neo4j.test.OtherThreadExecutor.WorkerCommand;
import org.neo4j.test.Race;
import org.neo4j.test.rule.RepeatRule;
import org.neo4j.test.rule.RepeatRule.Repeat;
import org.neo4j.unsafe.impl.batchimport.executor.ParkStrategy.Park;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
import static java.util.concurrent.TimeUnit.SECONDS;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.neo4j.unsafe.impl.batchimport.executor.TaskExecutor.SF_ABORT_QUEUED;
import static org.neo4j.unsafe.impl.batchimport.executor.TaskExecutor.SF_AWAIT_ALL_COMPLETED;
public class DynamicTaskExecutorTest
{
private static final Park PARK = new ParkStrategy.Park( 1, MILLISECONDS );
@Rule
public final RepeatRule repeater = new RepeatRule();
@Test
public void shouldExecuteTasksInParallel() throws Exception
{
// GIVEN
TaskExecutor<Void> executor = new DynamicTaskExecutor<>( 2, 0, 5, PARK,
getClass().getSimpleName() );
ControlledTask task1 = new ControlledTask();
TestTask task2 = new TestTask();
// WHEN
executor.submit( task1 );
task1.latch.waitForAllToStart();
executor.submit( task2 );
//noinspection StatementWithEmptyBody
while ( task2.executed == 0 )
{ // Busy loop
}
task1.latch.finish();
//noinspection StatementWithEmptyBody
while ( task1.executed == 0 )
{ // Busy loop
}
executor.shutdown( SF_AWAIT_ALL_COMPLETED );
// THEN
assertEquals( 1, task1.executed );
assertEquals( 1, task2.executed );
}
@Test
public void shouldIncrementNumberOfProcessorsWhenRunning() throws Exception
{
// GIVEN
TaskExecutor<Void> executor = new DynamicTaskExecutor<>( 1, 0, 5, PARK,
getClass().getSimpleName() );
ControlledTask task1 = new ControlledTask();
TestTask task2 = new TestTask();
// WHEN
executor.submit( task1 );
task1.latch.waitForAllToStart();
executor.submit( task2 );
executor.processors( 1 ); // now at 2
//noinspection StatementWithEmptyBody
while ( task2.executed == 0 )
{ // With one additional worker, the second task can execute even if task one is still executing
}
task1.latch.finish();
//noinspection StatementWithEmptyBody
while ( task1.executed == 0 )
{ // Busy loop
}
executor.shutdown( SF_AWAIT_ALL_COMPLETED );
// THEN
assertEquals( 1, task1.executed );
assertEquals( 1, task2.executed );
}
@Test
public void shouldDecrementNumberOfProcessorsWhenRunning() throws Exception
{
// GIVEN
TaskExecutor<Void> executor = new DynamicTaskExecutor<>( 2, 0, 5, PARK,
getClass().getSimpleName() );
ControlledTask task1 = new ControlledTask();
ControlledTask task2 = new ControlledTask();
ControlledTask task3 = new ControlledTask();
TestTask task4 = new TestTask();
// WHEN
executor.submit( task1 );
executor.submit( task2 );
task1.latch.waitForAllToStart();
task2.latch.waitForAllToStart();
executor.submit( task3 );
executor.submit( task4 );
executor.processors( -1 ); // it started at 2 ^^^
task1.latch.finish();
task2.latch.finish();
task3.latch.waitForAllToStart();
Thread.sleep( 200 ); // gosh, a Thread.sleep...
assertEquals( 0, task4.executed );
task3.latch.finish();
executor.shutdown( SF_AWAIT_ALL_COMPLETED );
// THEN
assertEquals( 1, task1.executed );
assertEquals( 1, task2.executed );
assertEquals( 1, task3.executed );
assertEquals( 1, task4.executed );
}
@Test
public void shouldExecuteMultipleTasks() throws Exception
{
// GIVEN
TaskExecutor<Void> executor = new DynamicTaskExecutor<>( 30, 0, 5, PARK,
getClass().getSimpleName() );
ExpensiveTask[] tasks = new ExpensiveTask[1000];
// WHEN
for ( int i = 0; i < tasks.length; i++ )
{
executor.submit( tasks[i] = new ExpensiveTask( 10 ) );
}
executor.shutdown( SF_AWAIT_ALL_COMPLETED );
// THEN
for ( ExpensiveTask task : tasks )
{
assertEquals( 1, task.executed );
}
}
@Test
public void shouldShutDownOnTaskFailure() throws Exception
{
// GIVEN
TaskExecutor<Void> executor = new DynamicTaskExecutor<>( 30, 0, 5, PARK,
getClass().getSimpleName() );
// WHEN
IOException exception = new IOException( "Test message" );
FailingTask task = new FailingTask( exception );
executor.submit( task );
task.latch.await();
task.latch.release();
// THEN
assertExceptionOnSubmit( executor, exception );
}
@Test
public void shouldShutDownOnTaskFailureEvenIfOtherTasksArePending() throws Exception
{
// GIVEN
TaskExecutor<Void> executor = new DynamicTaskExecutor<>( 2, 0, 10, PARK,
getClass().getSimpleName() );
IOException exception = new IOException( "Test message" );
ControlledTask firstBlockingTask = new ControlledTask();
ControlledTask secondBlockingTask = new ControlledTask();
executor.submit( firstBlockingTask );
executor.submit( secondBlockingTask );
firstBlockingTask.latch.waitForAllToStart();
secondBlockingTask.latch.waitForAllToStart();
FailingTask failingTask = new FailingTask( exception );
executor.submit( failingTask );
ControlledTask thirdBlockingTask = new ControlledTask();
executor.submit( thirdBlockingTask );
// WHEN
firstBlockingTask.latch.finish();
failingTask.latch.await();
failingTask.latch.release();
// THEN
assertExceptionOnSubmit( executor, exception );
executor.shutdown( SF_ABORT_QUEUED ); // call would block if the shutdown as part of failure doesn't complete properly
secondBlockingTask.latch.finish();
}
@Test
public void shouldSurfaceTaskErrorInAssertHealthy() throws Exception
{
// GIVEN
TaskExecutor<Void> executor = new DynamicTaskExecutor<>( 2, 0, 10, PARK,
getClass().getSimpleName() );
IOException exception = new IOException( "Failure" );
// WHEN
FailingTask failingTask = new FailingTask( exception );
executor.submit( failingTask );
failingTask.latch.await();
failingTask.latch.release();
// WHEN
for ( int i = 0; i < 5; i++ )
{
try
{
executor.assertHealthy();
// OK, so the executor hasn't executed the finally block after task was done yet
Thread.sleep( 100 );
}
catch ( Exception e )
{
assertTrue( Exceptions.contains( e, exception.getMessage(), exception.getClass() ) );
return;
}
}
fail( "Should not be considered healthy after failing task" );
}
@Test
public void shouldLetShutdownCompleteInEventOfPanic() throws Exception
{
// GIVEN
final TaskExecutor<Void> executor = new DynamicTaskExecutor<>( 2, 0, 10, PARK,
getClass().getSimpleName() );
IOException exception = new IOException( "Failure" );
// WHEN
FailingTask failingTask = new FailingTask( exception );
executor.submit( failingTask );
failingTask.latch.await();
// WHEN
try ( OtherThreadExecutor<Void> closer = new OtherThreadExecutor<>( "closer", null ) )
{
Future<Void> shutdown = closer.executeDontWait( new WorkerCommand<Void,Void>()
{
@Override
public Void doWork( Void state ) throws Exception
{
executor.shutdown( SF_AWAIT_ALL_COMPLETED );
return null;
}
} );
while ( !closer.waitUntilWaiting().isAt( DynamicTaskExecutor.class, "shutdown" ) )
{
Thread.sleep( 10 );
}
// Here we've got a shutdown call stuck awaiting queue to be empty (since true was passed in)
// at the same time we've got a FailingTask ready to throw its exception and another task
// sitting in the queue after it. Now make the task throw that exception.
failingTask.latch.release();
// Some time after throwing this, the shutdown request should have been completed.
shutdown.get();
}
}
@Test
public void shouldRespectMaxProcessors() throws Exception
{
// GIVEN
int maxProcessors = 4;
final TaskExecutor<Void> executor = new DynamicTaskExecutor<>( 1, maxProcessors, 10, PARK,
getClass().getSimpleName() );
// WHEN/THEN
assertEquals( 1, executor.processors( 0 ) );
assertEquals( 2, executor.processors( 1 ) );
assertEquals( 4, executor.processors( 3 ) /*would have gone to 5 otherwise*/ );
assertEquals( 4, executor.processors( 0 ) );
assertEquals( 4, executor.processors( 1 ) );
assertEquals( 3, executor.processors( -1 ) );
assertEquals( 1, executor.processors( -2 ) );
assertEquals( 1, executor.processors( -2 ) );
assertEquals( 1, executor.processors( 0 ) );
executor.shutdown( SF_AWAIT_ALL_COMPLETED );
}
@Repeat( times = 10 )
@Test
public void shouldCopeWithConcurrentIncrementOfProcessorsAndShutdown() throws Throwable
{
// GIVEN
TaskExecutor<Void> executor = new DynamicTaskExecutor<>( 1, 2, 2, PARK, "test" );
Race race = new Race().withRandomStartDelays();
race.addContestant( () -> executor.shutdown( SF_AWAIT_ALL_COMPLETED ) );
race.addContestant( () -> executor.processors( 1 ) );
// WHEN
race.go( 10, SECONDS );
// THEN we should be able to do so, there was a recent fix here and before that fix
// shutdown() would hang, that's why we wait for 10 seconds here to cap it if there's an issue.
}
private void assertExceptionOnSubmit( TaskExecutor<Void> executor, IOException exception )
{
Exception submitException = null;
for ( int i = 0; i < 5 && submitException == null; i++ )
{
try
{
executor.submit( new EmptyTask() );
Thread.sleep( 100 );
}
catch ( Exception e )
{
submitException = e;
}
}
assertNotNull( submitException );
assertEquals( exception, submitException.getCause() );
}
private static class TestTask implements Task<Void>
{
protected volatile int executed;
@Override
public void run( Void nothing )
{
executed++;
}
}
private static class EmptyTask implements Task<Void>
{
@Override
public void run( Void nothing ) throws Exception
{ // Do nothing
}
}
private static class FailingTask implements Task<Void>
{
private final Exception exception;
private final Barrier.Control latch = new Barrier.Control();
FailingTask( Exception exception )
{
this.exception = exception;
}
@Override
public void run( Void nothing ) throws Exception
{
try
{
throw exception;
}
finally
{
latch.reached();
}
}
}
private static class ExpensiveTask extends TestTask
{
private final int millis;
ExpensiveTask( int millis )
{
this.millis = millis;
}
@Override
public void run( Void nothing )
{
try
{
Thread.sleep( millis );
}
catch ( InterruptedException e )
{
throw new RuntimeException( e );
}
super.run( nothing );
}
}
private static class ControlledTask extends TestTask
{
private final DoubleLatch latch = new DoubleLatch();
@Override
public void run( Void nothing )
{
latch.startAndWaitForAllToStartAndFinish();
super.run( nothing );
}
}
}