org.apache.hadoop.hbase

Class HBaseCommonTestingUtility

java.lang.Object

org.apache.hadoop.hbase.HBaseCommonTestingUtility

Direct Known Subclasses:

HBaseZKTestingUtility

@InterfaceAudience.Public
public class HBaseCommonTestingUtility
extends Object

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

See Also:

HBaseCommonTestingUtility

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_TEST_DIRECTORY_KEY System property key to get base test directory value
static List<Object[]>	BOOLEAN_PARAMETERIZED This is for unit tests parameterized with a two booleans.
static Compression.Algorithm[]	COMPRESSION_ALGORITHMS Compression algorithms to use in testing
static List<Object[]>	COMPRESSION_ALGORITHMS_PARAMETERIZED Compression algorithms to use in parameterized JUnit 4 tests
protected org.apache.hadoop.conf.Configuration	conf
static String	DEFAULT_BASE_TEST_DIRECTORY Default base directory for test output.
protected static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
HBaseCommonTestingUtility()
HBaseCommonTestingUtility(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method and Description
boolean	cleanupTestDir()
protected void	createSubDir(String propertyName, org.apache.hadoop.fs.Path parent, String subDirName)
org.apache.hadoop.conf.Configuration	getConfiguration() Returns this classes's instance of Configuration.
org.apache.hadoop.fs.Path	getDataTestDir()
org.apache.hadoop.fs.Path	getDataTestDir(String name)
org.apache.hadoop.fs.Path	getRandomDir()
static UUID	getRandomUUID()
static int	randomFreePort()
protected org.apache.hadoop.fs.Path	setupDataTestDir() Sets up a directory for a test to use.
<E extends Exception> long	waitFor(long timeout, long interval, boolean failIfTimeout, Waiter.Predicate<E> predicate) Wrapper method for Waiter.waitFor(Configuration, long, long, boolean, Predicate).
<E extends Exception> long	waitFor(long timeout, long interval, Waiter.Predicate<E> predicate) Wrapper method for Waiter.waitFor(Configuration, long, long, Predicate).
<E extends Exception> long	waitFor(long timeout, Waiter.Predicate<E> predicate) Wrapper method for Waiter.waitFor(Configuration, long, Predicate).

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

COMPRESSION_ALGORITHMS_PARAMETERIZED

public static final List<Object[]> COMPRESSION_ALGORITHMS_PARAMETERIZED

Compression algorithms to use in parameterized JUnit 4 tests

BOOLEAN_PARAMETERIZED

public static final List<Object[]> BOOLEAN_PARAMETERIZED

This is for unit tests parameterized with a two booleans.

COMPRESSION_ALGORITHMS

public static final Compression.Algorithm[] COMPRESSION_ALGORITHMS

Compression algorithms to use in testing

conf

protected final org.apache.hadoop.conf.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(org.apache.hadoop.conf.Configuration conf)

Method Detail

getConfiguration

public org.apache.hadoop.conf.Configuration getConfiguration()

Returns this classes's instance of Configuration.

Returns:

Instance of Configuration.

getDataTestDir

public org.apache.hadoop.fs.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 org.apache.hadoop.fs.Path getDataTestDir(String name)

Parameters:

name - the name of a subdirectory or file in the test data directory

Returns:

Path to a subdirectory or file named {code subdirName} under getDataTestDir(). Does *NOT* create the directory or file if it does not exist.

setupDataTestDir

protected org.apache.hadoop.fs.Path setupDataTestDir()

Sets up a directory for a test to use.

Returns:

New directory path, if created.

getRandomDir

public org.apache.hadoop.fs.Path getRandomDir()

Returns:

A dir with a random (uuid) name under the test dir

See Also:

getBaseTestDir()

getRandomUUID

public static UUID getRandomUUID()

createSubDir

protected void createSubDir(String propertyName,
                            org.apache.hadoop.fs.Path parent,
                            String subDirName)

cleanupTestDir

public boolean cleanupTestDir()

Returns:

True if we removed the test dirs

waitFor

public <E extends Exception> long waitFor(long timeout,
                                          Waiter.Predicate<E> predicate)
                                   throws E extends Exception

Wrapper method for Waiter.waitFor(Configuration, long, Predicate).

Throws:

E extends Exception

waitFor

public <E extends Exception> long waitFor(long timeout,
                                          long interval,
                                          Waiter.Predicate<E> predicate)
                                   throws E extends Exception

Wrapper method for Waiter.waitFor(Configuration, long, long, Predicate).

Throws:

E extends Exception

waitFor

public <E extends Exception> long waitFor(long timeout,
                                          long interval,
                                          boolean failIfTimeout,
                                          Waiter.Predicate<E> predicate)
                                   throws E extends Exception

Wrapper method for Waiter.waitFor(Configuration, long, long, boolean, Predicate).

Throws:

E extends Exception

randomFreePort

public static int randomFreePort()