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).

Constructor Summary

Constructors

Constructor and Description
TestScannerHeartbeatMessages()

Method Summary

Modifier and Type	Method and Description
static void	setUpBeforeClass()
void	setupBeforeTest()
static void	tearDownAfterClass()
void	teardownAfterTest()
void	testEquivalenceOfScanWithHeartbeats(Scan scan, int rowSleepTime, int cfSleepTime, boolean sleepBeforeCf) Test the equivalence of a scan versus the same scan executed when heartbeat messages are necessary
Callable<Void>	testHeartbeatBetweenColumnFamilies() Test the case that the time limit for scans is reached in between column families
Callable<Void>	testHeartbeatBetweenRows() Test the case that the time limit for the scan is reached after each full row of cells is fetched.
void	testImportanceOfHeartbeats(Callable<Void> testCallable) Run the test callable when heartbeats are enabled/disabled.
void	testScannerHeartbeatMessages() Test a variety of scan configurations to ensure that they return the expected Results when heartbeat messages are necessary.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestScannerHeartbeatMessages

public TestScannerHeartbeatMessages()

Method Detail

setUpBeforeClass

public static void setUpBeforeClass()
                             throws Exception

Throws:

Exception

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

testScannerHeartbeatMessages

public void testScannerHeartbeatMessages()
                                  throws Exception

Test a variety of scan configurations to ensure that they return the expected Results when heartbeat messages are necessary. These tests are accumulated under one test case to ensure that they don't run in parallel. If the tests ran in parallel, they may conflict with each other due to changing static variables

Throws:

Exception

testImportanceOfHeartbeats

public 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.

Parameters:

testCallable -

Throws:

InterruptedException

testHeartbeatBetweenRows

public Callable<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 Callable<Void> testHeartbeatBetweenColumnFamilies()
                                                  throws Exception

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

Throws:

Exception

testEquivalenceOfScanWithHeartbeats

public void testEquivalenceOfScanWithHeartbeats(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