Package org.apache.hadoop.hbase.client

Class TestClientScannerTimeouts

java.lang.Object

org.apache.hadoop.hbase.client.TestClientScannerTimeouts

public class TestClientScannerTimeouts
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	TestClientScannerTimeouts.RegionServerWithScanTimeout
private static class	TestClientScannerTimeouts.RSRpcServicesWithScanTimeout

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.hadoop.hbase.client.AsyncConnection	ASYNC_CONN
static final HBaseClassTestRule	CLASS_RULE
private static final int	CLIENT_RETRIES_NUMBER
private org.apache.hadoop.hbase.client.Connection	CONN
private static final byte[]	FAMILY
private static final org.slf4j.Logger	LOG
private static final int	metaReadRpcTimeout
private static final int	metaScanTimeout
org.junit.rules.TestName	name
private static final byte[]	QUALIFIER
private static final byte[]	ROW0
private static final byte[]	ROW1
private static final byte[]	ROW2
private static final byte[]	ROW3
private static final int	rpcTimeout
private static final int	scanTimeout
private static org.apache.hadoop.hbase.TableName	tableName
private static final HBaseTestingUtility	TEST_UTIL
boolean	useScannerTimeoutPeriodForNextCalls
private static final byte[]	VALUE

Constructor Summary

Constructors

Constructor	Description
TestClientScannerTimeouts()

Method Summary

Modifier and Type	Method	Description
void	after()
private void	expectNumTries(int expected)
private void	expectRetryOutOfOrderScannerNext(Supplier<org.apache.hadoop.hbase.client.ResultScanner> scannerSupplier)
private void	expectRow(byte[] expected, org.apache.hadoop.hbase.client.Result result)
private void	expectTimeout(long start, int timeout)
private void	expectTimeoutOnCloseScanner(int timeout, Supplier<org.apache.hadoop.hbase.client.ResultScanner> scannerSupplier)
private void	expectTimeoutOnNext(int timeout, Supplier<org.apache.hadoop.hbase.client.ResultScanner> scannerSupplier)
private void	expectTimeoutOnOpenScanner(int timeout, Supplier<org.apache.hadoop.hbase.client.ResultScanner> scannerSupplier)
private void	expectTimeoutOnRenewScanner(int timeout, Supplier<org.apache.hadoop.hbase.client.ResultScanner> scannerSupplier)
private org.apache.hadoop.hbase.client.ResultScanner	getAsyncScanner()
private org.apache.hadoop.hbase.client.Connection	getNoRetriesConnection()
private org.apache.hadoop.hbase.client.ResultScanner	getScanner()
private org.apache.hadoop.hbase.client.ResultScanner	getScanner(org.apache.hadoop.hbase.client.Connection conn)
static Collection<Object[]>	parameters()
private void	putToTable(org.apache.hadoop.hbase.client.Table ht, byte[] rowkey)
void	setup(boolean isSystemTable)
void	setUp()
static void	setUpBeforeClass()
static void	tearDownAfterClass()
void	testMetaScanTimeoutOnClose()	Test close timeout for non-async scanner, which should use rpcTimeout.
void	testMetaScanTimeoutOnNext()	verify that we honor ConnectionConfiguration.HBASE_CLIENT_META_SCANNER_TIMEOUT for next() calls in meta scans
void	testMetaScanTimeoutOnNextAsync()	AsyncTable version of above
void	testMetaScanTimeoutOnOpenScanner()	verify that we honor ConnectionConfiguration.HBASE_CLIENT_META_READ_RPC_TIMEOUT_KEY for openScanner() calls for meta scans
void	testMetaScanTimeoutOnOpenScannerAsync()	AsyncTable version of above
void	testMetaScanTimeoutOnRenewLease()	Test renewLease timeout for non-async scanner, which should use rpcTimeout.
void	testNormalScanTimeoutOnClose()	Test close timeout for non-async scanner, which should use rpcTimeout.
void	testNormalScanTimeoutOnNext()
void	testNormalScanTimeoutOnNextAsync()	AsyncTable version of above
void	testNormalScanTimeoutOnOpenScanner()	verify that we honor HConstants.HBASE_RPC_READ_TIMEOUT_KEY for openScanner() calls for meta scans
void	testNormalScanTimeoutOnOpenScannerAsync()	AsyncTable version of above
void	testNormalScanTimeoutOnRenewLease()	Test renewLease timeout for non-async scanner, which should use rpcTimeout.
void	testRetryOutOfOrderScannerNextException()	verify that we don't miss any data when encountering an OutOfOrderScannerNextException.
void	testRetryOutOfOrderScannerNextExceptionAsync()	AsyncTable version of above
private void	testScanTimeoutOnNext(int rpcTimeout, int scannerTimeout)

