-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
ResetFuzzTest.java
334 lines (280 loc) · 9.74 KB
/
ResetFuzzTest.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
/*
* Copyright (c) 2002-2016 "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.runtime.internal;
import org.junit.After;
import org.junit.Test;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Random;
import java.util.concurrent.atomic.AtomicLong;
import org.neo4j.bolt.security.auth.AuthenticationException;
import org.neo4j.bolt.security.auth.AuthenticationResult;
import org.neo4j.bolt.security.auth.BasicAuthenticationResult;
import org.neo4j.bolt.v1.messaging.MessageHandler;
import org.neo4j.bolt.v1.messaging.message.DiscardAllMessage;
import org.neo4j.bolt.v1.messaging.message.Message;
import org.neo4j.bolt.v1.messaging.message.PullAllMessage;
import org.neo4j.bolt.v1.messaging.message.ResetMessage;
import org.neo4j.bolt.v1.messaging.message.RunMessage;
import org.neo4j.bolt.v1.messaging.msgprocess.TransportBridge;
import org.neo4j.bolt.v1.runtime.Session;
import org.neo4j.bolt.v1.runtime.integration.RecordingCallback;
import org.neo4j.bolt.v1.runtime.internal.concurrent.ThreadedSessions;
import org.neo4j.bolt.v1.runtime.spi.RecordStream;
import org.neo4j.helpers.collection.Iterables;
import org.neo4j.kernel.api.KernelTransaction;
import org.neo4j.kernel.api.Statement;
import org.neo4j.kernel.api.exceptions.KernelException;
import org.neo4j.kernel.api.exceptions.Status;
import org.neo4j.kernel.api.exceptions.TransactionFailureException;
import org.neo4j.kernel.api.security.AccessMode;
import org.neo4j.kernel.impl.logging.NullLogService;
import org.neo4j.kernel.impl.util.Neo4jJobScheduler;
import org.neo4j.kernel.lifecycle.LifeSupport;
import org.neo4j.logging.NullLog;
import static java.util.Arrays.asList;
import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.neo4j.bolt.v1.runtime.integration.SessionMatchers.recorded;
import static org.neo4j.bolt.v1.runtime.integration.SessionMatchers.success;
import static org.neo4j.bolt.v1.runtime.internal.SessionStateMachine.State.IDLE;
import static org.neo4j.helpers.collection.MapUtil.map;
public class ResetFuzzTest
{
// Because RESET has a "call ahead" mechanism where it will interrupt
// the session before RESET arrives in order to purge any statements
// ahead in the message queue, we use this test to convince ourselves
// there is no code path where RESET causes a session to not go back
// to a good state.
private final int seed = new Random().nextInt();
private final Random rand = new Random( seed );
private final LifeSupport life = new LifeSupport();
/** We track the number of un-closed transactions, and fail if we ever leak one */
private final AtomicLong liveTransactions = new AtomicLong();
private final Neo4jJobScheduler scheduler = life.add(new Neo4jJobScheduler());
private final SessionStateMachine ssm = new SessionStateMachine( new FuzzStubSPI() );
private final ThreadedSessions sessions =
new ThreadedSessions( ( enc, descriptor ) -> ssm, scheduler, NullLogService.getInstance() );
private final List<Message> messages = asList(
new RunMessage( "test", map() ),
new DiscardAllMessage(),
new PullAllMessage(),
new ResetMessage()
);
private final List<Message> sent = new LinkedList<>();
@Test
public void shouldAlwaysReturnToIdleAfterReset() throws Throwable
{
// given
life.start();
Session session = sessions.newSession( "<test>" );
session.init( "Test/0.0.0", map(), null, Session.Callback.NO_OP );
TransportBridge bridge = new TransportBridge(
NullLog.getInstance(), session, new MessageHandler.Adapter<>(), ( () -> {} ) );
// 5 seconds lead to testing ~1M permutations on my 5-year old MBP, so
// 2 seconds seemed like a sensible balance, testing 300K permutations or
// so per run without taking up too much test time. Simply bump this to
// run a longer test. This was green at 300 second runs when this is written.
long deadline = System.currentTimeMillis() + 2 * 1000;
// when
while( System.currentTimeMillis() < deadline )
{
dispatchRandomMessages( bridge );
assertSessionWorks( session );
}
}
private void assertSessionWorks( Session session )
{
RecordingCallback recorder = new RecordingCallback();
session.reset( null, recorder );
try
{
assertThat( recorder, recorded( success() ) );
assertThat( ssm.state(), equalTo( IDLE ) );
assertThat( liveTransactions.get(), equalTo( 0L ));
}
catch( AssertionError e )
{
throw new AssertionError( String.format( "Expected session to return to good state after RESET, but " +
"assertion failed: %s.%n" +
"Seed: %s%n" +
"Messages sent:%n" +
"%s",
e.getMessage(), seed, Iterables.toString( sent, "\n" ) ), e );
}
}
private void dispatchRandomMessages( MessageHandler session )
{
for ( int i = 0; i < 50; i++ )
{
Message message = messages.get( rand.nextInt( messages.size() ) );
sent.add( message );
message.<RuntimeException>dispatch( session );
}
}
@After
public void cleanup()
{
life.shutdown();
}
/**
* We can't use mockito to create this, because it stores all invocations,
* so we run out of RAM in like five seconds.
*/
private class FuzzStubSPI implements SessionStateMachine.SPI
{
@Override
public String connectionDescriptor()
{
return "<test>";
}
@Override
public void reportError( Neo4jError err )
{
}
@Override
public void reportError( String message, Throwable cause )
{
}
@Override
public KernelTransaction beginTransaction( KernelTransaction.Type type, AccessMode mode )
{
liveTransactions.incrementAndGet();
return new CloseTrackingKernelTransaction();
}
@Override
public void bindTransactionToCurrentThread( KernelTransaction tx )
{
}
@Override
public void unbindTransactionFromCurrentThread()
{
}
@Override
public RecordStream run( SessionStateMachine ctx, String statement, Map<String,Object> params )
throws KernelException
{
return RecordStream.EMPTY;
}
@Override
public AuthenticationResult authenticate( Map<String,Object> authToken ) throws AuthenticationException
{
return new BasicAuthenticationResult( AccessMode.Static.FULL, false );
}
@Override
public void udcRegisterClient( String clientName )
{
}
@Override
public Statement currentStatement()
{
return null;
}
}
/**
* Used to track begin/close of transactions, ensuring we never leak
* a transaction.
*/
private class CloseTrackingKernelTransaction implements KernelTransaction
{
@Override
public Statement acquireStatement()
{
throw new UnsupportedOperationException();
}
@Override
public void success()
{
}
@Override
public void failure()
{
}
@Override
public void close() throws TransactionFailureException
{
liveTransactions.decrementAndGet();
}
@Override
public boolean isOpen()
{
return false;
}
@Override
public AccessMode mode()
{
return null;
}
@Override
public Status getReasonIfTerminated()
{
return null;
}
@Override
public void markForTermination( Status reason )
{
}
@Override
public long lastTransactionTimestampWhenStarted()
{
return 0;
}
@Override
public void registerCloseListener( CloseListener listener )
{
}
@Override
public Type transactionType()
{
return null;
}
@Override
public long getTransactionId()
{
return -1;
}
@Override
public long getCommitTime()
{
return -1;
}
@Override
public Revertable restrict( AccessMode read )
{
return null;
}
@Override
public long lastTransactionIdWhenStarted()
{
return 0;
}
@Override
public long startTime()
{
return 0;
}
@Override
public long timeout()
{
return 0;
}
}
}