BaseFieldInfoFormatTestCase (Grandparent POM for Apache Lucene Core and Apache Solr 7.7.0 API)

java.lang.Object
- org.junit.Assert
- - org.apache.lucene.util.LuceneTestCase
  - - org.apache.lucene.index.BaseFieldInfoFormatTestCase

```
public abstract class BaseFieldInfoFormatTestCase
extends LuceneTestCase
```
Abstract class to do basic tests for fis format. NOTE: This test focuses on the fis impl, nothing else. The [stretch] goal is for this test to be so thorough in testing a new fis format that if this test passes, then all Lucene/Solr tests should also pass. Ie, if there is some bug in a given fis Format 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.SuppressFileSystems, LuceneTestCase.SuppressFsync, LuceneTestCase.SuppressReproduceLine, LuceneTestCase.SuppressSysoutChecks, LuceneTestCase.SuppressTempFileChecks, LuceneTestCase.ThrowingRunnable, LuceneTestCase.Weekly

Field Summary
- Fields inherited from class org.apache.lucene.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_SLOW, 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_SLOW, TEST_THROTTLING, TEST_WEEKLY, VERBOSE

Constructor Summary

Constructors
Constructor and Description

BaseFieldInfoFormatTestCase()

Constructors
Constructor and Description
`BaseFieldInfoFormatTestCase()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addAttributes(FieldInfo fi)` Hook to add any codec attributes to fieldinfo instances added in this test.
`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 void`	`assertEquals(FieldInfo expected, FieldInfo actual)` equality for two individual fieldinfo objects
`protected void`	`assertEquals(FieldInfos expected, FieldInfos actual)` equality for entirety of fieldinfos
`protected java.util.Collection<java.lang.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 DocValuesType[]`	`getDocValuesTypes()` Deprecated. only for Only available to ancient codecs can limit this to the subset of types they support.
`protected boolean`	`mergeIsStable()`
`protected static SegmentInfo`	`newSegmentInfo(Directory dir, java.lang.String name)` Returns a new fake segment
`void`	`setUp()` For subclasses to override.
`void`	`tearDown()` For subclasses to override.
`void`	`testExceptionOnCloseInput()` Test field infos read that hits exception on close.
`void`	`testExceptionOnCloseOutput()` Test field infos write that hits exception on close.
`void`	`testExceptionOnCreateOutput()` Test field infos write that hits exception immediately on open.
`void`	`testExceptionOnOpenInput()` Test field infos read that hits exception immediately on open.
`void`	`testImmutableAttributes()` Test field infos attributes coming back are not mutable
`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`	`testOneField()` Test field infos read/write with a single field
`void`	`testRamBytesUsed()` Test the accuracy of the ramBytesUsed estimations.
`void`	`testRandom()` Test field infos read/write with random fields, with different values.
`void`	`testRandomExceptions()` Tests exception handling on write and openInput/createOutput

Methods inherited from class org.apache.lucene.util.LuceneTestCase
addVirusChecker, assertDeletedDocsEquals, assertDocsAndPositionsEnumEquals, assertDocsEnumEquals, assertDocsSkippingEquals, assertDocValuesEquals, assertDocValuesEquals, assertFieldInfosEquals, assertFieldsEquals, assertFieldStatisticsEquals, assertNormsEquals, assertPointsEquals, assertPositionsSkippingEquals, assertReaderEquals, assertReaderStatisticsEquals, assertStoredFieldEquals, assertStoredFieldsEquals, assertTermsEnumEquals, assertTermsEquals, assertTermsStatisticsEquals, assertTermStatsEquals, assertTermVectorsEquals, asSet, assumeFalse, assumeNoException, assumeTrue, assumeWorkingMMapOnWindows, atLeast, atLeast, closeAfterSuite, closeAfterTest, collate, createTempDir, createTempDir, createTempFile, createTempFile, dumpArray, dumpIterator, expectThrows, expectThrows, expectThrows, expectThrowsAnyOf, expectThrowsAnyOf, getBaseTempDirForTestClass, getDataInputStream, getDataPath, getOnlyLeafReader, getTestClass, getTestName, hasWorkingMMapOnWindows, isTestThread, localeForLanguageTag, maybeChangeLiveIndexWriterConfig, maybeWrapReader, newAlcoholicMergePolicy, newAlcoholicMergePolicy, 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, newStringField, newStringField, newStringField, newStringField, newTextField, newTextField, newTieredMergePolicy, newTieredMergePolicy, overrideDefaultQueryCache, overrideTestDefaultQueryCache, random, randomLocale, randomTimeZone, rarely, rarely, replaceMaxFailureRule, resetDefaultQueryCache, restoreCPUCoreCount, restoreIndexWriterMaxDocs, restoreSpins, runWithRestrictedPermissions, setIndexWriterMaxDocs, setupCPUCoreCount, setupSpins, 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
  - BaseFieldInfoFormatTestCase
```
public BaseFieldInfoFormatTestCase()
```
- Method Detail
  - testOneField
