org.apache.hadoop.hbase

Class IntegrationTestingUtility

java.lang.Object

HBaseTestingUtility

org.apache.hadoop.hbase.IntegrationTestingUtility

public class IntegrationTestingUtility
extends HBaseTestingUtility

Facility for integration/system tests. This extends HBaseTestingUtility and adds-in the functionality needed by integration and system tests. This class understands distributed and pseudo-distributed/local cluster deployments, and abstracts those from the tests in this module.

IntegrationTestingUtility is constructed and used by the integration tests, but the tests themselves should not assume a particular deployment. They can rely on the methods in this class and HBaseCluster. Before the testing begins, the test should initialize the cluster by calling initializeCluster(int).

The cluster that is used defaults to a mini cluster, but it can be forced to use a distributed cluster by calling setUseDistributedCluster(Configuration). This method is invoked by test drivers (maven, IntegrationTestsDriver, etc) before initializing the cluster via initializeCluster(int). Individual tests should not directly call setUseDistributedCluster(Configuration).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IS_DISTRIBUTED_CLUSTER Configuration that controls whether this utility assumes a running/deployed cluster.

Constructor Summary

Constructors

Constructor and Description
IntegrationTestingUtility()
IntegrationTestingUtility(Configuration conf)

Method Summary

Modifier and Type	Method and Description
void	checkNodeCount(int numSlaves) Checks whether we have more than numSlaves nodes.
void	createDistributedHBaseCluster()
void	initializeCluster(int numSlaves) Initializes the state of the cluster.
boolean	isDistributedCluster()
void	restoreCluster() Restores the cluster to the initial state if it is a distributed cluster, otherwise, shutdowns the mini cluster.
static void	setUseDistributedCluster(Configuration conf) Sets the configuration property to use a distributed cluster for the integration tests.

Methods inherited from class java.lang.Object

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

Field Detail

IS_DISTRIBUTED_CLUSTER

public static final java.lang.String IS_DISTRIBUTED_CLUSTER

Configuration that controls whether this utility assumes a running/deployed cluster. This is different than "hbase.cluster.distributed" since that parameter indicates whether the cluster is in an actual distributed environment, while this shows that there is a deployed (distributed or pseudo-distributed) cluster running, and we do not need to start a mini-cluster for tests.

See Also:

Constant Field Values

Constructor Detail

IntegrationTestingUtility

public IntegrationTestingUtility()

IntegrationTestingUtility

public IntegrationTestingUtility(Configuration conf)

Method Detail

initializeCluster

public void initializeCluster(int numSlaves)
                       throws java.lang.Exception

Initializes the state of the cluster. It starts a new in-process mini cluster, OR if we are given an already deployed distributed cluster it initializes the state.

Parameters:

numSlaves - Number of slaves to start up if we are booting a mini cluster. Otherwise we check whether this many nodes are available and throw an exception if not.

Throws:

java.lang.Exception

checkNodeCount

public void checkNodeCount(int numSlaves)
                    throws java.lang.Exception

Checks whether we have more than numSlaves nodes. Throws an exception otherwise.

Throws:

java.lang.Exception

restoreCluster

public void restoreCluster()
                    throws java.io.IOException

Restores the cluster to the initial state if it is a distributed cluster, otherwise, shutdowns the mini cluster.

Throws:

java.io.IOException

setUseDistributedCluster

public static void setUseDistributedCluster(Configuration conf)

Sets the configuration property to use a distributed cluster for the integration tests. Test drivers should use this to enforce cluster deployment.

isDistributedCluster

public boolean isDistributedCluster()

Returns:

whether we are interacting with a distributed cluster as opposed to and in-process mini cluster or a local cluster.

See Also:

setUseDistributedCluster(Configuration)

createDistributedHBaseCluster

public void createDistributedHBaseCluster()
                                   throws java.io.IOException

Throws:

java.io.IOException