org.elasticsearch.test

Class ESBackcompatTestCase

java.lang.Object

org.junit.Assert

org.apache.lucene.util.LuceneTestCase

org.elasticsearch.test.ESTestCase

org.elasticsearch.test.ESIntegTestCase

org.elasticsearch.test.ESBackcompatTestCase

public abstract class ESBackcompatTestCase
extends ESIntegTestCase

Abstract base class for backwards compatibility tests. Subclasses of this class can run tests against a mixed version cluster. A subset of the nodes in the cluster are started in dedicated process running off a full fledged elasticsearch release. Nodes can be "upgraded" from the "backwards" node to an "new" node where "new" nodes version corresponds to current version. The purpose of this test class is to run tests in scenarios where clusters are in an intermediate state during a rolling upgrade as well as upgrade situations. The clients accessed via #client() are random clients to the nodes in the cluster which might execute requests on the "new" as well as the "old" nodes.

Note: this base class is still experimental and might have bugs or leave external processes running behind.

Backwards compatibility tests are disabled by default via ESBackcompatTestCase.Backwards annotation. The following system variables control the test execution:

• "tests.bwc" enables / disables tests annotated with ESBackcompatTestCase.Backwards (defaults to false)
• "tests.bwc.version" sets the version to run the external nodes from formatted as X.Y.Z. The tests class will try to locate a release folder elasticsearch-X.Y.Z within path passed via "tests.bwc.path" depending on this system variable.
• "tests.bwc.path" the path to the elasticsearch releases to run backwards compatibility tests against.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ESBackcompatTestCase.Backwards Annotation for backwards compat tests
static interface	ESBackcompatTestCase.CompatibilityVersion If a test is annotated with ESBackcompatTestCase.CompatibilityVersion all randomized settings will only contain settings or mappings which are compatible with the specified version ID.

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

ESIntegTestCase.ClusterScope, ESIntegTestCase.NumShards, ESIntegTestCase.Scope, ESIntegTestCase.SuiteScopeTestCase, ESIntegTestCase.SuppressLocalMode, ESIntegTestCase.SuppressNetworkMode, ESIntegTestCase.TestSeedPlugin, ESIntegTestCase.ThirdParty

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

ESTestCase.GeohashGenerator

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 and Description
static java.lang.String	TESTS_BACKWARDS_COMPATIBILITY Key used to set the path for the elasticsearch executable used to run backwards compatibility tests from via the commandline -D"tests.bwc"
static java.lang.String	TESTS_BACKWARDS_COMPATIBILITY_PATH Key used to set the path for the elasticsearch executable used to run backwards compatibility tests from via the commandline -D"tests.bwc.path"
static java.lang.String	TESTS_BACKWARDS_COMPATIBILITY_VERSION

Fields inherited from class org.elasticsearch.test.ESIntegTestCase

DEFAULT_MAX_NUM_SHARDS, DEFAULT_MIN_NUM_SHARDS, INDEX_TEST_SEED_SETTING, SUITE_CLUSTER_NODE_PREFIX, SYSPROP_THIRDPARTY, TEST_CLUSTER_NODE_PREFIX, TESTS_CLIENT_RATIO, TESTS_CLUSTER, TESTS_ENABLE_MOCK_MODULES

Fields inherited from class org.elasticsearch.test.ESTestCase

checkIndexFailed, failureAndSuccessEvents, logger

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_CODEC, TEST_DIRECTORY, TEST_DOCVALUESFORMAT, TEST_LINE_DOCS_FILE, TEST_NIGHTLY, TEST_POSTINGSFORMAT, TEST_SLOW, TEST_THROTTLING, TEST_WEEKLY, VERBOSE

Constructor Summary

Constructors

Constructor and Description
ESBackcompatTestCase()

Method Summary

Modifier and Type	Method and Description
void	assertAllShardsOnNodes(java.lang.String index, java.lang.String pattern)
CompositeTestCluster	backwardsCluster()
protected TestCluster	buildTestCluster(ESIntegTestCase.Scope scope, long seed)
protected org.elasticsearch.common.settings.Settings	commonNodeSettings(int nodeOrdinal)
org.elasticsearch.Version	compatibilityVersion() Retruns the tests compatibility version.
protected org.elasticsearch.common.settings.Settings	externalNodeSettings(int nodeOrdinal)
static org.elasticsearch.Version	globalCompatibilityVersion() Returns a global compatibility version that is set via the or "tests.bwc.version" system property.
protected int	maxExternalNodes()
protected int	maximumNumberOfReplicas()
protected int	minExternalNodes()
protected org.elasticsearch.common.settings.Settings	nodeSettings(int nodeOrdinal) This method is used to obtain settings for the Nth node in the cluster.
protected org.elasticsearch.common.settings.Settings	requiredSettings()

Methods inherited from class org.elasticsearch.test.ESIntegTestCase

