Class ESIntegTestCase
- Direct Known Subclasses:
AbstractNumericTestCase
,AbstractSnapshotIntegTestCase
,AbstractTermsTestCase
,DiskUsageIntegTestCase
,ESBlobStoreRepositoryIntegTestCase
@SuppressFileSystems("ExtrasFS") public abstract class ESIntegTestCase extends ESTestCase
ESIntegTestCase
is an abstract base class to run integration
tests against a JVM private Elasticsearch Cluster. The test class supports 2 different
cluster scopes.
ESIntegTestCase.Scope.TEST
- uses a new cluster for each individual test method.ESIntegTestCase.Scope.SUITE
- uses a cluster shared across all test methods in the same suite
The most common test scope is ESIntegTestCase.Scope.SUITE
which shares a cluster per test suite.
If the test methods need specific node settings or change persistent and/or transient cluster settings ESIntegTestCase.Scope.TEST
should be used. To configure a scope for the test cluster the ESIntegTestCase.ClusterScope
annotation
should be used, here is an example:
@NodeScope(scope=Scope.TEST) public class SomeIT extends ESIntegTestCase { public void testMethod() {} }
If no ESIntegTestCase.ClusterScope
annotation is present on an integration test the default scope is ESIntegTestCase.Scope.SUITE
A test cluster creates a set of nodes in the background before the test starts. The number of nodes in the cluster is
determined at random and can change across tests. The ESIntegTestCase.ClusterScope
allows configuring the initial number of nodes
that are created before the tests start.
@NodeScope(scope=Scope.SUITE, numDataNodes=3) public class SomeIT extends ESIntegTestCase { public void testMethod() {} }
Note, the ESIntegTestCase
uses randomized settings on a cluster and index level. For instance
each test might use different directory implementation for each test or will return a random client to one of the
nodes in the cluster for each call to client()
. Test failures might only be reproducible if the correct
system properties are passed to the test execution environment.
This class supports the following system properties (passed with -Dkey=value to the application)
- -D"tests.client.ratio" - a double value in the interval [0..1] which defines the ration between node and transport clients used
- -D"tests.enable_mock_modules" - a boolean value to enable or disable mock modules. This is useful to test the system without asserting modules that to make sure they don't hide any bugs in production.
- - a random seed used to initialize the index random context.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ESIntegTestCase.AssertActionNamePlugin
static interface
ESIntegTestCase.ClusterScope
Defines a cluster scope for aESIntegTestCase
subclass.protected static class
ESIntegTestCase.NumShards
static class
ESIntegTestCase.Scope
The scope of a test cluster used together withESIntegTestCase.ClusterScope
annotations onESIntegTestCase
subclasses.static interface
ESIntegTestCase.SuiteScopeTestCase
If a test is annotated withESIntegTestCase.SuiteScopeTestCase
the checks and modifications that are applied to the used test cluster are only done after all tests of this class are executed.static class
ESIntegTestCase.TestSeedPlugin
static interface
ESIntegTestCase.ThirdParty
Annotation for third-party integration tests.Nested classes/interfaces inherited from class org.elasticsearch.test.ESTestCase
ESTestCase.GeohashGenerator, ESTestCase.TestAnalysis
Nested classes/interfaces inherited from class org.apache.lucene.util.LuceneTestCase
org.apache.lucene.util.LuceneTestCase.AwaitsFix, org.apache.lucene.util.LuceneTestCase.BadApple, org.apache.lucene.util.LuceneTestCase.Monster, org.apache.lucene.util.LuceneTestCase.Nightly, org.apache.lucene.util.LuceneTestCase.Slow, org.apache.lucene.util.LuceneTestCase.SuppressCodecs, org.apache.lucene.util.LuceneTestCase.SuppressFileSystems, org.apache.lucene.util.LuceneTestCase.SuppressFsync, org.apache.lucene.util.LuceneTestCase.SuppressReproduceLine, org.apache.lucene.util.LuceneTestCase.SuppressSysoutChecks, org.apache.lucene.util.LuceneTestCase.SuppressTempFileChecks, org.apache.lucene.util.LuceneTestCase.ThrowingRunnable, org.apache.lucene.util.LuceneTestCase.Weekly
-
Field Summary
Fields Modifier and Type Field Description protected static int
DEFAULT_MAX_NUM_SHARDS
Default maximum number of shards for an indexprotected static int
DEFAULT_MIN_NUM_SHARDS
Default minimum number of shards for an indexstatic org.elasticsearch.common.settings.Setting<java.lang.Long>
INDEX_TEST_SEED_SETTING
Key used to retrieve the index random seed from the index settings on a running node.static java.lang.String
SUITE_CLUSTER_NODE_PREFIX
node names of the corresponding clusters will start with these prefixesstatic java.lang.String
SYSPROP_THIRDPARTY
Property that controls whether ThirdParty Integration tests are run (not the default).static java.lang.String
TEST_CLUSTER_NODE_PREFIX
static java.lang.String
TESTS_CLIENT_RATIO
Key used to set the transport client ratio via the commandline -D"tests.client.ratio"static java.lang.String
TESTS_CLUSTER
Key used to eventually switch to using an external cluster and provide its transport addressesstatic java.lang.String
TESTS_ENABLE_MOCK_MODULES
A boolean value to enable or disable mock modules.Fields inherited from class org.elasticsearch.test.ESTestCase
checkIndexFailures, DEFAULT_NAMED_WRITABLE_REGISTRY, DEFAULT_TEST_WORKER_ID, failureAndSuccessEvents, FIPS_SYSPROP, JAVA_TIMEZONE_IDS, JAVA_ZONE_IDS, JODA_TIMEZONE_IDS, logger, MIN_PRIVATE_PORT, TEST_WORKER_SYS_PROPERTY, TEST_WORKER_VM_ID
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 Description ESIntegTestCase()
-
Method Summary
Modifier and Type Method Description protected boolean
addMockGeoShapeFieldMapper()
Returnstrue
iff this test cluster should use a dummy geo_shape field mapperprotected boolean
addMockHttpTransport()
Returnstrue
iff this test cluster should use a dummy http transportprotected boolean
addMockInternalEngine()
Returnstrue
if this test cluster can use a mock internal engine.protected boolean
addMockTransportService()
Iff this returns true mock transport implementations are used for the test runs.protected org.elasticsearch.client.AdminClient
admin()
Returns a random admin client.static void
afterClass()
void
allowNodes(java.lang.String index, int n)
Restricts the given index to be allocated onn
nodes using the allocation deciders.java.util.Set<java.lang.String>
assertAllShardsOnNodes(java.lang.String index, java.lang.String... pattern)
Asserts that all shards are allocated on nodes matching the given node pattern.void
assertResultsAndLogOnFailure(long expectedResults, org.elasticsearch.action.search.SearchResponse searchResponse)
Ensures the result counts are as expected, and logs the results if differentvoid
assertSortedSegments(java.lang.String indexName, org.apache.lucene.search.Sort expectedIndexSort)
Asserts that all segments are sorted with the providedSort
.static void
beforeClass()
protected void
beforeIndexDeletion()
protected void
beforeInternal()
protected TestCluster
buildTestCluster(ESIntegTestCase.Scope scope, long seed)
void
cleanUpCluster()
void
clearScroll(java.lang.String... scrollIds)
Clears the given scroll Idsstatic org.elasticsearch.client.Client
client()
static org.elasticsearch.client.Client
client(java.lang.String node)
static java.lang.Iterable<org.elasticsearch.client.Client>
clients()
static TestCluster
cluster()
protected org.elasticsearch.client.ClusterAdminClient
clusterAdmin()
Returns a random cluster admin client.org.elasticsearch.cluster.service.ClusterService
clusterService()
void
createIndex(java.lang.String... names)
Creates one or more indices and asserts that the indices are acknowledged.void
createIndex(java.lang.String name, org.elasticsearch.common.settings.Settings indexSettings)
creates an index with the given settingprotected static org.elasticsearch.client.RestClient
createRestClient()
protected static org.elasticsearch.client.RestClient
createRestClient(java.util.List<org.elasticsearch.action.admin.cluster.node.info.NodeInfo> nodes, org.elasticsearch.client.RestClientBuilder.HttpClientConfigCallback httpClientConfigCallback, java.lang.String protocol)
protected static org.elasticsearch.client.RestClient
createRestClient(org.elasticsearch.client.RestClientBuilder.HttpClientConfigCallback httpClientConfigCallback, java.lang.String protocol)
static org.elasticsearch.client.Client
dataNodeClient()
protected void
disableAllocation(java.lang.String... indices)
Syntactic sugar for disabling allocation forindices
static void
disableIndexBlock(java.lang.String index, java.lang.String block)
Disables an index block for the specified indexprotected void
enableAllocation(java.lang.String... indices)
Syntactic sugar for enabling allocation forindices
static void
enableIndexBlock(java.lang.String index, java.lang.String block)
Enables an index block for the specified indexprotected boolean
enableWarningsCheck()
Whether or not we check after each test whether it has left warnings behind.protected void
ensureClusterSizeConsistency()
protected void
ensureClusterStateCanBeReadByNodeTool()
protected void
ensureClusterStateConsistency()
Verifies that all nodes that have the same version of the cluster state as master have same cluster stateprotected void
ensureFullyConnectedCluster()
Ensures that all nodes in the cluster are connected to each other.org.elasticsearch.cluster.health.ClusterHealthStatus
ensureGreen(java.lang.String... indices)
Ensures the cluster has a green state via the cluster health API.org.elasticsearch.cluster.health.ClusterHealthStatus
ensureGreen(org.elasticsearch.common.unit.TimeValue timeout, java.lang.String... indices)
Ensures the cluster has a green state via the cluster health API.protected org.elasticsearch.cluster.health.ClusterHealthStatus
ensureSearchable(java.lang.String... indices)
Ensures the cluster is in a searchable state for the given indices.protected void
ensureStableCluster(int nodeCount)
protected void
ensureStableCluster(int nodeCount, java.lang.String viaNode)
protected void
ensureStableCluster(int nodeCount, org.elasticsearch.common.unit.TimeValue timeValue)
protected void
ensureStableCluster(int nodeCount, org.elasticsearch.common.unit.TimeValue timeValue, boolean local, java.lang.String viaNode)
org.elasticsearch.cluster.health.ClusterHealthStatus
ensureYellow(java.lang.String... indices)
Ensures the cluster has a yellow state via the cluster health API.org.elasticsearch.cluster.health.ClusterHealthStatus
ensureYellowAndNoInitializingShards(java.lang.String... indices)
Ensures the cluster has a yellow state via the cluster health API and ensures the that cluster has no initializing shards for the given indicesprotected java.util.Set<java.lang.String>
excludeTemplates()
protected org.elasticsearch.common.settings.Settings
externalClusterClientSettings()
protected org.elasticsearch.action.admin.indices.flush.FlushResponse
flush(java.lang.String... indices)
Flush some or all indices in the cluster.protected void
flushAndRefresh(java.lang.String... indices)
Flushes and refreshes all indices in the clusterprotected boolean
forbidPrivateIndexSettings()
protected org.elasticsearch.action.admin.indices.forcemerge.ForceMergeResponse
forceMerge()
Waits for all relocations and force merge all indices in the cluster to 1 segment.protected java.util.function.Function<org.elasticsearch.client.Client,org.elasticsearch.client.Client>
getClientWrapper()
Returns a function that allows to wrap / filter all clients that are exposed by the test cluster.protected java.util.Collection<java.lang.Class<? extends org.elasticsearch.plugins.Plugin>>
getMockPlugins()
Return the mock plugins the cluster should useprotected ESIntegTestCase.NumShards
getNumShards(java.lang.String index)
protected double
getPerTestTransportClientRatio()
Returns the transport client ratio from the class level annotation or viaSystem.getProperty(String)
if available.protected static org.elasticsearch.client.RestClient
getRestClient()
Returns an instance ofRestClient
pointing to the current test cluster.protected boolean
ignoreExternalCluster()
protected org.elasticsearch.action.index.IndexResponse
index(java.lang.String index, java.lang.String type, java.lang.String id, java.lang.Object... source)
Syntactic sugar for:protected org.elasticsearch.action.index.IndexResponse
index(java.lang.String index, java.lang.String type, java.lang.String id, java.lang.String source)
Syntactic sugar for:protected org.elasticsearch.action.index.IndexResponse
index(java.lang.String index, java.lang.String type, java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> source)
Syntactic sugar for:protected org.elasticsearch.action.index.IndexResponse
index(java.lang.String index, java.lang.String type, java.lang.String id, org.elasticsearch.common.xcontent.XContentBuilder source)
Syntactic sugar for:protected org.elasticsearch.action.index.IndexResponse
index(java.lang.String index, java.lang.String type, org.elasticsearch.common.xcontent.XContentBuilder source)
Syntactic sugar for:protected static boolean
indexExists(java.lang.String index)
Returnstrue
iff the given index exists otherwisefalse
void
indexRandom(boolean forceRefresh, boolean dummyDocuments, boolean maybeFlush, java.util.List<org.elasticsearch.action.index.IndexRequestBuilder> builders)
Indexes the givenIndexRequestBuilder
instances randomly.void
indexRandom(boolean forceRefresh, boolean dummyDocuments, java.util.List<org.elasticsearch.action.index.IndexRequestBuilder> builders)
Indexes the givenIndexRequestBuilder
instances randomly.void
indexRandom(boolean forceRefresh, boolean dummyDocuments, org.elasticsearch.action.index.IndexRequestBuilder... builders)
void
indexRandom(boolean forceRefresh, java.util.List<org.elasticsearch.action.index.IndexRequestBuilder> builders)
Indexes the givenIndexRequestBuilder
instances randomly.void
indexRandom(boolean forceRefresh, org.elasticsearch.action.index.IndexRequestBuilder... builders)
Convenience method that forwards toindexRandom(boolean, List)
.org.elasticsearch.common.settings.Settings
indexSettings()
Returns a settings object used increateIndex(String...)
andprepareCreate(String)
and friends.static boolean
inFipsJvm()
static InternalTestCluster
internalCluster()
static boolean
isInternalCluster()
protected static NetworkDisruption
isolateMasterDisruption(NetworkDisruption.NetworkLinkDisruptionType disruptionType)
Creates a disruption that isolates the current master node from all other nodes in the cluster.void
logClusterState()
Prints the current cluster state as debug logging.protected int
maximumNumberOfReplicas()
protected int
maximumNumberOfShards()
protected int
minimumNumberOfReplicas()
protected int
minimumNumberOfShards()
protected java.nio.file.Path
nodeConfigPath(int nodeOrdinal)
protected java.util.Collection<java.lang.Class<? extends org.elasticsearch.plugins.Plugin>>
nodePlugins()
Returns a collection of plugins that should be loaded on each node.protected org.elasticsearch.common.settings.Settings
nodeSettings(int nodeOrdinal)
This method is used to obtain settings for theN
th node in the cluster.protected int
numberOfReplicas()
protected int
numberOfShards()
org.elasticsearch.action.admin.indices.create.CreateIndexRequestBuilder
prepareCreate(java.lang.String index)
Creates a newCreateIndexRequestBuilder
with the settings obtained fromindexSettings()
.org.elasticsearch.action.admin.indices.create.CreateIndexRequestBuilder
prepareCreate(java.lang.String index, int numNodes)
Creates a newCreateIndexRequestBuilder
with the settings obtained fromindexSettings()
.org.elasticsearch.action.admin.indices.create.CreateIndexRequestBuilder
prepareCreate(java.lang.String index, int numNodes, org.elasticsearch.common.settings.Settings.Builder settingsBuilder)
Creates a newCreateIndexRequestBuilder
with the settings obtained fromindexSettings()
.org.elasticsearch.action.admin.indices.create.CreateIndexRequestBuilder
prepareCreate(java.lang.String index, org.elasticsearch.common.settings.Settings.Builder settingsBuilder)
Creates a newCreateIndexRequestBuilder
with the settings obtained fromindexSettings()
, augmented by the given builderjava.nio.file.Path
randomRepoPath()
Returns path to a random directory that can be used to create a temporary file system repostatic java.nio.file.Path
randomRepoPath(org.elasticsearch.common.settings.Settings settings)
Returns path to a random directory that can be used to create a temporary file system repoprotected org.elasticsearch.action.admin.indices.refresh.RefreshResponse
refresh(java.lang.String... indices)
Waits for relocations and refreshes all indices in the cluster.static void
refreshClusterInfo()
static java.lang.String
resolveCustomDataPath(java.lang.String index)
static org.elasticsearch.index.Index
resolveIndex(java.lang.String index)
protected void
restartNodesOnBrokenClusterState(org.elasticsearch.cluster.ClusterState.Builder clusterStateBuilder)
protected java.lang.String
routingKeyForShard(java.lang.String index, int shard)
Compute a routing key that will route documents to theshard
-th shard of the provided index.static void
setClusterReadOnly(boolean value)
Sets or unsets the cluster read_only modevoid
setDisruptionScheme(ServiceDisruptionScheme scheme)
protected org.elasticsearch.common.settings.Settings.Builder
setRandomIndexSettings(java.util.Random random, org.elasticsearch.common.settings.Settings.Builder builder)
protected void
setupSuiteScopeCluster()
This method is executed iff the test is annotated withESIntegTestCase.SuiteScopeTestCase
before the first test of this class is executed.void
setupTestCluster()
protected java.util.Collection<java.lang.Class<? extends org.elasticsearch.plugins.Plugin>>
transportClientPlugins()
Returns a collection of plugins that should be loaded when creating a transport client.protected org.elasticsearch.common.settings.Settings
transportClientSettings()
This method is used to obtain additional settings for clients created by the internal cluster.void
waitForDocs(long numDocs, BackgroundIndexer indexer)
Waits until at least a give number of document is visible for searchersorg.elasticsearch.cluster.health.ClusterHealthStatus
waitForRelocation()
Waits for all relocating shards to become active using the cluster health API.org.elasticsearch.cluster.health.ClusterHealthStatus
waitForRelocation(org.elasticsearch.cluster.health.ClusterHealthStatus status)
Waits for all relocating shards to become active and the cluster has reached the given health status using the cluster health API.void
waitNoPendingTasksOnAll()
Waits until all nodes have no pending tasks.protected boolean
willSufferDebian8MemoryProblem()
On Debian 8 the "memory" subsystem is not mounted by default when cgroups are enabled, and this confuses many versions of Java prior to Java 15.protected org.elasticsearch.common.xcontent.NamedXContentRegistry
xContentRegistry()
TheNamedXContentRegistry
to use for this test.Methods inherited from class org.elasticsearch.test.ESTestCase
after, afterIfFailed, afterIfSuccessful, allowedWarnings, assertArrayEquals, assertBusy, assertBusy, assertEquals, assertSettingDeprecationsAndWarnings, assertSettingDeprecationsAndWarnings, assertWarnings, assertWarnings, before, between, buildEnvSettings, buildNewFakeTransportAddress, checkStaticState, clearAdditionalRoles, copyInstance, copyNamedWriteable, copyNamedWriteable, copyWriteable, copyWriteable, createDefaultIndexAnalyzers, createParser, createParser, createParser, createParser, createParser, createParser, createTestAnalysis, createTestAnalysis, createTestAnalysis, enableJodaDeprecationWarningsCheck, ensureAllSearchContextsReleased, ensureCheckIndexPassed, ensureSupportedLocale, frequently, generateRandomStringArray, generateRandomStringArray, getBasePort, getDataPath, getPortRange, getSuiteFailureMarker, getTestTransportPlugin, getTestTransportType, iterations, maybeSet, mockScript, newEnvironment, newEnvironment, newNodeEnvironment, newNodeEnvironment, randomAlphaOfLength, randomAlphaOfLengthBetween, randomArray, randomArray, randomBigInteger, randomBoolean, randomByte, randomByteArrayOfLength, randomDateFormatterPattern, randomDateTimeZone, randomDouble, randomDoubleBetween, randomFloat, randomFrom, randomFrom, randomFrom, randomFrom, randomFrom, randomGeohash, randomInt, randomInt, randomIntBetween, randomIp, randomList, randomList, randomLong, randomLongBetween, randomNonNegativeByte, randomNonNegativeLong, randomPositiveTimeValue, randomRealisticUnicodeOfCodepointLength, randomRealisticUnicodeOfCodepointLengthBetween, randomRealisticUnicodeOfLength, randomRealisticUnicodeOfLengthBetween, randomShort, randomSubsetOf, randomSubsetOf, randomSubsetOf, randomTimeValue, randomTimeValue, randomTimeValue, randomTimeZone, randomUnicodeOfCodepointLength, randomUnicodeOfCodepointLengthBetween, randomUnicodeOfLength, randomUnicodeOfLengthBetween, randomUnique, randomValueOtherThan, randomValueOtherThanMany, randomZone, removeHeaderWarningAppender, resetCheckIndexStatus, resetPortCounter, restoreContentType, restoreFileSystem, scaledRandomIntBetween, setContentType, setFileSystem, setHeaderWarningAppender, settings, shuffleMap, shuffleXContent, shuffleXContent, spinForAtLeastNMilliseconds, spinForAtLeastOneMillisecond, terminate, terminate, tmpPaths, toShuffledXContent, waitUntil, waitUntil, writableRegistry
Methods inherited from class org.apache.lucene.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, getBaseTempDirForTestClass, getDataInputStream, 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, setUp, setupCPUCoreCount, setupSpins, 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, assertThat, assertThat, assertTrue, assertTrue, fail, fail
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
SYSPROP_THIRDPARTY
public static final java.lang.String SYSPROP_THIRDPARTYProperty that controls whether ThirdParty Integration tests are run (not the default).- See Also:
- Constant Field Values
-
SUITE_CLUSTER_NODE_PREFIX
public static final java.lang.String SUITE_CLUSTER_NODE_PREFIXnode names of the corresponding clusters will start with these prefixes- See Also:
- Constant Field Values
-
TEST_CLUSTER_NODE_PREFIX
public static final java.lang.String TEST_CLUSTER_NODE_PREFIX- See Also:
- Constant Field Values
-
TESTS_CLIENT_RATIO
public static final java.lang.String TESTS_CLIENT_RATIOKey used to set the transport client ratio via the commandline -D"tests.client.ratio"- See Also:
- Constant Field Values
-
TESTS_CLUSTER
public static final java.lang.String TESTS_CLUSTERKey used to eventually switch to using an external cluster and provide its transport addresses- See Also:
- Constant Field Values
-
INDEX_TEST_SEED_SETTING
public static final org.elasticsearch.common.settings.Setting<java.lang.Long> INDEX_TEST_SEED_SETTINGKey used to retrieve the index random seed from the index settings on a running node. The value of this seed can be used to initialize a random context for a specific index. It's set once per test via a generic index template. -
TESTS_ENABLE_MOCK_MODULES
public static final java.lang.String TESTS_ENABLE_MOCK_MODULESA boolean value to enable or disable mock modules. This is useful to test the system without asserting modules that to make sure they don't hide any bugs in production.- See Also:
ESIntegTestCase
, Constant Field Values
-
DEFAULT_MIN_NUM_SHARDS
protected static final int DEFAULT_MIN_NUM_SHARDSDefault minimum number of shards for an index- See Also:
- Constant Field Values
-
DEFAULT_MAX_NUM_SHARDS
protected static final int DEFAULT_MAX_NUM_SHARDSDefault maximum number of shards for an index- See Also:
- Constant Field Values
-
-
Constructor Details
-
ESIntegTestCase
public ESIntegTestCase()
-
-
Method Details
-
beforeClass
public static void beforeClass() throws java.lang.Exception- Throws:
java.lang.Exception
-
enableWarningsCheck
protected final boolean enableWarningsCheck()Description copied from class:ESTestCase
Whether or not we check after each test whether it has left warnings behind. That happens if any deprecated feature or syntax was used by the test and the test didn't assert on it usingESTestCase.assertWarnings(String...)
.- Overrides:
enableWarningsCheck
in classESTestCase
-
beforeInternal
protected final void beforeInternal() throws java.lang.Exception- Throws:
java.lang.Exception
-
setRandomIndexSettings
protected org.elasticsearch.common.settings.Settings.Builder setRandomIndexSettings(java.util.Random random, org.elasticsearch.common.settings.Settings.Builder builder) -
excludeTemplates
protected java.util.Set<java.lang.String> excludeTemplates()- Returns:
- An exclude set of index templates that will not be removed in between tests.
-
beforeIndexDeletion
protected void beforeIndexDeletion() throws java.lang.Exception- Throws:
java.lang.Exception
-
cluster
-
isInternalCluster
public static boolean isInternalCluster() -
internalCluster
-
clusterService
public org.elasticsearch.cluster.service.ClusterService clusterService() -
client
public static org.elasticsearch.client.Client client() -
client
public static org.elasticsearch.client.Client client(@Nullable java.lang.String node) -
dataNodeClient
public static org.elasticsearch.client.Client dataNodeClient() -
clients
public static java.lang.Iterable<org.elasticsearch.client.Client> clients() -
minimumNumberOfShards
protected int minimumNumberOfShards() -
maximumNumberOfShards
protected int maximumNumberOfShards() -
numberOfShards
protected int numberOfShards() -
minimumNumberOfReplicas
protected int minimumNumberOfReplicas() -
maximumNumberOfReplicas
protected int maximumNumberOfReplicas() -
numberOfReplicas
protected int numberOfReplicas() -
setDisruptionScheme
-
isolateMasterDisruption
protected static NetworkDisruption isolateMasterDisruption(NetworkDisruption.NetworkLinkDisruptionType disruptionType)Creates a disruption that isolates the current master node from all other nodes in the cluster.- Parameters:
disruptionType
- type of disruption to create- Returns:
- disruption
-
indexSettings
public org.elasticsearch.common.settings.Settings indexSettings()Returns a settings object used increateIndex(String...)
andprepareCreate(String)
and friends. This method can be overwritten by subclasses to set defaults for the indices that are created by the test. By default it returns a settings object that sets a random number of shards. Number of shards and replicas can be controlled through specific methods. -
createIndex
public final void createIndex(java.lang.String... names)Creates one or more indices and asserts that the indices are acknowledged. If one of the indices already exists this method will fail and wipe all the indices created so far. -
createIndex
public final void createIndex(java.lang.String name, org.elasticsearch.common.settings.Settings indexSettings)creates an index with the given setting -
prepareCreate
public final org.elasticsearch.action.admin.indices.create.CreateIndexRequestBuilder prepareCreate(java.lang.String index)Creates a newCreateIndexRequestBuilder
with the settings obtained fromindexSettings()
. -
prepareCreate
public final org.elasticsearch.action.admin.indices.create.CreateIndexRequestBuilder prepareCreate(java.lang.String index, int numNodes)Creates a newCreateIndexRequestBuilder
with the settings obtained fromindexSettings()
. The index that is created with this builder will only be allowed to allocate on the number of nodes passed to this method.This method uses allocation deciders to filter out certain nodes to allocate the created index on. It defines allocation rules based on
index.routing.allocation.exclude._name
. -
prepareCreate
public org.elasticsearch.action.admin.indices.create.CreateIndexRequestBuilder prepareCreate(java.lang.String index, org.elasticsearch.common.settings.Settings.Builder settingsBuilder)Creates a newCreateIndexRequestBuilder
with the settings obtained fromindexSettings()
, augmented by the given builder -
prepareCreate
public org.elasticsearch.action.admin.indices.create.CreateIndexRequestBuilder prepareCreate(java.lang.String index, int numNodes, org.elasticsearch.common.settings.Settings.Builder settingsBuilder)Creates a newCreateIndexRequestBuilder
with the settings obtained fromindexSettings()
. The index that is created with this builder will only be allowed to allocate on the number of nodes passed to this method.This method uses allocation deciders to filter out certain nodes to allocate the created index on. It defines allocation rules based on
index.routing.allocation.exclude._name
. -
waitNoPendingTasksOnAll
public void waitNoPendingTasksOnAll() throws java.lang.ExceptionWaits until all nodes have no pending tasks.- Throws:
java.lang.Exception
-
assertResultsAndLogOnFailure
public void assertResultsAndLogOnFailure(long expectedResults, org.elasticsearch.action.search.SearchResponse searchResponse)Ensures the result counts are as expected, and logs the results if different -
allowNodes
public void allowNodes(java.lang.String index, int n)Restricts the given index to be allocated onn
nodes using the allocation deciders. Yet if the shards can't be allocated on any other node shards for this index will remain allocated on more thann
nodes. -
ensureGreen
public org.elasticsearch.cluster.health.ClusterHealthStatus ensureGreen(java.lang.String... indices)Ensures the cluster has a green state via the cluster health API. This method will also wait for relocations. It is useful to ensure that all action on the cluster have finished and all shards that were currently relocating are now allocated and started. -
ensureGreen
public org.elasticsearch.cluster.health.ClusterHealthStatus ensureGreen(org.elasticsearch.common.unit.TimeValue timeout, java.lang.String... indices)Ensures the cluster has a green state via the cluster health API. This method will also wait for relocations. It is useful to ensure that all action on the cluster have finished and all shards that were currently relocating are now allocated and started.- Parameters:
timeout
- time out value to set onClusterHealthRequest
-
ensureYellow
public org.elasticsearch.cluster.health.ClusterHealthStatus ensureYellow(java.lang.String... indices)Ensures the cluster has a yellow state via the cluster health API. -
ensureYellowAndNoInitializingShards
public org.elasticsearch.cluster.health.ClusterHealthStatus ensureYellowAndNoInitializingShards(java.lang.String... indices)Ensures the cluster has a yellow state via the cluster health API and ensures the that cluster has no initializing shards for the given indices -
waitForRelocation
public org.elasticsearch.cluster.health.ClusterHealthStatus waitForRelocation()Waits for all relocating shards to become active using the cluster health API. -
waitForRelocation
public org.elasticsearch.cluster.health.ClusterHealthStatus waitForRelocation(org.elasticsearch.cluster.health.ClusterHealthStatus status)Waits for all relocating shards to become active and the cluster has reached the given health status using the cluster health API. -
waitForDocs
Waits until at least a give number of document is visible for searchers- Parameters:
numDocs
- number of documents to wait forindexer
- aBackgroundIndexer
. It will be first checked for documents indexed. This saves on unneeded searches.- Throws:
java.lang.Exception
-
logClusterState
public void logClusterState()Prints the current cluster state as debug logging. -
ensureClusterSizeConsistency
protected void ensureClusterSizeConsistency() -
ensureClusterStateConsistency
protected void ensureClusterStateConsistency() throws java.io.IOExceptionVerifies that all nodes that have the same version of the cluster state as master have same cluster state- Throws:
java.io.IOException
-
ensureClusterStateCanBeReadByNodeTool
protected void ensureClusterStateCanBeReadByNodeTool() throws java.io.IOException- Throws:
java.io.IOException
-
refreshClusterInfo
public static void refreshClusterInfo() -
ensureSearchable
protected org.elasticsearch.cluster.health.ClusterHealthStatus ensureSearchable(java.lang.String... indices)Ensures the cluster is in a searchable state for the given indices. This means a searchable copy of each shard is available on the cluster. -
ensureStableCluster
protected void ensureStableCluster(int nodeCount) -
ensureStableCluster
protected void ensureStableCluster(int nodeCount, org.elasticsearch.common.unit.TimeValue timeValue) -
ensureStableCluster
protected void ensureStableCluster(int nodeCount, @Nullable java.lang.String viaNode) -
ensureStableCluster
protected void ensureStableCluster(int nodeCount, org.elasticsearch.common.unit.TimeValue timeValue, boolean local, @Nullable java.lang.String viaNode) -
ensureFullyConnectedCluster
protected void ensureFullyConnectedCluster()Ensures that all nodes in the cluster are connected to each other. Some network disruptions may leave nodes that are not the master disconnected from each other.NodeConnectionsService
will eventually reconnect but it's handy to be able to ensure this happens faster -
index
protected final org.elasticsearch.action.index.IndexResponse index(java.lang.String index, java.lang.String type, org.elasticsearch.common.xcontent.XContentBuilder source)Syntactic sugar for:client().prepareIndex(index, type).setSource(source).execute().actionGet();
-
index
protected final org.elasticsearch.action.index.IndexResponse index(java.lang.String index, java.lang.String type, java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> source)Syntactic sugar for:client().prepareIndex(index, type).setSource(source).execute().actionGet();
-
index
protected final org.elasticsearch.action.index.IndexResponse index(java.lang.String index, java.lang.String type, java.lang.String id, org.elasticsearch.common.xcontent.XContentBuilder source)Syntactic sugar for:return client().prepareIndex(index, type, id).setSource(source).execute().actionGet();
-
index
protected final org.elasticsearch.action.index.IndexResponse index(java.lang.String index, java.lang.String type, java.lang.String id, java.lang.Object... source)Syntactic sugar for:return client().prepareIndex(index, type, id).setSource(source).execute().actionGet();
-
index
protected final org.elasticsearch.action.index.IndexResponse index(java.lang.String index, java.lang.String type, java.lang.String id, java.lang.String source)Syntactic sugar for:return client().prepareIndex(index, type, id).setSource(source).execute().actionGet();
where source is a JSON String.
-
refresh
protected final org.elasticsearch.action.admin.indices.refresh.RefreshResponse refresh(java.lang.String... indices)Waits for relocations and refreshes all indices in the cluster.- See Also:
waitForRelocation()
-
flushAndRefresh
protected final void flushAndRefresh(java.lang.String... indices)Flushes and refreshes all indices in the cluster -
flush
protected final org.elasticsearch.action.admin.indices.flush.FlushResponse flush(java.lang.String... indices)Flush some or all indices in the cluster. -
forceMerge
protected org.elasticsearch.action.admin.indices.forcemerge.ForceMergeResponse forceMerge()Waits for all relocations and force merge all indices in the cluster to 1 segment. -
indexExists
protected static boolean indexExists(java.lang.String index)Returnstrue
iff the given index exists otherwisefalse
-
enableAllocation
protected final void enableAllocation(java.lang.String... indices)Syntactic sugar for enabling allocation forindices
-
disableAllocation
protected final void disableAllocation(java.lang.String... indices)Syntactic sugar for disabling allocation forindices
-
admin
protected org.elasticsearch.client.AdminClient admin()Returns a random admin client. This client can either be a node or a transport client pointing to any of the nodes in the cluster. -
clusterAdmin
protected org.elasticsearch.client.ClusterAdminClient clusterAdmin()Returns a random cluster admin client. This client can be pointing to any of the nodes in the cluster. -
indexRandom
public void indexRandom(boolean forceRefresh, org.elasticsearch.action.index.IndexRequestBuilder... builders) throws java.lang.InterruptedExceptionConvenience method that forwards toindexRandom(boolean, List)
.- Throws:
java.lang.InterruptedException
-
indexRandom
public void indexRandom(boolean forceRefresh, boolean dummyDocuments, org.elasticsearch.action.index.IndexRequestBuilder... builders) throws java.lang.InterruptedException- Throws:
java.lang.InterruptedException
-
indexRandom
public void indexRandom(boolean forceRefresh, java.util.List<org.elasticsearch.action.index.IndexRequestBuilder> builders) throws java.lang.InterruptedExceptionIndexes the givenIndexRequestBuilder
instances randomly. It shuffles the given builders and either indexes them in a blocking or async fashion. This is very useful to catch problems that relate to internal document ids or index segment creations. Some features might have bug when a given document is the first or the last in a segment or if only one document is in a segment etc. This method prevents issues like this by randomizing the index layout.- Parameters:
forceRefresh
- iftrue
all involved indices are refreshed once the documents are indexed. Additionally iftrue
some empty dummy documents are may be randomly inserted into the document list and deleted once all documents are indexed. This is useful to produce deleted documents on the server side.builders
- the documents to index.- Throws:
java.lang.InterruptedException
- See Also:
indexRandom(boolean, boolean, java.util.List)
-
indexRandom
public void indexRandom(boolean forceRefresh, boolean dummyDocuments, java.util.List<org.elasticsearch.action.index.IndexRequestBuilder> builders) throws java.lang.InterruptedExceptionIndexes the givenIndexRequestBuilder
instances randomly. It shuffles the given builders and either indexes them in a blocking or async fashion. This is very useful to catch problems that relate to internal document ids or index segment creations. Some features might have bug when a given document is the first or the last in a segment or if only one document is in a segment etc. This method prevents issues like this by randomizing the index layout.- Parameters:
forceRefresh
- iftrue
all involved indices are refreshed once the documents are indexed.dummyDocuments
- iftrue
some empty dummy documents may be randomly inserted into the document list and deleted once all documents are indexed. This is useful to produce deleted documents on the server side.builders
- the documents to index.- Throws:
java.lang.InterruptedException
-
indexRandom
public void indexRandom(boolean forceRefresh, boolean dummyDocuments, boolean maybeFlush, java.util.List<org.elasticsearch.action.index.IndexRequestBuilder> builders) throws java.lang.InterruptedExceptionIndexes the givenIndexRequestBuilder
instances randomly. It shuffles the given builders and either indexes them in a blocking or async fashion. This is very useful to catch problems that relate to internal document ids or index segment creations. Some features might have bug when a given document is the first or the last in a segment or if only one document is in a segment etc. This method prevents issues like this by randomizing the index layout.- Parameters:
forceRefresh
- iftrue
all involved indices are refreshed once the documents are indexed.dummyDocuments
- iftrue
some empty dummy documents may be randomly inserted into the document list and deleted once all documents are indexed. This is useful to produce deleted documents on the server side.maybeFlush
- iftrue
this method may randomly execute full flushes after index operations.builders
- the documents to index.- Throws:
java.lang.InterruptedException
-
disableIndexBlock
public static void disableIndexBlock(java.lang.String index, java.lang.String block)Disables an index block for the specified index -
enableIndexBlock
public static void enableIndexBlock(java.lang.String index, java.lang.String block)Enables an index block for the specified index -
setClusterReadOnly
public static void setClusterReadOnly(boolean value)Sets or unsets the cluster read_only mode -
clearScroll
public void clearScroll(java.lang.String... scrollIds)Clears the given scroll Ids -
nodeSettings
protected org.elasticsearch.common.settings.Settings nodeSettings(int nodeOrdinal)This method is used to obtain settings for theN
th node in the cluster. Nodes in this cluster are associated with an ordinal number such that nodes can be started with specific configurations. This method might be called multiple times with the same ordinal and is expected to return the same value for each invocation. In other words subclasses must ensure this method is idempotent. -
nodeConfigPath
protected java.nio.file.Path nodeConfigPath(int nodeOrdinal) -
nodePlugins
protected java.util.Collection<java.lang.Class<? extends org.elasticsearch.plugins.Plugin>> nodePlugins()Returns a collection of plugins that should be loaded on each node. -
transportClientPlugins
protected java.util.Collection<java.lang.Class<? extends org.elasticsearch.plugins.Plugin>> transportClientPlugins()Returns a collection of plugins that should be loaded when creating a transport client. -
transportClientSettings
protected org.elasticsearch.common.settings.Settings transportClientSettings()This method is used to obtain additional settings for clients created by the internal cluster. These settings will be applied on the client in addition to some randomized settings defined in the cluster. These settings will also override any other settings the internal cluster might add by default. -
externalClusterClientSettings
protected org.elasticsearch.common.settings.Settings externalClusterClientSettings() -
ignoreExternalCluster
protected boolean ignoreExternalCluster() -
buildTestCluster
protected TestCluster buildTestCluster(ESIntegTestCase.Scope scope, long seed) throws java.io.IOException- Throws:
java.io.IOException
-
addMockTransportService
protected boolean addMockTransportService()Iff this returns true mock transport implementations are used for the test runs. Otherwise not mock transport impls are used. The default istrue
. -
addMockHttpTransport
protected boolean addMockHttpTransport()Returnstrue
iff this test cluster should use a dummy http transport -
addMockInternalEngine
protected boolean addMockInternalEngine()Returnstrue
if this test cluster can use a mock internal engine. Defaults to true. -
addMockGeoShapeFieldMapper
protected boolean addMockGeoShapeFieldMapper()Returnstrue
iff this test cluster should use a dummy geo_shape field mapper -
getClientWrapper
protected java.util.function.Function<org.elasticsearch.client.Client,org.elasticsearch.client.Client> getClientWrapper()Returns a function that allows to wrap / filter all clients that are exposed by the test cluster. This is useful for debugging or request / response pre and post processing. It also allows to intercept all calls done by the test framework. By default this method returns an identity functionFunction.identity()
. -
getMockPlugins
protected java.util.Collection<java.lang.Class<? extends org.elasticsearch.plugins.Plugin>> getMockPlugins()Return the mock plugins the cluster should use -
getPerTestTransportClientRatio
protected double getPerTestTransportClientRatio()Returns the transport client ratio from the class level annotation or viaSystem.getProperty(String)
if available. If both are not available this will return a random ratio in the interval[0..1]
. -
randomRepoPath
public java.nio.file.Path randomRepoPath()Returns path to a random directory that can be used to create a temporary file system repo -
randomRepoPath
public static java.nio.file.Path randomRepoPath(org.elasticsearch.common.settings.Settings settings)Returns path to a random directory that can be used to create a temporary file system repo -
getNumShards
-
assertAllShardsOnNodes
public java.util.Set<java.lang.String> assertAllShardsOnNodes(java.lang.String index, java.lang.String... pattern)Asserts that all shards are allocated on nodes matching the given node pattern. -
assertSortedSegments
public void assertSortedSegments(java.lang.String indexName, org.apache.lucene.search.Sort expectedIndexSort)Asserts that all segments are sorted with the providedSort
. -
setupTestCluster
public final void setupTestCluster() throws java.lang.Exception- Throws:
java.lang.Exception
-
cleanUpCluster
public final void cleanUpCluster() throws java.lang.Exception- Throws:
java.lang.Exception
-
afterClass
public static void afterClass() throws java.lang.Exception- Throws:
java.lang.Exception
-
routingKeyForShard
protected java.lang.String routingKeyForShard(java.lang.String index, int shard)Compute a routing key that will route documents to theshard
-th shard of the provided index. -
xContentRegistry
protected org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry()Description copied from class:ESTestCase
TheNamedXContentRegistry
to use for this test. Subclasses should override and use liberally.- Overrides:
xContentRegistry
in classESTestCase
-
forbidPrivateIndexSettings
protected boolean forbidPrivateIndexSettings() -
getRestClient
protected static org.elasticsearch.client.RestClient getRestClient()Returns an instance ofRestClient
pointing to the current test cluster. Creates a new client if the method is invoked for the first time in the context of the current test scope. The returned client gets automatically closed when needed, it shouldn't be closed as part of tests otherwise it cannot be reused by other tests anymore. -
createRestClient
protected static org.elasticsearch.client.RestClient createRestClient() -
createRestClient
protected static org.elasticsearch.client.RestClient createRestClient(org.elasticsearch.client.RestClientBuilder.HttpClientConfigCallback httpClientConfigCallback, java.lang.String protocol) -
createRestClient
protected static org.elasticsearch.client.RestClient createRestClient(java.util.List<org.elasticsearch.action.admin.cluster.node.info.NodeInfo> nodes, org.elasticsearch.client.RestClientBuilder.HttpClientConfigCallback httpClientConfigCallback, java.lang.String protocol) -
setupSuiteScopeCluster
protected void setupSuiteScopeCluster() throws java.lang.ExceptionThis method is executed iff the test is annotated withESIntegTestCase.SuiteScopeTestCase
before the first test of this class is executed.- Throws:
java.lang.Exception
- See Also:
ESIntegTestCase.SuiteScopeTestCase
-
resolveIndex
public static org.elasticsearch.index.Index resolveIndex(java.lang.String index) -
resolveCustomDataPath
public static java.lang.String resolveCustomDataPath(java.lang.String index) -
inFipsJvm
public static boolean inFipsJvm() -
restartNodesOnBrokenClusterState
protected void restartNodesOnBrokenClusterState(org.elasticsearch.cluster.ClusterState.Builder clusterStateBuilder) throws java.lang.Exception- Throws:
java.lang.Exception
-
willSufferDebian8MemoryProblem
protected boolean willSufferDebian8MemoryProblem()On Debian 8 the "memory" subsystem is not mounted by default when cgroups are enabled, and this confuses many versions of Java prior to Java 15. Tests that rely on machine memory being accurately determined will not work on such setups, and can use this method for selective muting. See https://github.com/elastic/elasticsearch/issues/67089 and https://github.com/elastic/elasticsearch/issues/66885
-