Package org.elasticsearch.index.mapper

Class BlockLoaderTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.tests.util.LuceneTestCase

org.elasticsearch.test.ESTestCase

org.elasticsearch.index.mapper.FieldTypeTestCase

org.elasticsearch.index.mapper.MapperServiceTestCase

org.elasticsearch.index.mapper.BlockLoaderTestCase

Direct Known Subclasses:

BinaryDVBlockLoaderTestCase, NumberFieldBlockLoaderTestCase

public abstract class BlockLoaderTestCase
extends MapperServiceTestCase

Test case for MappedFieldType.blockLoader(org.elasticsearch.index.mapper.MappedFieldType.BlockLoaderContext) specializing in configuring the mapping and invoking BlockLoader. See AbstractBlockLoaderTestCase for tests that don't require setting up a field mapper. TODO rename this.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	BlockLoaderTestCase.Params
static final record	BlockLoaderTestCase.TestContext

Nested classes/interfaces inherited from class org.elasticsearch.index.mapper.MapperServiceTestCase

MapperServiceTestCase.TestMapperServiceBuilder

Nested classes/interfaces inherited from class org.elasticsearch.test.ESTestCase

ESTestCase.DeprecationWarning, ESTestCase.EntitledTestPackages, ESTestCase.GeohashGenerator, ESTestCase.TestAnalysis, ESTestCase.WithEntitlementsOnTestCode, ESTestCase.WithoutEntitlements

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

org.apache.lucene.tests.util.LuceneTestCase.AwaitsFix, org.apache.lucene.tests.util.LuceneTestCase.Concurrency, org.apache.lucene.tests.util.LuceneTestCase.Monster, org.apache.lucene.tests.util.LuceneTestCase.Nightly, org.apache.lucene.tests.util.LuceneTestCase.SuppressAssertingFormats, org.apache.lucene.tests.util.LuceneTestCase.SuppressCodecs, org.apache.lucene.tests.util.LuceneTestCase.SuppressFileSystems, org.apache.lucene.tests.util.LuceneTestCase.SuppressFsync, org.apache.lucene.tests.util.LuceneTestCase.SuppressReproduceLine, org.apache.lucene.tests.util.LuceneTestCase.SuppressSysoutChecks, org.apache.lucene.tests.util.LuceneTestCase.SuppressTempFileChecks, org.apache.lucene.tests.util.LuceneTestCase.ThrowingConsumer<T>, org.apache.lucene.tests.util.LuceneTestCase.ThrowingRunnable, org.apache.lucene.tests.util.LuceneTestCase.Weekly

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	fieldName
protected final BlockLoaderTestCase.Params	params
protected static final MappedFieldType.FieldExtractPreference[]	PREFERENCES
static final ByteSizeValue	TEST_BREAKER_SIZE	A large enough size that loading the field won't circuit break.

Fields inherited from class org.elasticsearch.index.mapper.MapperServiceTestCase

INCLUDE_DEFAULTS, SETTINGS

Fields inherited from class org.elasticsearch.index.mapper.FieldTypeTestCase

MOCK_CONTEXT, MOCK_CONTEXT_DISALLOW_EXPENSIVE

Fields inherited from class org.elasticsearch.test.ESTestCase

checkIndexFailures, DEFAULT_DELTA, DEFAULT_TEST_WORKER_ID, failureAndSuccessEvents, FIPS_SYSPROP, JAVA_TIMEZONE_IDS, JAVA_ZONE_IDS, logger, MIN_PRIVATE_PORT, previousFailureSkipsRemainingRule, SAFE_AWAIT_TIMEOUT, TEMPLATE_DECORATOR_RULE, TEST_ENTITLEMENTS, TEST_REQUEST_TIMEOUT, TEST_WORKER_SYS_PROPERTY, TEST_WORKER_VM_ID, threadContext, UNSIGNED_LONG_MAX

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_FAILFAST, SYSPROP_MAXFAILURES, SYSPROP_MONSTER, SYSPROP_NIGHTLY, SYSPROP_WEEKLY, TEST_ASSERTS_ENABLED, TEST_AWAITSFIX, TEST_CODEC, TEST_DIRECTORY, TEST_DOCVALUESFORMAT, TEST_LINE_DOCS_FILE, TEST_MONSTER, TEST_NIGHTLY, TEST_POSTINGSFORMAT, TEST_THROTTLING, TEST_WEEKLY, VERBOSE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BlockLoaderTestCase(String fieldType, Collection<DataSourceHandler> customDataSourceHandlers, BlockLoaderTestCase.Params params)
protected	BlockLoaderTestCase(String fieldType, BlockLoaderTestCase.Params params)

