org.apache.hadoop.hbase

Class HBaseCommonTestingUtility

java.lang.Object

org.apache.hadoop.hbase.HBaseCommonTestingUtility

Direct Known Subclasses:

HBaseTestingUtility

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public class HBaseCommonTestingUtility
extends Object

Common helpers for testing HBase that do not depend on specific server/etc. things.

See Also:

HBaseTestingUtility}

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_TEST_DIRECTORY_KEY System property key to get base test directory value
protected Configuration	conf
static String	DEFAULT_BASE_TEST_DIRECTORY Default base directory for test output.
protected static Log	LOG

Constructor Summary

Constructors

Constructor and Description
HBaseCommonTestingUtility()
HBaseCommonTestingUtility(Configuration conf)

Method Summary

Modifier and Type	Method and Description
boolean	cleanupTestDir()
protected void	createSubDir(String propertyName, Path parent, String subDirName)
Configuration	getConfiguration() Returns this classes's instance of Configuration.
Path	getDataTestDir()
Path	getDataTestDir(String subdirName)
protected Path	setupDataTestDir() Sets up a directory for a test to use.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Log LOG

conf

protected Configuration conf

BASE_TEST_DIRECTORY_KEY

public static final String BASE_TEST_DIRECTORY_KEY

System property key to get base test directory value

See Also:

Constant Field Values

DEFAULT_BASE_TEST_DIRECTORY

public static final String DEFAULT_BASE_TEST_DIRECTORY

Default base directory for test output.

See Also:

Constant Field Values

Constructor Detail

HBaseCommonTestingUtility

public HBaseCommonTestingUtility()

HBaseCommonTestingUtility

public HBaseCommonTestingUtility(Configuration conf)

Method Detail

getConfiguration

public Configuration getConfiguration()

Returns this classes's instance of Configuration.

Returns:

Instance of Configuration.

getDataTestDir

public Path getDataTestDir()

Returns:

Where to write test data on local filesystem, specific to the test. Useful for tests that do not use a cluster. Creates it if it does not exist already.

getDataTestDir

public Path getDataTestDir(String subdirName)

Parameters:

subdirName -

Returns:

Path to a subdirectory named subdirName under getDataTestDir(). Does *NOT* create it if it does not exist.

setupDataTestDir

protected Path setupDataTestDir()

Sets up a directory for a test to use.

Returns:

New directory path, if created.

createSubDir

protected void createSubDir(String propertyName,
                            Path parent,
                            String subDirName)

cleanupTestDir

public boolean cleanupTestDir()
                       throws IOException

Returns:

True if we removed the test dirs

Throws:

IOException