Package org.apache.lucene.tests.index
Class BaseTermVectorsFormatTestCase
- java.lang.Object
-
- org.junit.Assert
-
- org.apache.lucene.tests.util.LuceneTestCase
-
- org.apache.lucene.tests.index.BaseTermVectorsFormatTestCase
-
public abstract class BaseTermVectorsFormatTestCase extends LuceneTestCase
Base class aiming at testingterm vectors formats
. To test a new format, all you need is to register a newCodec
which uses it and extend this class and overridegetCodec()
.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
BaseTermVectorsFormatTestCase.Options
A combination of term vectors options.protected class
BaseTermVectorsFormatTestCase.RandomDocument
Randomly generated document: call toDocument to index itprotected class
BaseTermVectorsFormatTestCase.RandomDocumentFactory
Factory for generating random documents, call newDocument to generate each onestatic class
BaseTermVectorsFormatTestCase.RandomTokenStream
Produces a random TokenStream based off of provided terms.-
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 BaseTermVectorsFormatTestCase()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected Document
addId(Document doc, String id)
protected void
addRandomFields(Document doc)
Add random fields to the provided document.protected <D extends Directory>
DapplyCreatedVersionMajor(D d)
Set the created version of the givenDirectory
and return it.protected void
assertEquals(BaseTermVectorsFormatTestCase.RandomDocument doc, Fields fields)
protected void
assertEquals(BaseTermVectorsFormatTestCase.RandomTokenStream tk, FieldType ft, Terms terms)
protected int
docID(IndexReader reader, String id)
protected static boolean
equals(Object o1, Object o2)
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 FieldType
fieldType(BaseTermVectorsFormatTestCase.Options options)
protected abstract Codec
getCodec()
Returns the codec to run tests againstprotected int
getCreatedVersionMajor()
Returns the major version that this codec is compatible with.protected Class<? extends Throwable>
getReadPastLastPositionExceptionClass()
protected DirectoryReader
maybeWrapWithMergingReader(DirectoryReader r)
protected boolean
mergeIsStable()
protected BaseTermVectorsFormatTestCase.Options
randomOptions()
void
setUp()
For subclasses to override.protected boolean
shouldTestMergeInstance()
Returnsfalse
if only the regular fields reader should be tested, andtrue
if only the merge instance should be tested.void
tearDown()
For subclasses to override.void
testCheckIntegrityReadsAllBytes()
This test is a best effort at verifying that checkIntegrity doesn't miss any files.void
testClone()
void
testHighFreqs()
void
testLotsOfFields()
void
testMerge()
void
testMergeStability()
The purpose of this test is to make sure that bulk merge doesn't accumulate useless data over runs.void
testMergeWithDeletes()
void
testMergeWithIndexSort()
void
testMergeWithIndexSortAndDeletes()
void
testMixedOptions()
void
testMultiClose()
Calls close multiple times on closeable codec apisvoid
testPostingsEnumAll()
void
testPostingsEnumFreqs()
void
testPostingsEnumOffsets()
void
testPostingsEnumOffsetsWithoutPositions()
void
testPostingsEnumPayloads()
void
testPostingsEnumPositions()
void
testRandom()
void
testRandomExceptions()
Tests exception handling on write and openInput/createOutputvoid
testRareVectors()
protected Set<BaseTermVectorsFormatTestCase.Options>
validOptions()
-
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, newSnapshotIndexWriterConfig, newStringField, newStringField, newStringField, newStringField, newTextField, newTextField, newTieredMergePolicy, newTieredMergePolicy, overrideDefaultQueryCache, overrideTestDefaultQueryCache, random, randomLocale, randomTimeZone, rarely, rarely, replaceMaxFailureRule, resetDefaultQueryCache, restoreCPUCoreCount, restoreIndexWriterMaxDocs, runWithRestrictedPermissions, setIndexWriterMaxDocs, setupCPUCoreCount, setUpExecutorService, shutdownExecutorService, 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
-
-
-
-
Method Detail
-
validOptions
protected Set<BaseTermVectorsFormatTestCase.Options> validOptions()
-
randomOptions
protected BaseTermVectorsFormatTestCase.Options randomOptions()
-
fieldType
protected FieldType fieldType(BaseTermVectorsFormatTestCase.Options options)
-
addRandomFields
protected void addRandomFields(Document doc)
Add random fields to the provided document.
-
assertEquals
protected void assertEquals(BaseTermVectorsFormatTestCase.RandomDocument doc, Fields fields) throws IOException
- Throws:
IOException
-
assertEquals
protected void assertEquals(BaseTermVectorsFormatTestCase.RandomTokenStream tk, FieldType ft, Terms terms) throws IOException
- Throws:
IOException
-
getReadPastLastPositionExceptionClass
protected Class<? extends Throwable> getReadPastLastPositionExceptionClass()
-
docID
protected int docID(IndexReader reader, String id) throws IOException
- Throws:
IOException
-
testRareVectors
public void testRareVectors() throws IOException
- Throws:
IOException
-
testHighFreqs
public void testHighFreqs() throws IOException
- Throws:
IOException
-
testLotsOfFields
public void testLotsOfFields() throws IOException
- Throws:
IOException
-
testMixedOptions
public void testMixedOptions() throws IOException
- Throws:
IOException
-
testRandom
public void testRandom() throws IOException
- Throws:
IOException
-
testMerge
public void testMerge() throws IOException
- Throws:
IOException
-
testMergeWithDeletes
public void testMergeWithDeletes() throws IOException
- Throws:
IOException
-
testMergeWithIndexSort
public void testMergeWithIndexSort() throws IOException
- Throws:
IOException
-
testMergeWithIndexSortAndDeletes
public void testMergeWithIndexSortAndDeletes() throws IOException
- Throws:
IOException
-
testClone
public void testClone() throws IOException, InterruptedException
- Throws:
IOException
InterruptedException
-
testPostingsEnumPositions
public void testPostingsEnumPositions() throws Exception
- Throws:
Exception
-
testPostingsEnumOffsetsWithoutPositions
public void testPostingsEnumOffsetsWithoutPositions() throws Exception
- Throws:
Exception
-
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 givenDirectory
and return it.- Throws:
IOException
-
setUp
public void setUp() throws Exception
Description copied from class:LuceneTestCase
For subclasses to override. Overrides must callsuper.setUp()
.- Overrides:
setUp
in classLuceneTestCase
- Throws:
Exception
-
tearDown
public void tearDown() throws Exception
Description copied from class:LuceneTestCase
For subclasses to override. Overrides must callsuper.tearDown()
.- Overrides:
tearDown
in classLuceneTestCase
- 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
-
mergeIsStable
protected boolean mergeIsStable()
-
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()
Returnsfalse
if only the regular fields reader should be tested, andtrue
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
-
-