-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
TestGraphDatabaseFactory.java
359 lines (314 loc) · 13.2 KB
/
TestGraphDatabaseFactory.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
/*
* 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.test;
import java.io.File;
import java.util.Collections;
import java.util.Map;
import java.util.function.Function;
import javax.annotation.Nonnull;
import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.graphdb.config.Setting;
import org.neo4j.graphdb.facade.GraphDatabaseDependencies;
import org.neo4j.graphdb.facade.GraphDatabaseFacadeFactory;
import org.neo4j.graphdb.factory.GraphDatabaseBuilder;
import org.neo4j.graphdb.factory.GraphDatabaseFactory;
import org.neo4j.graphdb.factory.GraphDatabaseSettings;
import org.neo4j.graphdb.factory.module.CommunityEditionModule;
import org.neo4j.graphdb.factory.module.EditionModule;
import org.neo4j.graphdb.factory.module.PlatformModule;
import org.neo4j.graphdb.mockfs.EphemeralFileSystemAbstraction;
import org.neo4j.graphdb.mockfs.UncloseableDelegatingFileSystemAbstraction;
import org.neo4j.graphdb.security.URLAccessRule;
import org.neo4j.io.fs.FileSystemAbstraction;
import org.neo4j.kernel.configuration.BoltConnector;
import org.neo4j.kernel.configuration.Config;
import org.neo4j.kernel.configuration.Settings;
import org.neo4j.kernel.extension.KernelExtensionFactory;
import org.neo4j.kernel.impl.factory.DatabaseInfo;
import org.neo4j.kernel.impl.logging.LogService;
import org.neo4j.kernel.impl.logging.SimpleLogService;
import org.neo4j.kernel.internal.locker.StoreLocker;
import org.neo4j.kernel.monitoring.Monitors;
import org.neo4j.logging.LogProvider;
import org.neo4j.logging.NullLogProvider;
import org.neo4j.time.SystemNanoClock;
import static org.neo4j.graphdb.factory.GraphDatabaseSettings.ephemeral;
import static org.neo4j.kernel.configuration.Connector.ConnectorType.BOLT;
import static org.neo4j.kernel.configuration.Settings.TRUE;
/**
* Test factory for graph databases.
* Please be aware that since it's a database it will close filesystem as part of its lifecycle.
* If you expect your file system to be open after database is closed, use {@link UncloseableDelegatingFileSystemAbstraction}
*/
public class TestGraphDatabaseFactory extends GraphDatabaseFactory
{
public TestGraphDatabaseFactory()
{
this( NullLogProvider.getInstance() );
}
public TestGraphDatabaseFactory( LogProvider logProvider )
{
super( new TestGraphDatabaseFactoryState() );
setUserLogProvider( logProvider );
}
public GraphDatabaseService newImpermanentDatabase()
{
return newImpermanentDatabaseBuilder().newGraphDatabase();
}
public GraphDatabaseService newImpermanentDatabase( File storeDir )
{
File absoluteDirectory = storeDir.getAbsoluteFile();
GraphDatabaseBuilder databaseBuilder = newImpermanentDatabaseBuilder( absoluteDirectory );
databaseBuilder.setConfig( GraphDatabaseSettings.active_database, absoluteDirectory.getName() );
databaseBuilder.setConfig( GraphDatabaseSettings.databases_root_path, absoluteDirectory.getParentFile().getAbsolutePath() );
return databaseBuilder.newGraphDatabase();
}
public GraphDatabaseService newImpermanentDatabase( Map<Setting<?>,String> config )
{
GraphDatabaseBuilder builder = newImpermanentDatabaseBuilder();
setConfig( config, builder );
return builder.newGraphDatabase();
}
public GraphDatabaseService newImpermanentDatabase( File storeDir , Map<Setting<?>,String> config )
{
GraphDatabaseBuilder builder = newImpermanentDatabaseBuilder(storeDir);
setConfig( config, builder );
return builder.newGraphDatabase();
}
private void setConfig( Map<Setting<?>,String> config, GraphDatabaseBuilder builder )
{
for ( Map.Entry<Setting<?>,String> entry : config.entrySet() )
{
Setting<?> key = entry.getKey();
String value = entry.getValue();
builder.setConfig( key, value );
}
}
public GraphDatabaseBuilder newImpermanentDatabaseBuilder()
{
return newImpermanentDatabaseBuilder( ImpermanentGraphDatabase.PATH );
}
@Override
protected void configure( GraphDatabaseBuilder builder )
{
// Reduce the default page cache memory size to 8 mega-bytes for test databases.
builder.setConfig( GraphDatabaseSettings.pagecache_memory, "8m" );
builder.setConfig( GraphDatabaseSettings.shutdown_transaction_end_timeout, "1s" );
builder.setConfig( new BoltConnector( "bolt" ).type, BOLT.name() );
builder.setConfig( new BoltConnector( "bolt" ).enabled, "false" );
}
private void configure( GraphDatabaseBuilder builder, File storeDir )
{
configure( builder );
builder.setConfig( GraphDatabaseSettings.logs_directory, new File( storeDir, "logs" ).getAbsolutePath() );
}
@Override
protected TestGraphDatabaseFactoryState getCurrentState()
{
return (TestGraphDatabaseFactoryState) super.getCurrentState();
}
@Override
protected TestGraphDatabaseFactoryState getStateCopy()
{
return new TestGraphDatabaseFactoryState( getCurrentState() );
}
public FileSystemAbstraction getFileSystem()
{
return getCurrentState().getFileSystem();
}
public TestGraphDatabaseFactory setFileSystem( FileSystemAbstraction fileSystem )
{
getCurrentState().setFileSystem( fileSystem );
return this;
}
@Override
public TestGraphDatabaseFactory setMonitors( Monitors monitors )
{
getCurrentState().setMonitors( monitors );
return this;
}
@Override
public TestGraphDatabaseFactory setUserLogProvider( LogProvider logProvider )
{
return (TestGraphDatabaseFactory) super.setUserLogProvider( logProvider );
}
public TestGraphDatabaseFactory setInternalLogProvider( LogProvider logProvider )
{
getCurrentState().setInternalLogProvider( logProvider );
return this;
}
public TestGraphDatabaseFactory setClock( SystemNanoClock clock )
{
getCurrentState().setClock( clock );
return this;
}
public TestGraphDatabaseFactory addKernelExtensions( Iterable<KernelExtensionFactory<?>> newKernelExtensions )
{
getCurrentState().addKernelExtensions( newKernelExtensions );
return this;
}
public TestGraphDatabaseFactory addKernelExtension( KernelExtensionFactory<?> newKernelExtension )
{
return addKernelExtensions( Collections.singletonList( newKernelExtension ) );
}
public TestGraphDatabaseFactory setKernelExtensions( Iterable<KernelExtensionFactory<?>> newKernelExtensions )
{
getCurrentState().setKernelExtensions( newKernelExtensions );
return this;
}
@Override
public TestGraphDatabaseFactory addURLAccessRule( String protocol, URLAccessRule rule )
{
return (TestGraphDatabaseFactory) super.addURLAccessRule( protocol, rule );
}
public GraphDatabaseBuilder newImpermanentDatabaseBuilder( final File storeDir )
{
final TestGraphDatabaseFactoryState state = getStateCopy();
GraphDatabaseBuilder.DatabaseCreator creator =
createImpermanentDatabaseCreator( storeDir, state );
TestGraphDatabaseBuilder builder = createImpermanentGraphDatabaseBuilder( creator );
configure( builder, storeDir );
return builder;
}
private TestGraphDatabaseBuilder createImpermanentGraphDatabaseBuilder(
GraphDatabaseBuilder.DatabaseCreator creator )
{
return new TestGraphDatabaseBuilder( creator );
}
@Override
protected GraphDatabaseService newEmbeddedDatabase( File storeDir, Config config,
GraphDatabaseFacadeFactory.Dependencies dependencies )
{
return new TestGraphDatabaseFacadeFactory( getCurrentState() ).newFacade( storeDir, config,
GraphDatabaseDependencies.newDependencies( dependencies ) );
}
protected GraphDatabaseBuilder.DatabaseCreator createImpermanentDatabaseCreator( final File storeDir,
final TestGraphDatabaseFactoryState state )
{
return new GraphDatabaseBuilder.DatabaseCreator()
{
@Override
public GraphDatabaseService newDatabase( @Nonnull Config config )
{
return new TestGraphDatabaseFacadeFactory( state, true ).newFacade( storeDir, config,
GraphDatabaseDependencies.newDependencies( state.databaseDependencies() ) );
}
};
}
public static class TestGraphDatabaseFacadeFactory extends GraphDatabaseFacadeFactory
{
private final TestGraphDatabaseFactoryState state;
private final boolean impermanent;
protected TestGraphDatabaseFacadeFactory( TestGraphDatabaseFactoryState state, boolean impermanent )
{
this( state, impermanent, DatabaseInfo.COMMUNITY, CommunityEditionModule::new );
}
protected TestGraphDatabaseFacadeFactory( TestGraphDatabaseFactoryState state, boolean impermanent,
DatabaseInfo databaseInfo, Function<PlatformModule,EditionModule> editionFactory )
{
super( databaseInfo, editionFactory );
this.state = state;
this.impermanent = impermanent;
}
TestGraphDatabaseFacadeFactory( TestGraphDatabaseFactoryState state )
{
this( state, false );
}
@Override
protected PlatformModule createPlatform( File storeDir, Config config, Dependencies dependencies )
{
File absoluteStoreDir = storeDir.getAbsoluteFile();
File databasesRoot = absoluteStoreDir.getParentFile();
config.augment( GraphDatabaseSettings.ephemeral, Settings.FALSE );
config.augment( GraphDatabaseSettings.active_database, absoluteStoreDir.getName() );
config.augment( GraphDatabaseSettings.databases_root_path, databasesRoot.getAbsolutePath() );
if ( impermanent )
{
config.augment( ephemeral, TRUE );
return new ImpermanentTestDatabasePlatformModule( databasesRoot, config, dependencies, this.databaseInfo );
}
else
{
return new TestDatabasePlatformModule( databasesRoot, config, dependencies, this.databaseInfo );
}
}
class TestDatabasePlatformModule extends PlatformModule
{
TestDatabasePlatformModule( File storeDir, Config config, Dependencies dependencies, DatabaseInfo databaseInfo )
{
super( storeDir, config, databaseInfo, dependencies );
}
@Override
protected FileSystemAbstraction createFileSystemAbstraction()
{
FileSystemAbstraction fs = state.getFileSystem();
if ( fs != null )
{
return fs;
}
else
{
return createNewFileSystem();
}
}
protected FileSystemAbstraction createNewFileSystem()
{
return super.createFileSystemAbstraction();
}
@Override
protected LogService createLogService( LogProvider userLogProvider )
{
LogProvider internalLogProvider = state.getInternalLogProvider();
if ( internalLogProvider == null )
{
if ( !impermanent )
{
return super.createLogService( userLogProvider );
}
internalLogProvider = NullLogProvider.getInstance();
}
return new SimpleLogService( userLogProvider, internalLogProvider );
}
@Override
protected SystemNanoClock createClock()
{
SystemNanoClock clock = state.clock();
return clock != null ? clock : super.createClock();
}
}
private class ImpermanentTestDatabasePlatformModule extends TestDatabasePlatformModule
{
ImpermanentTestDatabasePlatformModule( File storeDir, Config config, Dependencies dependencies, DatabaseInfo databaseInfo )
{
super( storeDir, config, dependencies, databaseInfo );
}
@Override
protected FileSystemAbstraction createNewFileSystem()
{
return new EphemeralFileSystemAbstraction();
}
@Override
protected StoreLocker createStoreLocker()
{
return new StoreLocker( fileSystem, storeLayout );
}
}
}
}