com.apple.foundationdb.relational.yamltests.YamlConnectionFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yaml-tests Show documentation

Tests of the Relational project driven off of YAML specifications.

The newest version!

/*
 * YamlConnectionFactory.java
 *
 * This source file is part of the FoundationDB open source project
 *
 * Copyright 2015-2025 Apple Inc. and the FoundationDB project authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.apple.foundationdb.relational.yamltests;

import com.apple.foundationdb.relational.api.RelationalConnection;
import com.apple.foundationdb.relational.yamltests.server.SemanticVersion;

import javax.annotation.Nonnull;
import java.net.URI;
import java.sql.SQLException;
import java.util.Set;

/**
 * Connection factory to support yaml tests (see {@link YamlRunner}.
 */
public interface YamlConnectionFactory {
    /**
     * Convert a connection uri into an actual connection.
     *
     * @param connectPath the path to connect to
     *
     * @return A new {@link RelationalConnection} for the given path appropriate for this test class
     *
     * @throws SQLException if we cannot connect
     */
    YamlConnection getNewConnection(@Nonnull URI connectPath) throws SQLException;

    /**
     * The versions that the connection has, other than the current code.
     * 
     * If we are just testing against the current code, this will be empty, but otherwise it will include the
     * versions that we're testing. In the future we may want to support tests that don't run against the
     * current version, but that's not currently needed, so not supported.
     * 
     *
     * @return A set of versions that we are testing against, or an empty set if just testing against the current
     * version
     */
    Set getVersionsUnderTest();

    /**
     * Whether the connection supports multiple servers.
     * There are some changes to the behavior that are to be expected when running the tests in multi-server mode,
     * this method allows the system to make that decision.
     *
     * @return TRUE if this connection factory can support multiple servers, false otherwise.
     */
    default boolean isMultiServer() {
        return false;
    }
}