TestBuilder (Drill : 1.19.0 API)

java.lang.Object
- org.apache.drill.test.TestBuilder

Direct Known Subclasses:

TestBuilder.BaselineQueryTestBuilder, TestBuilder.CSVTestBuilder, TestBuilder.JSONTestBuilder, TestBuilder.SchemaTestBuilder
```
public class TestBuilder
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`TestBuilder.BaselineQueryTestBuilder`
`class`	`TestBuilder.CSVTestBuilder`
`class`	`TestBuilder.JSONTestBuilder`
`class`	`TestBuilder.SchemaTestBuilder`

Field Summary

Fields
Modifier and Type Field and Description

protected String[] baselineColumns

protected Map<SchemaPath,TypeProtos.MajorType> baselineTypeMap

Fields
Modifier and Type	Field and Description
`protected String[]`	`baselineColumns`
`protected Map<SchemaPath,TypeProtos.MajorType>`	`baselineTypeMap`

Constructor Summary

Constructors
Constructor and Description
`TestBuilder(DrillTestWrapper.TestServices services)`
`TestBuilder(DrillTestWrapper.TestServices services, Object query, UserBitShared.QueryType queryType, Boolean ordered, boolean approximateEquality, Map<SchemaPath,TypeProtos.MajorType> baselineTypeMap, String baselineOptionSettingQueries, String testOptionSettingQueries, boolean highPerformanceComparison, int expectedNumBatches)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TestBuilder`	`approximateEquality()`
`TestBuilder`	`approximateEquality(double tolerance)`
`TestBuilder`	`baselineColumns(String... columns)` This setting has a slightly different impact on the test depending on some of the other configuration options are set.
`TestBuilder`	`baselineRecords(List<Map<String,Object>> materializedRecords)` This can be used in cases where we want to avoid issues with the assumptions made by the test framework.
`TestBuilder`	`baselineTypes(Map<SchemaPath,TypeProtos.MajorType> baselineTypeMap)`
`TestBuilder`	`baselineValues(Object... baselineValues)` This method is used to pass in a simple list of values for a single record verification without the need to create a CSV or JSON file to store the baseline.
`TestBuilder`	`baselineValuesForSingleColumn(Object... baselineValues)` This method is used to pass in an array of values for records verification in case if `baselineColumns(String...)` specifies one column only without the need to create a CSV or JSON file to store the baseline.
`DrillTestWrapper`	`build()`
`static LocalDateTime`	`convertToLocalDateTime(String value)` Helper method for the timestamp values that depend on the local timezone
`static Timestamp`	`convertToLocalTimestamp(String value)` Helper method for the timestamp values that depend on the local timezone
`TestBuilder.CSVTestBuilder`	`csvBaselineFile(String filePath)`
`TestBuilder`	`expectsEmptyResultSet()` Indicate that the tests query should be checked for an empty result set.
`TestBuilder`	`expectsNumBatches(int expectedNumBatches)` Sets the number of expected batch count for this query.
`TestBuilder`	`expectsNumRecords(int expectedNumRecords)`
`List<org.apache.commons.lang3.tuple.Pair<SchemaPath,TypeProtos.MajorType>>`	`getExpectedSchema()`
`protected UserBitShared.QueryType`	`getValidationQueryType()`
`void`	`go()`
`TestBuilder`	`highPerformanceComparison()`
`TestBuilder.JSONTestBuilder`	`jsonBaselineFile(String filePath)`
`static JsonStringArrayList<Object>`	`listOf(Object... values)` Convenience method to create a `list` from the given values.
`static JsonStringHashMap<String,Object>`	`mapOf(Object... keyValueSequence)` Convenience method to create a `JsonStringHashMap` map instance with the given key value sequence.
`static JsonStringHashMap<Object,Object>`	`mapOfObject(Object... keyValueSequence)` Convenience method to create an instance of `JsonStringHashMap<Object, Object>` with the given key-value sequence.
`TestBuilder`	`optionSettingQueriesForBaseline(String queries)`
`TestBuilder`	`optionSettingQueriesForBaseline(String queries, Object... args)`
`TestBuilder`	`optionSettingQueriesForTestQuery(String queries)` list of queries to run before the test query, can be used to set several options list takes the form of a semi-colon separated list.
`TestBuilder`	`optionSettingQueriesForTestQuery(String query, Object... args)`
`TestBuilder`	`ordered()`
`static SchemaPath`	`parsePath(String path)`
`TestBuilder.BaselineQueryTestBuilder`	`physicalPlanBaseline(String physicalPlan)`
`TestBuilder.BaselineQueryTestBuilder`	`physicalPlanBaselineQueryFromFile(String baselinePhysicalPlanPath)`
`TestBuilder`	`physicalPlanFromFile(String queryFile)`
`TestBuilder`	`preparedStatement(UserProtos.PreparedStatementHandle preparedStatementHandle)`
`protected TestBuilder`	`reset()`
`TestBuilder.SchemaTestBuilder`	`schemaBaseLine(BatchSchema batchSchema)`
`TestBuilder.SchemaTestBuilder`	`schemaBaseLine(List<org.apache.commons.lang3.tuple.Pair<SchemaPath,TypeProtos.MajorType>> expectedSchema)`
`TestBuilder.BaselineQueryTestBuilder`	`sqlBaselineQuery(Object baselineQuery)` Provide a SQL query to validate against.
`TestBuilder.BaselineQueryTestBuilder`	`sqlBaselineQuery(String query, String... replacements)`
`TestBuilder.BaselineQueryTestBuilder`	`sqlBaselineQueryFromFile(String baselineQueryFilename)`
`TestBuilder`	`sqlQuery(String query)`
`TestBuilder`	`sqlQuery(String query, Object... replacements)`
`TestBuilder`	`sqlQueryFromFile(String queryFile)`
`TestBuilder`	`unOrdered()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - baselineTypeMap
```
protected Map<SchemaPath,TypeProtos.MajorType> baselineTypeMap
```
  - baselineColumns
