org.apache.drill

Class PlanTestBase

java.lang.Object

DrillTest

org.apache.drill.exec.ExecTest

org.apache.drill.test.BaseTestQuery

org.apache.drill.PlanTestBase

Direct Known Subclasses:

BaseTestImpersonation, FormatPluginSerDeTest, JoinTestBase, TestBaseViewSupport, TestConstantFolding, TestCorrelation, TestCorruptParquetDateCorrection, TestCTASJson, TestCTASPartitionFilter, TestDirectoryExplorerUDFs, TestDirScanToValuesConversion, TestDropTable, TestFlattenPlanning, TestInfoSchemaFilterPushDown, TestLimitPlanning, TestLocalExchange, TestMemoryCalculator, TestMergeFilterPlan, TestOrderedMuxExchange, TestParquetFilterPushDown, TestParquetFilterPushDownForComplexTypes, TestParquetFilterPushDownForDateTimeCasts, TestParquetFilterPushdownWithTransitivePredicates, TestParquetMetadataCache, TestPartitionSender, TestPlanVerificationUtilities, TestProjectPushDown, TestPushDownAndPruningWithItemStar, TestSimpleRepeatedFunctions, TestSystemTable

public class PlanTestBase
extends BaseTestQuery

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.drill.test.BaseTestQuery

BaseTestQuery.ClassicTestServices, BaseTestQuery.SilentListener, BaseTestQuery.TestResultSet

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	EXPECTED_NOT_FOUND
protected static String	JSON_FORMAT
protected static String	OPTIQ_FORMAT
protected static String	UNEXPECTED_FOUND

Fields inherited from class org.apache.drill.test.BaseTestQuery

allocator, bits, client, config, serviceSet

Fields inherited from class org.apache.drill.exec.ExecTest

c, dirTestWatcher, optionManager

Constructor Summary

Constructors

Constructor and Description
PlanTestBase()

Method Summary

Modifier and Type	Method and Description
static void	checkForMetadataFile(String table) Helper method for checking the metadata file existence
static void	createMetadataDir(String table) Create a temp metadata directory to query the metadata summary cache file
static String	getPhysicalJsonPlan(String sql) Converts given sql query into physical JSON plan representation.
protected static String	getPlanInString(String sql, String columnName)
static void	testPhysicalPlan(String sql, String... expectedSubstrs) This method will take a SQL string statement, get the PHYSICAL plan in json format.
static void	testPhysicalPlanExecutionBasedOnQuery(String query) Creates physical plan for the given query and then executes this plan.
static void	testPlanMatchingPatterns(String query, Pattern[] expectedPatterns, Pattern[] excludedPatterns)
static void	testPlanMatchingPatterns(String query, String... expectedPatterns) The same as above, but without excludedPatterns
static void	testPlanMatchingPatterns(String query, String[] expectedPatterns, String[] excludedPatterns) Runs an explain plan query and check for expected regex patterns (in optiq text format), also ensure excluded patterns are not found.
static void	testPlanMatchingPatterns(String query, String planFormat, String[] expectedPatterns, String[] excludedPatterns)
static void	testPlanOneExcludedPattern(String query, String excludedPattern)
static void	testPlanOneExpectedPattern(String query, String expectedPattern)
static void	testPlanOneExpectedPatternOneExcluded(String query, String expectedPattern, String excludedPattern)
static void	testPlanSubstrPatterns(String query, String[] expectedPatterns, String[] excludedPatterns) Runs an explain plan query and check for expected substring patterns (in optiq text format), also ensure excluded patterns are not found.
static void	testPlanWithAttributesMatchingPatterns(String query, String[] expectedPatterns, String[] excludedPatterns) Runs an explain plan including attributes query and check for expected regex patterns (in optiq text format), also ensure excluded patterns are not found.
static void	testRelLogicalJoinOrder(String sql, String... expectedSubstrs) This method will take a SQL string statement, get the LOGICAL plan in Optiq RelNode format.
static void	testRelLogicalPlanLevDigest(String sql, String... expectedSubstrs) This method will take a SQL string statement, get the LOGICAL plan in Optiq RelNode format.
static void	testRelLogicalPlanLevExplain(String sql, String... expectedSubstrs) This method will take a SQL string statement, get the LOGICAL plan in Optiq RelNode format.
static void	testRelPhysicalJoinOrder(String sql, String... expectedSubstrs) This method will take a SQL string statement, get the LOGICAL plan in Optiq RelNode format.
static void	testRelPhysicalPlanLevDigest(String sql, String... expectedSubstrs) This method will take a SQL string statement, get the PHYSICAL plan in Optiq RelNode format.
static void	testRelPhysicalPlanLevExplain(String sql, String... expectedSubstrs) This method will take a SQL string statement, get the PHYSICAL plan in Optiq RelNode format.

