org.apache.hadoop.hbase

Class HBaseZKTestingUtility

java.lang.Object

org.apache.hadoop.hbase.HBaseCommonTestingUtility

org.apache.hadoop.hbase.HBaseZKTestingUtility

Direct Known Subclasses:

HBaseTestingUtility

@InterfaceAudience.Public
public class HBaseZKTestingUtility
extends HBaseCommonTestingUtility

Helpers for testing HBase that do not depend on specific server/etc. things. The main difference from HBaseCommonTestingUtility is that we can start a zookeeper cluster.

Field Summary

Fields

Modifier and Type	Field and Description
protected File	clusterTestDir Directory (a subdirectory of dataTestDir) used by the dfs cluster if any
protected ZKWatcher	zooKeeperWatcher

Fields inherited from class org.apache.hadoop.hbase.HBaseCommonTestingUtility

BASE_TEST_DIRECTORY_KEY, BOOLEAN_PARAMETERIZED, COMPRESSION_ALGORITHMS, COMPRESSION_ALGORITHMS_PARAMETERIZED, conf, DEFAULT_BASE_TEST_DIRECTORY, LOG

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	cleanupTestDir()
MiniZooKeeperCluster	getZkCluster()
ZKWatcher	getZooKeeperWatcher() Returns a ZKWatcher instance.
static ZKWatcher	getZooKeeperWatcher(HBaseZKTestingUtility testUtil) Gets a ZKWatcher.
protected void	setupClusterTestDir() Creates a directory for the cluster, under the test data
void	setZkCluster(MiniZooKeeperCluster zkCluster)
void	shutdownMiniZKCluster() Shuts down zk cluster created by call to startMiniZKCluster() or does nothing.
MiniZooKeeperCluster	startMiniZKCluster() Call this if you only want a zk cluster.
MiniZooKeeperCluster	startMiniZKCluster(int zooKeeperServerNum, int... clientPortList) Call this if you only want a zk cluster.

Methods inherited from class org.apache.hadoop.hbase.HBaseCommonTestingUtility

createSubDir, getConfiguration, getDataTestDir, getDataTestDir, getRandomDir, getRandomUUID, randomFreePort, setupDataTestDir, waitFor, waitFor, waitFor

Methods inherited from class java.lang.Object

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

Field Detail

zooKeeperWatcher

protected ZKWatcher zooKeeperWatcher

clusterTestDir

protected File clusterTestDir

Directory (a subdirectory of dataTestDir) used by the dfs cluster if any

Constructor Detail

HBaseZKTestingUtility

public HBaseZKTestingUtility()

HBaseZKTestingUtility

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

Method Detail

setupClusterTestDir

protected void setupClusterTestDir()

Creates a directory for the cluster, under the test data

startMiniZKCluster

public MiniZooKeeperCluster startMiniZKCluster()
                                        throws Exception

Call this if you only want a zk cluster.

Returns:

zk cluster started.

Throws:

Exception

See Also:

shutdownMiniZKCluster()

startMiniZKCluster

public MiniZooKeeperCluster startMiniZKCluster(int zooKeeperServerNum,
                                               int... clientPortList)
                                        throws Exception

Call this if you only want a zk cluster.

Returns:

zk cluster started.

Throws:

Exception

See Also:

shutdownMiniZKCluster()

getZkCluster

public MiniZooKeeperCluster getZkCluster()

setZkCluster

public void setZkCluster(MiniZooKeeperCluster zkCluster)

shutdownMiniZKCluster

public void shutdownMiniZKCluster()
                           throws IOException

Shuts down zk cluster created by call to startMiniZKCluster() or does nothing.

Throws:

IOException

See Also:

startMiniZKCluster()

getZooKeeperWatcher

public ZKWatcher getZooKeeperWatcher()
                              throws IOException

Returns a ZKWatcher instance. This instance is shared between HBaseTestingUtility instance users. Don't close it, it will be closed automatically when the cluster shutdowns

Returns:

The ZKWatcher instance.

Throws:

IOException

getZooKeeperWatcher

public static ZKWatcher getZooKeeperWatcher(HBaseZKTestingUtility testUtil)
                                     throws IOException

Gets a ZKWatcher.

Throws:

IOException

cleanupTestDir

public boolean cleanupTestDir()

Overrides:

cleanupTestDir in class HBaseCommonTestingUtility

Returns:

True if we removed the test dirs