```
protected String[] baselineColumns
```
- Constructor Detail
  - TestBuilder
```
public TestBuilder(DrillTestWrapper.TestServices services)
```
  - TestBuilder
```
public TestBuilder(DrillTestWrapper.TestServices services,
                   Object query,
                   UserBitShared.QueryType queryType,
                   Boolean ordered,
                   boolean approximateEquality,
                   Map<SchemaPath,TypeProtos.MajorType> baselineTypeMap,
                   String baselineOptionSettingQueries,
                   String testOptionSettingQueries,
                   boolean highPerformanceComparison,
                   int expectedNumBatches)
```
- Method Detail
  - reset
```
protected TestBuilder reset()
```
  - build
```
public DrillTestWrapper build()
```
  - getExpectedSchema
```
public List<org.apache.commons.lang3.tuple.Pair<SchemaPath,TypeProtos.MajorType>> getExpectedSchema()
```
  - go
```
public void go()
        throws Exception
```
    Throws:
    
    Exception
  - sqlQuery
```
public TestBuilder sqlQuery(String query)
```
  - sqlQuery
```
public TestBuilder sqlQuery(String query,
                            Object... replacements)
```
  - preparedStatement
```
public TestBuilder preparedStatement(UserProtos.PreparedStatementHandle preparedStatementHandle)
```
  - sqlQueryFromFile
```
public TestBuilder sqlQueryFromFile(String queryFile)
                             throws IOException
```
    Throws:
    
    IOException
  - physicalPlanFromFile
```
public TestBuilder physicalPlanFromFile(String queryFile)
                                 throws IOException
```
    Throws:
    
    IOException
  - ordered
```
public TestBuilder ordered()
```
  - unOrdered
```
public TestBuilder unOrdered()
```
  - highPerformanceComparison
```
public TestBuilder highPerformanceComparison()
                                      throws Exception
```
    Throws:
    
    Exception
  - optionSettingQueriesForBaseline
```
public TestBuilder optionSettingQueriesForBaseline(String queries)
```
  - optionSettingQueriesForBaseline
