ClusterFixture (Drill : 1.19.0 API)

java.lang.Object
- org.apache.drill.test.BaseFixture
- - org.apache.drill.test.ClusterFixture

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ClusterMockStorageFixture
```
public class ClusterFixture
extends BaseFixture
implements AutoCloseable
```
Test fixture to start a Drillbit with provide options, create a client, and execute queries. Can be used in JUnit tests, or in ad-hoc programs. Provides a builder to set the necessary embedded Drillbit and client options, then creates the requested Drillbit and client.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ClusterFixture.FixtureTestServices
Shim class to allow the TestBuilder class to work with the cluster fixture.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ClusterFixture.FixtureTestServices` Shim class to allow the `TestBuilder` class to work with the cluster fixture.

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<ClientFixture>`	`clients`
`static String`	`DEFAULT_BIT_NAME`
`static String`	`EXPLAIN_PLAN_JSON`
`static String`	`EXPLAIN_PLAN_TEXT`
`static int`	`MAX_WIDTH_PER_NODE`
`protected RestClientFixture`	`restClientFixture`
`static Properties`	`TEST_CONFIGURATIONS`

Fields inherited from class org.apache.drill.test.BaseFixture
allocator, config

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ClusterFixtureBuilder`	`bareBuilder(BaseDirTestWatcher dirTestWatcher)` Return a cluster builder without any of the usual defaults.
`static ClusterFixtureBuilder`	`builder(BaseDirTestWatcher dirTestWatcher)`
`DrillClient`	`client()`
`ClientFixture`	`client(String host, int port)` Create a test client for a specific host and port.
`ClientFixture.ClientBuilder`	`clientBuilder()`
`ClientFixture`	`clientFixture()`
`void`	`close()` Close the clients, Drillbits, allocator and Zookeeper.
`void`	`closeDrillbit(String drillbitName)` Shutdown the drillbit given the name of the drillbit.
`void`	`defineFormat(String pluginName, String name, FormatPluginConfig config)`
`void`	`defineFormats(String pluginName, Map<String,FormatPluginConfig> formats)`
`void`	`defineImmutableWorkspace(String pluginName, String schemaName, String path, String defaultFormat, FormatPluginConfig format)`
`void`	`defineStoragePlugin(String name, StoragePluginConfig config)`
`void`	`defineWorkspace(String pluginName, String schemaName, String path, String defaultFormat)` Define a workspace within an existing storage plugin.
`void`	`defineWorkspace(String pluginName, String schemaName, String path, String defaultFormat, FormatPluginConfig format)`
`Drillbit`	`drillbit()`
`Drillbit`	`drillbit(String name)`
`Collection<Drillbit>`	`drillbits()`
`Properties`	`getClientProps()`
`File`	`getDrillTempDir()`
`File`	`getProfileDir()` Returns the directory that holds query profiles.
`static String`	`getResource(String resource)`
`Connection`	`jdbcConnection()` Return a JDBC connection to the default (first) Drillbit.
`static String`	`loadResource(String resource)` Load a resource file, returning the resource as a string.
`File`	`makeDataDir(String key, String defaultFormat, FormatPluginConfig formatPluginConfig)` Create a temporary data directory which will be removed when the cluster closes, and register it as a "dfs" name space.
`RestClientFixture.Builder`	`restClientBuilder()`
`RestClientFixture`	`restClientFixture()`
`RemoteServiceSet`	`serviceSet()`
`static ClusterFixture`	`standardCluster(BaseDirTestWatcher dirTestWatcher)` Return a cluster fixture built with standard options.
`StoragePluginRegistry`	`storageRegistry()`
`StoragePluginRegistry`	`storageRegistry(String name)`
`static String`	`stringify(Object value)` Convert a Java object (typically a boxed scalar) to a string for use in SQL.
`static String`	`trimSlash(String path)` Guava likes paths to resources without an initial slash, the JDK needs a slash.
`boolean`	`usesZK()`

Methods inherited from class org.apache.drill.test.BaseFixture
allocator, config, dirtyMemory, dirtyMemory, getTempDir

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

- Field Detail
  - MAX_WIDTH_PER_NODE
```
public static final int MAX_WIDTH_PER_NODE
```
    See Also:
    
    Constant Field Values
  - TEST_CONFIGURATIONS
```
public static final Properties TEST_CONFIGURATIONS
```
  - DEFAULT_BIT_NAME
```
public static final String DEFAULT_BIT_NAME
```
    See Also:
    
    Constant Field Values
  - clients
```
protected List<ClientFixture> clients
```
  - restClientFixture
```
protected RestClientFixture restClientFixture
```
  - EXPLAIN_PLAN_TEXT
```
public static final String EXPLAIN_PLAN_TEXT
```
    See Also:
    
    Constant Field Values
  - EXPLAIN_PLAN_JSON
```
public static final String EXPLAIN_PLAN_JSON
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getClientProps
```
public Properties getClientProps()
```
  - drillbit