Methods inherited from class org.apache.drill.test.BaseTestQuery

alterSession, cloneDefaultTestConfigProperties, closeClient, errorMsgTestHelper, getAllocator, getDrillbitContext, getFile, getPhysicalFileFromResource, getResultString, getUserPort, logResult, newTest, parseErrorHelper, printResult, resetAllSessionOptions, resetDrillbitCount, resetSessionOption, runSQL, setColumnWidth, setColumnWidths, setSessionOption, setSessionOption, setSessionOption, setSessionOption, setupDefaultTestCluster, test, test, testBuilder, testLogicalWithResults, testNoResult, testNoResult, testPhysical, testPhysicalFromFile, testPhysicalWithResults, testPreparedStatement, testRunAndPrint, testRunAndReturn, testSql, testSqlWithResults, testWithListener, updateClient, updateClient, updateClient, updateTestCluster, updateTestCluster

Methods inherited from class org.apache.drill.exec.ExecTest

clear, getLocalFileSystem, mockDrillbitContext, mockUsDateFormatSymbols, mockUtcDateTimeZone, parseExpr, setupOptionManager

Methods inherited from class java.lang.Object

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

Field Detail

OPTIQ_FORMAT

protected static final String OPTIQ_FORMAT

See Also:

Constant Field Values

JSON_FORMAT

protected static final String JSON_FORMAT

See Also:

Constant Field Values

EXPECTED_NOT_FOUND

protected static final String EXPECTED_NOT_FOUND

See Also:

Constant Field Values

UNEXPECTED_FOUND

protected static final String UNEXPECTED_FOUND

See Also:

Constant Field Values

Constructor Detail

PlanTestBase

public PlanTestBase()

Method Detail

testPhysicalPlan

public static void testPhysicalPlan(String sql,
                                    String... expectedSubstrs)
                             throws Exception

This method will take a SQL string statement, get the PHYSICAL plan in json format. Then check the physical plan against the list expected substrs. Verify all the expected strings are contained in the physical plan string.

Throws:

Exception

getPhysicalJsonPlan

public static String getPhysicalJsonPlan(String sql)
                                  throws Exception

Converts given sql query into physical JSON plan representation.

Parameters:

sql - sql query

Returns:

physical plan in JSON format

Throws:

Exception

testPlanMatchingPatterns

public static void testPlanMatchingPatterns(String query,
                                            String[] expectedPatterns,
                                            String[] excludedPatterns)
                                     throws Exception

Runs an explain plan query and check for expected regex patterns (in optiq text format), also ensure excluded patterns are not found. Either list can be empty or null to skip that part of the check. See the convenience methods for passing a single string in either the excluded list, included list or both.

Parameters:

query - - an explain query, this method does not add it for you

expectedPatterns - - list of patterns that should appear in the plan

excludedPatterns - - list of patterns that should not appear in the plan

Throws:

Exception - - if an inclusion or exclusion check fails, or the planning process throws an exception

testPlanMatchingPatterns

public static void testPlanMatchingPatterns(String query,
                                            Pattern[] expectedPatterns,
                                            Pattern[] excludedPatterns)
                                     throws Exception

Throws:

Exception

testPlanMatchingPatterns

public static void testPlanMatchingPatterns(String query,
                                            String planFormat,
                                            String[] expectedPatterns,
                                            String[] excludedPatterns)
                                     throws Exception

Throws:

Exception

testPlanMatchingPatterns

public static void testPlanMatchingPatterns(String query,
                                            String... expectedPatterns)
                                     throws Exception

The same as above, but without excludedPatterns

Throws:

Exception

testPlanWithAttributesMatchingPatterns

public static void testPlanWithAttributesMatchingPatterns(String query,
                                                          String[] expectedPatterns,
                                                          String[] excludedPatterns)
                                                   throws Exception

Runs an explain plan including attributes query and check for expected regex patterns (in optiq text format), also ensure excluded patterns are not found. Either list can be empty or null to skip that part of the check. See the convenience methods for passing a single string in either the excluded list, included list or both.

Parameters:

query - - an explain query, this method does not add it for you

expectedPatterns - - list of patterns that should appear in the plan

