com.exasol.exasoltestsetup.ExasolTestSetup Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of exasol-test-setup-abstraction-java Show documentation
Common interface for testing with an exasol database local and on AWS using Java.
The newest version!
package com.exasol.exasoltestsetup;

import java.net.InetSocketAddress;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.List;
import java.util.Set;

import com.exasol.bucketfs.Bucket;

/**
 * This is an interface for accessing a running Exasol database for testing. It abstracts over the type of installation
 * (cloud / docker, cluster / single-node).
 */
public interface ExasolTestSetup extends AutoCloseable {

    /**
     * Create a connection to the Exasol database with default credentials.
     * 
     * @return SQL connection
     * @throws SQLException if something went wrong
     */
    public Connection createConnection() throws SQLException;

    /**
     * Get the information required for connection to the Exasol database.
     * 
     * @return object containing the connection details
     */
    public SqlConnectionInfo getConnectionInfo();

    /**
     * Get an API object for the default BucketFS bucket.
     * 
     * @return API object for the default BucketFS bucket
     */
    public Bucket getDefaultBucket();

    /**
     * Make a local TCP service available from within the Exasol database.
     * 
     * You can use this method for example for accessing a local s3 bucket implementation from inside the Exasol
     * database. Another example is to connect from UDFs to a debugger running on the test PC.
     * 
     * 
     * @param localPort port of the service @ localhost
     * @return address under which the service is available from within the exasol database (same port)
     */
    public InetSocketAddress makeLocalTcpServiceAccessibleFromDatabase(int localPort);

    /**
     * Make the port of a database node available from localhost. If the target is a cluster, this methods sets up a
     * redirect for each node and returns multiple local port numbers.
     * 
     * You can use this method for example to connect from your test PC to a profiling agent that listens on a TCP
     * socket in an UDF.
     * 
     * 
     * @param databasePort database port
     * @return list of local port numbers. One entry per cluster node.
     */
    public List makeDatabaseTcpServiceAccessibleFromLocalhost(int databasePort);

    /**
     * Make a given TCP service available inside of the Exasol database.
     * 
     * @param serviceAddress service address in the format host:port
     * @return modified service address
     */
    public default InetSocketAddress makeTcpServiceAccessibleFromDatabase(final InetSocketAddress serviceAddress) {
        final boolean isLocalAddress = Set.of("localhost", "127.0.0.1").contains(serviceAddress.getHostName());
        if (isLocalAddress) {
            return this.makeLocalTcpServiceAccessibleFromDatabase(serviceAddress.getPort());
        } else {
            return serviceAddress;
        }
    }

    @Override
    public void close();
}