```
public Drillbit drillbit()
```
  - drillbit
```
public Drillbit drillbit(String name)
```
  - drillbits
```
public Collection<Drillbit> drillbits()
```
  - serviceSet
```
public RemoteServiceSet serviceSet()
```
  - clientBuilder
```
public ClientFixture.ClientBuilder clientBuilder()
```
  - restClientBuilder
```
public RestClientFixture.Builder restClientBuilder()
```
  - clientFixture
```
public ClientFixture clientFixture()
```
  - client
```
public ClientFixture client(String host,
                            int port)
```
    Create a test client for a specific host and port.
    
    Parameters:
    
    host - host, must be one of those created by this fixture
    
    port - post, must be one of those created by this fixture
    
    Returns:
    
    a test client. Client will be closed when this cluster fixture closes, or can be closed early
  - restClientFixture
```
public RestClientFixture restClientFixture()
```
  - client
```
public DrillClient client()
```
  - jdbcConnection
```
public Connection jdbcConnection()
```
    Return a JDBC connection to the default (first) Drillbit. Note that this code requires special setup of the test code. Tests in the "exec" package do not normally have visibility to the Drill JDBC driver. So, the test must put that code on the class path manually in order for this code to load the JDBC classes. The caller is responsible for closing the JDBC connection before closing the cluster. (An enhancement is to do the close automatically as is done for clients.)
    
    Returns:
    
    a JDBC connection to the default Drillbit
  - close
```
public void close()
           throws Exception
```
    Close the clients, Drillbits, allocator and Zookeeper. Checks for exceptions. If an exception occurs, continues closing, suppresses subsequent exceptions, and throws the first exception at completion of close. This allows the test code to detect any state corruption which only shows itself when shutting down resources (memory leaks, for example.)
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    Exception
  - closeDrillbit
```
public void closeDrillbit(String drillbitName)
                   throws Exception
```
    Shutdown the drillbit given the name of the drillbit.
    
    Throws:
    
    Exception
  - defineStoragePlugin
```
public void defineStoragePlugin(String name,
                                StoragePluginConfig config)
```
  - defineWorkspace
```
public void defineWorkspace(String pluginName,
                            String schemaName,
                            String path,
                            String defaultFormat)
```
    Define a workspace within an existing storage plugin. Useful for pointing to local file system files outside the Drill source tree.
    
    Parameters:
    
    pluginName - name of the plugin like "dfs".
    
    schemaName - name of the new schema
    
    path - directory location (usually local)
    
    defaultFormat - default format for files in the schema
  - defineWorkspace
```
public void defineWorkspace(String pluginName,
                            String schemaName,
                            String path,
                            String defaultFormat,
                            FormatPluginConfig format)
```
  - defineImmutableWorkspace
```
public void defineImmutableWorkspace(String pluginName,
                                     String schemaName,
                                     String path,
                                     String defaultFormat,
                                     FormatPluginConfig format)
```
  - defineFormat
