-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
BlockBasedIndexPopulatorTest.java
239 lines (212 loc) · 10.1 KB
/
BlockBasedIndexPopulatorTest.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
/*
* 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.kernel.impl.index.schema;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import java.io.File;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.concurrent.Future;
import org.neo4j.graphdb.mockfs.EphemeralFileSystemAbstraction;
import org.neo4j.internal.kernel.api.schema.IndexProviderDescriptor;
import org.neo4j.io.fs.FileSystemAbstraction;
import org.neo4j.kernel.api.index.IndexDirectoryStructure;
import org.neo4j.kernel.api.index.IndexEntryUpdate;
import org.neo4j.kernel.api.schema.SchemaDescriptorFactory;
import org.neo4j.kernel.configuration.Config;
import org.neo4j.kernel.impl.index.schema.config.ConfiguredSpaceFillingCurveSettingsCache;
import org.neo4j.kernel.impl.index.schema.config.IndexSpecificSpaceFillingCurveSettingsCache;
import org.neo4j.storageengine.api.schema.IndexDescriptorFactory;
import org.neo4j.storageengine.api.schema.PopulationProgress;
import org.neo4j.storageengine.api.schema.StoreIndexDescriptor;
import org.neo4j.test.Barrier;
import org.neo4j.test.Race;
import org.neo4j.test.rule.PageCacheAndDependenciesRule;
import org.neo4j.test.rule.concurrent.OtherThreadRule;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.neo4j.kernel.api.index.IndexDirectoryStructure.directoriesByProvider;
import static org.neo4j.kernel.api.index.IndexProvider.Monitor.EMPTY;
import static org.neo4j.kernel.impl.api.index.PhaseTracker.nullInstance;
import static org.neo4j.kernel.impl.index.schema.BlockStorage.Monitor.NO_MONITOR;
import static org.neo4j.test.OtherThreadExecutor.command;
import static org.neo4j.test.Race.throwing;
import static org.neo4j.values.storable.Values.stringValue;
public class BlockBasedIndexPopulatorTest
{
private static final StoreIndexDescriptor INDEX_DESCRIPTOR = IndexDescriptorFactory.forSchema( SchemaDescriptorFactory.forLabel( 1, 1 ) ).withId( 1 );
@Rule
public final PageCacheAndDependenciesRule storage = new PageCacheAndDependenciesRule();
@Rule
public final OtherThreadRule<Void> t2 = new OtherThreadRule<>( "MERGER" );
@Rule
public final OtherThreadRule<Void> t3 = new OtherThreadRule<>( "CLOSER" );
private IndexDirectoryStructure directoryStructure;
private File indexDir;
private File indexFile;
private FileSystemAbstraction fs;
private IndexDropAction dropAction;
@Before
public void setup()
{
IndexProviderDescriptor providerDescriptor = new IndexProviderDescriptor( "test", "v1" );
directoryStructure = directoriesByProvider( storage.directory().databaseDir() ).forProvider( providerDescriptor );
indexDir = directoryStructure.directoryForIndex( INDEX_DESCRIPTOR.getId() );
indexFile = new File( indexDir, "index" );
fs = storage.fileSystem();
dropAction = new FileSystemIndexDropAction( fs, directoryStructure );
}
@Test
public void shouldAwaitMergeToBeFullyAbortedBeforeLeavingCloseMethod() throws Exception
{
// given
TrappingMonitor monitor = new TrappingMonitor( false );
BlockBasedIndexPopulator<GenericKey,NativeIndexValue> populator = instantiatePopulatorWithSomeData( monitor );
// when starting to merge (in a separate thread)
Future<Object> mergeFuture = t2.execute( command( () -> populator.scanCompleted( nullInstance ) ) );
// and waiting for merge to get going
monitor.barrier.awaitUninterruptibly();
// calling close here should wait for the merge future, so that checking the merge future for "done" immediately afterwards must say true
Future<Object> closeFuture = t3.execute( command( () -> populator.close( false ) ) );
t3.get().waitUntilWaiting();
monitor.barrier.release();
closeFuture.get();
// then
assertTrue( mergeFuture.isDone() );
}
@Test
public void shouldReportAccurateProgressThroughoutThePhases() throws Exception
{
// given
TrappingMonitor monitor = new TrappingMonitor( true );
BlockBasedIndexPopulator<GenericKey,NativeIndexValue> populator = instantiatePopulatorWithSomeData( monitor );
try
{
// when starting to merge (in a separate thread)
Future<Object> mergeFuture = t2.execute( command( () -> populator.scanCompleted( nullInstance ) ) );
// and waiting for merge to get going
monitor.barrier.awaitUninterruptibly();
// this is a bit fuzzy, but what we want is to assert that the scan doesn't represent 100% of the work
assertEquals( 0.5f, populator.progress( PopulationProgress.DONE ).getProgress(), 0.1f );
monitor.barrier.release();
monitor.mergeFinishedBarrier.awaitUninterruptibly();
assertEquals( 0.7f, populator.progress( PopulationProgress.DONE ).getProgress(), 0.1f );
monitor.mergeFinishedBarrier.release();
mergeFuture.get();
assertEquals( 1f, populator.progress( PopulationProgress.DONE ).getProgress(), 0f );
}
finally
{
populator.close( true );
}
}
@Test
public void shouldCorrectlyDecideToAwaitMergeDependingOnProgress() throws Throwable
{
// given
BlockBasedIndexPopulator<GenericKey,NativeIndexValue> populator = instantiatePopulatorWithSomeData( NO_MONITOR );
// when
Race race = new Race();
race.addContestant( throwing( () -> populator.scanCompleted( nullInstance ) ) );
race.addContestant( throwing( () -> populator.close( false ) ) );
race.go();
// then regardless of who wins (close/merge) after close call returns no files should still be mapped
EphemeralFileSystemAbstraction ephemeralFileSystem = (EphemeralFileSystemAbstraction) fs;
ephemeralFileSystem.assertNoOpenFiles();
}
@Test
public void shouldDeleteDirectoryOnDrop() throws Exception
{
// given
TrappingMonitor monitor = new TrappingMonitor( false );
BlockBasedIndexPopulator<GenericKey,NativeIndexValue> populator = instantiatePopulatorWithSomeData( monitor );
// when starting to merge (in a separate thread)
Future<Object> mergeFuture = t2.execute( command( () -> populator.scanCompleted( nullInstance ) ) );
// and waiting for merge to get going
monitor.barrier.awaitUninterruptibly();
// calling drop here should wait for the merge future and then delete index directory
assertTrue( fs.fileExists( indexDir ) );
assertTrue( fs.isDirectory( indexDir ) );
assertTrue( fs.listFiles( indexDir ).length > 0 );
Future<Object> dropFuture = t3.execute( command( populator::drop ) );
t3.get().waitUntilWaiting();
monitor.barrier.release();
dropFuture.get();
// then
assertTrue( mergeFuture.isDone() );
assertFalse( fs.fileExists( indexDir ) );
}
private BlockBasedIndexPopulator<GenericKey,NativeIndexValue> instantiatePopulatorWithSomeData( BlockStorage.Monitor monitor )
{
Config config = Config.defaults();
ConfiguredSpaceFillingCurveSettingsCache settingsCache = new ConfiguredSpaceFillingCurveSettingsCache( config );
IndexSpecificSpaceFillingCurveSettingsCache spatialSettings = new IndexSpecificSpaceFillingCurveSettingsCache( settingsCache, new HashMap<>() );
GenericLayout layout = new GenericLayout( 1, spatialSettings );
BlockBasedIndexPopulator<GenericKey,NativeIndexValue> populator =
new BlockBasedIndexPopulator<GenericKey,NativeIndexValue>( storage.pageCache(), fs, indexFile, layout, EMPTY,
INDEX_DESCRIPTOR, spatialSettings, directoryStructure, dropAction, false, 100, 2, monitor )
{
@Override
NativeIndexReader<GenericKey,NativeIndexValue> newReader()
{
throw new UnsupportedOperationException( "Not needed in this test" );
}
};
populator.create();
populator.add( batchOfUpdates() );
return populator;
}
private static Collection<IndexEntryUpdate<?>> batchOfUpdates()
{
List<IndexEntryUpdate<?>> updates = new ArrayList<>();
for ( int i = 0; i < 50; i++ )
{
updates.add( IndexEntryUpdate.add( i, INDEX_DESCRIPTOR, stringValue( "Value" + i ) ) );
}
return updates;
}
private static class TrappingMonitor extends BlockStorage.Monitor.Adapter
{
private final Barrier.Control barrier = new Barrier.Control();
private final Barrier.Control mergeFinishedBarrier = new Barrier.Control();
private final boolean alsoTrapAfterMergeCompleted;
TrappingMonitor( boolean alsoTrapAfterMergeCompleted )
{
this.alsoTrapAfterMergeCompleted = alsoTrapAfterMergeCompleted;
}
@Override
public void mergedBlocks( long resultingBlockSize, long resultingEntryCount, long numberOfBlocks )
{
barrier.reached();
}
@Override
public void mergeIterationFinished( long numberOfBlocksBefore, long numberOfBlocksAfter )
{
if ( numberOfBlocksAfter == 1 && alsoTrapAfterMergeCompleted )
{
mergeFinishedBarrier.reached();
}
}
}
}