addMockTransportService, admin, after, afterClass, afterInternal, allowNodes, assertAllShardsOnNodes, assertConcreteMappingsOnAll, assertMappingOnMaster, assertResultsAndLogOnFailure, before, beforeClass, beforeIndexDeletion, beforeInternal, clearDisruptionScheme, clearScroll, client, client, clients, cluster, clusterService, createIndex, createRestClient, createRestClient, dataNodeClient, disableAllocation, disableIndexBlock, enableAllocation, enableIndexBlock, ensureClusterSizeConsistency, ensureClusterStateConsistency, ensureGreen, ensureGreen, ensureSearchable, ensureStableCluster, ensureStableCluster, ensureStableCluster, ensureStableCluster, ensureYellow, excludeTemplates, externalClusterClientSettings, flush, flushAndRefresh, forceMerge, get, getClientWrapper, getMockPlugins, getNodeConfigSource, getNumShards, getPerTestTransportClientRatio, getRestClient, ignoreExternalCluster, index, index, index, index, index, indexExists, indexRandom, indexRandom, indexRandom, indexRandom, indexRandom, indexSettings, internalCluster, isInternalCluster, logClusterState, logMemoryStats, logSegmentsState, maximumNumberOfShards, minimumNumberOfReplicas, minimumNumberOfShards, nodePlugins, numberOfReplicas, numberOfShards, prepareBackwardsDataDir, prepareCreate, prepareCreate, prepareCreate, randomIndexTemplate, randomRepoPath, randomRepoPath, refresh, resolveIndex, routingKeyForShard, setClusterReadOnly, setDisruptionScheme, setMinimumMasterNodes, setRandomIndexSettings, setupSuiteScopeCluster, transportClientPlugins, transportClientSettings, waitForDocs, waitForDocs, waitForDocs, waitForRelocation, waitForRelocation, waitNoPendingTasksOnAll

Methods inherited from class org.elasticsearch.test.ESTestCase

afterIfFailed, afterIfSuccessful, assertAllIndicesRemovedAndDeletionCompleted, assertArrayEquals, assertBusy, assertBusy, assertEquals, assertionsEnabled, assertPathHasBeenCleared, awaitBusy, awaitBusy, between, createAnalysisService, createAnalysisService, createAnalysisService, ensureAllSearchContextsReleased, ensureCheckIndexPassed, ensureCleanedUp, frequently, generateRandomStringArray, generateRandomStringArray, getBwcIndicesPath, getDataPath, getSuiteFailureMarker, iterations, maybeSet, newNodeEnvironment, newNodeEnvironment, newTestIndicesModule, newTestScriptModule, randomAsciiOfLength, randomAsciiOfLengthBetween, randomBoolean, randomByte, randomDateTimeZone, randomDouble, randomDoubleBetween, randomFloat, randomFrom, randomFrom, randomFrom, randomFrom, randomGeohash, randomInt, randomInt, randomIntBetween, randomLong, randomPositiveLong, randomPositiveTimeValue, randomRealisticUnicodeOfCodepointLength, randomRealisticUnicodeOfCodepointLengthBetween, randomRealisticUnicodeOfLength, randomRealisticUnicodeOfLengthBetween, randomShort, randomSubsetOf, randomSubsetOf, randomSubsetOf, randomTimeValue, randomUnicodeOfCodepointLength, randomUnicodeOfCodepointLengthBetween, randomUnicodeOfLength, randomUnicodeOfLengthBetween, randomUnique, randomValueOtherThan, randomValueOtherThanMany, resetCheckIndexStatus, restoreContentType, restoreFileSystem, scaledRandomIntBetween, setContentType, setFileSystem, settings, shuffleXContent, spinForAtLeastOneMillisecond, terminate, terminate, tmpPaths

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, atLeast, atLeast, closeAfterSuite, closeAfterTest, collate, createTempDir, createTempDir, createTempFile, createTempFile, dumpArray, dumpIterator, expectThrows, getBaseTempDirForTestClass, getDataInputStream, getOnlyLeafReader, getTestClass, getTestName, 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, 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, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, 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 Detail

TESTS_BACKWARDS_COMPATIBILITY

public static final java.lang.String TESTS_BACKWARDS_COMPATIBILITY

Key used to set the path for the elasticsearch executable used to run backwards compatibility tests from via the commandline -D"tests.bwc"

See Also:

Constant Field Values

TESTS_BACKWARDS_COMPATIBILITY_VERSION

public static final java.lang.String TESTS_BACKWARDS_COMPATIBILITY_VERSION

See Also:

Constant Field Values

TESTS_BACKWARDS_COMPATIBILITY_PATH

public static final java.lang.String TESTS_BACKWARDS_COMPATIBILITY_PATH

Key used to set the path for the elasticsearch executable used to run backwards compatibility tests from via the commandline -D"tests.bwc.path"

See Also:

Constant Field Values

Constructor Detail

ESBackcompatTestCase

public ESBackcompatTestCase()

Method Detail

compatibilityVersion

public org.elasticsearch.Version compatibilityVersion()

Retruns the tests compatibility version.

globalCompatibilityVersion

public static org.elasticsearch.Version globalCompatibilityVersion()

Returns a global compatibility version that is set via the or "tests.bwc.version" system property. If both are unset the current version is used as the global compatibility version. This compatibility version is used for static randomization. For per-suite compatibility version see compatibilityVersion()

backwardsCluster

public CompositeTestCluster backwardsCluster()

buildTestCluster

protected TestCluster buildTestCluster(ESIntegTestCase.Scope scope,
                                       long seed)
                                throws java.io.IOException

Overrides:

buildTestCluster in class ESIntegTestCase

Throws:

java.io.IOException

minExternalNodes

protected int minExternalNodes()

maxExternalNodes

protected int maxExternalNodes()

maximumNumberOfReplicas

protected int maximumNumberOfReplicas()

Overrides:

maximumNumberOfReplicas in class ESIntegTestCase

requiredSettings

protected org.elasticsearch.common.settings.Settings requiredSettings()

nodeSettings

protected org.elasticsearch.common.settings.Settings nodeSettings(int nodeOrdinal)

Description copied from class: ESIntegTestCase

This method is used to obtain settings for the Nth 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.

Overrides:

nodeSettings in class ESIntegTestCase

assertAllShardsOnNodes

public void assertAllShardsOnNodes(java.lang.String index,
                                   java.lang.String pattern)

commonNodeSettings

protected org.elasticsearch.common.settings.Settings commonNodeSettings(int nodeOrdinal)

externalNodeSettings

protected org.elasticsearch.common.settings.Settings externalNodeSettings(int nodeOrdinal)