-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
FileWatchIT.java
452 lines (387 loc) · 16.7 KB
/
FileWatchIT.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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
/*
* Copyright (c) 2002-2019 "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.store.watch;
import org.apache.commons.lang3.SystemUtils;
import org.hamcrest.Matchers;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import java.io.File;
import java.io.IOException;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import org.neo4j.graphdb.DependencyResolver;
import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.graphdb.Label;
import org.neo4j.graphdb.Node;
import org.neo4j.graphdb.Transaction;
import org.neo4j.graphdb.factory.GraphDatabaseSettings;
import org.neo4j.graphdb.schema.IndexDefinition;
import org.neo4j.index.impl.lucene.explicit.LuceneDataSource;
import org.neo4j.io.fs.DefaultFileSystemAbstraction;
import org.neo4j.io.fs.FileUtils;
import org.neo4j.io.fs.watcher.FileWatchEventListener;
import org.neo4j.io.fs.watcher.FileWatcher;
import org.neo4j.io.layout.DatabaseLayout;
import org.neo4j.kernel.configuration.Settings;
import org.neo4j.kernel.impl.transaction.log.checkpoint.CheckPointer;
import org.neo4j.kernel.impl.transaction.log.checkpoint.SimpleTriggerInfo;
import org.neo4j.kernel.impl.transaction.log.files.TransactionLogFiles;
import org.neo4j.kernel.impl.util.watcher.DefaultFileDeletionEventListener;
import org.neo4j.kernel.impl.util.watcher.FileSystemWatcherService;
import org.neo4j.kernel.internal.GraphDatabaseAPI;
import org.neo4j.logging.AssertableLogProvider;
import org.neo4j.test.TestGraphDatabaseFactory;
import org.neo4j.test.rule.TestDirectory;
import static org.hamcrest.Matchers.containsString;
import static org.junit.Assert.assertThat;
import static org.junit.Assume.assumeFalse;
public class FileWatchIT
{
private static final long TEST_TIMEOUT = 600_000;
@Rule
public final TestDirectory testDirectory = TestDirectory.testDirectory();
private File storeDir;
private AssertableLogProvider logProvider;
private GraphDatabaseService database;
@Before
public void setUp()
{
storeDir = testDirectory.storeDir();
logProvider = new AssertableLogProvider();
database = new TestGraphDatabaseFactory().setInternalLogProvider( logProvider ).newEmbeddedDatabase( storeDir );
}
@After
public void tearDown()
{
shutdownDatabaseSilently( database );
}
@Test( timeout = TEST_TIMEOUT )
public void notifyAboutStoreFileDeletion() throws Exception
{
assumeFalse( SystemUtils.IS_OS_WINDOWS );
String fileName = testDirectory.databaseLayout().metadataStore().getName();
FileWatcher fileWatcher = getFileWatcher( database );
CheckPointer checkpointer = getCheckpointer( database );
DeletionLatchEventListener deletionListener = new DeletionLatchEventListener( fileName );
fileWatcher.addFileWatchEventListener( deletionListener );
do
{
createNode( database );
forceCheckpoint( checkpointer );
}
while ( !deletionListener.awaitModificationNotification() );
deleteFile( testDirectory.storeDir(), fileName );
deletionListener.awaitDeletionNotification();
logProvider.rawMessageMatcher().assertContains(
"'" + fileName + "' which belongs to the store was deleted while database was running." );
}
@Test( timeout = TEST_TIMEOUT )
public void notifyWhenFileWatchingFailToStart()
{
AssertableLogProvider logProvider = new AssertableLogProvider( true );
GraphDatabaseService db = null;
try
{
db = new TestGraphDatabaseFactory().setInternalLogProvider( logProvider )
.setFileSystem( new NonWatchableFileSystemAbstraction() )
.newEmbeddedDatabase( testDirectory.storeDir( "failed-start-db" ) );
logProvider.rawMessageMatcher().assertContains( "Can not create file watcher for current file system. " +
"File monitoring capabilities for store files will be disabled." );
}
finally
{
shutdownDatabaseSilently( db );
}
}
@Test( timeout = TEST_TIMEOUT )
public void notifyAboutExplicitIndexFolderRemoval() throws InterruptedException, IOException
{
String monitoredDirectory = getExplicitIndexDirectory( testDirectory.databaseLayout() );
FileWatcher fileWatcher = getFileWatcher( database );
CheckPointer checkPointer = getCheckpointer( database );
DeletionLatchEventListener deletionListener = new DeletionLatchEventListener( monitoredDirectory );
String metadataStore = testDirectory.databaseLayout().metadataStore().getName();
ModificationEventListener modificationEventListener = new ModificationEventListener( metadataStore );
fileWatcher.addFileWatchEventListener( deletionListener );
fileWatcher.addFileWatchEventListener( modificationEventListener );
do
{
createNode( database );
forceCheckpoint( checkPointer );
}
while ( !modificationEventListener.awaitModificationNotification() );
deleteStoreDirectory( storeDir, monitoredDirectory );
deletionListener.awaitDeletionNotification();
logProvider.rawMessageMatcher().assertContains(
"'" + monitoredDirectory + "' which belongs to the store was deleted while database was running." );
}
@Test( timeout = TEST_TIMEOUT )
public void doNotNotifyAboutLuceneIndexFilesDeletion() throws InterruptedException, IOException
{
DependencyResolver dependencyResolver = ((GraphDatabaseAPI) database).getDependencyResolver();
FileWatcher fileWatcher = getFileWatcher( database );
CheckPointer checkPointer = dependencyResolver.resolveDependency( CheckPointer.class );
String propertyStoreName = testDirectory.databaseLayout().propertyStore().getName();
AccumulativeDeletionEventListener accumulativeListener = new AccumulativeDeletionEventListener();
ModificationEventListener modificationListener = new ModificationEventListener( propertyStoreName );
fileWatcher.addFileWatchEventListener( modificationListener );
fileWatcher.addFileWatchEventListener( accumulativeListener );
String labelName = "labelName";
String propertyName = "propertyName";
Label testLabel = Label.label( labelName );
createIndexes( database, propertyName, testLabel );
do
{
createNode( database, propertyName, testLabel );
forceCheckpoint( checkPointer );
}
while ( !modificationListener.awaitModificationNotification() );
fileWatcher.removeFileWatchEventListener( modificationListener );
ModificationEventListener afterRemovalListener = new ModificationEventListener( propertyStoreName );
fileWatcher.addFileWatchEventListener( afterRemovalListener );
dropAllIndexes( database );
do
{
createNode( database, propertyName, testLabel );
forceCheckpoint( checkPointer );
}
while ( !afterRemovalListener.awaitModificationNotification() );
accumulativeListener.assertDoesNotHaveAnyDeletions();
}
@Test( timeout = TEST_TIMEOUT )
public void doNotMonitorTransactionLogFiles() throws InterruptedException, IOException
{
assumeFalse( SystemUtils.IS_OS_WINDOWS );
FileWatcher fileWatcher = getFileWatcher( database );
CheckPointer checkpointer = getCheckpointer( database );
String metadataStore = testDirectory.databaseLayout().metadataStore().getName();
ModificationEventListener modificationEventListener =
new ModificationEventListener( metadataStore );
fileWatcher.addFileWatchEventListener( modificationEventListener );
do
{
createNode( database );
forceCheckpoint( checkpointer );
}
while ( !modificationEventListener.awaitModificationNotification() );
String fileName = TransactionLogFiles.DEFAULT_NAME + ".0";
DeletionLatchEventListener deletionListener = new DeletionLatchEventListener( fileName );
fileWatcher.addFileWatchEventListener( deletionListener );
deleteFile( testDirectory.storeDir(), fileName );
deletionListener.awaitDeletionNotification();
AssertableLogProvider.LogMatcher logMatcher =
AssertableLogProvider.inLog( DefaultFileDeletionEventListener.class )
.info( containsString( fileName ) );
logProvider.assertNone( logMatcher );
}
@Test( timeout = TEST_TIMEOUT )
public void notifyWhenWholeStoreDirectoryRemoved() throws IOException, InterruptedException
{
assumeFalse( SystemUtils.IS_OS_WINDOWS );
String fileName = testDirectory.databaseLayout().metadataStore().getName();
FileWatcher fileWatcher = getFileWatcher( database );
CheckPointer checkpointer = getCheckpointer( database );
ModificationEventListener modificationListener = new ModificationEventListener( fileName );
fileWatcher.addFileWatchEventListener( modificationListener );
do
{
createNode( database );
forceCheckpoint( checkpointer );
}
while ( !modificationListener.awaitModificationNotification() );
fileWatcher.removeFileWatchEventListener( modificationListener );
String storeDirectoryName = testDirectory.databaseLayout().databaseDirectory().getName();
DeletionLatchEventListener eventListener = new DeletionLatchEventListener( storeDirectoryName );
fileWatcher.addFileWatchEventListener( eventListener );
FileUtils.deleteRecursively( testDirectory.databaseLayout().databaseDirectory() );
eventListener.awaitDeletionNotification();
logProvider.rawMessageMatcher().assertContains(
"'" + storeDirectoryName + "' which belongs to the store was deleted while database was running." );
}
@Test( timeout = TEST_TIMEOUT )
public void shouldLogWhenDisabled()
{
AssertableLogProvider logProvider = new AssertableLogProvider( true );
GraphDatabaseService db = null;
try
{
db = new TestGraphDatabaseFactory().setInternalLogProvider( logProvider )
.setFileSystem( new NonWatchableFileSystemAbstraction() )
.newEmbeddedDatabaseBuilder( testDirectory.directory( "failed-start-db" ) )
.setConfig( GraphDatabaseSettings.filewatcher_enabled, Settings.FALSE )
.newGraphDatabase();
logProvider.rawMessageMatcher().assertContains( "File watcher disabled by configuration." );
}
finally
{
shutdownDatabaseSilently( db );
}
}
private static void shutdownDatabaseSilently( GraphDatabaseService databaseService )
{
if ( databaseService != null )
{
try
{
databaseService.shutdown();
}
catch ( Exception expected )
{
// ignored
}
}
}
private static void dropAllIndexes( GraphDatabaseService database )
{
try ( Transaction transaction = database.beginTx() )
{
for ( IndexDefinition definition : database.schema().getIndexes() )
{
definition.drop();
}
transaction.success();
}
}
private static void createIndexes( GraphDatabaseService database, String propertyName, Label testLabel )
{
try ( Transaction transaction = database.beginTx() )
{
database.schema().indexFor( testLabel ).on( propertyName ).create();
transaction.success();
}
try ( Transaction ignored = database.beginTx() )
{
database.schema().awaitIndexesOnline( 1, TimeUnit.MINUTES );
}
}
private static void forceCheckpoint( CheckPointer checkPointer ) throws IOException
{
checkPointer.forceCheckPoint( new SimpleTriggerInfo( "testForceCheckPoint" ) );
}
private static String getExplicitIndexDirectory( DatabaseLayout databaseLayout )
{
File schemaIndexDirectory = LuceneDataSource.getLuceneIndexStoreDirectory( databaseLayout );
Path relativeIndexPath = databaseLayout.databaseDirectory().toPath().relativize( schemaIndexDirectory.toPath() );
return relativeIndexPath.getName( 0 ).toString();
}
private static void createNode( GraphDatabaseService database, String propertyName, Label testLabel )
{
try ( Transaction transaction = database.beginTx() )
{
Node node = database.createNode( testLabel );
node.setProperty( propertyName, "value" );
transaction.success();
}
}
private static CheckPointer getCheckpointer( GraphDatabaseService database )
{
return ((GraphDatabaseAPI) database).getDependencyResolver().resolveDependency( CheckPointer.class );
}
private static FileWatcher getFileWatcher( GraphDatabaseService database )
{
DependencyResolver dependencyResolver = ((GraphDatabaseAPI) database).getDependencyResolver();
return dependencyResolver.resolveDependency( FileSystemWatcherService.class ).getFileWatcher();
}
private static void deleteFile( File storeDir, String fileName )
{
File metadataStore = new File( storeDir, fileName );
FileUtils.deleteFile( metadataStore );
}
private static void deleteStoreDirectory( File storeDir, String directoryName ) throws IOException
{
File directory = new File( storeDir, directoryName );
FileUtils.deleteRecursively( directory );
}
private static void createNode( GraphDatabaseService database )
{
try ( Transaction transaction = database.beginTx() )
{
database.createNode();
transaction.success();
}
}
private static class NonWatchableFileSystemAbstraction extends DefaultFileSystemAbstraction
{
@Override
public FileWatcher fileWatcher() throws IOException
{
throw new IOException( "You can't watch me!" );
}
}
private static class AccumulativeDeletionEventListener implements FileWatchEventListener
{
private final List<String> deletedFiles = new ArrayList<>();
@Override
public void fileDeleted( String fileName )
{
deletedFiles.add( fileName );
}
void assertDoesNotHaveAnyDeletions()
{
assertThat( "Should not have any deletions registered", deletedFiles, Matchers.empty() );
}
}
private static class ModificationEventListener implements FileWatchEventListener
{
final String expectedFileName;
private final CountDownLatch modificationLatch = new CountDownLatch( 1 );
ModificationEventListener( String expectedFileName )
{
this.expectedFileName = expectedFileName;
}
@Override
public void fileModified( String fileName )
{
if ( expectedFileName.equals( fileName ) )
{
modificationLatch.countDown();
}
}
boolean awaitModificationNotification() throws InterruptedException
{
return modificationLatch.await(1, TimeUnit.SECONDS);
}
}
private static class DeletionLatchEventListener extends ModificationEventListener
{
private final CountDownLatch deletionLatch = new CountDownLatch( 1 );
DeletionLatchEventListener( String expectedFileName )
{
super( expectedFileName );
}
@Override
public void fileDeleted( String fileName )
{
if ( fileName.endsWith( expectedFileName ) )
{
deletionLatch.countDown();
}
}
void awaitDeletionNotification() throws InterruptedException
{
deletionLatch.await();
}
}
}