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.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.HBaseCommonTestingUtility

HBaseCommonTestingUtility.PortAllocator

Field Summary

Fields

Modifier and Type	Field and Description
protected File	clusterTestDir Directory (a subdirectory of dataTestDir) used by the dfs cluster if any
private boolean	passedZkCluster Set if we were passed a zkCluster.
private org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster	zkCluster
protected org.apache.hadoop.hbase.zookeeper.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, random

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	cleanupTestDir()
(package private) org.apache.hadoop.fs.Path	getClusterTestDir()
org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster	getZkCluster()
org.apache.hadoop.hbase.zookeeper.ZKWatcher	getZooKeeperWatcher() Returns a ZKWatcher instance.
static org.apache.hadoop.hbase.zookeeper.ZKWatcher	getZooKeeperWatcher(HBaseZKTestingUtility testUtil) Gets a ZKWatcher.
protected void	setupClusterTestDir() Creates a directory for the cluster, under the test data
void	setZkCluster(org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster zkCluster)
void	shutdownMiniZKCluster() Shuts down zk cluster created by call to startMiniZKCluster() or does nothing.
org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster	startMiniZKCluster() Call this if you only want a zk cluster.
private org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster	startMiniZKCluster(File dir, int zooKeeperServerNum, int[] clientPortList) Start a mini ZK cluster.
org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster	startMiniZKCluster(int zooKeeperServerNum, int... clientPortList) Call this if you only want a zk cluster.

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

cleanupTestDir, createSubDir, deleteDir, deleteOnExit, 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

zkCluster

private org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster zkCluster

passedZkCluster

private boolean passedZkCluster

Set if we were passed a zkCluster. If so, we won't shutdown zk as part of general shutdown.

zooKeeperWatcher

protected org.apache.hadoop.hbase.zookeeper.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

getClusterTestDir

org.apache.hadoop.fs.Path getClusterTestDir()

Returns:

Where the cluster will write data on the local subsystem. Creates it if it does not exist already. A subdir of HBaseCommonTestingUtility#getBaseTestDir()

setupClusterTestDir

protected void setupClusterTestDir()

Creates a directory for the cluster, under the test data

startMiniZKCluster

public org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster startMiniZKCluster()
                                                                          throws Exception

Call this if you only want a zk cluster.

Returns:

zk cluster started.

Throws:

Exception

See Also:

shutdownMiniZKCluster()

startMiniZKCluster

public org.apache.hadoop.hbase.zookeeper.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()

startMiniZKCluster

private org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster startMiniZKCluster(File dir,
                                                                                  int zooKeeperServerNum,
                                                                                  int[] clientPortList)
                                                                           throws Exception

Start a mini ZK cluster. If the property "test.hbase.zookeeper.property.clientPort" is set the port mentioned is used as the default port for ZooKeeper.

Throws:

Exception

getZkCluster

public org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster getZkCluster()

setZkCluster

public void setZkCluster(org.apache.hadoop.hbase.zookeeper.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 org.apache.hadoop.hbase.zookeeper.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 org.apache.hadoop.hbase.zookeeper.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