org.apache.drill.test

Class BaseDirTestWatcher

java.lang.Object

org.junit.rules.TestWatcher

org.apache.drill.test.DirTestWatcher

org.apache.drill.test.BaseDirTestWatcher

All Implemented Interfaces:

org.junit.rules.TestRule

public class BaseDirTestWatcher
extends DirTestWatcher

Overview

This is a DirTestWatcher which creates all the temporary directories required by a Drillbit and the various dfs.* storage workspaces. It also provides convenience methods that do the following:

1. Copy project files to temp directories. This is useful for copying the sample data into a temp directory.
2. Copy resource files to temp.
3. Updating parquet metadata files.

The BaseDirTestWatcher creates the following directories in the base temp directory (for a description of where the base temp directory is located please read the docs for DirTestWatcher):

• tmp: getTmpDir()
• store: getStoreDir()
• root: getRootDir()
• dfsTestTmp: getDfsTestTmpDir()

Examples

The BaseDirTestWatcher is used in BaseTestQuery and an example of how it is used in conjunction with the ClusterFixture can be found in ExampleTest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseDirTestWatcher.DirType An enum used to represent the directories mapped to the dfs.root and dfs.tmp workspaces respectively.

Constructor Summary

Constructors

Constructor and Description
BaseDirTestWatcher() Creates a BaseDirTestWatcher which does not delete it's temp directories at the end of tests.
BaseDirTestWatcher(boolean deleteDirAtEnd) Creates a BaseDirTestWatcher.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear contents of cluster directories
File	copyFileToRoot(Path relPath) This copies a filed or directory from the maven project into the temp root directory (corresponding to dfs.root).
File	copyResourceToRoot(Path relPath) This copies a file or directory from src/test/resources into the temp root directory (corresponding to dfs.root).
File	copyResourceToRoot(Path relPath, Path destPath) This copies a file or directory from src/test/resources into the temp root directory (corresponding to dfs.root).
File	copyResourceToTestTmp(Path relPath, Path destPath) This copies a file or directory from src/test/resources into the temp root directory (corresponding to dfs.root).
File	getCodegenDir() Gets the temp directory that should be used to save generated code files.
File	getDfsTestTmpDir() Gets the temp directory that should be used by the dfs.tmp workspace.
File	getHomeDir() Gets the temp directory that is a proxy for the user's home directory.
File	getRootDir() Gets the temp directory that should be used to hold the contents of the dfs.root workspace.
File	getSpillDir()
File	getStoreDir() Gets the temp directory that should be used by the LocalPersistentStore.
File	getTmpDir() Gets the temp directory that should be used as a Drillbit's temp tmp directory.
File	makeRootSubDir(Path relPath) Creates a directory in the temp root directory (corresponding to dfs.root) at the given relative path.
File	makeTestTmpSubDir(Path relPath) Creates a directory in the tmp directory (corresponding to dfs.tmp) at the given relative path.
void	newDfsTestTmpDir() This methods creates a new directory which can be mapped to dfs.tmp.
void	removeFileFromRoot(Path relPath) Removes a file or directory copied at relativePath inside the root directory
void	replaceMetaDataContents(File metaDataFile, File replacePath, String customStringReplacement) Replaces placeholders in test Parquet metadata files.
void	start(Class<?> suite)
protected void	starting(org.junit.runner.Description description)

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

createTempDir, failed, finished, getDir, makeSubDir

Methods inherited from class org.junit.rules.TestWatcher

apply, skipped, skipped, succeeded

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseDirTestWatcher

public BaseDirTestWatcher()

Creates a BaseDirTestWatcher which does not delete it's temp directories at the end of tests.

BaseDirTestWatcher

public BaseDirTestWatcher(boolean deleteDirAtEnd)

Creates a BaseDirTestWatcher.

Parameters:

deleteDirAtEnd - If true, temp directories are deleted at the end of tests. If false, temp directories are not deleted at the end of tests.

Method Detail

start

public void start(Class<?> suite)

starting

protected void starting(org.junit.runner.Description description)

Overrides:

starting in class DirTestWatcher

clear

public void clear()

Clear contents of cluster directories

getTmpDir

public File getTmpDir()

Gets the temp directory that should be used as a Drillbit's temp tmp directory.

