-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
RecoveryTest.java
470 lines (410 loc) · 19.3 KB
/
RecoveryTest.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
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
/*
* 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.apache.commons.lang3.ArrayUtils;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.mockito.InOrder;
import java.io.File;
import java.io.IOException;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Consumer;
import org.neo4j.helpers.collection.Pair;
import org.neo4j.helpers.collection.Visitor;
import org.neo4j.io.fs.OpenMode;
import org.neo4j.kernel.impl.transaction.CommittedTransactionRepresentation;
import org.neo4j.kernel.impl.transaction.SimpleLogVersionRepository;
import org.neo4j.kernel.impl.transaction.SimpleTransactionIdStore;
import org.neo4j.kernel.impl.transaction.log.LogPosition;
import org.neo4j.kernel.impl.transaction.log.LogPositionMarker;
import org.neo4j.kernel.impl.transaction.log.LogVersionRepository;
import org.neo4j.kernel.impl.transaction.log.LogVersionedStoreChannel;
import org.neo4j.kernel.impl.transaction.log.LogicalTransactionStore;
import org.neo4j.kernel.impl.transaction.log.PhysicalLogVersionedStoreChannel;
import org.neo4j.kernel.impl.transaction.log.PhysicalLogicalTransactionStore;
import org.neo4j.kernel.impl.transaction.log.PositionAwarePhysicalFlushableChannel;
import org.neo4j.kernel.impl.transaction.log.ReadableClosablePositionAwareChannel;
import org.neo4j.kernel.impl.transaction.log.TransactionIdStore;
import org.neo4j.kernel.impl.transaction.log.TransactionMetadataCache;
import org.neo4j.kernel.impl.transaction.log.entry.CheckPoint;
import org.neo4j.kernel.impl.transaction.log.entry.LogEntry;
import org.neo4j.kernel.impl.transaction.log.entry.LogEntryCommit;
import org.neo4j.kernel.impl.transaction.log.entry.LogEntryReader;
import org.neo4j.kernel.impl.transaction.log.entry.LogEntryStart;
import org.neo4j.kernel.impl.transaction.log.entry.LogEntryWriter;
import org.neo4j.kernel.impl.transaction.log.entry.LogHeader;
import org.neo4j.kernel.impl.transaction.log.entry.VersionAwareLogEntryReader;
import org.neo4j.kernel.impl.transaction.log.files.LogFiles;
import org.neo4j.kernel.impl.transaction.log.files.LogFilesBuilder;
import org.neo4j.kernel.impl.util.monitoring.SilentProgressReporter;
import org.neo4j.kernel.lifecycle.LifeSupport;
import org.neo4j.kernel.monitoring.Monitors;
import org.neo4j.kernel.recovery.CorruptedLogsTruncator;
import org.neo4j.kernel.recovery.DefaultRecoveryService;
import org.neo4j.kernel.recovery.LogTailScanner;
import org.neo4j.kernel.recovery.Recovery;
import org.neo4j.kernel.recovery.RecoveryApplier;
import org.neo4j.kernel.recovery.RecoveryMonitor;
import org.neo4j.storageengine.api.StorageEngine;
import org.neo4j.storageengine.api.TransactionApplicationMode;
import org.neo4j.test.rule.TestDirectory;
import org.neo4j.test.rule.fs.DefaultFileSystemRule;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verifyZeroInteractions;
import static org.neo4j.kernel.impl.transaction.log.TransactionIdStore.BASE_TX_COMMIT_TIMESTAMP;
import static org.neo4j.kernel.impl.transaction.log.entry.LogHeaderWriter.writeLogHeader;
import static org.neo4j.kernel.impl.transaction.log.entry.LogVersions.CURRENT_LOG_VERSION;
import static org.neo4j.kernel.recovery.RecoveryStartInformationProvider.NO_MONITOR;
public class RecoveryTest
{
@Rule
public final DefaultFileSystemRule fileSystemRule = new DefaultFileSystemRule();
@Rule
public final TestDirectory directory = TestDirectory.testDirectory();
private final LogVersionRepository logVersionRepository = new SimpleLogVersionRepository();
private final TransactionIdStore transactionIdStore = new SimpleTransactionIdStore( 5L, 0,
BASE_TX_COMMIT_TIMESTAMP, 0, 0 );
private final int logVersion = 0;
private LogEntry lastCommittedTxStartEntry;
private LogEntry lastCommittedTxCommitEntry;
private LogEntry expectedStartEntry;
private LogEntry expectedCommitEntry;
private LogEntry expectedCheckPointEntry;
private Monitors monitors = new Monitors();
private final SimpleLogVersionRepository versionRepository = new SimpleLogVersionRepository();
private LogFiles logFiles;
private File storeDir;
@Before
public void setUp() throws Exception
{
storeDir = directory.storeDir();
logFiles = LogFilesBuilder.builder( directory.databaseLayout(), fileSystemRule.get() )
.withLogVersionRepository( logVersionRepository )
.withTransactionIdStore( transactionIdStore )
.build();
}
@Test
public void shouldRecoverExistingData() throws Exception
{
File file = logFiles.getLogFileForVersion( logVersion );
writeSomeData( file, pair ->
{
LogEntryWriter writer = pair.first();
Consumer<LogPositionMarker> consumer = pair.other();
LogPositionMarker marker = new LogPositionMarker();
// last committed tx
consumer.accept( marker );
LogPosition lastCommittedTxPosition = marker.newPosition();
writer.writeStartEntry( 0, 1, 2L, 3L, new byte[0] );
lastCommittedTxStartEntry = new LogEntryStart( 0, 1, 2L, 3L, new byte[0], lastCommittedTxPosition );
writer.writeCommitEntry( 4L, 5L );
lastCommittedTxCommitEntry = new LogEntryCommit( 4L, 5L );
// check point pointing to the previously committed transaction
writer.writeCheckPointEntry( lastCommittedTxPosition );
expectedCheckPointEntry = new CheckPoint( lastCommittedTxPosition );
// tx committed after checkpoint
consumer.accept( marker );
writer.writeStartEntry( 0, 1, 6L, 4L, new byte[0] );
expectedStartEntry = new LogEntryStart( 0, 1, 6L, 4L, new byte[0], marker.newPosition() );
writer.writeCommitEntry( 5L, 7L );
expectedCommitEntry = new LogEntryCommit( 5L, 7L );
return true;
} );
LifeSupport life = new LifeSupport();
RecoveryMonitor monitor = mock( RecoveryMonitor.class );
final AtomicBoolean recoveryRequired = new AtomicBoolean();
try
{
StorageEngine storageEngine = mock( StorageEngine.class );
final LogEntryReader<ReadableClosablePositionAwareChannel> reader = new VersionAwareLogEntryReader<>();
LogTailScanner tailScanner = getTailScanner( logFiles, reader );
TransactionMetadataCache metadataCache = new TransactionMetadataCache( 100 );
LogicalTransactionStore txStore = new PhysicalLogicalTransactionStore( logFiles, metadataCache, reader,
monitors, false );
CorruptedLogsTruncator logPruner = new CorruptedLogsTruncator( storeDir, logFiles, fileSystemRule.get() );
life.add( new Recovery( new DefaultRecoveryService( storageEngine, tailScanner, transactionIdStore,
txStore, versionRepository, NO_MONITOR )
{
private int nr;
@Override
public void startRecovery()
{
recoveryRequired.set( true );
}
@Override
public RecoveryApplier getRecoveryApplier( TransactionApplicationMode mode )
throws Exception
{
RecoveryApplier actual = super.getRecoveryApplier( mode );
if ( mode == TransactionApplicationMode.REVERSE_RECOVERY )
{
return actual;
}
return new RecoveryApplier()
{
@Override
public void close() throws Exception
{
actual.close();
}
@Override
public boolean visit( CommittedTransactionRepresentation tx ) throws Exception
{
actual.visit( tx );
switch ( nr++ )
{
case 0:
assertEquals( lastCommittedTxStartEntry, tx.getStartEntry() );
assertEquals( lastCommittedTxCommitEntry, tx.getCommitEntry() );
break;
case 1:
assertEquals( expectedStartEntry, tx.getStartEntry() );
assertEquals( expectedCommitEntry, tx.getCommitEntry() );
break;
default: fail( "Too many recovered transactions" );
}
return false;
}
};
}
}, logPruner, monitor, SilentProgressReporter.INSTANCE, false ) );
life.start();
InOrder order = inOrder( monitor );
order.verify( monitor, times( 1 ) ).recoveryRequired( any( LogPosition.class ) );
order.verify( monitor, times( 1 ) ).recoveryCompleted( 2 );
assertTrue( recoveryRequired.get() );
}
finally
{
life.shutdown();
}
}
@Test
public void shouldSeeThatACleanDatabaseShouldNotRequireRecovery() throws Exception
{
File file = logFiles.getLogFileForVersion( logVersion );
writeSomeData( file, pair ->
{
LogEntryWriter writer = pair.first();
Consumer<LogPositionMarker> consumer = pair.other();
LogPositionMarker marker = new LogPositionMarker();
// last committed tx
consumer.accept( marker );
writer.writeStartEntry( 0, 1, 2L, 3L, new byte[0] );
writer.writeCommitEntry( 4L, 5L );
// check point
consumer.accept( marker );
writer.writeCheckPointEntry( marker.newPosition() );
return true;
} );
LifeSupport life = new LifeSupport();
RecoveryMonitor monitor = mock( RecoveryMonitor.class );
try
{
StorageEngine storageEngine = mock( StorageEngine.class );
final LogEntryReader<ReadableClosablePositionAwareChannel> reader = new VersionAwareLogEntryReader<>();
LogTailScanner tailScanner = getTailScanner( logFiles, reader );
TransactionMetadataCache metadataCache = new TransactionMetadataCache( 100 );
LogicalTransactionStore txStore = new PhysicalLogicalTransactionStore( logFiles, metadataCache, reader,
monitors, false );
CorruptedLogsTruncator logPruner = new CorruptedLogsTruncator( storeDir, logFiles, fileSystemRule.get() );
life.add( new Recovery( new DefaultRecoveryService( storageEngine, tailScanner, transactionIdStore,
txStore, versionRepository, NO_MONITOR )
{
@Override
public void startRecovery()
{
fail( "Recovery should not be required" );
}
}, logPruner, monitor, SilentProgressReporter.INSTANCE, false ) );
life.start();
verifyZeroInteractions( monitor );
}
finally
{
life.shutdown();
}
}
@Test
public void shouldTruncateLogAfterSinglePartialTransaction() throws Exception
{
// GIVEN
File file = logFiles.getLogFileForVersion( logVersion );
final LogPositionMarker marker = new LogPositionMarker();
writeSomeData( file, pair ->
{
LogEntryWriter writer = pair.first();
Consumer<LogPositionMarker> consumer = pair.other();
// incomplete tx
consumer.accept( marker ); // <-- marker has the last good position
writer.writeStartEntry( 0, 1, 5L, 4L, new byte[0] );
return true;
} );
// WHEN
boolean recoveryRequired = recover( storeDir, logFiles );
// THEN
assertTrue( recoveryRequired );
assertEquals( marker.getByteOffset(), file.length() );
}
@Test
public void doNotTruncateCheckpointsAfterLastTransaction() throws IOException
{
File file = logFiles.getLogFileForVersion( logVersion );
LogPositionMarker marker = new LogPositionMarker();
writeSomeData( file, pair ->
{
LogEntryWriter writer = pair.first();
writer.writeStartEntry( 1, 1, 1L, 1L, ArrayUtils.EMPTY_BYTE_ARRAY );
writer.writeCommitEntry( 1L, 2L );
writer.writeCheckPointEntry( new LogPosition( logVersion, LogHeader.LOG_HEADER_SIZE ) );
writer.writeCheckPointEntry( new LogPosition( logVersion, LogHeader.LOG_HEADER_SIZE ) );
writer.writeCheckPointEntry( new LogPosition( logVersion, LogHeader.LOG_HEADER_SIZE ) );
writer.writeCheckPointEntry( new LogPosition( logVersion, LogHeader.LOG_HEADER_SIZE ) );
Consumer<LogPositionMarker> other = pair.other();
other.accept( marker );
return true;
} );
assertTrue( recover( storeDir, logFiles ) );
assertEquals( marker.getByteOffset(), file.length() );
}
@Test
public void shouldTruncateLogAfterLastCompleteTransactionAfterSuccessfulRecovery() throws Exception
{
// GIVEN
File file = logFiles.getLogFileForVersion( logVersion );
final LogPositionMarker marker = new LogPositionMarker();
writeSomeData( file, pair ->
{
LogEntryWriter writer = pair.first();
Consumer<LogPositionMarker> consumer = pair.other();
// last committed tx
writer.writeStartEntry( 0, 1, 2L, 3L, new byte[0] );
writer.writeCommitEntry( 4L, 5L );
// incomplete tx
consumer.accept( marker ); // <-- marker has the last good position
writer.writeStartEntry( 0, 1, 5L, 4L, new byte[0] );
return true;
} );
// WHEN
boolean recoveryRequired = recover( storeDir, logFiles );
// THEN
assertTrue( recoveryRequired );
assertEquals( marker.getByteOffset(), file.length() );
}
@Test
public void shouldTellTransactionIdStoreAfterSuccessfulRecovery() throws Exception
{
// GIVEN
File file = logFiles.getLogFileForVersion( logVersion );
final LogPositionMarker marker = new LogPositionMarker();
final byte[] additionalHeaderData = new byte[0];
final int masterId = 0;
final int authorId = 1;
final long transactionId = 4;
final long commitTimestamp = 5;
writeSomeData( file, pair ->
{
LogEntryWriter writer = pair.first();
Consumer<LogPositionMarker> consumer = pair.other();
// last committed tx
writer.writeStartEntry( masterId, authorId, 2L, 3L, additionalHeaderData );
writer.writeCommitEntry( transactionId, commitTimestamp );
consumer.accept( marker );
return true;
} );
// WHEN
boolean recoveryRequired = recover( storeDir, logFiles );
// THEN
assertTrue( recoveryRequired );
long[] lastClosedTransaction = transactionIdStore.getLastClosedTransaction();
assertEquals( transactionId, lastClosedTransaction[0] );
assertEquals( LogEntryStart.checksum( additionalHeaderData, masterId, authorId ),
transactionIdStore.getLastCommittedTransaction().checksum() );
assertEquals( commitTimestamp, transactionIdStore.getLastCommittedTransaction().commitTimestamp() );
assertEquals( logVersion, lastClosedTransaction[1] );
assertEquals( marker.getByteOffset(), lastClosedTransaction[2] );
}
private boolean recover( File storeDir, LogFiles logFiles )
{
LifeSupport life = new LifeSupport();
RecoveryMonitor monitor = mock( RecoveryMonitor.class );
final AtomicBoolean recoveryRequired = new AtomicBoolean();
try
{
StorageEngine storageEngine = mock( StorageEngine.class );
final LogEntryReader<ReadableClosablePositionAwareChannel> reader = new VersionAwareLogEntryReader<>();
LogTailScanner tailScanner = getTailScanner( logFiles, reader );
TransactionMetadataCache metadataCache = new TransactionMetadataCache( 100 );
LogicalTransactionStore txStore = new PhysicalLogicalTransactionStore( logFiles, metadataCache, reader, monitors, false );
CorruptedLogsTruncator logPruner = new CorruptedLogsTruncator( storeDir, logFiles, fileSystemRule.get() );
life.add( new Recovery( new DefaultRecoveryService( storageEngine, tailScanner, transactionIdStore,
txStore, versionRepository, NO_MONITOR )
{
@Override
public void startRecovery()
{
recoveryRequired.set( true );
}
}, logPruner, monitor, SilentProgressReporter.INSTANCE, false ) );
life.start();
}
finally
{
life.shutdown();
}
return recoveryRequired.get();
}
private LogTailScanner getTailScanner( LogFiles logFiles,
LogEntryReader<ReadableClosablePositionAwareChannel> reader )
{
return new LogTailScanner( logFiles, reader, monitors, false );
}
private void writeSomeData( File file,
Visitor<Pair<LogEntryWriter,Consumer<LogPositionMarker>>,IOException> visitor ) throws IOException
{
try ( LogVersionedStoreChannel versionedStoreChannel = new PhysicalLogVersionedStoreChannel(
fileSystemRule.get().open( file, OpenMode.READ_WRITE ), logVersion, CURRENT_LOG_VERSION );
PositionAwarePhysicalFlushableChannel writableLogChannel = new PositionAwarePhysicalFlushableChannel(
versionedStoreChannel ) )
{
writeLogHeader( writableLogChannel, logVersion, 2L );
Consumer<LogPositionMarker> consumer = marker ->
{
try
{
writableLogChannel.getCurrentPosition( marker );
}
catch ( IOException e )
{
throw new RuntimeException( e );
}
};
LogEntryWriter first = new LogEntryWriter( writableLogChannel );
visitor.visit( Pair.of( first, consumer ) );
}
}
}