```
public void defineFormat(String pluginName,
                         String name,
                         FormatPluginConfig config)
```
  - defineFormats
```
public void defineFormats(String pluginName,
                          Map<String,FormatPluginConfig> formats)
```
  - builder
```
public static ClusterFixtureBuilder builder(BaseDirTestWatcher dirTestWatcher)
```
  - bareBuilder
```
public static ClusterFixtureBuilder bareBuilder(BaseDirTestWatcher dirTestWatcher)
```
    Return a cluster builder without any of the usual defaults. Use this only for special cases. Your code is responsible for all the odd bits that must be set to get the setup right. See TEST_CONFIGURATIONS for details. Note that you are often better off using the defaults, then replacing selected properties with the values you prefer.
    
    Returns:
    
    a fixture builder with no default properties set
  - standardCluster
```
public static ClusterFixture standardCluster(BaseDirTestWatcher dirTestWatcher)
```
    Return a cluster fixture built with standard options. This is a short-cut for simple tests that don't need special setup.
    
    Parameters:
    
    dirTestWatcher - directory test watcher
    
    Returns:
    
    a cluster fixture with standard options
  - stringify
```
public static String stringify(Object value)
```
    Convert a Java object (typically a boxed scalar) to a string for use in SQL. Quotes strings but just converts others to string format. If value to encode is null, return null.
    
    Parameters:
    
    value - the value to encode
    
    Returns:
    
    the SQL-acceptable string equivalent
  - getResource
```
public static String getResource(String resource)
                          throws IOException
```
    Throws:
    
    IOException
  - loadResource
```
public static String loadResource(String resource)
```
    Load a resource file, returning the resource as a string. "Hides" the checked exception as unchecked, which is fine in a test as the unchecked exception will fail the test without unnecessary error fiddling.
    
    Parameters:
    
    resource - path to the resource
    
    Returns:
    
    the resource contents as a string
  - trimSlash
```
public static String trimSlash(String path)
```
    Guava likes paths to resources without an initial slash, the JDK needs a slash. Normalize the path when needed.
    
    Parameters:
    
    path - resource path with optional leading slash
    
    Returns:
    
    same path without the leading slash
  - makeDataDir
```
public File makeDataDir(String key,
                        String defaultFormat,
                        FormatPluginConfig formatPluginConfig)
```
    Create a temporary data directory which will be removed when the cluster closes, and register it as a "dfs" name space.
    
    Parameters:
    
    key - The name to use for the directory and the name space. Access the directory as "dfs.".
    
    defaultFormat - The default storage format for the workspace.
    
    formatPluginConfig - The format plugin config.
    
    Returns:
    
    location of the directory which can be used to create temporary input files
  - getDrillTempDir
```
public File getDrillTempDir()
```
  - usesZK
```
public boolean usesZK()
```
  - getProfileDir
```
public File getProfileDir()
```
    Returns the directory that holds query profiles. Valid only for an embedded Drillbit with local cluster coordinator – the normal case for unit tests.
    
    Returns:
    
    query profile directory
  - storageRegistry
```
public StoragePluginRegistry storageRegistry()
```
  - storageRegistry
```
public StoragePluginRegistry storageRegistry(String name)
```

Class ClusterFixture

Nested Class Summary

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

MAX_WIDTH_PER_NODE

TEST_CONFIGURATIONS

DEFAULT_BIT_NAME

clients

restClientFixture

EXPLAIN_PLAN_TEXT

EXPLAIN_PLAN_JSON

Method Detail

getClientProps

drillbit

drillbit

drillbits

serviceSet

clientBuilder

restClientBuilder

clientFixture

client

restClientFixture

client

jdbcConnection

close

closeDrillbit

defineStoragePlugin

defineWorkspace

defineWorkspace

defineImmutableWorkspace

defineFormat

defineFormats

builder

bareBuilder

standardCluster

stringify

getResource

loadResource

trimSlash

makeDataDir

getDrillTempDir

usesZK

getProfileDir

storageRegistry

storageRegistry