Method Summary

Modifier and Type	Method	Description
static List<Object[]>	args()
static DataGeneratorSpecification	buildSpecification(Collection<DataSourceHandler> customHandlers)
protected BlockLoaderTestRunner	configureRunner(BlockLoaderTestRunner runner, Settings.Builder settings, Mapping mapping)
protected abstract Object	expected(Map<String,Object> fieldMapping, Object value, BlockLoaderTestCase.TestContext testContext)	For a given mapping and input value, compute the value that will be in the block.
protected String	getFieldNameToLoad(String fieldName, Object value)
protected Object	getFieldValue(Map<String,Object> document, String fieldName)
protected Settings.Builder	getSettingsForParams()
static boolean	hasDocValues(Map<String,Object> fieldMapping, boolean defaultValue)
protected static Object	maybeFoldList(List<?> list)
protected boolean	supportsMultiField()
void	testBlockLoader()
void	testBlockLoaderForFieldInObject()
void	testBlockLoaderForFieldInObjectWithCranky()
void	testBlockLoaderOfMultiField()
void	testBlockLoaderOfMultiFieldWithCranky()
void	testBlockLoaderWithCranky()
void	testFieldHasValue()
void	testFieldHasValueWithEmptyFieldInfos()

Methods inherited from class org.elasticsearch.index.mapper.MapperServiceTestCase

compileScript, createDocumentMapper, createDocumentMapper, createDocumentMapper, createDocumentMapper, createIndexAnalyzers, createIndexAnalyzers, createIndexSettings, createIndexSettings, createLogsModeDocumentMapper, createMapperService, createMapperService, createMapperService, createMapperService, createMapperService, createMapperService, createMapperService, createMapperService, createMapperService, createMapperServiceWithNamespaceValidator, createSearchExecutionContext, createSearchExecutionContext, createSearchExecutionContext, createSytheticSourceMapperService, createTestMapperMetrics, createTimeSeriesModeDocumentMapper, dynamicMapping, fieldDataLookup, fieldDataLookup, fieldMapping, getIndexSettings, getIndexSettingsBuilder, getPlugins, getVersion, indexWriterForSyntheticSource, mapping, mappingNoSubobjects, mappingWithSubobjects, merge, merge, merge, merge, mergeDynamicUpdate, parseDynamicUpdate, parseMappings, randomIndexOptions, runtimeFieldMapping, runtimeMapping, source, source, source, source, source, syntheticSource, syntheticSource, syntheticSource, syntheticSource, topMapping, validateRoundTripReader, withAggregationContext, withAggregationContext, withAggregationContext, withAggregationContext, withLuceneIndex, withMapping, wrapInMockESDirectoryReader

Methods inherited from class org.elasticsearch.index.mapper.FieldTypeTestCase

fetchSourceValue, fetchSourceValue, fetchSourceValues, fetchStoredValue, getFieldInfoWithName, getMappedFieldType, randomMockContext

Methods inherited from class org.elasticsearch.test.ESTestCase

