org.apache.drill.test

Class QueryTestUtil

java.lang.Object

org.apache.drill.test.QueryTestUtil

public class QueryTestUtil
extends Object

Utilities useful for tests that issue SQL queries.

Method Summary

Modifier and Type	Method and Description
static long	ConvertDateToLong(String dateString) When writing Drill unit tests, Drill will output strings for dates.
static DrillClient	createClient(DrillConfig drillConfig, RemoteServiceSet remoteServiceSet, int maxWidth, Properties props) Create a DrillClient that can be used to query a drill cluster.
static void	generateCompressedFile(String fileName, String codecName, String outFileName) Generates a compressed version of the file for testing
static int	getFreePortNumber(int portNumber, int numberOfAttempts) Checks that port with specified number is free and returns it.
static String	normalizeQuery(String query) Normalize the query relative to the test environment.
static void	restoreScalarReplacementOption(Drillbit drillbit, String srOption) Restore the original scalar replacement option returned from setupScalarReplacementOption().
static OptionValue	setupScalarReplacementOption(Drillbit drillbit, ClassTransformer.ScalarReplacementOption srOption) Set up the options to test the scalar replacement retry option (see ClassTransformer.java).
static void	testRunAndLog(DrillClient drillClient, String queryString) Execute one or more queries separated by semicolons, and log the results.
static void	testRunAndLog(DrillClient drillClient, String query, Object... args) Execute one or more queries separated by semicolons, and log the results, with the option to add formatted arguments to the query string.
static int	testRunAndLog(DrillClient drillClient, UserBitShared.QueryType type, String queryString) Execute a SQL query, and log the results.
static void	testRunAndOutput(DrillClient drillClient, String queryString, boolean print) Execute one or more queries separated by semicolons, and output the results.
static void	testRunAndPrint(DrillClient drillClient, String queryString) Execute one or more queries separated by semicolons, and print the results.
static void	testRunAndPrint(DrillClient drillClient, String query, Object... args) Execute one or more queries separated by semicolons, and print the results, with the option to add formatted arguments to the query string.
static int	testRunAndPrint(DrillClient drillClient, UserBitShared.QueryType type, String queryString) Execute a SQL query, and print the results.
static void	testWithListener(DrillClient drillClient, UserBitShared.QueryType type, String queryString, UserResultsListener resultListener) Execute a single query with a user supplied result listener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createClient

public static DrillClient createClient(DrillConfig drillConfig,
                                       RemoteServiceSet remoteServiceSet,
                                       int maxWidth,
                                       Properties props)
                                throws RpcException,
                                       OutOfMemoryException

Create a DrillClient that can be used to query a drill cluster.

Parameters:

drillConfig -

remoteServiceSet - remote service set

maxWidth - maximum width per node

props - Connection properties contains properties such as "user", "password", "schema" etc

Returns:

the newly created client

Throws:

RpcException - if there is a problem setting up the client

OutOfMemoryException

normalizeQuery

public static String normalizeQuery(String query)

Normalize the query relative to the test environment.

Looks for "${WORKING_PATH}" in the query string, and replaces it the current working patch obtained from TestTools#WORKING_PATH.

Parameters:

query - the query string

Returns:

the normalized query string

testRunAndOutput

public static void testRunAndOutput(DrillClient drillClient,
                                    String queryString,
                                    boolean print)
                             throws Exception

Execute one or more queries separated by semicolons, and output the results.

Parameters:

drillClient - drill client to use

queryString - the query string

print - True to output results to stdout. False to log results.

Throws:

Exception - An error while running the query.

testRunAndLog

public static int testRunAndLog(DrillClient drillClient,
                                UserBitShared.QueryType type,
                                String queryString)
                         throws Exception

Execute a SQL query, and log the results.

Parameters:

drillClient - drill client to use

type - type of the query

queryString - query string

Returns:

number of rows returned

Throws:

Exception - An error while running the query.

testRunAndLog

public static void testRunAndLog(DrillClient drillClient,
                                 String queryString)
                          throws Exception

Execute one or more queries separated by semicolons, and log the results.