```
public TestBuilder optionSettingQueriesForBaseline(String queries,
                                                   Object... args)
```
  - optionSettingQueriesForTestQuery
```
public TestBuilder optionSettingQueriesForTestQuery(String queries)
```
    list of queries to run before the test query, can be used to set several options list takes the form of a semi-colon separated list.
    
    Parameters:
    
    queries - queries that set session and system options
    
    Returns:
    
    this test builder
  - optionSettingQueriesForTestQuery
```
public TestBuilder optionSettingQueriesForTestQuery(String query,
                                                    Object... args)
                                             throws Exception
```
    Throws:
    
    Exception
  - approximateEquality
```
public TestBuilder approximateEquality()
```
  - approximateEquality
```
public TestBuilder approximateEquality(double tolerance)
```
  - parsePath
```
public static SchemaPath parsePath(String path)
```
  - getValidationQueryType
```
protected UserBitShared.QueryType getValidationQueryType()
```
  - jsonBaselineFile
```
public TestBuilder.JSONTestBuilder jsonBaselineFile(String filePath)
```
  - csvBaselineFile
```
public TestBuilder.CSVTestBuilder csvBaselineFile(String filePath)
```
  - schemaBaseLine
```
public TestBuilder.SchemaTestBuilder schemaBaseLine(BatchSchema batchSchema)
```
  - schemaBaseLine
```
public TestBuilder.SchemaTestBuilder schemaBaseLine(List<org.apache.commons.lang3.tuple.Pair<SchemaPath,TypeProtos.MajorType>> expectedSchema)
```
  - baselineTypes
```
public TestBuilder baselineTypes(Map<SchemaPath,TypeProtos.MajorType> baselineTypeMap)
```
  - expectsEmptyResultSet
```
public TestBuilder expectsEmptyResultSet()
```
    Indicate that the tests query should be checked for an empty result set.
    
    Returns:
    
    the test builder
  - expectsNumBatches
```
public TestBuilder expectsNumBatches(int expectedNumBatches)
```
    Sets the number of expected batch count for this query. The test will fail if the query returns a different number of batches
    
    Parameters:
    
    expectedNumBatches - expected batch count
    
    Returns:
    
    this test builder
  - expectsNumRecords
```
public TestBuilder expectsNumRecords(int expectedNumRecords)
```
  - baselineValues
```
public TestBuilder baselineValues(Object... baselineValues)
```
    This method is used to pass in a simple list of values for a single record verification without the need to create a CSV or JSON file to store the baseline. This can be called repeatedly to pass a list of records to verify. It works for both ordered and unordered checks.
    
    Parameters:
    
    baselineValues - - the baseline values to validate
    
    Returns:
    
    the test builder
  - baselineValuesForSingleColumn
```
public TestBuilder baselineValuesForSingleColumn(Object... baselineValues)
```
    This method is used to pass in an array of values for records verification in case if baselineColumns(String...) specifies one column only without the need to create a CSV or JSON file to store the baseline. This can be called repeatedly to pass an array of records to verify. It works for both ordered and unordered checks.
    
    Parameters:
    
    baselineValues - baseline values for a single column to validate
    
    Returns:
    
    this test builder
  - baselineRecords
```
public TestBuilder baselineRecords(List<Map<String,Object>> materializedRecords)
```
    This can be used in cases where we want to avoid issues with the assumptions made by the test framework. Most of the methods for verification in the framework run drill queries to generate the read baseline files or execute alternative baseline queries. This model relies on basic functionality of reading files with storage plugins and applying casts/projects to be stable. This method can be used to verify the engine for these cases and any other future execution paths that would be used by both the test query and baseline. Without tests like this it is possible that some tests could falsely report as passing, as both the test query and baseline query could run into the same problem with an assumed stable code path and produce the same erroneous result.
    
    Parameters:
    
    materializedRecords - - a list of maps representing materialized results
    
    Returns:
    
    the test builder
  - baselineColumns
