-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
StoreCopyClientTest.java
372 lines (310 loc) · 14.6 KB
/
StoreCopyClientTest.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
/*
* 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 Affero 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.com.storecopy;
import org.junit.Assert;
import org.junit.Rule;
import org.junit.Test;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.atomic.AtomicBoolean;
import org.neo4j.com.RequestContext;
import org.neo4j.com.Response;
import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.graphdb.Transaction;
import org.neo4j.helpers.CancellationRequest;
import org.neo4j.helpers.Service;
import org.neo4j.helpers.collection.Iterators;
import org.neo4j.io.fs.DefaultFileSystemAbstraction;
import org.neo4j.io.pagecache.PageCache;
import org.neo4j.kernel.NeoStoreDataSource;
import org.neo4j.kernel.configuration.Config;
import org.neo4j.kernel.extension.KernelExtensionFactory;
import org.neo4j.kernel.impl.storageengine.impl.recordstorage.RecordStorageEngine;
import org.neo4j.kernel.impl.store.MetaDataStore;
import org.neo4j.kernel.impl.store.StoreId;
import org.neo4j.kernel.impl.store.format.highlimit.HighLimit;
import org.neo4j.kernel.impl.store.format.lowlimit.LowLimitV3_0;
import org.neo4j.kernel.impl.transaction.log.LogicalTransactionStore;
import org.neo4j.kernel.impl.transaction.log.TransactionIdStore;
import org.neo4j.kernel.impl.transaction.log.checkpoint.CheckPointer;
import org.neo4j.kernel.impl.transaction.log.entry.LogHeader;
import org.neo4j.kernel.internal.GraphDatabaseAPI;
import org.neo4j.kernel.monitoring.Monitors;
import org.neo4j.logging.NullLogProvider;
import org.neo4j.test.PageCacheRule;
import org.neo4j.test.TargetDirectory;
import org.neo4j.test.TestGraphDatabaseFactory;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.equalTo;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.fail;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.neo4j.graphdb.DynamicLabel.label;
import static org.neo4j.helpers.collection.MapUtil.stringMap;
import static org.neo4j.kernel.impl.factory.GraphDatabaseFacadeFactory.Configuration.record_format;
public class StoreCopyClientTest
{
@Rule
public TargetDirectory.TestDirectory testDir = TargetDirectory.testDirForTest( getClass() );
@Rule
public PageCacheRule pageCacheRule = new PageCacheRule();
private final DefaultFileSystemAbstraction fs = new DefaultFileSystemAbstraction();
@Test
public void shouldCopyStoreFilesAcrossIfACancellationRequestHappensAfterTheTempStoreHasBeenRecovered()
throws Exception
{
// given
final File copyDir = new File( testDir.directory(), "copy" );
final File originalDir = new File( testDir.directory(), "original" );
final AtomicBoolean cancelStoreCopy = new AtomicBoolean( false );
CancellationRequest cancellationRequest = () -> cancelStoreCopy.get();
StoreCopyClient.Monitor storeCopyMonitor = new StoreCopyClient.Monitor.Adapter()
{
@Override
public void finishRecoveringStore()
{
// simulate a cancellation request
cancelStoreCopy.set( true );
}
};
PageCache pageCache = pageCacheRule.getPageCache( fs );
StoreCopyClient copier =
new StoreCopyClient( copyDir, Config.empty(), loadKernelExtensions(), NullLogProvider.getInstance(), fs, pageCache, storeCopyMonitor,
false );
final GraphDatabaseAPI original =
(GraphDatabaseAPI) startDatabase( originalDir );
try ( Transaction tx = original.beginTx() )
{
original.createNode( label( "BeforeCopyBegins" ) );
tx.success();
}
StoreCopyClient.StoreCopyRequester storeCopyRequest = storeCopyRequest( originalDir, original );
// when
copier.copyStore( storeCopyRequest, cancellationRequest );
// Then
GraphDatabaseService copy = startDatabase( copyDir );
try ( Transaction tx = copy.beginTx() )
{
long nodesCount = Iterators.count( copy.findNodes( label( "BeforeCopyBegins" ) ) );
assertThat( nodesCount, equalTo( 1l ) );
assertThat( Iterators.single( copy.findNodes( label( "BeforeCopyBegins" ) ) ).getId(),
equalTo( 0l ) );
tx.success();
}
finally
{
copy.shutdown();
original.shutdown();
}
verify( storeCopyRequest, times( 1 ) ).done();
}
@Test
public void storeCopyClientMustRespectConfiguredRecordFormat() throws Exception
{
final File copyDir = new File( testDir.directory(), "copy" );
final File originalDir = new File( testDir.directory(), "original" );
PageCache pageCache = pageCacheRule.getPageCache( fs );
String unkownFormat = "unkown_format";
Config config = Config.empty().augment( stringMap( record_format.name(), unkownFormat ) );
StoreCopyClient copier = new StoreCopyClient(
copyDir, config, loadKernelExtensions(), NullLogProvider.getInstance(), fs, pageCache,
new StoreCopyClient.Monitor.Adapter(), false );
final GraphDatabaseAPI original = (GraphDatabaseAPI) startDatabase( originalDir );
StoreCopyClient.StoreCopyRequester storeCopyRequest = storeCopyRequest( originalDir, original );
// This should complain about the unkown format
try
{
copier.copyStore( storeCopyRequest, CancellationRequest.NEVER_CANCELLED );
fail( "copyStore should have failed with this format configuration" );
}
catch ( Exception e )
{
assertThat( e.getMessage(), containsString( unkownFormat ) );
}
}
@Test
public void storeCopyClientMustWorkWithLowLimitRecordFormat() throws Exception
{
final File copyDir = new File( testDir.directory(), "copy" );
final File originalDir = new File( testDir.directory(), "original" );
PageCache pageCache = pageCacheRule.getPageCache( fs );
Config config = Config.empty().augment( stringMap( record_format.name(), LowLimitV3_0.NAME ) );
StoreCopyClient copier = new StoreCopyClient(
copyDir, config, loadKernelExtensions(), NullLogProvider.getInstance(), fs, pageCache,
new StoreCopyClient.Monitor.Adapter(), false );
final GraphDatabaseAPI original = (GraphDatabaseAPI) startDatabase( originalDir, LowLimitV3_0.NAME );
StoreCopyClient.StoreCopyRequester storeCopyRequest = storeCopyRequest( originalDir, original );
copier.copyStore( storeCopyRequest, CancellationRequest.NEVER_CANCELLED );
GraphDatabaseService copy = startDatabase( copyDir, LowLimitV3_0.NAME );
copy.shutdown();
original.shutdown();
}
@Test
public void shouldEndUpWithAnEmptyStoreIfCancellationRequestIssuedJustBeforeRecoveryTakesPlace()
throws Exception
{
// given
final File copyDir = new File( testDir.directory(), "copy" );
final File originalDir = new File( testDir.directory(), "original" );
final AtomicBoolean cancelStoreCopy = new AtomicBoolean( false );
CancellationRequest cancellationRequest = () -> cancelStoreCopy.get();
StoreCopyClient.Monitor storeCopyMonitor = new StoreCopyClient.Monitor.Adapter()
{
@Override
public void finishReceivingStoreFiles()
{
// simulate a cancellation request
cancelStoreCopy.set( true );
}
};
PageCache pageCache = pageCacheRule.getPageCache( fs );
StoreCopyClient copier =
new StoreCopyClient( copyDir, Config.empty(), loadKernelExtensions(), NullLogProvider.getInstance(), fs, pageCache, storeCopyMonitor,
false );
final GraphDatabaseAPI original = (GraphDatabaseAPI) startDatabase( originalDir );
try ( Transaction tx = original.beginTx() )
{
original.createNode( label( "BeforeCopyBegins" ) );
tx.success();
}
StoreCopyClient.StoreCopyRequester storeCopyRequest = storeCopyRequest( originalDir, original );
// when
copier.copyStore( storeCopyRequest, cancellationRequest );
// Then
GraphDatabaseService copy = startDatabase( copyDir );
try ( Transaction tx = copy.beginTx() )
{
long nodesCount = Iterators.count( copy.findNodes( label( "BeforeCopyBegins" ) ) );
assertThat( nodesCount, equalTo( 0l ) );
tx.success();
}
finally
{
copy.shutdown();
original.shutdown();
}
verify( storeCopyRequest, times( 1 ) ).done();
}
@Test
public void shouldResetNeoStoreLastTransactionOffsetForNonForensicCopy() throws Exception
{
// GIVEN
File initialStore = testDir.directory( "initialStore" );
File backupStore = testDir.directory( "backupStore" );
PageCache pageCache = pageCacheRule.getPageCache( fs );
GraphDatabaseService initialDatabase = null;
try
{
initialDatabase = startDatabase( initialStore );
for ( int i = 0; i < 10; i++ )
try ( Transaction tx = initialDatabase.beginTx() )
{
initialDatabase.createNode( label( "Neo" + i ) );
tx.success();
}
initialDatabase.shutdown();
long originalTransactionOffset =
MetaDataStore.getRecord( pageCache, new File( initialStore, MetaDataStore.DEFAULT_NAME ),
MetaDataStore.Position.LAST_CLOSED_TRANSACTION_LOG_BYTE_OFFSET );
initialDatabase = startDatabase( initialStore );
StoreCopyClient copier =
new StoreCopyClient( backupStore, Config.empty(), loadKernelExtensions(), NullLogProvider
.getInstance(), fs, pageCache, new StoreCopyClient.Monitor.Adapter(), false );
CancellationRequest falseCancellationRequest = () -> false;
StoreCopyClient.StoreCopyRequester storeCopyRequest = storeCopyRequest( initialStore, (GraphDatabaseAPI)
initialDatabase );
// WHEN
copier.copyStore( storeCopyRequest, falseCancellationRequest );
// THEN
long updatedTransactionOffset =
MetaDataStore.getRecord( pageCache, new File( backupStore, MetaDataStore.DEFAULT_NAME ),
MetaDataStore.Position.LAST_CLOSED_TRANSACTION_LOG_BYTE_OFFSET );
Assert.assertNotEquals( originalTransactionOffset, updatedTransactionOffset );
Assert.assertEquals( LogHeader.LOG_HEADER_SIZE, updatedTransactionOffset );
}
finally
{
if (initialDatabase != null)
{
initialDatabase.shutdown();
}
}
}
private GraphDatabaseService startDatabase( File storeDir )
{
return startDatabase( storeDir, HighLimit.NAME );
}
private GraphDatabaseService startDatabase( File storeDir, String recordFormatName )
{
return new TestGraphDatabaseFactory()
.newEmbeddedDatabaseBuilder( storeDir )
.setConfig( record_format, recordFormatName )
.newGraphDatabase();
}
private StoreCopyClient.StoreCopyRequester storeCopyRequest( final File originalDir,
final GraphDatabaseAPI original )
{
return spy( new StoreCopyClient.StoreCopyRequester()
{
public Response<?> response;
@Override
public Response<?> copyStore( StoreWriter writer )
{
NeoStoreDataSource neoStoreDataSource =
original.getDependencyResolver().resolveDependency( NeoStoreDataSource.class );
TransactionIdStore transactionIdStore =
original.getDependencyResolver().resolveDependency( TransactionIdStore.class );
LogicalTransactionStore logicalTransactionStore =
original.getDependencyResolver().resolveDependency( LogicalTransactionStore.class );
CheckPointer checkPointer =
original.getDependencyResolver().resolveDependency( CheckPointer.class );
RequestContext requestContext = new StoreCopyServer( neoStoreDataSource,
checkPointer, fs, originalDir, new Monitors().newMonitor( StoreCopyServer.Monitor.class ) )
.flushStoresAndStreamStoreFiles( writer, false );
final StoreId storeId = original.getDependencyResolver().resolveDependency( RecordStorageEngine.class )
.testAccessNeoStores().getMetaDataStore().getStoreId();
ResponsePacker responsePacker = new ResponsePacker( logicalTransactionStore,
transactionIdStore, () -> storeId );
response = spy(responsePacker.packTransactionStreamResponse( requestContext, null ));
return response;
}
@Override
public void done()
{
// Ensure response is closed before this method is called
assertNotNull( response );
verify( response, times( 1 ) ).close();
}
} );
}
private static List<KernelExtensionFactory<?>> loadKernelExtensions()
{
List<KernelExtensionFactory<?>> kernelExtensions = new ArrayList<>();
for ( KernelExtensionFactory<?> factory : Service.load( KernelExtensionFactory.class ) )
{
kernelExtensions.add( factory );
}
return kernelExtensions;
}
}