after, afterIfFailed, afterIfSuccessful, allBreakersMemoryReleased, asInstanceOf, assertArrayEquals, assertArrayEqualsPercent, assertArrayEqualsPercent, assertArrayEqualsPercent, assertBusy, assertBusy, assertCriticalWarnings, assertEquals, assertLeakDetected, assertSettingDeprecationsAndWarnings, assertThat, assertThat, assertWarnings, assertWarnings, before, between, buildEnvSettings, buildNewFakeTransportAddress, captureLoggingLevel, checkPreviousFailureSkipsRemaining, checkStaticState, compatibleMediaType, copyInstance, copyNamedWriteable, copyNamedWriteable, copyWriteable, copyWriteable, createDefaultIndexAnalyzers, createParser, createParser, createParser, createParser, createParser, createParser, createParserWithCompatibilityFor, createTestAnalysis, createTestAnalysis, createTestAnalysis, createThreadPool, defaultIndexSettings, embedInRandomBytes, emptyProject, enableBigArraysReleasedCheck, enableWarningsCheck, ensureAllContextsReleased, ensureAllSearchContextsReleased, ensureCheckIndexPassed, ensureNoWarnings, ensureSupportedLocale, expectThrows, expectThrows, expectThrows, expectThrows, fail, fail, filteredWarnings, flushThreadPoolExecutor, frequently, generateRandomStringArray, generateRandomStringArray, getDataPath, getPortRange, getResourceDataPath, getSuiteFailureMarker, getTestTransportPlugin, getTestTransportType, getWorkerBasePort, indexSettings, indexSettings, indexSettings, inFipsJvm, initTestSeed, isTurkishLocale, iterations, maybeSet, maybeWrapDirectoryInFilterDirectory, mockScript, newEnvironment, newEnvironment, newLimitedBreaker, newLimitedBreakerService, newNodeEnvironment, newNodeEnvironment, newSearcher, newSearcher, newSearcher, newSearcher, parserConfig, previousFailureSkipsRemaining, projectStateFromProject, projectStateFromProject, projectStateWithEmptyProject, randomAlphanumericOfLength, randomAlphaOfLength, randomAlphaOfLengthBetween, randomAlphaOfLengthOrNull, randomArray, randomArray, randomArrayOtherThan, randomArrayOtherThan, randomArrayOtherThan, randomArrayOtherThan, randomArrayOtherThan, randomArrayOtherThan, randomArrayOtherThan, randomArrayOtherThan, randomArrayOtherThan, randomBigInteger, randomBoolean, randomByte, randomByteArrayOfLength, randomByteBetween, randomBytesBetween, randomByteSizeValue, randomBytesReference, randomCompatibleMediaType, randomDateFormatterPattern, randomDouble, randomDoubleBetween, randomDoubles, randomDoubles, randomExecutor, randomFloat, randomFloatBetween, randomFloatOrNull, randomFrom, randomFrom, randomFrom, randomFrom, randomFrom, randomFrom, randomGaussianDouble, randomGeohash, randomIdentifier, randomIdentifier, randomIndexName, randomInstantBetween, randomInt, randomInt, randomIntBetween, randomIntOrNull, randomInts, randomInts, randomIp, randomList, randomList, randomLong, randomLong, randomLongBetween, randomLongOrNull, randomLongs, randomLongs, randomMap, randomMillisUpToYear9999, randomNegativeInt, randomNegativeLong, randomNonEmptySubsetOf, randomNonNegativeByte, randomNonNegativeInt, randomNonNegativeIntOrNull, randomNonNegativeLong, randomNonNegativeLongOrNull, randomOptionalBoolean, randomOptionalDouble, randomPositiveTimeValue, randomProjectIdOrDefault, randomRealisticUnicodeOfCodepointLength, randomRealisticUnicodeOfCodepointLengthBetween, randomRealisticUnicodeOfLength, randomRealisticUnicodeOfLengthBetween, randomReleasableBytesReference, randomRepoName, randomSecretKey, randomSecureStringOfLength, randomSet, randomShort, randomSnapshotName, randomSubsetOf, randomSubsetOf, randomSubsetOf, randomTimeValue, randomTimeValue, randomTimeValue, randomTimeValueGreaterThan, randomTimeZone, randomUnicodeOfCodepointLength, randomUnicodeOfCodepointLengthBetween, randomUnicodeOfLength, randomUnicodeOfLengthBetween, randomUnique, randomUniqueProjectId, randomUnsignedLongBetween, randomUUID, randomValueOtherThan, randomValueOtherThanMany, randomVendorType, randomZone, removeHeaderWarningAppender, resetCheckIndexStatus, resetPortCounter, restoreContentType, restoreFileSystem, restoreLoggingLevel, runInParallel, runInParallel, safeAcquire, safeAcquire, safeAwait, safeAwait, safeAwait, safeAwait, safeAwait, safeAwait, safeAwaitAndUnwrapFailure, safeAwaitFailure, safeAwaitFailure, safeAwaitFailure, safeAwaitFailure, safeExecute, safeGet, safeGet, safeJoin, safeSleep, safeSleep, scaledRandomIntBetween, secureRandom, secureRandom, secureRandomFips, secureRandomFips, secureRandomNonFips, secureRandomNonFips, setContentType, setFileSystem, setHeaderWarningAppender, settings, shouldFailureSkipRemainingTests, shuffledList, shuffledList, shuffleMap, shuffleXContent, shuffleXContent, skipTestWaitingForLuceneFix, spinForAtLeastNMilliseconds, spinForAtLeastOneMillisecond, startInParallel, terminate, terminate, tmpPaths, toShuffledXContent, toShuffledXContent, waitUntil, waitUntil, writableRegistry, xContentRegistry

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

