org.opensearch.test.ParameterizedOpenSearchIntegTestCase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of framework Show documentation
OpenSearch subproject :test:framework
There is a newer version: 2.17.0
/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

package org.opensearch.test;

import org.opensearch.common.settings.Settings;

import static org.opensearch.search.SearchService.CLUSTER_CONCURRENT_SEGMENT_SEARCH_MODE;
import static org.opensearch.search.SearchService.CLUSTER_CONCURRENT_SEGMENT_SEARCH_SETTING;
import static org.opensearch.search.SearchService.CONCURRENT_SEGMENT_SEARCH_MODE_ALL;
import static org.opensearch.search.SearchService.CONCURRENT_SEGMENT_SEARCH_MODE_AUTO;

/**
 * Base class for running the tests with parameterization of the settings.
 * For any class that wants to use parameterization, use {@link com.carrotsearch.randomizedtesting.annotations.ParametersFactory} to generate
 * different parameters.
 *
 * There are two flavors of applying the parameterized settings to the cluster on the suite level:
 *  - static: the cluster will be pre-created with the settings at startup, please subclass {@link ParameterizedStaticSettingsOpenSearchIntegTestCase}, the method
 *    {@link #hasSameParametersAs(ParameterizedOpenSearchIntegTestCase)} is being used by the test scaffolding to detect when the test suite is instantiated with
 *    the new parameters and the test cluster has to be recreated
 *  - dynamic: the cluster will be created once before the test suite and the settings will be applied dynamically , please subclass {@link ParameterizedDynamicSettingsOpenSearchIntegTestCase},
 *    please notice that not all settings could be changed dynamically
 *
 * If the test suites use per-test level, the cluster will be recreated per each test method (applying static or dynamic settings).
 */
abstract class ParameterizedOpenSearchIntegTestCase extends OpenSearchIntegTestCase {
    protected final Settings settings;

    ParameterizedOpenSearchIntegTestCase(Settings settings) {
        this.settings = settings;
    }

    // This method shouldn't be called in setupSuiteScopeCluster(). Only call this method inside single test.
    public void indexRandomForConcurrentSearch(String... indices) throws InterruptedException {
        if (CLUSTER_CONCURRENT_SEGMENT_SEARCH_SETTING.get(settings)
            || CLUSTER_CONCURRENT_SEGMENT_SEARCH_MODE.get(settings).equals(CONCURRENT_SEGMENT_SEARCH_MODE_AUTO)
            || CLUSTER_CONCURRENT_SEGMENT_SEARCH_MODE.get(settings).equals(CONCURRENT_SEGMENT_SEARCH_MODE_ALL)) {
            indexRandomForMultipleSlices(indices);
        }
    }

    /**
     * Compares the parameters of the two {@link ParameterizedOpenSearchIntegTestCase} test suite instances.
     * This method is being use by {@link OpenSearchTestClusterRule} to determine when the parameterized test suite is instantiated with
     * another set of parameters and the test cluster has to be recreated to reflect that.
     * @param obj instance of the {@link ParameterizedOpenSearchIntegTestCase} to compare with
     * @return {@code true} of the parameters of the test suites are the same, {@code false} otherwise
     */
    abstract boolean hasSameParametersAs(ParameterizedOpenSearchIntegTestCase obj);
}