org.apache.hadoop.hbase.regionserver

Class TestScannerHeartbeatMessages

java.lang.Object

org.apache.hadoop.hbase.regionserver.TestScannerHeartbeatMessages

public class TestScannerHeartbeatMessages
extends Object

Here we test to make sure that scans return the expected Results when the server is sending the Client heartbeat messages. Heartbeat messages are essentially keep-alive messages (they prevent the scanner on the client side from timing out). A heartbeat message is sent from the server to the client when the server has exceeded the time limit during the processing of the scan. When the time limit is reached, the server will return to the Client whatever Results it has accumulated (potentially empty).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	TestScannerHeartbeatMessages.HeartbeatHRegion Custom HRegion class that instantiates RegionScanners with configurable sleep times between fetches of row Results and/or column family cells.
private static class	TestScannerHeartbeatMessages.HeartbeatHRegionServer Custom HRegionServer instance that instantiates TestScannerHeartbeatMessages.HeartbeatRPCServices in place of RSRpcServices to allow us to toggle support for heartbeat messages
private static class	TestScannerHeartbeatMessages.HeartbeatKVHeap Custom KV Heap that can be configured to sleep/wait in between retrievals of column family cells.
private static class	TestScannerHeartbeatMessages.HeartbeatRegionScanner Custom RegionScanner that can be configured to sleep between retrievals of row Results and/or column family cells
private static class	TestScannerHeartbeatMessages.HeartbeatReversedKVHeap Custom reversed KV Heap that can be configured to sleep in between retrievals of column family cells.
private static class	TestScannerHeartbeatMessages.HeartbeatReversedRegionScanner Custom ReversedRegionScanner that can be configured to sleep between retrievals of row Results and/or column family cells
private static class	TestScannerHeartbeatMessages.HeartbeatRPCServices Custom RSRpcServices instance that allows heartbeat support to be toggled
static class	TestScannerHeartbeatMessages.SparseCellFilter
static class	TestScannerHeartbeatMessages.SparseRowFilter

Field Summary

Fields

Modifier and Type	Field and Description
static HBaseClassTestRule	CLASS_RULE
private static int	CLIENT_TIMEOUT
private static int	DEFAULT_CF_SLEEP_TIME
private static int	DEFAULT_ROW_SLEEP_TIME
private static byte[][]	FAMILIES
private static byte[]	FAMILY
private static int	NUM_FAMILIES
private static int	NUM_QUALIFIERS
private static int	NUM_ROWS
private static byte[]	QUALIFIER
private static byte[][]	QUALIFIERS
private static byte[]	ROW
private static byte[][]	ROWS
private static int	SERVER_TIMEOUT
private static org.apache.hadoop.hbase.client.Table	TABLE
private static org.apache.hadoop.hbase.TableName	TABLE_NAME Table configuration
private static HBaseTestingUtility	TEST_UTIL
private static byte[]	VALUE
private static int	VALUE_SIZE

Constructor Summary

Constructors

Constructor and Description
TestScannerHeartbeatMessages()

Method Summary

Modifier and Type	Method and Description
private static void	configureSleepTime(int rowSleepTime, int cfSleepTime, boolean sleepBeforeCf) Helper method for setting the time to sleep between rows and column families.
(package private) static ArrayList<org.apache.hadoop.hbase.client.Put>	createPuts(byte[][] rows, byte[][] families, byte[][] qualifiers, byte[] value) Make puts to put the input value into each combination of row, family, and qualifier
(package private) static org.apache.hadoop.hbase.client.Table	createTestTable(org.apache.hadoop.hbase.TableName name, byte[][] rows, byte[][] families, byte[][] qualifiers, byte[] cellValue)
private static void	disableSleeping() Disable the sleeping mechanism server side.
static void	setUpBeforeClass()
void	setupBeforeTest()
static void	tearDownAfterClass()
void	teardownAfterTest()
private void	testEquivalenceOfScanWithHeartbeats(org.apache.hadoop.hbase.client.Scan scan, int rowSleepTime, int cfSleepTime, boolean sleepBeforeCf) Test the equivalence of a scan versus the same scan executed when heartbeat messages are necessary
void	testHeartbeatBetweenColumnFamilies() Test the case that the time limit for scans is reached in between column families
void	testHeartbeatBetweenRows() Test the case that the time limit for the scan is reached after each full row of cells is fetched.
void	testHeartbeatWithSparseCellFilter() Test the case that there is a filter which filters most of cells
void	testHeartbeatWithSparseRowFilter() Test the case that there is a filter which filters most of rows
private void	testImportanceOfHeartbeats(Callable<Void> testCallable) Run the test callable when heartbeats are enabled/disabled.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_RULE

