/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the "Elastic License
 * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
 * Public License v 1"; you may not use this file except in compliance with, at
 * your election, the "Elastic License 2.0", the "GNU Affero General Public
 * License v3.0 only", or the "Server Side Public License, v 1".
 */

package org.elasticsearch.test.rest.yaml;

/**
 * Contains the logic for which test suites should execute which tests.
 * YAML tests are split between multiple suites to avoid the test suite timing out.
 *
 * IMPORTANT: This is a temporary solution to reduce the number of test failures
 * due to suite timeouts for this large test set which suffers the problem more
 * than most. It is not a pattern that should be copied or applied elsewhere.
 * A longer term solution would be the test runner automatically splitting the
 * tests.
 */
class TestSuiteApiCheck {

    /**
     * Returns true if the test suite should run the tests for the given API.
     * @param testSuite a concrete subclass of ESClientYamlSuiteTestCase
     * @param apiName The API name as described in the rest spec e.g. `search`
     * @return True if the test should be run
     */
    public static boolean shouldExecuteTest(ESClientYamlSuiteTestCase testSuite, String apiName) {
        return switch (testSuite) {
            case CssSearchYamlTestSuiteIT cssSearch -> isSearchApi(apiName);
            case RcsCcsSearchYamlTestSuiteIT rssSearch -> isSearchApi(apiName);
            // Search tests are not executed in the common suite.
            case CcsCommonYamlTestSuiteIT cssCommon -> isSearchApi(apiName) == false;
            case RcsCcsCommonYamlTestSuiteIT rssCommon -> isSearchApi(apiName) == false;
            default -> throw new IllegalArgumentException("unexpected test suite [" + testSuite.getClass().getSimpleName() + "]");
        };
    }

    private static boolean isSearchApi(String apiName) {
        return apiName.startsWith("search") || apiName.startsWith("msearch");
    }

    private TestSuiteApiCheck() {}
}