org.apache.hadoop.hbase.testing

Interface TestingHBaseCluster

All Known Implementing Classes:

TestingHBaseClusterImpl

@InterfaceAudience.Public
public interface TestingHBaseCluster

A mini hbase cluster used for testing.

It will also start the necessary zookeeper cluster and dfs cluster. But we will not provide methods for controlling the zookeeper cluster and dfs cluster, as end users do not need to test the HBase behavior when these systems are broken.

The implementation is not required to be thread safe, so do not call different methods concurrently.

Method Summary

Modifier and Type	Method and Description
static TestingHBaseCluster	create(TestingHBaseClusterOption option) Create a TestingHBaseCluster.
Optional<ServerName>	getActiveMasterAddress() Get the address of active master if there is one.
List<ServerName>	getBackupMasterAddresses() Get all the backup master addresses.
org.apache.hadoop.conf.Configuration	getConf() Get configuration of this cluster.
Optional<OnlineRegions>	getOnlineRegionsInterface(ServerName serverName) Get the server side OnlineRegions interface for the specific region server.
Optional<Region>	getRegion(RegionInfo regionInfo) Get the server side Region interface for the specific region.
List<ServerName>	getRegionServerAddresses() Get all the region server addresses.
boolean	isClusterRunning() Return whether the cluster is running.
boolean	isHBaseClusterRunning() Return whether the hbase cluster is running.
void	start() Start the whole mini cluster, including zookeeper cluster, dfs cluster and hbase cluster.
void	startHBaseCluster() Start the hbase cluster.
void	startMaster() Start a new master with localhost and random port.
void	startMaster(String hostname, int port) Start a new master bind on the given host and port.
void	startRegionServer() Start a new region server with localhost and random port.
void	startRegionServer(String hostname, int port) Start a new region server bind on the given host and port.
void	stop() Stop the whole mini cluster, including zookeeper cluster, dfs cluster and hbase cluster.
void	stopHBaseCluster() Stop the hbase cluster.
CompletableFuture<Void>	stopMaster(ServerName serverName) Stop the given master.
CompletableFuture<Void>	stopRegionServer(ServerName serverName) Stop the given region server.

Method Detail

getConf

org.apache.hadoop.conf.Configuration getConf()

Get configuration of this cluster.

You could use the returned Configuration to create Connection for accessing the testing cluster.

startMaster

void startMaster()
          throws Exception

Start a new master with localhost and random port.

Throws:

Exception

startMaster

void startMaster(String hostname,
                 int port)
          throws Exception

Start a new master bind on the given host and port.

Throws:

Exception

stopMaster

CompletableFuture<Void> stopMaster(ServerName serverName)
                            throws Exception

Stop the given master.

Wait on the returned CompletableFuture to wait on the master quit. The differences comparing to Admin.stopMaster() is that first, we could also stop backup masters here, second, this method does not always fail since we do not use rpc to stop the master.

Throws:

Exception

startRegionServer

void startRegionServer()
                throws Exception

Start a new region server with localhost and random port.

Throws:

Exception

startRegionServer

void startRegionServer(String hostname,
                       int port)
                throws Exception

Start a new region server bind on the given host and port.

Throws:

Exception

stopRegionServer

CompletableFuture<Void> stopRegionServer(ServerName serverName)
                                  throws Exception

Stop the given region server.

Wait on the returned CompletableFuture to wait on the master quit. The difference comparing to Admin.stopMaster() is that this method does not always fail since we do not use rpc to stop the region server.

Throws:

Exception

stopHBaseCluster

void stopHBaseCluster()
               throws Exception

Stop the hbase cluster.

You need to call start() first before calling this method, otherwise an IllegalStateException will be thrown. If the hbase is not running because you have already stopped the cluster, an IllegalStateException will be thrown too.

Throws:

Exception

startHBaseCluster

void startHBaseCluster()
                throws Exception

Start the hbase cluster.

This is used to start the hbase cluster again after you call stopHBaseCluster(). If the cluster is already running or you have not called start() yet, an IllegalStateException will be thrown.

Throws:

Exception

isHBaseClusterRunning

boolean isHBaseClusterRunning()

Return whether the hbase cluster is running.

start

void start()
    throws Exception

Start the whole mini cluster, including zookeeper cluster, dfs cluster and hbase cluster.

You can only call this method once at the beginning, unless you have called stop() to shutdown the cluster completely, and then you can call this method to start the whole cluster again. An IllegalStateException will be thrown if you call this method incorrectly.

Throws:

Exception

getActiveMasterAddress

Optional<ServerName> getActiveMasterAddress()

Get the address of active master if there is one.

getBackupMasterAddresses

List<ServerName> getBackupMasterAddresses()

Get all the backup master addresses.

getRegionServerAddresses

List<ServerName> getRegionServerAddresses()

Get all the region server addresses.

getRegion

@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
Optional<Region> getRegion(RegionInfo regionInfo)

Get the server side Region interface for the specific region.

This is used for CPs to test something which can only be accessed at server side, such as tags.

getOnlineRegionsInterface

@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
Optional<OnlineRegions> getOnlineRegionsInterface(ServerName serverName)

Get the server side OnlineRegions interface for the specific region server.

You could list the addresses of all the region server through the getRegionServerAddresses() method.

This is used for CPs to test something which can only be accessed at server side, such as tags. And also you could use the returned interface to get all regions on this region server, etc.

isClusterRunning

boolean isClusterRunning()

Return whether the cluster is running.

Notice that, this only means you have called start() and have not called stop() yet. If you want to make sure the hbase cluster is running, use isHBaseClusterRunning().

stop

void stop()
   throws Exception

Stop the whole mini cluster, including zookeeper cluster, dfs cluster and hbase cluster.

You can only call this method after calling start(), otherwise an IllegalStateException will be thrown.

Throws:

Exception

create

static TestingHBaseCluster create(TestingHBaseClusterOption option)

Create a TestingHBaseCluster. You need to call start() of the returned TestingHBaseCluster to actually start the mini testing cluster.