Methods inherited from class java.lang.Object

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

Field Details

CLASS_RULE

public static final HBaseClassTestRule CLASS_RULE

LOG

private static final org.slf4j.Logger LOG

TEST_UTIL

private static final HBaseTestingUtility TEST_UTIL

ASYNC_CONN

private org.apache.hadoop.hbase.client.AsyncConnection ASYNC_CONN

CONN

private org.apache.hadoop.hbase.client.Connection CONN

FAMILY

private static final byte[] FAMILY

QUALIFIER

private static final byte[] QUALIFIER

VALUE

private static final byte[] VALUE

ROW0

private static final byte[] ROW0

ROW1

private static final byte[] ROW1

ROW2

private static final byte[] ROW2

ROW3

private static final byte[] ROW3

rpcTimeout

private static final int rpcTimeout

See Also:

• Constant Field Values

scanTimeout

private static final int scanTimeout

See Also:

• Constant Field Values

metaReadRpcTimeout

private static final int metaReadRpcTimeout

See Also:

• Constant Field Values

metaScanTimeout

private static final int metaScanTimeout

See Also:

• Constant Field Values

CLIENT_RETRIES_NUMBER

private static final int CLIENT_RETRIES_NUMBER

See Also:

• Constant Field Values

tableName

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

name

public org.junit.rules.TestName name

useScannerTimeoutPeriodForNextCalls

public boolean useScannerTimeoutPeriodForNextCalls

Constructor Details

TestClientScannerTimeouts

public TestClientScannerTimeouts()

Method Details

parameters

public static Collection<Object[]> parameters()

setUpBeforeClass

public static void setUpBeforeClass()
                             throws Exception

Throws:

Exception

setUp

public void setUp()
           throws Exception

Throws:

Exception

after

public void after()
           throws Exception

Throws:

Exception

tearDownAfterClass

public static void tearDownAfterClass()
                               throws Exception

Throws:

Exception

setup

public void setup(boolean isSystemTable)
           throws IOException

Throws:

IOException

expectRow

private void expectRow(byte[] expected,
 org.apache.hadoop.hbase.client.Result result)

expectNumTries

private void expectNumTries(int expected)

testRetryOutOfOrderScannerNextException

public void testRetryOutOfOrderScannerNextException()
                                             throws IOException

verify that we don't miss any data when encountering an OutOfOrderScannerNextException. Typically, the only way to naturally trigger this is if a client-side timeout causes an erroneous next() call. This is relatively hard to do these days because the server attempts to always return before the timeout. In this test we force the server to throw this exception, so that we can test the retry logic appropriately.

Throws:

IOException

testRetryOutOfOrderScannerNextExceptionAsync

public void testRetryOutOfOrderScannerNextExceptionAsync()
                                                  throws IOException

AsyncTable version of above

Throws:

IOException

testNormalScanTimeoutOnNext

public void testNormalScanTimeoutOnNext()
                                 throws IOException

Throws:

IOException

testNormalScanTimeoutOnNextAsync

public void testNormalScanTimeoutOnNextAsync()
                                      throws IOException

AsyncTable version of above

Throws:

IOException

testNormalScanTimeoutOnOpenScanner

public void testNormalScanTimeoutOnOpenScanner()
                                        throws IOException

verify that we honor HConstants.HBASE_RPC_READ_TIMEOUT_KEY for openScanner() calls for meta scans

Throws:

IOException

testNormalScanTimeoutOnOpenScannerAsync

public void testNormalScanTimeoutOnOpenScannerAsync()
                                             throws IOException

AsyncTable version of above

Throws:

IOException

testMetaScanTimeoutOnNext

