Package org.apache.lucene.tests.index

Class BasePointsFormatTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.tests.util.LuceneTestCase

org.apache.lucene.tests.index.BasePointsFormatTestCase

public abstract class BasePointsFormatTestCase
extends LuceneTestCase

Abstract class to do basic tests for a points format. NOTE: This test focuses on the points impl, nothing else. The [stretch] goal is for this test to be so thorough in testing a new PointsFormat that if this test passes, then all Lucene/Solr tests should also pass. Ie, if there is some bug in a given PointsFormat that this test fails to catch then this test needs to be improved!

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.tests.util.LuceneTestCase

LuceneTestCase.AwaitsFix, LuceneTestCase.BadApple, LuceneTestCase.Monster, LuceneTestCase.Nightly, LuceneTestCase.SuppressCodecs, LuceneTestCase.SuppressFileSystems, LuceneTestCase.SuppressFsync, LuceneTestCase.SuppressReproduceLine, LuceneTestCase.SuppressSysoutChecks, LuceneTestCase.SuppressTempFileChecks, LuceneTestCase.ThrowingConsumer<T>, LuceneTestCase.ThrowingRunnable, LuceneTestCase.Weekly

Field Summary

Fields inherited from class org.apache.lucene.tests.util.LuceneTestCase

assertsAreEnabled, classRules, DEFAULT_LINE_DOCS_FILE, INFOSTREAM, JENKINS_LARGE_LINE_DOCS_FILE, LEAVE_TEMPORARY, MAYBE_CACHE_POLICY, RANDOM_MULTIPLIER, ruleChain, suiteFailureMarker, SYSPROP_AWAITSFIX, SYSPROP_BADAPPLES, SYSPROP_FAILFAST, SYSPROP_MAXFAILURES, SYSPROP_MONSTER, SYSPROP_NIGHTLY, SYSPROP_WEEKLY, TEST_ASSERTS_ENABLED, TEST_AWAITSFIX, TEST_BADAPPLES, TEST_CODEC, TEST_DIRECTORY, TEST_DOCVALUESFORMAT, TEST_LINE_DOCS_FILE, TEST_MONSTER, TEST_NIGHTLY, TEST_POSTINGSFORMAT, TEST_THROTTLING, TEST_WEEKLY, VERBOSE

Constructor Summary

Constructors

Constructor	Description
BasePointsFormatTestCase()

Method Summary

Modifier and Type	Method	Description
protected void	addRandomFields(Document doc)	Add random fields to the provided document.
protected <D extends Directory> D	applyCreatedVersionMajor(D d)	Set the created version of the given Directory and return it.
protected Collection<String>	excludedExtensionsFromByteCounts()	Return the list of extensions that should be excluded from byte counts when comparing indices that store the same content.
protected abstract Codec	getCodec()	Returns the codec to run tests against
protected int	getCreatedVersionMajor()	Returns the major version that this codec is compatible with.
protected DirectoryReader	maybeWrapWithMergingReader(DirectoryReader r)
protected boolean	mergeIsStable()
void	setUp()	For subclasses to override.
protected boolean	shouldTestMergeInstance()	Returns false if only the regular fields reader should be tested, and true if only the merge instance should be tested.
void	tearDown()	For subclasses to override.
void	testAddIndexes()
void	testAllEqual()
void	testAllPointDocsDeletedInSegment()
void	testBasic()
void	testBigIntNDims()
void	testCheckIntegrityReadsAllBytes()	This test is a best effort at verifying that checkIntegrity doesn't miss any files.
void	testDocCountEdgeCases()
void	testMerge()
void	testMergeMissing()
void	testMergeStability()	The purpose of this test is to make sure that bulk merge doesn't accumulate useless data over runs.
void	testMultiClose()	Calls close multiple times on closeable codec apis
void	testMultiValued()
void	testOneDimEqual()
void	testOneDimTwoValues()
void	testRandomBinaryBig()
void	testRandomBinaryMedium()
void	testRandomBinaryTiny()
void	testRandomDocCount()
void	testRandomExceptions()	Tests exception handling on write and openInput/createOutput
void	testWithExceptions()	Make sure we close open files, delete temp files, etc., on exception

Methods inherited from class org.apache.lucene.tests.util.LuceneTestCase

addVirusChecker, assertDeletedDocsEquals, assertDocsAndPositionsEnumEquals, assertDocsEnumEquals, assertDocsSkippingEquals, assertDocValuesEquals, assertDocValuesEquals, assertFieldInfosEquals, assertNormsEquals, assertPointsEquals, assertPositionsSkippingEquals, assertReaderEquals, assertReaderStatisticsEquals, assertStoredFieldEquals, assertStoredFieldsEquals, assertTermsEnumEquals, assertTermsEquals, assertTermsEquals, assertTermsStatisticsEquals, assertTermStatsEquals, assertTermVectorsEquals, asSet, assumeFalse, assumeNoException, assumeTrue, assumeWorkingMMapOnWindows, atLeast, atLeast, callStackContains, callStackContains, callStackContainsAnyOf, closeAfterSuite, closeAfterTest, collate, createTempDir, createTempDir, createTempFile, createTempFile, dumpArray, dumpIterator, ensureSaneIWCOnNightly, expectThrows, expectThrows, expectThrows, expectThrowsAnyOf, expectThrowsAnyOf, getDataInputStream, getDataPath, getJvmForkArguments, getOnlyLeafReader, getTestClass, getTestName, hasWorkingMMapOnWindows, isTestThread, localeForLanguageTag, maybeChangeLiveIndexWriterConfig, maybeWrapReader, newAlcoholicMergePolicy, newAlcoholicMergePolicy, newBytesRef, newBytesRef, newBytesRef, newBytesRef, newBytesRef, newBytesRef, newDirectory, newDirectory, newDirectory, newDirectory, newDirectory, newField, newField, newFSDirectory, newFSDirectory, newIndexWriterConfig, newIndexWriterConfig, newIndexWriterConfig, newIOContext, newIOContext, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newMaybeVirusCheckingDirectory, newMaybeVirusCheckingFSDirectory, newMergePolicy, newMergePolicy, newMergePolicy, newMockDirectory, newMockDirectory, newMockDirectory, newMockFSDirectory, newMockFSDirectory, newSearcher, newSearcher, newSearcher, newSearcher, newStringField, newStringField, newStringField, newStringField, newTextField, newTextField, newTieredMergePolicy, newTieredMergePolicy, overrideDefaultQueryCache, overrideTestDefaultQueryCache, random, randomLocale, randomTimeZone, rarely, rarely, replaceMaxFailureRule, resetDefaultQueryCache, restoreCPUCoreCount, restoreIndexWriterMaxDocs, runWithRestrictedPermissions, setIndexWriterMaxDocs, setupCPUCoreCount, slowFileExists, usually, usually, wrapReader

Methods inherited from class org.junit.Assert

assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertArrayEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotEquals, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertThat, assertThat, assertThrows, assertThrows, assertTrue, assertTrue, fail, fail

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasePointsFormatTestCase

public BasePointsFormatTestCase()

Method Detail

addRandomFields

protected void addRandomFields(Document doc)

Add random fields to the provided document.

testBasic

public void testBasic()
               throws Exception

Throws:

Exception

testMerge

public void testMerge()
               throws Exception

Throws:

Exception

testAllPointDocsDeletedInSegment

public void testAllPointDocsDeletedInSegment()
                                      throws Exception

Throws:

Exception

testWithExceptions

public void testWithExceptions()
                        throws Exception

Make sure we close open files, delete temp files, etc., on exception

Throws:

Exception

testMultiValued

public void testMultiValued()
                     throws Exception

Throws:

Exception

testAllEqual

public void testAllEqual()
                  throws Exception

Throws:

Exception

testOneDimEqual

public void testOneDimEqual()
                     throws Exception

Throws:

Exception

testOneDimTwoValues

public void testOneDimTwoValues()
                         throws Exception

Throws:

Exception

testBigIntNDims

public void testBigIntNDims()
                     throws Exception

Throws:

Exception

testRandomBinaryTiny

public void testRandomBinaryTiny()
                          throws Exception

Throws:

Exception

testRandomBinaryMedium

public void testRandomBinaryMedium()
                            throws Exception

Throws:

Exception

testRandomBinaryBig

@Nightly
public void testRandomBinaryBig()
                         throws Exception

Throws:

Exception

testAddIndexes

public void testAddIndexes()
                    throws IOException

Throws:

IOException

mergeIsStable

protected boolean mergeIsStable()

testMergeMissing

public void testMergeMissing()
                      throws Exception

Throws:

Exception

testDocCountEdgeCases

public void testDocCountEdgeCases()

testRandomDocCount

public void testRandomDocCount()

getCodec

protected abstract Codec getCodec()

Returns the codec to run tests against

getCreatedVersionMajor

protected int getCreatedVersionMajor()

Returns the major version that this codec is compatible with.

applyCreatedVersionMajor

protected final <D extends Directory> D applyCreatedVersionMajor(D d)
                                                          throws IOException

Set the created version of the given Directory and return it.

Throws:

IOException

setUp

public void setUp()
           throws Exception

Description copied from class: LuceneTestCase

For subclasses to override. Overrides must call super.setUp().

Overrides:

setUp in class LuceneTestCase

Throws:

Exception

tearDown

public void tearDown()
              throws Exception

Description copied from class: LuceneTestCase

For subclasses to override. Overrides must call super.tearDown().

Overrides:

tearDown in class LuceneTestCase

Throws:

Exception

excludedExtensionsFromByteCounts

protected Collection<String> excludedExtensionsFromByteCounts()

Return the list of extensions that should be excluded from byte counts when comparing indices that store the same content.

testMergeStability

public void testMergeStability()
                        throws Exception

The purpose of this test is to make sure that bulk merge doesn't accumulate useless data over runs.

Throws:

Exception

testMultiClose

public void testMultiClose()
                    throws IOException

Calls close multiple times on closeable codec apis

Throws:

IOException

testRandomExceptions

public void testRandomExceptions()
                          throws Exception

Tests exception handling on write and openInput/createOutput

Throws:

Exception

shouldTestMergeInstance

protected boolean shouldTestMergeInstance()

Returns false if only the regular fields reader should be tested, and true if only the merge instance should be tested.

maybeWrapWithMergingReader

protected final DirectoryReader maybeWrapWithMergingReader(DirectoryReader r)
                                                    throws IOException

Throws:

IOException

testCheckIntegrityReadsAllBytes

public void testCheckIntegrityReadsAllBytes()
                                     throws Exception

This test is a best effort at verifying that checkIntegrity doesn't miss any files. It tests that the combination of opening a reader and calling checkIntegrity on it reads all bytes of all files.

Throws:

Exception