Returns:

The temp directory that should be used as a Drillbit's temp tmp directory.

getHomeDir

public File getHomeDir()

Gets the temp directory that is a proxy for the user's home directory.

Returns:

proxy for the user's home directory

getStoreDir

public File getStoreDir()

Gets the temp directory that should be used by the LocalPersistentStore.

Returns:

The temp directory that should be used by the LocalPersistentStore.

getDfsTestTmpDir

public File getDfsTestTmpDir()

Gets the temp directory that should be used by the dfs.tmp workspace.

Returns:

The temp directory that should be used by the dfs.tmp workspace.

getRootDir

public File getRootDir()

Gets the temp directory that should be used to hold the contents of the dfs.root workspace.

Returns:

The temp directory that should be used to hold the contents of the dfs.root workspace.

getCodegenDir

public File getCodegenDir()

Gets the temp directory that should be used to save generated code files.

Returns:

The temp directory that should be used to save generated code files.

getSpillDir

public File getSpillDir()

newDfsTestTmpDir

public void newDfsTestTmpDir()

This methods creates a new directory which can be mapped to dfs.tmp.

makeRootSubDir

public File makeRootSubDir(Path relPath)

Creates a directory in the temp root directory (corresponding to dfs.root) at the given relative path.

Parameters:

relPath - The relative path in the temp root directory at which to create a directory.

Returns:

The File corresponding to the sub directory that was created.

makeTestTmpSubDir

public File makeTestTmpSubDir(Path relPath)

Creates a directory in the tmp directory (corresponding to dfs.tmp) at the given relative path.

Parameters:

relPath - The relative path in the tmp directory at which to create a directory.

Returns:

The File corresponding to the sub directory that was created.

copyResourceToRoot

public File copyResourceToRoot(Path relPath)

This copies a file or directory from src/test/resources into the temp root directory (corresponding to dfs.root). The relative path of the file or directory in src/test/resources is preserved in the temp root directory.

Parameters:

relPath - The relative path of the file or directory in src/test/resources to copy into the root temp folder.

Returns:

The File corresponding to the copied file or directory in the temp root directory.

copyFileToRoot

public File copyFileToRoot(Path relPath)

This copies a filed or directory from the maven project into the temp root directory (corresponding to dfs.root). The relative path of the file or directory in the maven module is preserved in the temp root directory.

Parameters:

relPath - The relative path of the file or directory in the maven module to copy into the root temp folder.

Returns:

The File corresponding to the copied file or directory in the temp root directory.

copyResourceToRoot

public File copyResourceToRoot(Path relPath,
                               Path destPath)

This copies a file or directory from src/test/resources into the temp root directory (corresponding to dfs.root). The file or directory is copied to the provided relative destPath in the temp root directory.

Parameters:

relPath - The source relative path of a file or directory from src/test/resources that will be copied.

destPath - The destination relative path of the file or directory in the temp root directory.

Returns:

The File corresponding to the final copied file or directory in the temp root directory.

removeFileFromRoot

public void removeFileFromRoot(Path relPath)
                        throws IOException

Removes a file or directory copied at relativePath inside the root directory

Parameters:

relPath - - relative path of file/directory to be deleted from the root directory

Throws:

IOException - - Throws exception in case of failure

copyResourceToTestTmp

public File copyResourceToTestTmp(Path relPath,
                                  Path destPath)

This copies a file or directory from src/test/resources into the temp root directory (corresponding to dfs.root). The file or directory is copied to the provided relative destPath in the temp root directory.

Parameters:

relPath - The source relative path of a file or directory from src/test/resources that will be copied.

destPath - The destination relative path of the file or directory in the temp root directory.

Returns:

The File corresponding to the final copied file or directory in the temp root directory.

replaceMetaDataContents

public void replaceMetaDataContents(File metaDataFile,
                                    File replacePath,
                                    String customStringReplacement)

Replaces placeholders in test Parquet metadata files.

Parameters:

metaDataFile - The Parquet metadata file to do string replacement on.

replacePath - The path to replace >REPLACED_IN_TEST with in the Parquet metadata file.

customStringReplacement - If this is provided a CUSTOM_STRING_REPLACEMENT is replaced in the Parquet metadata file with this string.