-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
SessionStateMachineTest.java
327 lines (273 loc) · 11 KB
/
SessionStateMachineTest.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
/*
* 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.hamcrest.CoreMatchers;
import org.junit.Before;
import org.junit.Test;
import org.neo4j.bolt.security.auth.AuthenticationResult;
import org.neo4j.bolt.v1.runtime.Session;
import org.neo4j.bolt.v1.runtime.spi.RecordStream;
import org.neo4j.kernel.api.KernelTransaction;
import org.neo4j.kernel.api.exceptions.Status;
import org.neo4j.kernel.api.security.AccessMode;
import static java.util.Collections.emptyMap;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.equalTo;
import static org.mockito.Matchers.any;
import static org.mockito.Matchers.anyMapOf;
import static org.mockito.Matchers.anyString;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.neo4j.bolt.v1.runtime.Session.Callback.noOp;
import static org.neo4j.bolt.v1.runtime.internal.SessionStateMachine.State.ERROR;
import static org.neo4j.bolt.v1.runtime.internal.SessionStateMachine.State.IDLE;
public class SessionStateMachineTest
{
private final KernelTransaction ktx = mock( KernelTransaction.class );
private final SessionStateMachine.SPI spi = mock( SessionStateMachine.SPI.class );
private final SessionStateMachine machine = new SessionStateMachine( spi );
@Test
public void initialStateShouldBeUninitalized()
{
// When & Then
assertThat( machine.state(), CoreMatchers.equalTo( SessionStateMachine.State.UNINITIALIZED ) );
}
@Test
public void shouldRollbackExplicitTransactionOnReset() throws Throwable
{
// Given
when( spi.run( any( SessionStateMachine.class ), anyString(), anyMapOf( String.class, Object.class) ) )
.thenThrow( new RollbackInducingKernelException() );
machine.init( "FunClient/1.2", emptyMap(), -1, null, noOp() );
machine.beginImplicitTransaction();
// When
machine.run( "Hello, world!", emptyMap(), null, noOp() );
// Then
assertThat( machine.state(), equalTo( ERROR ) );
verify( ktx ).failure();
// And when
machine.reset( null, noOp() );
// Then the machine goes back to an idle (no open transaction) state
verify( ktx ).close();
assertThat( machine.state(), equalTo( IDLE ) );
}
@Test
public void shouldStopRunningTxOnHalt() throws Throwable
{
// When
machine.init( "FunClient/1.2", emptyMap(), -1, null, Session.Callback.NO_OP );
machine.beginTransaction();
machine.close();
// Then
assertThat( machine.state(), CoreMatchers.equalTo( SessionStateMachine.State.STOPPED ) );
verify( spi ).beginTransaction( any( KernelTransaction.Type.class ), any( AccessMode.class ),
any( VersionTracker.class ) );
verify( ktx ).close();
}
@Test
public void shouldPublishClientName() throws Throwable
{
// When
machine.init( "FunClient/1.2", emptyMap(), -1, null, Session.Callback.NO_OP );
// Then
verify( spi ).udcRegisterClient( "FunClient/1.2" );
}
@Test
public void shouldResetToIdleOnIdle() throws Throwable
{
// Given
machine.init( "FunClient/1.2", emptyMap(), -1, null, Session.Callback.NO_OP );
// When
TestCallback<Void> callback = new TestCallback<>();
machine.reset( null, callback );
// Then
assertThat( machine.state(), equalTo( IDLE ) );
assertThat( callback.completedCount, equalTo( 1 ) );
}
@Test
public void shouldResetToIdleOnInTransaction() throws Throwable
{
// Given
machine.init( "FunClient/1.2", emptyMap(), -1, null, Session.Callback.NO_OP );
machine.beginTransaction();
// When
TestCallback<Void> callback = new TestCallback<>();
machine.reset( null, callback );
// Then
assertThat( machine.state(), equalTo( IDLE ) );
assertThat( callback.completedCount, equalTo( 1 ) );
}
@Test
public void shouldResetToIdleOnStreamOpenWithExplicitTransaction() throws Throwable
{
// Given
when( spi.run( any( SessionStateMachine.class ), anyString(), anyMapOf( String.class, Object.class) ) )
.thenReturn( mock( RecordStream.class ) );
machine.init( "FunClient/1.2", emptyMap(), -1, null, Session.Callback.NO_OP );
machine.beginTransaction();
machine.run( "RETURN 1", emptyMap(), null, Session.Callback.NO_OP );
// When
TestCallback<Void> callback = new TestCallback<>();
machine.reset( null, callback );
// Then
assertThat( machine.state(), equalTo( IDLE ) );
assertThat( callback.completedCount, equalTo( 1 ) );
}
@Test
public void shouldResetToIdleOnStreamOpenWithImplicitTransaction() throws Throwable
{
// Given
when( spi.run( any( SessionStateMachine.class ), anyString(), anyMapOf( String.class, Object.class) ) )
.thenReturn( mock( RecordStream.class ) );
machine.init( "FunClient/1.2", emptyMap(), -1, null, Session.Callback.NO_OP );
machine.run( "RETURN 1", emptyMap(), null, Session.Callback.NO_OP );
// When
TestCallback<Void> callback = new TestCallback<>();
machine.reset( null, callback );
// Then
assertThat( machine.state(), equalTo( IDLE ) );
assertThat( callback.completedCount, equalTo( 1 ) );
}
@Test
public void shouldCallStartedWhenStartingProcessing() throws Throwable
{
// Given
TestCallback<Boolean> callback = new TestCallback<>();
// When
machine.init( "FunClient/1.2", emptyMap(), -1, null, callback );
// Then
assertThat( callback.startedCount, equalTo( 1 ) );
}
@Test
public void shouldResetToIdleOnError() throws Throwable
{
// Given
when( spi.run( any( SessionStateMachine.class ), anyString(), anyMapOf( String.class, Object.class) ) )
.thenThrow( new RollbackInducingKernelException() );
machine.init( "FunClient/1.2", emptyMap(), -1, null, Session.Callback.NO_OP );
machine.run( "RETURN 1", emptyMap(), null, Session.Callback.NO_OP );
// When
TestCallback<Void> callback = new TestCallback<>();
machine.reset( null, callback );
// Then
assertThat( machine.state(), equalTo( IDLE ) );
assertThat( callback.completedCount, equalTo( 1 ) );
}
@Test
public void shouldErrorWhenOutOfOrderRollback() throws Throwable
{
// Given
when( spi.run( any( SessionStateMachine.class ), anyString(), anyMapOf( String.class, Object.class) ) )
.thenThrow( new RollbackInducingKernelException() );
machine.init( "FunClient/1.2", emptyMap(), -1, null, Session.Callback.NO_OP );
// When
machine.run( "ROLLBACK", emptyMap(), null, Session.Callback.NO_OP );
// Then
assertThat( machine.state(), equalTo( ERROR ) );
}
@Test
public void shouldGoBackToIdleAfterImplicitTxFailure() throws Throwable
{
// Given
when( spi.run( any( SessionStateMachine.class ), anyString(), anyMapOf( String.class, Object.class) ) )
.thenThrow( new RollbackInducingKernelException() );
machine.init( "FunClient/1.2", emptyMap(), -1, null, noOp() );
// When
machine.run( "Statement that fails", emptyMap(), null, noOp() );
machine.ackFailure( null, noOp() );
// Then
assertThat( machine.state(), equalTo( IDLE ) );
}
@Test
public void shouldMoveBackTo_IN_TRANSACTION_afterAckFailureOnExplicitTx() throws Throwable
{
// Given all statements will fail
when( spi.run( any( SessionStateMachine.class ), anyString(), anyMapOf( String.class, Object.class) ) )
.thenThrow( new RollbackInducingKernelException() );
machine.init( "FunClient/1.2", emptyMap(), -1, null, noOp() );
// When
machine.beginTransaction();
machine.run( "statement that fails", emptyMap(), null, noOp() );
machine.ackFailure( null, noOp() );
// Then
assertThat( machine.state(), equalTo( SessionStateMachine.State.IN_TRANSACTION ) );
}
@Test
public void shouldRemainStoppedAfterInterrupted() throws Throwable
{
// Given
TestCallback callback = new TestCallback();
// When
machine.close();
machine.interrupt();
machine.reset( null, callback ); // could be any method call who invokes before
// Then
assertThat( machine.state(), equalTo( SessionStateMachine.State.STOPPED ) );
assertThat( callback.completedCount, equalTo( 1 ) );
}
@Before
public void setup() throws Exception
{
when( spi.authenticate( any() ) ).thenReturn( AuthenticationResult.AUTH_DISABLED );
when( spi.beginTransaction( any(), any(), any() ) ).thenAnswer( (inv) -> {
// The state machine will ask for different types of transactions, we
// modify out mock to suit it's needs. I'm not sure this is a good way
// to do this.
KernelTransaction.Type type = (KernelTransaction.Type) inv.getArguments()[0];
when( ktx.transactionType() ).thenReturn( type );
return ktx;
});
}
private static class TestCallback<V> extends Session.Callback.Adapter<V, Object>
{
private int completedCount;
int ignoredCount;
int startedCount;
@Override
public void started( Object attachment )
{
startedCount += 1;
}
@Override
public void completed( Object attachment )
{
completedCount += 1;
}
@Override
public void ignored( Object attachment )
{
ignoredCount += 1;
}
@Override
public void failure( Neo4jError err, Object attachment )
{
err.cause().printStackTrace( System.err );
}
}
private static class RollbackInducingKernelException extends RuntimeException implements Status.HasStatus
{
@Override
public Status status()
{
return Status.General.UnknownError;
}
}
}