-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
DatabaseAvailabilityGuardTest.java
344 lines (284 loc) · 11.8 KB
/
DatabaseAvailabilityGuardTest.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
/*
* Copyright (c) 2002-2018 "Neo4j,"
* Neo4j Sweden AB [http://neo4j.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.kernel;
import org.junit.Test;
import org.mockito.Mockito;
import java.time.Clock;
import java.util.concurrent.atomic.AtomicBoolean;
import org.neo4j.kernel.availability.AvailabilityListener;
import org.neo4j.kernel.availability.AvailabilityRequirement;
import org.neo4j.kernel.availability.DatabaseAvailabilityGuard;
import org.neo4j.kernel.availability.DescriptiveAvailabilityRequirement;
import org.neo4j.kernel.availability.UnavailableException;
import org.neo4j.logging.Log;
import org.neo4j.logging.NullLog;
import org.neo4j.time.Clocks;
import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.greaterThanOrEqualTo;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.Mockito.atLeast;
import static org.mockito.Mockito.atLeastOnce;
import static org.mockito.Mockito.atMost;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyZeroInteractions;
import static org.neo4j.dbms.database.DatabaseManager.DEFAULT_DATABASE_NAME;
import static org.neo4j.logging.NullLog.getInstance;
public class DatabaseAvailabilityGuardTest
{
private static final AvailabilityRequirement REQUIREMENT_1 = new DescriptiveAvailabilityRequirement( "Requirement 1" );
private static final AvailabilityRequirement REQUIREMENT_2 = new DescriptiveAvailabilityRequirement( "Requirement 2" );
private final Clock clock = Clocks.systemClock();
@Test
public void logOnAvailabilityChange()
{
// Given
Log log = mock( Log.class );
DatabaseAvailabilityGuard databaseAvailabilityGuard = getDatabaseAvailabilityGuard( clock, log );
// When starting out
verifyZeroInteractions( log );
// When requirement is added
databaseAvailabilityGuard.require( REQUIREMENT_1 );
// Then log should have been called
verify( log, atLeastOnce() ).info( anyString() );
// When requirement fulfilled
databaseAvailabilityGuard.fulfill( REQUIREMENT_1 );
// Then log should have been called
verify( log, atLeast( 2 ) ).info( anyString() );
// When requirement is added
databaseAvailabilityGuard.require( REQUIREMENT_1 );
databaseAvailabilityGuard.require( REQUIREMENT_2 );
// Then log should have been called
verify( log, atLeast( 3 ) ).info( anyString() );
// When requirement fulfilled
databaseAvailabilityGuard.fulfill( REQUIREMENT_1 );
// Then log should not have been called
verify( log, atMost( 3 ) ).info( anyString() );
// When requirement fulfilled
databaseAvailabilityGuard.fulfill( REQUIREMENT_2 );
// Then log should have been called
verify( log, atLeast( 4 ) ).info( anyString() );
verify( log, atMost( 4 ) ).info( anyString() );
}
@Test
public void givenAccessGuardWith2ConditionsWhenAwaitThenTimeoutAndReturnFalse()
{
// Given
Log log = mock( Log.class );
DatabaseAvailabilityGuard databaseAvailabilityGuard = getDatabaseAvailabilityGuard( clock, log );
databaseAvailabilityGuard.require( REQUIREMENT_1 );
databaseAvailabilityGuard.require( REQUIREMENT_2 );
// When
boolean result = databaseAvailabilityGuard.isAvailable( 1000 );
// Then
assertThat( result, equalTo( false ) );
}
@Test
public void givenAccessGuardWith2ConditionsWhenAwaitThenActuallyWaitGivenTimeout()
{
// Given
Log log = mock( Log.class );
DatabaseAvailabilityGuard databaseAvailabilityGuard = getDatabaseAvailabilityGuard( clock, log );
databaseAvailabilityGuard.require( REQUIREMENT_1 );
databaseAvailabilityGuard.require( REQUIREMENT_2 );
// When
long timeout = 1000;
long start = clock.millis();
boolean result = databaseAvailabilityGuard.isAvailable( timeout );
long end = clock.millis();
// Then
long waitTime = end - start;
assertThat( result, equalTo( false ) );
assertThat( waitTime, greaterThanOrEqualTo( timeout ) );
}
@Test
public void givenAccessGuardWith2ConditionsWhenGrantOnceAndAwaitThenTimeoutAndReturnFalse()
{
// Given
Log log = mock( Log.class );
DatabaseAvailabilityGuard databaseAvailabilityGuard = getDatabaseAvailabilityGuard( clock, log );
databaseAvailabilityGuard.require( REQUIREMENT_1 );
databaseAvailabilityGuard.require( REQUIREMENT_2 );
// When
long start = clock.millis();
long timeout = 1000;
databaseAvailabilityGuard.fulfill( REQUIREMENT_1 );
boolean result = databaseAvailabilityGuard.isAvailable( timeout );
long end = clock.millis();
// Then
long waitTime = end - start;
assertFalse( result );
assertThat( waitTime, greaterThanOrEqualTo( timeout ) );
}
@Test
public void givenAccessGuardWith2ConditionsWhenGrantEachAndAwaitThenTrue()
{
// Given
Log log = mock( Log.class );
DatabaseAvailabilityGuard databaseAvailabilityGuard = getDatabaseAvailabilityGuard( clock, log );
databaseAvailabilityGuard.require( REQUIREMENT_1 );
databaseAvailabilityGuard.require( REQUIREMENT_2 );
// When
databaseAvailabilityGuard.fulfill( REQUIREMENT_1 );
databaseAvailabilityGuard.fulfill( REQUIREMENT_2 );
assertTrue( databaseAvailabilityGuard.isAvailable( 1000 ) );
}
@Test
public void givenAccessGuardWith2ConditionsWhenGrantTwiceAndDenyOnceAndAwaitThenTimeoutAndReturnFalse()
{
// Given
Log log = mock( Log.class );
DatabaseAvailabilityGuard databaseAvailabilityGuard = getDatabaseAvailabilityGuard( clock, log );
databaseAvailabilityGuard.require( REQUIREMENT_1 );
databaseAvailabilityGuard.require( REQUIREMENT_2 );
// When
databaseAvailabilityGuard.fulfill( REQUIREMENT_1 );
databaseAvailabilityGuard.fulfill( REQUIREMENT_1 );
databaseAvailabilityGuard.require( REQUIREMENT_2 );
long start = clock.millis();
long timeout = 1000;
boolean result = databaseAvailabilityGuard.isAvailable( timeout );
long end = clock.millis();
// Then
long waitTime = end - start;
assertFalse( result );
assertThat( waitTime, greaterThanOrEqualTo( timeout ) );
}
@Test
public void givenAccessGuardWith2ConditionsWhenGrantOnceAndAwaitAndGrantAgainThenReturnTrue()
{
// Given
Log log = mock( Log.class );
final DatabaseAvailabilityGuard databaseAvailabilityGuard = getDatabaseAvailabilityGuard( clock, log );
databaseAvailabilityGuard.require( REQUIREMENT_1 );
databaseAvailabilityGuard.require( REQUIREMENT_2 );
databaseAvailabilityGuard.fulfill( REQUIREMENT_2 );
assertFalse( databaseAvailabilityGuard.isAvailable( 100 ) );
databaseAvailabilityGuard.fulfill( REQUIREMENT_1 );
assertTrue( databaseAvailabilityGuard.isAvailable( 100 ) );
}
@Test
public void givenAccessGuardWithConditionWhenGrantThenNotifyListeners()
{
// Given
Log log = mock( Log.class );
final DatabaseAvailabilityGuard databaseAvailabilityGuard = getDatabaseAvailabilityGuard( clock, log );
databaseAvailabilityGuard.require( REQUIREMENT_1 );
final AtomicBoolean notified = new AtomicBoolean();
AvailabilityListener availabilityListener = new AvailabilityListener()
{
@Override
public void available()
{
notified.set( true );
}
@Override
public void unavailable()
{
}
};
databaseAvailabilityGuard.addListener( availabilityListener );
// When
databaseAvailabilityGuard.fulfill( REQUIREMENT_1 );
// Then
assertThat( notified.get(), equalTo( true ) );
}
@Test
public void givenAccessGuardWithConditionWhenGrantAndDenyThenNotifyListeners()
{
// Given
Log log = mock( Log.class );
final DatabaseAvailabilityGuard databaseAvailabilityGuard = getDatabaseAvailabilityGuard( clock, log );
databaseAvailabilityGuard.require( REQUIREMENT_1 );
final AtomicBoolean notified = new AtomicBoolean();
AvailabilityListener availabilityListener = new AvailabilityListener()
{
@Override
public void available()
{
}
@Override
public void unavailable()
{
notified.set( true );
}
};
databaseAvailabilityGuard.addListener( availabilityListener );
// When
databaseAvailabilityGuard.fulfill( REQUIREMENT_1 );
databaseAvailabilityGuard.require( REQUIREMENT_1 );
// Then
assertThat( notified.get(), equalTo( true ) );
}
@Test
public void givenAccessGuardWithConditionWhenShutdownThenInstantlyDenyAccess()
{
// Given
Clock clock = Mockito.mock( Clock.class );
final DatabaseAvailabilityGuard databaseAvailabilityGuard = getDatabaseAvailabilityGuard( clock, NullLog.getInstance() );
databaseAvailabilityGuard.require( REQUIREMENT_1 );
// When
databaseAvailabilityGuard.shutdown();
// Then
assertFalse( databaseAvailabilityGuard.isAvailable( 1000 ) );
verifyZeroInteractions( clock );
}
@Test
public void shouldExplainWhoIsBlockingAccess()
{
// Given
Log log = mock( Log.class );
DatabaseAvailabilityGuard databaseAvailabilityGuard = getDatabaseAvailabilityGuard( clock, log );
// When
databaseAvailabilityGuard.require( REQUIREMENT_1 );
databaseAvailabilityGuard.require( REQUIREMENT_2 );
// Then
assertThat( databaseAvailabilityGuard.describeWhoIsBlocking(), equalTo( "2 reasons for blocking: Requirement 1, Requirement 2." ) );
}
@Test
public void shouldExplainBlockersOnCheckAvailable() throws Exception
{
// GIVEN
DatabaseAvailabilityGuard databaseAvailabilityGuard = getDatabaseAvailabilityGuard( Clocks.systemClock(), getInstance() );
// At this point it should be available
databaseAvailabilityGuard.checkAvailable();
// WHEN
databaseAvailabilityGuard.require( REQUIREMENT_1 );
// THEN
try
{
databaseAvailabilityGuard.checkAvailable();
fail( "Should not be available" );
}
catch ( UnavailableException e )
{
assertThat( e.getMessage(), containsString( REQUIREMENT_1.description() ) );
}
}
private static DatabaseAvailabilityGuard getDatabaseAvailabilityGuard( Clock clock, Log log )
{
return new DatabaseAvailabilityGuard( DEFAULT_DATABASE_NAME, clock, log );
}
}