org.apache.kudu.test

Class KuduTestHarness

java.lang.Object

org.junit.rules.ExternalResource

org.apache.kudu.test.KuduTestHarness

All Implemented Interfaces:

org.junit.rules.TestRule

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class KuduTestHarness
extends org.junit.rules.ExternalResource

A Junit Rule that manages a Kudu cluster and clients for testing. This rule also includes utility methods for the cluster and clients.

 public static class TestFoo {

  @Rule
  public KuduTestHarness harness = new KuduTestHarness();

  ...
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SLEEP

Constructor Summary

Constructors

Constructor and Description
KuduTestHarness()
KuduTestHarness(org.apache.kudu.test.cluster.MiniKuduCluster.MiniKuduClusterBuilder clusterBuilder)

Method Summary

Modifier and Type	Method and Description
void	after()
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
void	before()
String	createJwtFor(String accountId, String subject, boolean isValid)
org.apache.kudu.client.HostAndPort	findLeaderMasterServer() Find the host and port of the leader master.
org.apache.kudu.client.HostAndPort	findLeaderTabletServer(LocatedTablet tablet) Finds the RPC port of the given tablet's leader tserver.
AsyncKuduClient	getAsyncClient()
static org.apache.kudu.test.cluster.MiniKuduCluster.MiniKuduClusterBuilder	getBaseClusterBuilder() Returns the base MiniKuduClusterBuilder used when creating a KuduTestHarness with the default constructor.
KuduClient	getClient()
byte[]	getClusterCACertDer()
String	getClusterRoot()
String	getMasterAddressesAsString() Return the comma-separated list of "host:port" pairs that describes the master config for this cluster.
List<org.apache.kudu.client.HostAndPort>	getMasterServers()
String	getPrincipal()
List<org.apache.kudu.client.HostAndPort>	getTabletServers()
void	kdestroy() Removes all credentials for all principals from the Kerberos credential cache.
void	killAllMasterServers() Kills all the master servers.
void	killAllTabletServers() Kills all the tablet servers.
org.apache.kudu.client.HostAndPort	killLeaderMasterServer() Helper method to easily kill the leader master.
void	killTabletLeader(KuduTable table) Helper method to easily kill a tablet server that serves the given table's only tablet's leader.
org.apache.kudu.client.HostAndPort	killTabletLeader(LocatedTablet tablet) Helper method to kill a tablet server that serves the given tablet's leader replica.
org.apache.kudu.client.HostAndPort	killTabletLeader(org.apache.kudu.client.RemoteTablet tablet) Helper method to kill a tablet server that hosts the given tablet's leader replica.
void	kinit(String username) Re-initialize Kerberos credentials for the given username, writing them into the Kerberos credential cache.
org.apache.kudu.client.HostAndPort	pauseLeaderMaster() Finds and pauses the leader master.
void	pauseMaster(org.apache.kudu.client.HostAndPort hp) Pauses the specified master.
void	resetClients() Resets the clients so that their state is completely fresh, including meta cache, connections, open tables, sessions and scanners, and propagated timestamp.
org.apache.kudu.client.HostAndPort	restartLeaderMaster() Kills and restarts the leader master.
org.apache.kudu.client.HostAndPort	restartTabletLeader(LocatedTablet tablet) Kills and starts back a tablet server that serves the given tablet's leader.
void	restartTabletServer(KuduTable table) Picks at random a tablet server that serves tablets from the passed table and restarts it.
org.apache.kudu.client.HostAndPort	restartTabletServer(org.apache.kudu.client.RemoteTablet tablet) Kills a tablet server that serves the given tablet's leader and restarts it.
void	resumeMaster(org.apache.kudu.client.HostAndPort hp) Resumes the specified master.
void	setMasterFlag(org.apache.kudu.client.HostAndPort hp, String flag, String value) Set a run-time flag for a Kudu master identified by its host and port.
void	setTabletServerFlag(org.apache.kudu.client.HostAndPort hp, String flag, String value) Set a run-time flag for a tablet server identified by its host and port.
void	startAllMasterServers() Starts all the master servers.
void	startAllTabletServers() Starts all the tablet servers.
void	startMaster(org.apache.kudu.client.HostAndPort hp) Start master which has previously been registered at the specified host and port.
void	startTabletServer(org.apache.kudu.client.HostAndPort hp) Start tablet server which has previously been registered at the specified host and port.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SLEEP

public static final int DEFAULT_SLEEP

See Also:

Constant Field Values

Constructor Detail

KuduTestHarness

public KuduTestHarness(org.apache.kudu.test.cluster.MiniKuduCluster.MiniKuduClusterBuilder clusterBuilder)

KuduTestHarness

public KuduTestHarness()

Method Detail

getBaseClusterBuilder

public static org.apache.kudu.test.cluster.MiniKuduCluster.MiniKuduClusterBuilder getBaseClusterBuilder()

Returns the base MiniKuduClusterBuilder used when creating a KuduTestHarness with the default constructor. This is useful if you want to add to the default cluster setup.

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)