Parameters:

drillClient - drill client to use

queryString - the query string

Throws:

Exception - An error while running the queries.

testRunAndLog

public static void testRunAndLog(DrillClient drillClient,
                                 String query,
                                 Object... args)
                          throws Exception

Execute one or more queries separated by semicolons, and log the results, with the option to add formatted arguments to the query string.

Parameters:

drillClient - drill client to use

query - the query string; may contain formatting specifications to be used by String.format(String, Object...).

args - optional args to use in the formatting call for the query string

Throws:

Exception - An error while running the query.

testRunAndPrint

public static int testRunAndPrint(DrillClient drillClient,
                                  UserBitShared.QueryType type,
                                  String queryString)
                           throws Exception

Execute a SQL query, and print the results.

Parameters:

drillClient - drill client to use

type - type of the query

queryString - query string

Returns:

number of rows returned

Throws:

Exception - An error while running the query.

testRunAndPrint

public static void testRunAndPrint(DrillClient drillClient,
                                   String queryString)
                            throws Exception

Execute one or more queries separated by semicolons, and print the results.

Parameters:

drillClient - drill client to use

queryString - the query string

Throws:

Exception - An error while running the queries.

testRunAndPrint

public static void testRunAndPrint(DrillClient drillClient,
                                   String query,
                                   Object... args)
                            throws Exception

Execute one or more queries separated by semicolons, and print the results, with the option to add formatted arguments to the query string.

Parameters:

drillClient - drill client to use

query - the query string; may contain formatting specifications to be used by String.format(String, Object...).

args - optional args to use in the formatting call for the query string

Throws:

Exception - An error while running the query.

testWithListener

public static void testWithListener(DrillClient drillClient,
                                    UserBitShared.QueryType type,
                                    String queryString,
                                    UserResultsListener resultListener)

Execute a single query with a user supplied result listener.

Parameters:

drillClient - drill client to use

type - type of query

queryString - the query string

resultListener - the result listener

setupScalarReplacementOption

public static OptionValue setupScalarReplacementOption(Drillbit drillbit,
                                                       ClassTransformer.ScalarReplacementOption srOption)

Set up the options to test the scalar replacement retry option (see ClassTransformer.java). Scalar replacement rewrites bytecode to replace value holders (essentially boxed values) with their member variables as locals. There is still one pattern that doesn't work, and occasionally new ones are introduced. This can be used in tests that exercise failing patterns.

This also flushes the compiled code cache.

Parameters:

drillbit - the drillbit

srOption - the scalar replacement option value to use

Returns:

the original scalar replacement option setting (so it can be restored)

restoreScalarReplacementOption

public static void restoreScalarReplacementOption(Drillbit drillbit,
                                                  String srOption)

Restore the original scalar replacement option returned from setupScalarReplacementOption().

This also flushes the compiled code cache.

Parameters:

drillbit - the drillbit

srOption - the scalar replacement option value to use

getFreePortNumber

public static int getFreePortNumber(int portNumber,
                                    int numberOfAttempts)
                             throws IOException

Checks that port with specified number is free and returns it. Otherwise, increases port number and checks until free port is found or the number of attempts is reached specified numberOfAttempts

Parameters:

portNumber - initial port number

numberOfAttempts - max number of attempts to find port with greater number

Returns:

free port number

Throws:

BindException - if free port was not found and all attempts were used.

IOException

generateCompressedFile

public static void generateCompressedFile(String fileName,
                                          String codecName,
                                          String outFileName)
                                   throws IOException

Generates a compressed version of the file for testing

Parameters:

fileName - Name of the input file

codecName - The desired CODEC to be used.

outFileName - Name of generated compressed file

Throws:

IOException - If function cannot generate file, throws IOException

ConvertDateToLong

public static long ConvertDateToLong(String dateString)

When writing Drill unit tests, Drill will output strings for dates. However, these strings must be converted into timestamps (long) for use in unit tests. This method provides a convenient way to do so.

Parameters:

dateString - An input date string from Drill output

Returns:

The datestring in epoch/millis.