Package org.apache.hadoop.hbase

Class MiniClusterRule

java.lang.Object

org.junit.rules.ExternalResource

org.apache.hadoop.hbase.MiniClusterRule

All Implemented Interfaces:

org.junit.rules.TestRule

public final class MiniClusterRule
extends org.junit.rules.ExternalResource

A TestRule that manages an instance of the MiniHBaseCluster. Can be used in either the Rule or ClassRule positions. Built on top of an instance of HBaseTestingUtility, so be weary of intermixing direct use of that class with this Rule.

Use in combination with ConnectionRule, for example:

 {
   @code
   public class TestMyClass {
     @ClassRule
     public static final MiniClusterRule miniClusterRule = MiniClusterRule.newBuilder().build();

     @Rule
     public final ConnectionRule connectionRule =
       ConnectionRule.createAsyncConnectionRule(miniClusterRule::createAsyncConnection);
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MiniClusterRule.Builder	A builder for fluent composition of a new MiniClusterRule.

Field Summary

Fields

Modifier and Type	Field	Description
private MiniHBaseCluster	miniCluster
private final StartMiniClusterOption	miniClusterOptions
private final HBaseTestingUtility	testingUtility

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MiniClusterRule(org.apache.hadoop.conf.Configuration conf, StartMiniClusterOption miniClusterOptions)

Method Summary

Modifier and Type	Method	Description
protected void	after()
protected void	before()
CompletableFuture<org.apache.hadoop.hbase.client.AsyncConnection>	createAsyncConnection()	Create a AsyncConnection to the managed MiniHBaseCluster.
org.apache.hadoop.hbase.client.Connection	createConnection()	Create a Connection to the managed MiniHBaseCluster.
HBaseTestingUtility	getTestingUtility()	Returns the underlying instance of HBaseTestingUtility
static MiniClusterRule.Builder	newBuilder()

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

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

Field Details

testingUtility

private final HBaseTestingUtility testingUtility

miniClusterOptions

private final StartMiniClusterOption miniClusterOptions

miniCluster

private MiniHBaseCluster miniCluster

Constructor Details

MiniClusterRule

private MiniClusterRule(org.apache.hadoop.conf.Configuration conf,
 StartMiniClusterOption miniClusterOptions)

Method Details

newBuilder

public static MiniClusterRule.Builder newBuilder()

getTestingUtility

public HBaseTestingUtility getTestingUtility()

Returns the underlying instance of HBaseTestingUtility

createConnection

public org.apache.hadoop.hbase.client.Connection createConnection()

Create a Connection to the managed MiniHBaseCluster. It's up to the caller to close() the connection when finished.

createAsyncConnection

public CompletableFuture<org.apache.hadoop.hbase.client.AsyncConnection> createAsyncConnection()

Create a AsyncConnection to the managed MiniHBaseCluster. It's up to the caller to close() the connection when finished.

before

protected void before()
               throws Throwable

Overrides:

before in class org.junit.rules.ExternalResource

Throws:

Throwable

after

protected void after()

Overrides:

after in class org.junit.rules.ExternalResource