public void testMetaScanTimeoutOnNext()
                               throws IOException

verify that we honor ConnectionConfiguration.HBASE_CLIENT_META_SCANNER_TIMEOUT for next() calls in meta scans

Throws:

IOException

testScanTimeoutOnNext

private void testScanTimeoutOnNext(int rpcTimeout,
 int scannerTimeout)
                            throws IOException

Throws:

IOException

getNoRetriesConnection

private org.apache.hadoop.hbase.client.Connection getNoRetriesConnection()
                                                                  throws IOException

Throws:

IOException

testMetaScanTimeoutOnNextAsync

public void testMetaScanTimeoutOnNextAsync()
                                    throws IOException

AsyncTable version of above

Throws:

IOException

testMetaScanTimeoutOnOpenScanner

public void testMetaScanTimeoutOnOpenScanner()
                                      throws IOException

verify that we honor ConnectionConfiguration.HBASE_CLIENT_META_READ_RPC_TIMEOUT_KEY for openScanner() calls for meta scans

Throws:

IOException

testMetaScanTimeoutOnOpenScannerAsync

public void testMetaScanTimeoutOnOpenScannerAsync()
                                           throws IOException

AsyncTable version of above

Throws:

IOException

testNormalScanTimeoutOnRenewLease

public void testNormalScanTimeoutOnRenewLease()
                                       throws IOException

Test renewLease timeout for non-async scanner, which should use rpcTimeout. Async scanner does lease renewal automatically in the background, so renewLease() always returns false. So this test doesn't have an Async counterpart like the others.

Throws:

IOException

testMetaScanTimeoutOnRenewLease

public void testMetaScanTimeoutOnRenewLease()
                                     throws IOException

Test renewLease timeout for non-async scanner, which should use rpcTimeout. Async scanner does lease renewal automatically in the background, so renewLease() always returns false. So this test doesn't have an Async counterpart like the others.

Throws:

IOException

testNormalScanTimeoutOnClose

public void testNormalScanTimeoutOnClose()
                                  throws IOException

Test close timeout for non-async scanner, which should use rpcTimeout. Async scanner does closes async and always returns immediately. So this test doesn't have an Async counterpart like the others.

Throws:

IOException

testMetaScanTimeoutOnClose

public void testMetaScanTimeoutOnClose()
                                throws IOException

Test close timeout for non-async scanner, which should use rpcTimeout. Async scanner does closes async and always returns immediately. So this test doesn't have an Async counterpart like the others.

Throws:

IOException

expectRetryOutOfOrderScannerNext

private void expectRetryOutOfOrderScannerNext(Supplier<org.apache.hadoop.hbase.client.ResultScanner> scannerSupplier)
                                       throws IOException

Throws:

IOException

expectTimeoutOnNext

private void expectTimeoutOnNext(int timeout,
 Supplier<org.apache.hadoop.hbase.client.ResultScanner> scannerSupplier)
                          throws IOException

Throws:

IOException

expectTimeoutOnOpenScanner

private void expectTimeoutOnOpenScanner(int timeout,
 Supplier<org.apache.hadoop.hbase.client.ResultScanner> scannerSupplier)
                                 throws IOException

Throws:

IOException

expectTimeoutOnRenewScanner

private void expectTimeoutOnRenewScanner(int timeout,
 Supplier<org.apache.hadoop.hbase.client.ResultScanner> scannerSupplier)
                                  throws IOException

Throws:

IOException

expectTimeoutOnCloseScanner

private void expectTimeoutOnCloseScanner(int timeout,
 Supplier<org.apache.hadoop.hbase.client.ResultScanner> scannerSupplier)
                                  throws IOException

Throws:

IOException

expectTimeout

private void expectTimeout(long start,
 int timeout)

getScanner

private org.apache.hadoop.hbase.client.ResultScanner getScanner()

getScanner

private org.apache.hadoop.hbase.client.ResultScanner getScanner(org.apache.hadoop.hbase.client.Connection conn)

getAsyncScanner

private org.apache.hadoop.hbase.client.ResultScanner getAsyncScanner()

putToTable

private void putToTable(org.apache.hadoop.hbase.client.Table ht,
 byte[] rowkey)
                 throws IOException

Throws:

IOException