Specified by:

apply in interface org.junit.rules.TestRule

Overrides:

apply in class org.junit.rules.ExternalResource

before

public void before()
            throws Exception

Overrides:

before in class org.junit.rules.ExternalResource

Throws:

Exception

after

public void after()

Overrides:

after in class org.junit.rules.ExternalResource

getClient

public KuduClient getClient()

getAsyncClient

public AsyncKuduClient getAsyncClient()

killTabletLeader

public void killTabletLeader(KuduTable table)
                      throws Exception

Helper method to easily kill a tablet server that serves the given table's only tablet's leader. The currently running test case will be failed if there's more than one tablet, if the tablet has no leader after some retries, or if the tablet server was already killed. This method is thread-safe.

Parameters:

table - a KuduTable which will get its single tablet's leader killed.

Throws:

Exception

killTabletLeader

public org.apache.kudu.client.HostAndPort killTabletLeader(org.apache.kudu.client.RemoteTablet tablet)
                                                    throws Exception

Helper method to kill a tablet server that hosts the given tablet's leader replica. This method is thread-safe.

Parameters:

tablet - a RemoteTablet which will get its leader killed

Returns:

the host and port of the tablet server which hosted the tablet's leader replica

Throws:

Exception - if no leader replica found after a few retries, or if the tablet server isn't running

killTabletLeader

public org.apache.kudu.client.HostAndPort killTabletLeader(LocatedTablet tablet)
                                                    throws Exception

Helper method to kill a tablet server that serves the given tablet's leader replica. This method is thread-safe.

Parameters:

tablet - a LocatedTablet which will get its leader killed

Returns:

the host and port of the tablet server which hosted the tablet's leader replica

Throws:

Exception - if no leader replica found or if the tablet server isn't running

findLeaderTabletServer

public org.apache.kudu.client.HostAndPort findLeaderTabletServer(LocatedTablet tablet)
                                                          throws Exception

Finds the RPC port of the given tablet's leader tserver.

Parameters:

tablet - a LocatedTablet

Returns:

the host and port of the given tablet's leader tserver

Throws:

Exception - if unable to find a tablet server with leader replica

startTabletServer

public void startTabletServer(org.apache.kudu.client.HostAndPort hp)
                       throws Exception

Start tablet server which has previously been registered at the specified host and port.

Parameters:

hp - host and port of the tablet server to start back

Throws:

Exception

findLeaderMasterServer

public org.apache.kudu.client.HostAndPort findLeaderMasterServer()
                                                          throws Exception

Find the host and port of the leader master.

Returns:

the host and port of the leader master

Throws:

Exception - if we are unable to find the leader master

killLeaderMasterServer

public org.apache.kudu.client.HostAndPort killLeaderMasterServer()
                                                          throws Exception

Helper method to easily kill the leader master. This method is thread-safe.

Returns:

the host and port of the detected leader master

Throws:

Exception - if there is an error finding or killing the leader master.

restartTabletServer

public void restartTabletServer(KuduTable table)
                         throws Exception

Picks at random a tablet server that serves tablets from the passed table and restarts it.

Parameters:

table - table to query for a TS to restart

Throws:

Exception

restartTabletServer

public org.apache.kudu.client.HostAndPort restartTabletServer(org.apache.kudu.client.RemoteTablet tablet)
                                                       throws Exception

Kills a tablet server that serves the given tablet's leader and restarts it.

Parameters:

tablet - a RemoteTablet which will get its leader killed and restarted

Returns:

the host and port of the restarted tablet server