addVirusChecker, assertDeletedDocsEquals, assertDocsAndPositionsEnumEquals, assertDocsEnumEquals, assertDocsSkippingEquals, assertDocValuesEquals, assertDocValuesEquals, assertDoubleUlpEquals, assertFieldInfosEquals, assertFloatUlpEquals, assertNormsEquals, assertPointsEquals, assertPositionsSkippingEquals, assertReaderEquals, assertReaderStatisticsEquals, assertStoredFieldEquals, assertStoredFieldsEquals, assertTermsEnumEquals, assertTermsEquals, assertTermsEquals, assertTermsStatisticsEquals, assertTermStatsEquals, assertTermVectorsEquals, asSet, assumeFalse, assumeNoException, assumeTrue, atLeast, atLeast, callStackContains, callStackContains, callStackContainsAnyOf, closeAfterSuite, closeAfterTest, collate, createTempDir, createTempDir, createTempFile, createTempFile, dumpArray, dumpIterator, ensureSaneIWCOnNightly, expectThrows, expectThrows, expectThrows, expectThrowsAnyOf, expectThrowsAnyOf, getDataInputStream, getJvmForkArguments, getOnlyLeafReader, getTestClass, getTestName, 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, newSnapshotIndexWriterConfig, newStringField, newStringField, newStringField, newStringField, newTextField, newTextField, newTieredMergePolicy, newTieredMergePolicy, overrideDefaultQueryCache, overrideTestDefaultQueryCache, random, randomLocale, randomTimeZone, randomVectorFormat, rarely, rarely, replaceMaxFailureRule, resetDefaultQueryCache, restoreCPUCoreCount, restoreIndexWriterMaxDocs, runWithRestrictedPermissions, setIndexWriterMaxDocs, setUp, setupCPUCoreCount, setUpExecutorService, shutdownExecutorService, slowFileExists, tearDown, 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, assertThrows, assertThrows, assertTrue, assertTrue, fail, fail

Methods inherited from class java.lang.Object

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

Field Details

PREFERENCES

protected static final MappedFieldType.FieldExtractPreference[] PREFERENCES

TEST_BREAKER_SIZE

public static final ByteSizeValue TEST_BREAKER_SIZE

A large enough size that loading the field won't circuit break.

params

protected final BlockLoaderTestCase.Params params

fieldName

protected final String fieldName

Constructor Details

BlockLoaderTestCase

protected BlockLoaderTestCase(String fieldType,
 BlockLoaderTestCase.Params params)

BlockLoaderTestCase

protected BlockLoaderTestCase(String fieldType,
 Collection<DataSourceHandler> customDataSourceHandlers,
 BlockLoaderTestCase.Params params)

Method Details

args

@ParametersFactory(argumentFormatting="preference=%s")
public static List<Object[]> args()

testFieldHasValue

public void testFieldHasValue()

Overrides:

testFieldHasValue in class FieldTypeTestCase

testFieldHasValueWithEmptyFieldInfos

public void testFieldHasValueWithEmptyFieldInfos()

Overrides:

testFieldHasValueWithEmptyFieldInfos in class FieldTypeTestCase

getFieldNameToLoad

protected String getFieldNameToLoad(String fieldName,
 Object value)

testBlockLoader

public void testBlockLoader()
                     throws IOException

Throws:

IOException

testBlockLoaderWithCranky

public void testBlockLoaderWithCranky()
                               throws IOException

Throws:

IOException

configureRunner

protected BlockLoaderTestRunner configureRunner(BlockLoaderTestRunner runner,
 Settings.Builder settings,
 Mapping mapping)

testBlockLoaderForFieldInObject

public void testBlockLoaderForFieldInObject()
                                     throws IOException

Throws:

IOException

testBlockLoaderForFieldInObjectWithCranky

public void testBlockLoaderForFieldInObjectWithCranky()
                                               throws IOException

Throws:

IOException

supportsMultiField

protected boolean supportsMultiField()

testBlockLoaderOfMultiField

public void testBlockLoaderOfMultiField()
                                 throws IOException

Throws:

IOException

testBlockLoaderOfMultiFieldWithCranky

public void testBlockLoaderOfMultiFieldWithCranky()
                                           throws IOException

Throws:

IOException

getSettingsForParams

protected Settings.Builder getSettingsForParams()

buildSpecification

public static DataGeneratorSpecification buildSpecification(Collection<DataSourceHandler> customHandlers)

expected

protected abstract Object expected(Map<String,Object> fieldMapping,
 Object value,
 BlockLoaderTestCase.TestContext testContext)

For a given mapping and input value, compute the value that will be in the block. Values are generated from the DocumentGenerator, and the behavior can be controled by writing a custom DataSourceHandler.

Parameters:

fieldMapping - Generated parameters for this field mapping

value - Generated input value to convert

testContext - Context information for the current test run

Returns:

The value that will be added to the block

maybeFoldList

protected static Object maybeFoldList(List<?> list)

getFieldValue

protected Object getFieldValue(Map<String,Object> document,
 String fieldName)

hasDocValues

public static boolean hasDocValues(Map<String,Object> fieldMapping,
 boolean defaultValue)