excludedPatterns - - list of patterns that should not appear in the plan

Throws:

Exception - - if an inclusion or exclusion check fails, or the planning process throws an exception

testPlanSubstrPatterns

public static void testPlanSubstrPatterns(String query,
                                          String[] expectedPatterns,
                                          String[] excludedPatterns)
                                   throws Exception

Runs an explain plan query and check for expected substring patterns (in optiq text format), also ensure excluded patterns are not found. Either list can be empty or null to skip that part of the check. This is different from testPlanMatchingPatterns in that this one use substring contains, in stead of regex pattern matching. This one is useful when the pattern contains many regex reserved chars, and you do not want to put the escape char. See the convenience methods for passing a single string in either the excluded list, included list or both.

Parameters:

query - - an explain query, this method does not add it for you

expectedPatterns - - list of patterns that should appear in the plan

excludedPatterns - - list of patterns that should not appear in the plan

Throws:

Exception - - if an inclusion or exclusion check fails, or the planning process throws an exception

testPlanOneExpectedPatternOneExcluded

public static void testPlanOneExpectedPatternOneExcluded(String query,
                                                         String expectedPattern,
                                                         String excludedPattern)
                                                  throws Exception

Throws:

Exception

testPlanOneExpectedPattern

public static void testPlanOneExpectedPattern(String query,
                                              String expectedPattern)
                                       throws Exception

Throws:

Exception

testPlanOneExcludedPattern

public static void testPlanOneExcludedPattern(String query,
                                              String excludedPattern)
                                       throws Exception

Throws:

Exception

testRelLogicalJoinOrder

public static void testRelLogicalJoinOrder(String sql,
                                           String... expectedSubstrs)
                                    throws Exception

This method will take a SQL string statement, get the LOGICAL plan in Optiq RelNode format. Then check the physical plan against the list expected substrs. Verify all the expected strings are contained in the physical plan string.

Throws:

Exception

testRelPhysicalJoinOrder

public static void testRelPhysicalJoinOrder(String sql,
                                            String... expectedSubstrs)
                                     throws Exception

This method will take a SQL string statement, get the LOGICAL plan in Optiq RelNode format. Then check the physical plan against the list expected substrs. Verify all the expected strings are contained in the physical plan string.

Throws:

Exception

testRelPhysicalPlanLevDigest

public static void testRelPhysicalPlanLevDigest(String sql,
                                                String... expectedSubstrs)
                                         throws Exception

This method will take a SQL string statement, get the PHYSICAL plan in Optiq RelNode format. Then check the physical plan against the list expected substrs. Verify all the expected strings are contained in the physical plan string.

Throws:

Exception

testRelLogicalPlanLevDigest

public static void testRelLogicalPlanLevDigest(String sql,
                                               String... expectedSubstrs)
                                        throws Exception

This method will take a SQL string statement, get the LOGICAL plan in Optiq RelNode format. Then check the physical plan against the list expected substrs. Verify all the expected strings are contained in the physical plan string.

Throws:

Exception

testRelPhysicalPlanLevExplain

public static void testRelPhysicalPlanLevExplain(String sql,
                                                 String... expectedSubstrs)
                                          throws Exception

This method will take a SQL string statement, get the PHYSICAL plan in Optiq RelNode format. Then check the physical plan against the list expected substrs. Verify all the expected strings are contained in the physical plan string.

Throws:

Exception

testRelLogicalPlanLevExplain

public static void testRelLogicalPlanLevExplain(String sql,
                                                String... expectedSubstrs)
                                         throws Exception

This method will take a SQL string statement, get the LOGICAL plan in Optiq RelNode format. Then check the physical plan against the list expected substrs. Verify all the expected strings are contained in the physical plan string.

Throws:

Exception

testPhysicalPlanExecutionBasedOnQuery

public static void testPhysicalPlanExecutionBasedOnQuery(String query)
                                                  throws Exception

Creates physical plan for the given query and then executes this plan. This method is useful for testing serialization / deserialization issues.

Parameters:

query - query string

Throws:

Exception

checkForMetadataFile

public static void checkForMetadataFile(String table)

Helper method for checking the metadata file existence

Parameters:

table - table name or table path

getPlanInString

protected static String getPlanInString(String sql,
                                        String columnName)
                                 throws Exception

Throws:

Exception

createMetadataDir

public static void createMetadataDir(String table)
                              throws IOException

Create a temp metadata directory to query the metadata summary cache file

Parameters:

table - table name or table path

Throws:

IOException