-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
VerboseTimeout.java
254 lines (226 loc) · 8.07 KB
/
VerboseTimeout.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
/*
* Copyright (c) 2002-2018 "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.test.rule;
import org.apache.commons.lang3.StringUtils;
import org.junit.rules.Timeout;
import org.junit.runners.model.Statement;
import org.junit.runners.model.TestTimedOutException;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.FutureTask;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.function.Function;
import org.neo4j.test.ThreadTestUtils;
/**
* Timeout rule implementation that print out stack traces of all thread
* instead of just one suspect, as default implementation does.
* <p>
* In addition provide possibility to describe provided custom entities on timeout failure.
* Object description can be customized by provided function, by default - toString() method will be used.
* <p>
* For example:
* <pre> {@code
* public VerboseTimeout timeout = VerboseTimeout.builder()
* .withTimeout( 50, TimeUnit.SECONDS )
* .describeOnFailure( locks )
* .build()};
* </pre>
*
* @see Timeout
*/
public class VerboseTimeout extends Timeout
{
private VerboseTimeoutBuilder timeoutBuilder;
private VerboseTimeout( VerboseTimeoutBuilder timeoutBuilder )
{
super( timeoutBuilder );
this.timeoutBuilder = timeoutBuilder;
}
public static VerboseTimeoutBuilder builder()
{
return new VerboseTimeoutBuilder();
}
@Override
protected Statement createFailOnTimeoutStatement( Statement statement )
{
return new VerboseFailOnTimeout( statement, timeoutBuilder );
}
/**
* Helper builder class of {@link VerboseTimeout} test rule.
*/
public static class VerboseTimeoutBuilder extends Timeout.Builder
{
private TimeUnit timeUnit = TimeUnit.SECONDS;
private long timeout;
private List<FailureParameter<?>> additionalParameters = new ArrayList<>();
private static Function<Object,String> toStringFunction()
{
return value -> value == null ? StringUtils.EMPTY : value.toString();
}
@Override
public VerboseTimeoutBuilder withTimeout( long timeout, TimeUnit unit )
{
this.timeout = timeout;
this.timeUnit = unit;
return this;
}
public <T> VerboseTimeoutBuilder describeOnFailure( T entity, Function<T,String> descriptor )
{
additionalParameters.add( new FailureParameter<>( entity, descriptor ) );
return this;
}
public <T> VerboseTimeoutBuilder describeOnFailure( T entity )
{
return describeOnFailure( entity, toStringFunction() );
}
@Override
public VerboseTimeout build()
{
return new VerboseTimeout( this );
}
@Override
protected long getTimeout()
{
return timeout;
}
@Override
protected TimeUnit getTimeUnit()
{
return timeUnit;
}
public List<FailureParameter<?>> getAdditionalParameters()
{
return additionalParameters;
}
private class FailureParameter<T>
{
private final T entity;
private final Function<T,String> descriptor;
FailureParameter( T entity, Function<T,String> descriptor )
{
this.entity = entity;
this.descriptor = descriptor;
}
String describe()
{
return descriptor.apply( entity );
}
}
}
/**
* Statement that in case of timeout, unlike junit {@link org.junit.internal.runners.statements.FailOnTimeout}
* will print thread dumps of all threads in JVM, that should help in investigation of stuck threads.
*/
private class VerboseFailOnTimeout extends Statement
{
private final Statement originalStatement;
private final TimeUnit timeUnit;
private final long timeout;
private final List<VerboseTimeoutBuilder.FailureParameter<?>> additionalParameters;
VerboseFailOnTimeout( Statement statement, VerboseTimeoutBuilder builder )
{
originalStatement = statement;
timeout = builder.timeout;
timeUnit = builder.getTimeUnit();
additionalParameters = builder.getAdditionalParameters();
}
@Override
public void evaluate() throws Throwable
{
CallableStatement callable = new CallableStatement();
FutureTask<Throwable> task = new FutureTask<>( callable );
Thread thread = new Thread( task, "Time-limited test" );
thread.setDaemon( true );
thread.start();
callable.awaitStarted();
Throwable throwable = getResult( task, thread );
if ( throwable != null )
{
throw throwable;
}
}
private Throwable getResult( FutureTask<Throwable> task, Thread thread ) throws Throwable
{
try
{
if ( timeout > 0 )
{
return task.get( timeout, timeUnit );
}
else
{
return task.get();
}
}
catch ( ExecutionException e )
{
ThreadTestUtils.dumpAllStackTraces();
return e.getCause();
}
catch ( TimeoutException e )
{
if ( !additionalParameters.isEmpty() )
{
System.err.println( "==== Requested additional parameters: ====" );
for ( VerboseTimeoutBuilder.FailureParameter<?> additionalParameter : additionalParameters )
{
System.err.println( additionalParameter.describe() );
}
}
System.err.println( "=== Thread dump ===" );
ThreadTestUtils.dumpAllStackTraces();
return buildTimeoutException( thread );
}
}
private Throwable buildTimeoutException( Thread thread )
{
StackTraceElement[] stackTrace = thread.getStackTrace();
TestTimedOutException timedOutException = new TestTimedOutException( timeout, timeUnit );
timedOutException.setStackTrace( stackTrace );
return timedOutException;
}
private class CallableStatement implements Callable<Throwable>
{
private final CountDownLatch startLatch = new CountDownLatch( 1 );
@Override
public Throwable call()
{
try
{
startLatch.countDown();
originalStatement.evaluate();
}
catch ( Throwable e )
{
return e;
}
return null;
}
public void awaitStarted() throws InterruptedException
{
startLatch.await();
}
}
}
}