public static final HBaseClassTestRule CLASS_RULE

TEST_UTIL

private static final HBaseTestingUtility TEST_UTIL

TABLE

private static org.apache.hadoop.hbase.client.Table TABLE

TABLE_NAME

private static org.apache.hadoop.hbase.TableName TABLE_NAME

Table configuration

NUM_ROWS

private static int NUM_ROWS

ROW

private static byte[] ROW

ROWS

private static byte[][] ROWS

NUM_FAMILIES

private static int NUM_FAMILIES

FAMILY

private static byte[] FAMILY

FAMILIES

private static byte[][] FAMILIES

NUM_QUALIFIERS

private static int NUM_QUALIFIERS

QUALIFIER

private static byte[] QUALIFIER

QUALIFIERS

private static byte[][] QUALIFIERS

VALUE_SIZE

private static int VALUE_SIZE

VALUE

private static byte[] VALUE

SERVER_TIMEOUT

private static int SERVER_TIMEOUT

CLIENT_TIMEOUT

private static int CLIENT_TIMEOUT

DEFAULT_ROW_SLEEP_TIME

private static int DEFAULT_ROW_SLEEP_TIME

DEFAULT_CF_SLEEP_TIME

private static int DEFAULT_CF_SLEEP_TIME

Constructor Detail

TestScannerHeartbeatMessages

public TestScannerHeartbeatMessages()

Method Detail

setUpBeforeClass

public static void setUpBeforeClass()
                             throws Exception

Throws:

Exception

createTestTable

static org.apache.hadoop.hbase.client.Table createTestTable(org.apache.hadoop.hbase.TableName name,
                                                            byte[][] rows,
                                                            byte[][] families,
                                                            byte[][] qualifiers,
                                                            byte[] cellValue)
                                                     throws IOException

Throws:

IOException

createPuts

static ArrayList<org.apache.hadoop.hbase.client.Put> createPuts(byte[][] rows,
                                                                byte[][] families,
                                                                byte[][] qualifiers,
                                                                byte[] value)
                                                         throws IOException

Make puts to put the input value into each combination of row, family, and qualifier

Throws:

IOException

tearDownAfterClass

public static void tearDownAfterClass()
                               throws Exception

Throws:

Exception

setupBeforeTest

public void setupBeforeTest()
                     throws Exception

Throws:

Exception

teardownAfterTest

public void teardownAfterTest()
                       throws Exception

Throws:

Exception

testImportanceOfHeartbeats

private void testImportanceOfHeartbeats(Callable<Void> testCallable)
                                 throws InterruptedException

Run the test callable when heartbeats are enabled/disabled. We expect all tests to only pass when heartbeat messages are enabled (otherwise the test is pointless). When heartbeats are disabled, the test should throw an exception.

Throws:

InterruptedException

testHeartbeatBetweenRows

public void testHeartbeatBetweenRows()
                              throws Exception

Test the case that the time limit for the scan is reached after each full row of cells is fetched.

Throws:

Exception

testHeartbeatBetweenColumnFamilies

public void testHeartbeatBetweenColumnFamilies()
                                        throws Exception

Test the case that the time limit for scans is reached in between column families

Throws:

Exception

testHeartbeatWithSparseCellFilter

public void testHeartbeatWithSparseCellFilter()
                                       throws Exception

Test the case that there is a filter which filters most of cells

Throws:

Exception

testHeartbeatWithSparseRowFilter

public void testHeartbeatWithSparseRowFilter()
                                      throws Exception

Test the case that there is a filter which filters most of rows

Throws:

Exception

testEquivalenceOfScanWithHeartbeats

private void testEquivalenceOfScanWithHeartbeats(org.apache.hadoop.hbase.client.Scan scan,
                                                 int rowSleepTime,
                                                 int cfSleepTime,
                                                 boolean sleepBeforeCf)
                                          throws Exception

Test the equivalence of a scan versus the same scan executed when heartbeat messages are necessary

Parameters:

scan - The scan configuration being tested

rowSleepTime - The time to sleep between fetches of row cells

cfSleepTime - The time to sleep between fetches of column family cells

sleepBeforeCf - set to true when column family sleeps should occur before the cells for that column family are fetched

Throws:

Exception

configureSleepTime

private static void configureSleepTime(int rowSleepTime,
                                       int cfSleepTime,
                                       boolean sleepBeforeCf)

Helper method for setting the time to sleep between rows and column families. If a sleep time is negative then that sleep will be disabled

disableSleeping

private static void disableSleeping()

Disable the sleeping mechanism server side.