Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
More testing for opening a partially created GBPTree
This uncovered paths that weren't guarded when opening a GBPTree normally via its constructor (previous testing was only for its static readHeader method). Also added GBPTreePartialCreateFuzzIT that, through randomized testing, has the ability to uncover even more cases in the future.
- Loading branch information
Showing
3 changed files
with
205 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
115 changes: 115 additions & 0 deletions
115
...nity/index/src/test/java/org/neo4j/index/internal/gbptree/GBPTreePartialCreateFuzzIT.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| /* | ||
| * Copyright (c) 2002-2018 "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 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.index.internal.gbptree; | ||
|
|
||
| import org.junit.Rule; | ||
| import org.junit.Test; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.util.concurrent.ThreadLocalRandom; | ||
|
|
||
| import org.neo4j.io.fs.DefaultFileSystemAbstraction; | ||
| import org.neo4j.io.fs.FileSystemAbstraction; | ||
| import org.neo4j.io.pagecache.PageCache; | ||
| import org.neo4j.io.pagecache.impl.SingleFilePageSwapperFactory; | ||
| import org.neo4j.io.pagecache.impl.muninn.MuninnPageCache; | ||
| import org.neo4j.io.pagecache.tracing.PageCacheTracer; | ||
| import org.neo4j.io.pagecache.tracing.cursor.PageCursorTracerSupplier; | ||
| import org.neo4j.test.rule.PageCacheAndDependenciesRule; | ||
| import org.neo4j.test.rule.fs.DefaultFileSystemRule; | ||
|
|
||
| import static org.junit.Assert.assertNotEquals; | ||
|
|
||
| import static java.lang.ProcessBuilder.Redirect.INHERIT; | ||
| import static java.util.Arrays.asList; | ||
| import static org.neo4j.graphdb.config.Configuration.EMPTY; | ||
| import static org.neo4j.index.internal.gbptree.GBPTree.NO_HEADER_READER; | ||
| import static org.neo4j.io.ByteUnit.kibiBytes; | ||
|
|
||
| /** | ||
| * Tests functionality around process crashing, or similar, when having started, but not completed creation of an index file, | ||
| * i.e. opening an index file for the first time. | ||
| * | ||
| * This test is an asset in finding potentially new issues regarding partially created index files over time. | ||
| * It will not guarantee, in one run, that every case has been covered. There are other specific test cases for that. | ||
| * When this test finds a new issue that should be encoded into a proper unit test in {@link GBPTreeTest} or similar. | ||
| */ | ||
| public class GBPTreePartialCreateFuzzIT | ||
| { | ||
| @Rule | ||
| public final PageCacheAndDependenciesRule storage = new PageCacheAndDependenciesRule( DefaultFileSystemRule::new, getClass() ); | ||
|
|
||
| @Test | ||
| public void shouldDetectAndThrowIOExceptionOnPartiallyCreatedFile() throws Exception | ||
| { | ||
| // given a crashed-on-open index | ||
| File file = storage.directory().file( "index" ); | ||
| Process process = new ProcessBuilder( asList( "java", "-cp", System.getProperty( "java.class.path" ), getClass().getName(), | ||
| file.getAbsolutePath() ) ).redirectError( INHERIT ).redirectOutput( INHERIT ).start(); | ||
| Thread.sleep( ThreadLocalRandom.current().nextInt( 1_000 ) ); | ||
| int exitCode = process.destroyForcibly().waitFor(); | ||
|
|
||
| // then reading it should either work or throw IOException | ||
| try ( PageCache pageCache = storage.pageCache() ) | ||
| { | ||
| SimpleLongLayout layout = new SimpleLongLayout(); | ||
|
|
||
| // check readHeader | ||
| try | ||
| { | ||
| GBPTree.readHeader( pageCache, file, layout, NO_HEADER_READER ); | ||
| } | ||
| catch ( IOException e ) | ||
| { | ||
| // It's OK if the process was destroyed | ||
| assertNotEquals( 0, exitCode ); | ||
| } | ||
|
|
||
| // check constructor | ||
| try | ||
| { | ||
| new GBPTreeBuilder<>( pageCache, file, layout ).build().close(); | ||
| } | ||
| catch ( IOException e ) | ||
| { | ||
| // It's OK if the process was destroyed | ||
| assertNotEquals( 0, exitCode ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public static void main( String[] args ) throws IOException | ||
| { | ||
| // Just start and immediately close. The process spawning this subprocess will kill it in the middle of all this | ||
| File file = new File( args[0] ); | ||
| try ( FileSystemAbstraction fs = new DefaultFileSystemAbstraction() ) | ||
| { | ||
| SingleFilePageSwapperFactory swapper = new SingleFilePageSwapperFactory(); | ||
| swapper.open( fs, EMPTY ); | ||
| try ( PageCache pageCache = new MuninnPageCache( swapper, 10, (int) kibiBytes( 8 ), | ||
| PageCacheTracer.NULL, PageCursorTracerSupplier.NULL ) ) | ||
| { | ||
| fs.deleteFile( file ); | ||
| new GBPTreeBuilder<>( pageCache, file, new SimpleLongLayout() ).build().close(); | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters