org.apache.lucene.index

Class BasePostingsFormatTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.util.LuceneTestCase

org.apache.lucene.index.BasePostingsFormatTestCase

public abstract class BasePostingsFormatTestCase
extends LuceneTestCase

Abstract class to do basic tests for a postings format. NOTE: This test focuses on the postings (docs/freqs/positions/payloads/offsets) impl, not the terms dict. The [stretch] goal is for this test to be so thorough in testing a new PostingsFormat that if this test passes, then all Lucene/Solr tests should also pass. Ie, if there is some bug in a given PostingsFormat 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.util.LuceneTestCase

LuceneTestCase.AwaitsFix, LuceneTestCase.BadApple, LuceneTestCase.Monster, LuceneTestCase.Nightly, LuceneTestCase.Slow, LuceneTestCase.SuppressCodecs, LuceneTestCase.SuppressSysoutChecks, LuceneTestCase.SuppressTempFileChecks, LuceneTestCase.Weekly

Field Summary

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

classRules, DEFAULT_LINE_DOCS_FILE, doesntSupportOffsets, INFOSTREAM, JENKINS_LARGE_LINE_DOCS_FILE, LEAVE_TEMPORARY, OLD_FORMAT_IMPERSONATION_IS_ACTIVE, RANDOM_MULTIPLIER, ruleChain, SYSPROP_AWAITSFIX, SYSPROP_BADAPPLES, SYSPROP_FAILFAST, SYSPROP_MAXFAILURES, SYSPROP_MONSTER, SYSPROP_NIGHTLY, SYSPROP_SLOW, SYSPROP_WEEKLY, TEST_AWAITSFIX, TEST_CODEC, TEST_DIRECTORY, TEST_DOCVALUESFORMAT, TEST_LINE_DOCS_FILE, TEST_NIGHTLY, TEST_POSTINGSFORMAT, TEST_SLOW, TEST_THROTTLING, TEST_VERSION_CURRENT, TEST_WEEKLY, VERBOSE

Constructor Summary

Constructors

Constructor and Description
BasePostingsFormatTestCase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addRandomFields(Document doc) Add random fields to the provided document.
static void	afterClass()
static void	createPostings()
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
void	setUp() For subclasses to override.
void	tearDown() For subclasses to override.
void	testDocsAndFreqs()
void	testDocsAndFreqsAndPositions()
void	testDocsAndFreqsAndPositionsAndOffsets()
void	testDocsAndFreqsAndPositionsAndOffsetsAndPayloads()
void	testDocsAndFreqsAndPositionsAndPayloads()
void	testDocsOnly()
void	testMergeStability() The purpose of this test is to make sure that bulk merge doesn't accumulate useless data over runs.
void	testRamBytesUsed() Test the accuracy of the ramBytesUsed estimations.
void	testRandom()

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

assertDeletedDocsEquals, assertDocsAndPositionsEnumEquals, assertDocsEnumEquals, assertDocsSkippingEquals, assertDocValuesEquals, assertDocValuesEquals, assertFieldInfosEquals, assertFieldsEquals, assertFieldStatisticsEquals, assertNormsEquals, assertPositionsSkippingEquals, assertReaderEquals, assertReaderStatisticsEquals, assertSaneFieldCaches, assertStoredFieldEquals, assertStoredFieldsEquals, assertTermsEnumEquals, assertTermsEquals, assertTermsStatisticsEquals, assertTermStatsEquals, assertTermVectorsEquals, asSet, assumeFalse, assumeNoException, assumeTrue, atLeast, atLeast, closeAfterSuite, closeAfterTest, createTempDir, createTempDir, createTempFile, createTempFile, defaultCodecSupportsDocsWithField, defaultCodecSupportsDocValues, defaultCodecSupportsFieldUpdates, defaultCodecSupportsMissingDocValues, defaultCodecSupportsSortedNumeric, defaultCodecSupportsSortedSet, dumpArray, dumpIterator, getBaseTempDirForTestClass, getDataFile, getOnlySegmentReader, getTestClass, getTestName, isTestThread, localeForName, maybeChangeLiveIndexWriterConfig, maybeWrapReader, newAlcoholicMergePolicy, newAlcoholicMergePolicy, newDirectory, newDirectory, newDirectory, newDirectory, newField, newField, newFSDirectory, newFSDirectory, newIndexWriterConfig, newIndexWriterConfig, newIOContext, newIOContext, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newLogMergePolicy, newMergePolicy, newMergePolicy, newMockDirectory, newMockDirectory, newMockFSDirectory, newSearcher, newSearcher, newSearcher, newStringField, newStringField, newTextField, newTextField, newTieredMergePolicy, newTieredMergePolicy, random, randomLocale, randomTimeZone, rarely, rarely, replaceMaxFailureRule, slowFileExists, usually, usually

Methods inherited from class org.junit.Assert

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, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertThat, assertThat, assertTrue, assertTrue, fail, fail

Methods inherited from class java.lang.Object

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

Constructor Detail

BasePostingsFormatTestCase

public BasePostingsFormatTestCase()

Method Detail

createPostings

public static void createPostings()
                           throws IOException

Throws:

IOException

afterClass

public static void afterClass()
                       throws Exception

Throws:

Exception

testDocsOnly

public void testDocsOnly()
                  throws Exception

Throws:

Exception

testDocsAndFreqs

public void testDocsAndFreqs()
                      throws Exception

Throws:

Exception

testDocsAndFreqsAndPositions

public void testDocsAndFreqsAndPositions()
                                  throws Exception

Throws:

Exception

testDocsAndFreqsAndPositionsAndPayloads

public void testDocsAndFreqsAndPositionsAndPayloads()
                                             throws Exception

Throws:

Exception

testDocsAndFreqsAndPositionsAndOffsets

public void testDocsAndFreqsAndPositionsAndOffsets()
                                            throws Exception

Throws:

Exception

testDocsAndFreqsAndPositionsAndOffsetsAndPayloads

public void testDocsAndFreqsAndPositionsAndOffsetsAndPayloads()
                                                       throws Exception

Throws:

Exception

testRandom

public void testRandom()
                throws Exception

Throws:

Exception

addRandomFields

protected void addRandomFields(Document doc)

Add random fields to the provided document.

getCodec

protected abstract Codec getCodec()

Returns the codec to run tests against

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

testRamBytesUsed

public void testRamBytesUsed()
                      throws IOException

Test the accuracy of the ramBytesUsed estimations.

Throws:

IOException