org.apache.drill.test

Class ClusterTest

java.lang.Object

DrillTest

org.apache.drill.test.ClusterTest

Direct Known Subclasses:

AvroFormatTest, BaseCsvTest, CredentialsProviderImplementationsTest, CredentialsProviderSerDeTest, CrossJoinTest, DrillSeparatePlanningTest, DropboxFileSystemTest, EnumPluginTest, InteractiveUI, ParquetInternalsTest, ResetOptionHandlerTest, RestServerTest, SetOptionHandlerTest, SslContextFactoryConfiguratorTest, TestAggregateFunctions, TestAggWithAnyValue.TestAggWithAnyValueSingleBatch, TestAliasCommands, TestAliasSubstitution, TestAliasSystemTables, TestAnalyze, TestCastEmptyStrings, TestCastFunctions, TestCompressedFiles, TestConformance, TestConvertCountToDirectScan, TestCustomUserAuthenticator, TestDisabledPlugin, TestDrillbitResilience, TestE2EUnnestAndLateral, TestEmptyParquet, TestFilesTable, TestGracefulShutdown, TestHashJoinJPPDCorrectness, TestHtpasswdFileUserAuthenticator, TestInfoSchemaWithMetastore, TestIntervalDayFunctions, TestJsonEscapeAnyChar, TestLargeFileCompilation, TestLogReader, TestMetastoreCommands, TestMetastoreWithEasyFormatPlugin, TestMockPlugin, TestNewSimpleRepeatedFunctions, TestOperatorDump, TestParquetBulkReader, TestParquetLimitPushDown, TestParquetWriter, TestParseFunctions, TestPartitionFilter, TestProjectWithFunctions, TestPushDownAndPruningForDecimal, TestPushDownAndPruningForVarchar, TestQueryProfiles, TestResponseHeaders, TestRestJson, TestSchemaCaseInsensitivity, TestSchemaCommands, TestSchemaWithTableFunction, TestSelectWithOption, TestSequenceFileReader, TestServerMetaProvider, TestSortSpillWithException, TestTextWriter, TestTimestampAddDiffFunctions, TestTpchDistributedConcurrent, TestTypeFns, TestUntypedNull, TestValues, TestVarArgFunctions, TestVarlenDecimal, TestVaultUserAuthenticator

public class ClusterTest
extends DrillTest

Base class for tests that use a single cluster fixture for a set of tests. Extend your test case directly from DrillTest if you need to start up and shut down a cluster multiple times.

To create a test with a single cluster config, do the following:

 public class YourTest extends ClusterTest {
    @BeforeClass
   public static setup( ) throws Exception {
     FixtureBuilder builder = ClusterFixture.builder()
       // Set options, etc.
       ;
     startCluster(builder);
   }

   // Your tests
 }
 

This class takes care of shutting down the cluster at the end of the test.

The simplest possible setup:

    @BeforeClass
   public static setup( ) throws Exception {
     startCluster(ClusterFixture.builder( ));
   }
 

If you need to start the cluster with different (boot time) configurations, do the following instead:

 public class YourTest extends DrillTest {
    @Test
   public someTest() throws Exception {
     FixtureBuilder builder = ClusterFixture.builder()
       // Set options, etc.
       ;
     try(ClusterFixture cluster = builder.build) {
       // Tests here
     }
   }
 }
 

The try-with-resources block ensures that the cluster is shut down at the end of each test method.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientFixture	client
protected static ClusterFixture	cluster
static BaseDirTestWatcher	dirTestWatcher

Constructor Summary

Constructors

Constructor and Description
ClusterTest()

Method Summary

Modifier and Type	Method and Description
String	getFile(String resource) Convenience method when converting classic tests to use the cluster fixture.
QueryBuilder	queryBuilder()
static void	run(String query, Object... args)
void	runAndLog(String sqlQuery)
void	runAndPrint(String sqlQuery)
void	runAndPrint(String sqlQuery, Object... args)
static void	shutdown()
protected static void	startCluster(ClusterFixtureBuilder builder)
TestBuilder	testBuilder() Convenience method when converting classic tests to use the cluster fixture.

Methods inherited from class java.lang.Object

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

Field Detail

dirTestWatcher

public static final BaseDirTestWatcher dirTestWatcher

cluster

protected static ClusterFixture cluster

client

protected static ClientFixture client

Constructor Detail

ClusterTest

public ClusterTest()

Method Detail

startCluster

protected static void startCluster(ClusterFixtureBuilder builder)
                            throws Exception

Throws:

Exception

shutdown

public static void shutdown()
                     throws Exception

Throws:

Exception

testBuilder

public TestBuilder testBuilder()

Convenience method when converting classic tests to use the cluster fixture.

Returns:

a test builder that works against the cluster fixture

getFile

public String getFile(String resource)
               throws IOException

Convenience method when converting classic tests to use the cluster fixture.

Returns:

the contents of the resource text file

Throws:

IOException

runAndLog

public void runAndLog(String sqlQuery)
               throws Exception

Throws:

Exception

runAndPrint

public void runAndPrint(String sqlQuery)

runAndPrint

public void runAndPrint(String sqlQuery,
                        Object... args)

run

public static void run(String query,
                       Object... args)
                throws Exception

Throws:

Exception

queryBuilder

public QueryBuilder queryBuilder()