Throws:

Exception

setTabletServerFlag

public void setTabletServerFlag(org.apache.kudu.client.HostAndPort hp,
                                String flag,
                                String value)
                         throws IOException

Set a run-time flag for a tablet server identified by its host and port.

Parameters:

hp - HostAndPort object identifying the target tablet server

flag - a flag to set (prefix dash(es) omitted)

value - a stringified representation of the flag's value to set

Throws:

IOException

restartTabletLeader

public org.apache.kudu.client.HostAndPort restartTabletLeader(LocatedTablet tablet)
                                                       throws Exception

Kills and starts back a tablet server that serves the given tablet's leader.

Parameters:

tablet - a LocatedTablet which is hosted by the target tablet server

Returns:

the host and port of the restarted tablet server

Throws:

Exception

restartLeaderMaster

public org.apache.kudu.client.HostAndPort restartLeaderMaster()
                                                       throws Exception

Kills and restarts the leader master.

Returns:

the host and port of the restarted master

Throws:

Exception

startMaster

public void startMaster(org.apache.kudu.client.HostAndPort hp)
                 throws Exception

Start master which has previously been registered at the specified host and port.

Parameters:

hp - host and port of the master to start back

Throws:

Exception

pauseLeaderMaster

public org.apache.kudu.client.HostAndPort pauseLeaderMaster()
                                                     throws Exception

Finds and pauses the leader master.

Returns:

the host and port of the paused master

Throws:

Exception

pauseMaster

public void pauseMaster(org.apache.kudu.client.HostAndPort hp)
                 throws Exception

Pauses the specified master.

Throws:

Exception

resumeMaster

public void resumeMaster(org.apache.kudu.client.HostAndPort hp)
                  throws Exception

Resumes the specified master.

Throws:

Exception

setMasterFlag

public void setMasterFlag(org.apache.kudu.client.HostAndPort hp,
                          String flag,
                          String value)
                   throws IOException

Set a run-time flag for a Kudu master identified by its host and port.

Parameters:

hp - HostAndPort object identifying the target master

flag - a flag to set (prefix dash(es) omitted)

value - a stringified representation of the flag's value to set

Throws:

IOException

getMasterAddressesAsString

public String getMasterAddressesAsString()

Return the comma-separated list of "host:port" pairs that describes the master config for this cluster.

Returns:

The master config string.

getMasterServers

public List<org.apache.kudu.client.HostAndPort> getMasterServers()

Returns:

the list of master servers

getTabletServers

public List<org.apache.kudu.client.HostAndPort> getTabletServers()

Returns:

the list of tablet servers

getClusterRoot

public String getClusterRoot()

Returns:

path to the mini cluster root directory

getPrincipal

public String getPrincipal()

Returns:

the service principal name

killAllMasterServers

public void killAllMasterServers()
                          throws IOException

Kills all the master servers. Does nothing to the servers that are already dead.

Throws:

IOException

startAllMasterServers

public void startAllMasterServers()
                           throws IOException

Starts all the master servers. Does nothing to the servers that are already running.

Throws:

IOException

killAllTabletServers

public void killAllTabletServers()
                          throws IOException

Kills all the tablet servers. Does nothing to the servers that are already dead.

Throws:

IOException

startAllTabletServers

public void startAllTabletServers()
                           throws IOException

Starts all the tablet servers. Does nothing to the servers that are already running.

Throws:

IOException

kdestroy

public void kdestroy()
              throws IOException

Removes all credentials for all principals from the Kerberos credential cache.

Throws:

IOException

kinit

public void kinit(String username)
           throws IOException

Re-initialize Kerberos credentials for the given username, writing them into the Kerberos credential cache.

Parameters:

username - the username to kinit as

Throws:

IOException

resetClients

public void resetClients()
                  throws IOException

Resets the clients so that their state is completely fresh, including meta cache, connections, open tables, sessions and scanners, and propagated timestamp.

Throws:

IOException

createJwtFor

public String createJwtFor(String accountId,
                           String subject,
                           boolean isValid)
                    throws IOException

Throws:

IOException

getClusterCACertDer

public byte[] getClusterCACertDer()
                           throws IOException

Returns:

cluster's CA certificate in DER format or null if catalog manager isn't ready

Throws:

IOException