Package org.apache.hadoop.hbase

Class HBaseCommonTestingUtil

java.lang.Object

org.apache.hadoop.hbase.HBaseCommonTestingUtil

Direct Known Subclasses:

HBaseZKTestingUtil

@LimitedPrivate("Phoenix")
@Evolving
public class HBaseCommonTestingUtil
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	HBaseCommonTestingUtil.PortAllocator

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_TEST_DIRECTORY_KEY	System property key to get base test directory value
static final List<Object[]>	BOOLEAN_PARAMETERIZED	This is for unit tests parameterized with a two booleans.
static final org.apache.hadoop.hbase.io.compress.Compression.Algorithm[]	COMPRESSION_ALGORITHMS	Compression algorithms to use in testing
static final List<Object[]>	COMPRESSION_ALGORITHMS_PARAMETERIZED	Compression algorithms to use in parameterized JUnit 4 tests
protected final org.apache.hadoop.conf.Configuration	conf
private File	dataTestDir	Directory where we put the data for this instance of HBaseTestingUtility
static final String	DEFAULT_BASE_TEST_DIRECTORY	Default base directory for test output.
protected static final org.slf4j.Logger	LOG
private static final HBaseCommonTestingUtil.PortAllocator	portAllocator

Constructor Summary

Constructors

Constructor	Description
HBaseCommonTestingUtil()
HBaseCommonTestingUtil(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method	Description
boolean	cleanupTestDir()	Returns true if we removed the test dirs
boolean	cleanupTestDir(String subdir)	Returns true if we removed the test dir
protected void	createSubDir(String propertyName, org.apache.hadoop.fs.Path parent, String subDirName)
(package private) boolean	deleteDir(File dir)	Returns true if we deleted it.
(package private) boolean	deleteOnExit()	Returns true if we should delete testing dirs on exit.
private org.apache.hadoop.fs.Path	getBaseTestDir()	Returns Where to write test data on local filesystem; usually DEFAULT_BASE_TEST_DIRECTORY Should not be used by the unit tests, hence its's private.
org.apache.hadoop.conf.Configuration	getConfiguration()	Returns this classes's instance of Configuration.
org.apache.hadoop.fs.Path	getDataTestDir()	Returns Where to write test data on local filesystem, specific to the test.
org.apache.hadoop.fs.Path	getDataTestDir(String name)	Returns the path to a subdirectory or file named {code subdirName} under getDataTestDir().
org.apache.hadoop.fs.Path	getRandomDir()	Returns a dir with a random (uuid) name under the test dir
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 Details

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 org.apache.hadoop.hbase.io.compress.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

dataTestDir

private File dataTestDir

Directory where we put the data for this instance of HBaseTestingUtility

portAllocator

private static final HBaseCommonTestingUtil.PortAllocator portAllocator

Constructor Details

HBaseCommonTestingUtil

public HBaseCommonTestingUtil()

HBaseCommonTestingUtil

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

Method Details

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)

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

Parameters:

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

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)

deleteOnExit

boolean deleteOnExit()

Returns true if we should delete testing dirs on exit.

cleanupTestDir

public boolean cleanupTestDir()

Returns true if we removed the test dirs

cleanupTestDir

public boolean cleanupTestDir(String subdir)

Returns true if we removed the test dir

Parameters:

subdir - Test subdir name.

getBaseTestDir

private org.apache.hadoop.fs.Path getBaseTestDir()

Returns Where to write test data on local filesystem; usually DEFAULT_BASE_TEST_DIRECTORY Should not be used by the unit tests, hence its's private. Unit test will use a subdirectory of this directory.

See Also:

• setupDataTestDir()

deleteDir

boolean deleteDir(File dir)

Returns true if we deleted it.

Parameters:

dir - Directory to delete

waitFor

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

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

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

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

Throws:

E extends Exception

randomFreePort

public static int randomFreePort()