```
public TestBuilder baselineColumns(String... columns)
```
    This setting has a slightly different impact on the test depending on some of the other configuration options are set. If a JSON baseline file is given, this list will act as a project list to verify the test query against a subset of the columns in the file. For a CSV baseline file, these will act as aliases for columns [0 .. n] in the repeated varchar column that is read out of CSV. For a baseline sql query, this currently has no effect. For explicit baseline values given in java code with the baselineValues() method, these will be used to create a map for the one record verification.
  - sqlBaselineQuery
```
public TestBuilder.BaselineQueryTestBuilder sqlBaselineQuery(Object baselineQuery)
```
    Provide a SQL query to validate against.
    
    Parameters:
    
    baselineQuery -
    
    Returns:
    
    the test builder
  - sqlBaselineQuery
```
public TestBuilder.BaselineQueryTestBuilder sqlBaselineQuery(String query,
                                                             String... replacements)
```
  - sqlBaselineQueryFromFile
```
public TestBuilder.BaselineQueryTestBuilder sqlBaselineQueryFromFile(String baselineQueryFilename)
                                                              throws IOException
```
    Throws:
    
    IOException
  - physicalPlanBaselineQueryFromFile
```
public TestBuilder.BaselineQueryTestBuilder physicalPlanBaselineQueryFromFile(String baselinePhysicalPlanPath)
                                                                       throws IOException
```
    Throws:
    
    IOException
  - physicalPlanBaseline
```
public TestBuilder.BaselineQueryTestBuilder physicalPlanBaseline(String physicalPlan)
```
  - listOf
```
public static JsonStringArrayList<Object> listOf(Object... values)
```
    Convenience method to create a list from the given values.
  - mapOf
```
public static JsonStringHashMap<String,Object> mapOf(Object... keyValueSequence)
```
    Convenience method to create a JsonStringHashMap map instance with the given key value sequence. Key value sequence consists of key - value pairs such that a key precedes its value. For instance: mapOf("name", "Adam", "age", 41) corresponds to {"name": "Adam", "age": 41} in JSON.
  - mapOfObject
```
public static JsonStringHashMap<Object,Object> mapOfObject(Object... keyValueSequence)
```
    Convenience method to create an instance of JsonStringHashMap<Object, Object> with the given key-value sequence. By default, any String instance will be wrapped by Text instance. To disable wrapping pass false as the first object to key-value sequence.
    
    Parameters:
    
    keyValueSequence - sequence of key-value pairs with optional boolean flag which disables wrapping String instances by Text.
    
    Returns:
    
    map consisting of entries given in the key-value sequence.
  - convertToLocalTimestamp
```
public static Timestamp convertToLocalTimestamp(String value)
```
    Helper method for the timestamp values that depend on the local timezone
    
    Parameters:
    
    value - expected timestamp value in UTC
    
    Returns:
    
    timestamp value for the local timezone
  - convertToLocalDateTime
```
public static LocalDateTime convertToLocalDateTime(String value)
```
    Helper method for the timestamp values that depend on the local timezone
    
    Parameters:
    
    value - expected timestamp value in UTC
    
    Returns:
    
    LocalDateTime value for the local timezone

Class TestBuilder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

baselineTypeMap

baselineColumns

Constructor Detail

TestBuilder

TestBuilder

Method Detail

reset

build

getExpectedSchema

go

sqlQuery

sqlQuery

preparedStatement

sqlQueryFromFile

physicalPlanFromFile

ordered

unOrdered

highPerformanceComparison

optionSettingQueriesForBaseline

optionSettingQueriesForBaseline

optionSettingQueriesForTestQuery

optionSettingQueriesForTestQuery

approximateEquality

approximateEquality

parsePath

getValidationQueryType

jsonBaselineFile

csvBaselineFile

schemaBaseLine

schemaBaseLine

baselineTypes

expectsEmptyResultSet

expectsNumBatches

expectsNumRecords

baselineValues

baselineValuesForSingleColumn

baselineRecords

baselineColumns

sqlBaselineQuery

sqlBaselineQuery

sqlBaselineQueryFromFile

physicalPlanBaselineQueryFromFile

physicalPlanBaseline

listOf

mapOf

mapOfObject

convertToLocalTimestamp

convertToLocalDateTime