```
public void testOneField()
                  throws java.lang.Exception
```
    Test field infos read/write with a single field
    
    Throws:
    
    java.lang.Exception
  - testImmutableAttributes
```
public void testImmutableAttributes()
                             throws java.lang.Exception
```
    Test field infos attributes coming back are not mutable
    
    Throws:
    
    java.lang.Exception
  - testExceptionOnCreateOutput
```
public void testExceptionOnCreateOutput()
                                 throws java.lang.Exception
```
    Test field infos write that hits exception immediately on open. make sure we get our exception back, no file handle leaks, etc.
    
    Throws:
    
    java.lang.Exception
  - testExceptionOnCloseOutput
```
public void testExceptionOnCloseOutput()
                                throws java.lang.Exception
```
    Test field infos write that hits exception on close. make sure we get our exception back, no file handle leaks, etc.
    
    Throws:
    
    java.lang.Exception
  - testExceptionOnOpenInput
```
public void testExceptionOnOpenInput()
                              throws java.lang.Exception
```
    Test field infos read that hits exception immediately on open. make sure we get our exception back, no file handle leaks, etc.
    
    Throws:
    
    java.lang.Exception
  - testExceptionOnCloseInput
```
public void testExceptionOnCloseInput()
                               throws java.lang.Exception
```
    Test field infos read that hits exception on close. make sure we get our exception back, no file handle leaks, etc.
    
    Throws:
    
    java.lang.Exception
  - testRandom
```
public void testRandom()
                throws java.lang.Exception
```
    Test field infos read/write with random fields, with different values.
    
    Throws:
    
    java.lang.Exception
  - addAttributes
```
protected void addAttributes(FieldInfo fi)
```
    Hook to add any codec attributes to fieldinfo instances added in this test.
  - getDocValuesTypes
```
@Deprecated
protected DocValuesType[] getDocValuesTypes()
```
    Deprecated. only for Only available to ancient codecs can limit this to the subset of types they support.
    
    Docvalues types to test.
  - assertEquals
```
protected void assertEquals(FieldInfos expected,
                            FieldInfos actual)
```
    equality for entirety of fieldinfos
  - assertEquals
```
protected void assertEquals(FieldInfo expected,
                            FieldInfo actual)
```
    equality for two individual fieldinfo objects
  - newSegmentInfo
```
protected static SegmentInfo newSegmentInfo(Directory dir,
                                            java.lang.String name)
```
    Returns a new fake segment
  - addRandomFields
```
protected void addRandomFields(Document doc)
```
    Add random fields to the provided document.
  - testRamBytesUsed
```
public void testRamBytesUsed()
                      throws java.io.IOException
```
    Test the accuracy of the ramBytesUsed estimations.
    
    Throws:
    
    java.io.IOException
  - 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 java.io.IOException
```
    Set the created version of the given Directory and return it.
    
    Throws:
    
    java.io.IOException
  - setUp
```
public void setUp()
           throws java.lang.Exception
```
    Description copied from class: LuceneTestCase
    
    For subclasses to override. Overrides must call super.setUp().
    
    Overrides:
    
    setUp in class LuceneTestCase
    
    Throws:
    
    java.lang.Exception
  - tearDown
```
public void tearDown()
              throws java.lang.Exception
```
    Description copied from class: LuceneTestCase
    
    For subclasses to override. Overrides must call super.tearDown().
    
    Overrides:
    
    tearDown in class LuceneTestCase
    
    Throws:
    
    java.lang.Exception
  - excludedExtensionsFromByteCounts
```
protected java.util.Collection<java.lang.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 java.lang.Exception
```
    The purpose of this test is to make sure that bulk merge doesn't accumulate useless data over runs.
    
    Throws:
    
    java.lang.Exception
  - mergeIsStable
```
protected boolean mergeIsStable()
```
  - testMultiClose
```
public void testMultiClose()
                    throws java.io.IOException
```
    Calls close multiple times on closeable codec apis
    
    Throws:
    
    java.io.IOException
  - testRandomExceptions
```
public void testRandomExceptions()
                          throws java.lang.Exception
```
    Tests exception handling on write and openInput/createOutput
    
    Throws:
    
    java.lang.Exception

Class BaseFieldInfoFormatTestCase

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class org.junit.Assert

Methods inherited from class java.lang.Object

Constructor Detail

BaseFieldInfoFormatTestCase

Method Detail

testOneField

testImmutableAttributes

testExceptionOnCreateOutput

testExceptionOnCloseOutput

testExceptionOnOpenInput

testExceptionOnCloseInput

testRandom

addAttributes

getDocValuesTypes

assertEquals

assertEquals

newSegmentInfo

addRandomFields

testRamBytesUsed

getCodec

getCreatedVersionMajor

applyCreatedVersionMajor

setUp

tearDown

excludedExtensionsFromByteCounts

testMergeStability

mergeIsStable

testMultiClose

testRandomExceptions