Package org.apache.hadoop.hbase.wal

Class TestWALSplit

java.lang.Object

org.apache.hadoop.hbase.wal.TestWALSplit

Direct Known Subclasses:

TestWALSplitBoundedLogWriterCreation, TestWALSplitCompressed, TestWALSplitValueCompression

@Tag("org.apache.hadoop.hbase.testclassification.RegionServerTests") @Tag("org.apache.hadoop.hbase.testclassification.LargeTests")
public class TestWALSplit
extends Object

Testing WAL splitting code.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	TestWALSplit.Corruptions
private class	TestWALSplit.SplitWALWorker
private class	TestWALSplit.ZombieLastLogWriterRegionServer	This thread will keep writing to a 'wal' file even after the split process has started.

Field Summary

Fields

Modifier and Type	Field	Description
private static org.apache.hadoop.conf.Configuration	conf
private org.apache.hadoop.fs.Path	CORRUPTDIR
private static final int	ENTRIES
private static final byte[]	FAMILY
private static final String	FILENAME_BEING_SPLIT
private org.apache.hadoop.fs.FileSystem	fs
private static String[]	GROUP
private org.apache.hadoop.fs.Path	HBASEDIR
private org.apache.hadoop.fs.Path	HBASELOGDIR
private static final org.slf4j.Logger	LOG
private static final int	NUM_WRITERS
private org.apache.hadoop.fs.Path	OLDLOGDIR
private static final byte[]	QUALIFIER
private static List<String>	REGIONS
private static String	ROBBER
private static final org.apache.hadoop.hbase.TableName	TABLE_NAME
private org.apache.hadoop.fs.Path	TABLEDIR
protected static final HBaseTestingUtil	TEST_UTIL
private String	testMethodName
private String	TMPDIRNAME
private static final byte[]	VALUE
private static final String	WAL_FILE_PREFIX
private org.apache.hadoop.fs.Path	WALDIR
private org.apache.hadoop.hbase.wal.WALFactory	wals
private static String	ZOMBIE

Constructor Summary

Constructors

Constructor	Description
TestWALSplit()

Method Summary

Modifier and Type	Method	Description
private static void	appendCompactionEvent(org.apache.hadoop.hbase.wal.WALProvider.Writer w, org.apache.hadoop.hbase.client.RegionInfo hri, String[] inputs, String output)
private static long	appendEmptyEntry(org.apache.hadoop.hbase.wal.WALProvider.Writer writer, org.apache.hadoop.hbase.TableName table, byte[] region, long seq)
private static long	appendEntry(org.apache.hadoop.hbase.wal.WALProvider.Writer writer, org.apache.hadoop.hbase.TableName table, byte[] region, byte[] row, byte[] family, byte[] qualifier, byte[] value, long seq)
private static void	appendRegionEvent(org.apache.hadoop.hbase.wal.WALProvider.Writer w, String region)
private void	closeOrFlush(boolean close, org.apache.hadoop.fs.FSDataOutputStream out)
private void	corruptWAL(org.apache.hadoop.fs.Path path, TestWALSplit.Corruptions corruption, boolean close)
private int	countWAL(org.apache.hadoop.fs.Path log)
private static org.apache.hadoop.hbase.wal.WAL.Entry	createEmptyEntry(org.apache.hadoop.hbase.TableName table, byte[] region, long seq)
private org.apache.hadoop.fs.Path	createRecoveredEditsPathForRegion()
private static org.apache.hadoop.hbase.wal.WAL.Entry	createTestEntry(org.apache.hadoop.hbase.TableName table, byte[] region, byte[] row, byte[] family, byte[] qualifier, byte[] value, long seq)
private void	doTestThreading(int numFakeEdits, int bufferSize, int writerSlowness)	Sets up a log splitter with a mock reader and writer.
private void	generateEmptyEditWAL(org.apache.hadoop.fs.Path path, byte[] region)
private void	generateReplicationMarkerEdits(org.apache.hadoop.fs.Path path, org.apache.hadoop.hbase.client.RegionInfo regionInfo)
private org.apache.hadoop.hbase.wal.WALProvider.Writer	generateWALs(int leaveOpen)
private org.apache.hadoop.hbase.wal.WALProvider.Writer	generateWALs(int writers, int entries, int leaveOpen)
private org.apache.hadoop.hbase.wal.WALProvider.Writer	generateWALs(int writers, int entries, int leaveOpen, int regionEvents)
private org.apache.hadoop.fs.Path[]	getLogForRegion(org.apache.hadoop.hbase.TableName table, String region)
private void	ignoreCorruption(TestWALSplit.Corruptions corruption, int entryCount, int expectedCount)
private void	injectEmptyFile(String suffix, boolean closeFile)
private boolean	logsAreEqual(org.apache.hadoop.fs.Path p1, org.apache.hadoop.fs.Path p2)
private void	makeRegionDirs(List<String> regions)
private void	retryOverHdfsProblem(org.apache.hadoop.fs.FileSystem spiedFs)
void	setUp(org.junit.jupiter.api.TestInfo testInfo)
static void	setUpBeforeClass()
private int	splitAndCount(int expectedFiles, int expectedEntries)
private Set<String>	splitCorruptWALs(FaultyProtobufWALStreamReader.FailureType failureType)
void	tearDown()
static void	tearDownAfterClass()
void	testConcurrentSplitLogAndReplayRecoverEdit()
void	testCorruptedFileGetsArchivedIfSkipErrors()
void	testCorruptedLogFilesSkipErrorsFalseDoesNotTouchLogs()
void	testCorruptWALTrailer()
void	testEmptyLogFiles()
private void	testEmptyLogFiles(boolean close)
void	testEmptyOpenLogFiles()
void	testEmptyWALEdit()	See HBASE-27644, typically we should not have empty WALEdit but we should be able to process it, instead of losing data after it.
void	testEOFisIgnored()
void	testFirstLineCorruptionLogFileSkipErrorsPasses()
void	testHasRecoveredEdits()
void	testIOEOnOutputThread()
void	testLogCannotBeWrittenOnceParsed()	Simulates splitting a WAL out from under a regionserver that is still trying to write it.
void	testLogDirectoryShouldBeDeletedAfterSuccessfulSplit()
void	testLogsGetArchivedAfterSplit()
void	testMiddleGarbageCorruptionSkipErrorsReadsHalfOfFile()
void	testMovedWALDuringRecovery()
void	testOldRecoveredEditsFileSidelined()	Test old recovered edits file doesn't break WALSplitter.
void	testOpenZeroLengthReportedFileButWithDataGetsSplit()
void	testRecoveredEditsPathForMeta()
void	testRecoveredEditsStoragePolicy()
void	testRetryOpenDuringRecovery()
void	testSplit()
void	testSplitDeletedRegion()
void	testSplitLeavesCompactionEventsEdits()
void	testSplitLogFileDeletedRegionDir()
void	testSplitLogFileEmpty()
void	testSplitLogFileFirstLineCorruptionLog()
void	testSplitLogFileMultipleRegions()
void	testSplitPreservesEdits()
void	testSplitRemovesRegionEventsEdits()
void	testSplitRemovesReplicationMarkerEdits()	Tests that WalSplitter ignores replication marker edits.
void	testSplitWillFailIfWritingToRegionFails()
void	testTerminationAskedByReporter()
void	testThreading()	Test log split process with fake data and lots of edits to trigger threading issues.
void	testThreadingSlowWriterSmallBuffer()	Test blocking behavior of the log split process if writers are writing slower than the reader is reading.
void	testTrailingGarbageCorruptionLogFileSkipErrorsFalseThrows()
void	testTralingGarbageCorruptionFileSkipErrorsPasses()
void	testTwoWorkerSplittingSameWAL()
private void	useDifferentDFSClient()

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

conf

private static org.apache.hadoop.conf.Configuration conf

fs

private org.apache.hadoop.fs.FileSystem fs

TEST_UTIL

protected static final HBaseTestingUtil TEST_UTIL

HBASEDIR

private org.apache.hadoop.fs.Path HBASEDIR

HBASELOGDIR

private org.apache.hadoop.fs.Path HBASELOGDIR

WALDIR

private org.apache.hadoop.fs.Path WALDIR

OLDLOGDIR

private org.apache.hadoop.fs.Path OLDLOGDIR

CORRUPTDIR

private org.apache.hadoop.fs.Path CORRUPTDIR

TABLEDIR

private org.apache.hadoop.fs.Path TABLEDIR

TMPDIRNAME

private String TMPDIRNAME

NUM_WRITERS

private static final int NUM_WRITERS

See Also:

• Constant Field Values

ENTRIES

private static final int ENTRIES

See Also:

• Constant Field Values

FILENAME_BEING_SPLIT

private static final String FILENAME_BEING_SPLIT

See Also:

• Constant Field Values

TABLE_NAME

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

FAMILY

private static final byte[] FAMILY

QUALIFIER

private static final byte[] QUALIFIER

VALUE

private static final byte[] VALUE

WAL_FILE_PREFIX

private static final String WAL_FILE_PREFIX

See Also:

• Constant Field Values

REGIONS

private static List<String> REGIONS

ROBBER

private static String ROBBER

ZOMBIE

private static String ZOMBIE

GROUP

private static String[] GROUP

testMethodName

private String testMethodName

wals

private org.apache.hadoop.hbase.wal.WALFactory wals

Constructor Details

TestWALSplit

public TestWALSplit()

Method Details

setUpBeforeClass

@BeforeAll
public static void setUpBeforeClass()
                             throws Exception

Throws:

Exception

tearDownAfterClass

@AfterAll
public static void tearDownAfterClass()
                               throws Exception

Throws:

Exception

setUp

@BeforeEach
public void setUp(org.junit.jupiter.api.TestInfo testInfo)
           throws Exception

Throws:

Exception

tearDown

@AfterEach
public void tearDown()
              throws Exception

Throws:

Exception

testLogCannotBeWrittenOnceParsed

@Test
public void testLogCannotBeWrittenOnceParsed()
                                      throws IOException,
InterruptedException

Simulates splitting a WAL out from under a regionserver that is still trying to write it. Ensures we do not lose edits.

Throws:

IOException

InterruptedException

testTwoWorkerSplittingSameWAL

@Test
public void testTwoWorkerSplittingSameWAL()
                                   throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

testRecoveredEditsPathForMeta

@Test
public void testRecoveredEditsPathForMeta()
                                   throws IOException

Throws:

IOException

See Also:

• "https://issues.apache.org/jira/browse/HBASE-3020"

testOldRecoveredEditsFileSidelined

@Test
public void testOldRecoveredEditsFileSidelined()
                                        throws IOException

Test old recovered edits file doesn't break WALSplitter. This is useful in upgrading old instances.

Throws:

IOException

createRecoveredEditsPathForRegion

private org.apache.hadoop.fs.Path createRecoveredEditsPathForRegion()
                                                             throws IOException

Throws:

IOException

testHasRecoveredEdits

@Test
public void testHasRecoveredEdits()
                           throws IOException

Throws:

IOException

useDifferentDFSClient

private void useDifferentDFSClient()
                            throws IOException

Throws:

IOException

testSplitPreservesEdits

@Test
public void testSplitPreservesEdits()
                             throws IOException

Throws:

IOException

testSplitRemovesRegionEventsEdits

@Test
public void testSplitRemovesRegionEventsEdits()
                                       throws IOException

Throws:

IOException

testSplitLeavesCompactionEventsEdits

@Test
public void testSplitLeavesCompactionEventsEdits()
                                          throws IOException

Throws:

IOException

testSplitRemovesReplicationMarkerEdits

@Test
public void testSplitRemovesReplicationMarkerEdits()
                                            throws IOException

Tests that WalSplitter ignores replication marker edits.

Throws:

IOException

generateReplicationMarkerEdits

private void generateReplicationMarkerEdits(org.apache.hadoop.fs.Path path,
 org.apache.hadoop.hbase.client.RegionInfo regionInfo)
                                     throws IOException

Throws:

IOException

splitAndCount

private int splitAndCount(int expectedFiles,
 int expectedEntries)
                   throws IOException

Parameters:

expectedEntries - -1 to not assert

Returns:

the count across all regions

Throws:

IOException

testEmptyLogFiles

@Test
public void testEmptyLogFiles()
                       throws IOException

Throws:

IOException

testEmptyOpenLogFiles

@Test
public void testEmptyOpenLogFiles()
                           throws IOException

Throws:

IOException

testEmptyLogFiles

private void testEmptyLogFiles(boolean close)
                        throws IOException

Throws:

IOException

testOpenZeroLengthReportedFileButWithDataGetsSplit

@Test
public void testOpenZeroLengthReportedFileButWithDataGetsSplit()
                                                        throws IOException

Throws:

IOException

testTralingGarbageCorruptionFileSkipErrorsPasses

@Test
public void testTralingGarbageCorruptionFileSkipErrorsPasses()
                                                      throws IOException

Throws:

IOException

testFirstLineCorruptionLogFileSkipErrorsPasses

@Test
public void testFirstLineCorruptionLogFileSkipErrorsPasses()
                                                    throws IOException

Throws:

IOException

testMiddleGarbageCorruptionSkipErrorsReadsHalfOfFile

@Test
public void testMiddleGarbageCorruptionSkipErrorsReadsHalfOfFile()
                                                          throws IOException

Throws:

IOException

testCorruptedFileGetsArchivedIfSkipErrors

@Test
public void testCorruptedFileGetsArchivedIfSkipErrors()
                                               throws IOException

Throws:

IOException

splitCorruptWALs

private Set<String> splitCorruptWALs(FaultyProtobufWALStreamReader.FailureType failureType)
                              throws IOException

Returns:

set of wal names present prior to split attempt.

Throws:

IOException - if the split process fails

testTrailingGarbageCorruptionLogFileSkipErrorsFalseThrows

@Test
public void testTrailingGarbageCorruptionLogFileSkipErrorsFalseThrows()
                                                               throws IOException

Throws:

IOException

testCorruptedLogFilesSkipErrorsFalseDoesNotTouchLogs

@Test
public void testCorruptedLogFilesSkipErrorsFalseDoesNotTouchLogs()
                                                          throws IOException

Throws:

IOException

ignoreCorruption

private void ignoreCorruption(TestWALSplit.Corruptions corruption,
 int entryCount,
 int expectedCount)
                       throws IOException

Throws:

IOException

testEOFisIgnored

@Test
public void testEOFisIgnored()
                      throws IOException

Throws:

IOException

testCorruptWALTrailer

@Test
public void testCorruptWALTrailer()
                           throws IOException

Throws:

IOException

testLogsGetArchivedAfterSplit

@Test
public void testLogsGetArchivedAfterSplit()
                                   throws IOException

Throws:

IOException

testSplit

@Test
public void testSplit()
               throws IOException

Throws:

IOException

testLogDirectoryShouldBeDeletedAfterSuccessfulSplit

@Test
public void testLogDirectoryShouldBeDeletedAfterSuccessfulSplit()
                                                         throws IOException

Throws:

IOException

testSplitWillFailIfWritingToRegionFails

@Test
public void testSplitWillFailIfWritingToRegionFails()
                                             throws Exception

Throws:

Exception

testSplitDeletedRegion

@Test
public void testSplitDeletedRegion()
                            throws IOException

Throws:

IOException

testIOEOnOutputThread

@Test
public void testIOEOnOutputThread()
                           throws Exception

Throws:

Exception

retryOverHdfsProblem

private void retryOverHdfsProblem(org.apache.hadoop.fs.FileSystem spiedFs)
                           throws Exception

Parameters:

spiedFs - should be instrumented for failure.

Throws:

Exception

testMovedWALDuringRecovery

@Test
public void testMovedWALDuringRecovery()
                                throws Exception

Throws:

Exception

testRetryOpenDuringRecovery

@Test
public void testRetryOpenDuringRecovery()
                                 throws Exception

Throws:

Exception

testTerminationAskedByReporter

@Test
public void testTerminationAskedByReporter()
                                    throws IOException,
org.apache.hadoop.hbase.wal.WALSplitter.CorruptedLogFileException

Throws:

IOException

org.apache.hadoop.hbase.wal.WALSplitter.CorruptedLogFileException

testThreading

@Test
public void testThreading()
                   throws Exception

Test log split process with fake data and lots of edits to trigger threading issues.

Throws:

Exception

testThreadingSlowWriterSmallBuffer

@Test
public void testThreadingSlowWriterSmallBuffer()
                                        throws Exception

Test blocking behavior of the log split process if writers are writing slower than the reader is reading.

Throws:

Exception

doTestThreading

private void doTestThreading(int numFakeEdits,
 int bufferSize,
 int writerSlowness)
                      throws Exception

Sets up a log splitter with a mock reader and writer. The mock reader generates a specified number of edits spread across 5 regions. The mock writer optionally sleeps for each edit it is fed. After the split is complete, verifies that the statistics show the correct number of edits output into each region.

Parameters:

numFakeEdits - number of fake edits to push through pipeline

bufferSize - size of in-memory buffer

writerSlowness - writer threads will sleep this many ms per edit

Throws:

Exception

testSplitLogFileDeletedRegionDir

@Test
public void testSplitLogFileDeletedRegionDir()
                                      throws IOException

Throws:

IOException

testSplitLogFileEmpty

@Test
public void testSplitLogFileEmpty()
                           throws IOException

Throws:

IOException

testSplitLogFileMultipleRegions

@Test
public void testSplitLogFileMultipleRegions()
                                     throws IOException

Throws:

IOException

testSplitLogFileFirstLineCorruptionLog

@Test
public void testSplitLogFileFirstLineCorruptionLog()
                                            throws IOException

Throws:

IOException

testConcurrentSplitLogAndReplayRecoverEdit

@Test
public void testConcurrentSplitLogAndReplayRecoverEdit()
                                                throws IOException

Throws:

IOException

See Also:

• "https://issues.apache.org/jira/browse/HBASE-4862"

testRecoveredEditsStoragePolicy

@Test
public void testRecoveredEditsStoragePolicy()
                                     throws IOException

Throws:

IOException

testEmptyWALEdit

@Test
public void testEmptyWALEdit()
                      throws IOException

See HBASE-27644, typically we should not have empty WALEdit but we should be able to process it, instead of losing data after it.

Throws:

IOException

generateEmptyEditWAL

private void generateEmptyEditWAL(org.apache.hadoop.fs.Path path,
 byte[] region)
                           throws IOException

Throws:

IOException

generateWALs

private org.apache.hadoop.hbase.wal.WALProvider.Writer generateWALs(int leaveOpen)
                                                             throws IOException

Throws:

IOException

generateWALs

private org.apache.hadoop.hbase.wal.WALProvider.Writer generateWALs(int writers,
 int entries,
 int leaveOpen)
                                                             throws IOException

Throws:

IOException

makeRegionDirs

private void makeRegionDirs(List<String> regions)
                     throws IOException

Throws:

IOException

generateWALs

private org.apache.hadoop.hbase.wal.WALProvider.Writer generateWALs(int writers,
 int entries,
 int leaveOpen,
 int regionEvents)
                                                             throws IOException

Parameters:

leaveOpen - index to leave un-closed. -1 to close all.

Returns:

the writer that's still open, or null if all were closed.

Throws:

IOException

getLogForRegion

private org.apache.hadoop.fs.Path[] getLogForRegion(org.apache.hadoop.hbase.TableName table,
 String region)
                                             throws IOException

Throws:

IOException

corruptWAL

private void corruptWAL(org.apache.hadoop.fs.Path path,
 TestWALSplit.Corruptions corruption,
 boolean close)
                 throws IOException

Throws:

IOException

closeOrFlush

private void closeOrFlush(boolean close,
 org.apache.hadoop.fs.FSDataOutputStream out)
                   throws IOException

Throws:

IOException

countWAL

private int countWAL(org.apache.hadoop.fs.Path log)
              throws IOException

Throws:

IOException

appendCompactionEvent

private static void appendCompactionEvent(org.apache.hadoop.hbase.wal.WALProvider.Writer w,
 org.apache.hadoop.hbase.client.RegionInfo hri,
 String[] inputs,
 String output)
                                   throws IOException

Throws:

IOException

appendRegionEvent

private static void appendRegionEvent(org.apache.hadoop.hbase.wal.WALProvider.Writer w,
 String region)
                               throws IOException

Throws:

IOException

appendEntry

private static long appendEntry(org.apache.hadoop.hbase.wal.WALProvider.Writer writer,
 org.apache.hadoop.hbase.TableName table,
 byte[] region,
 byte[] row,
 byte[] family,
 byte[] qualifier,
 byte[] value,
 long seq)
                         throws IOException

Throws:

IOException

createTestEntry

private static org.apache.hadoop.hbase.wal.WAL.Entry createTestEntry(org.apache.hadoop.hbase.TableName table,
 byte[] region,
 byte[] row,
 byte[] family,
 byte[] qualifier,
 byte[] value,
 long seq)

appendEmptyEntry

private static long appendEmptyEntry(org.apache.hadoop.hbase.wal.WALProvider.Writer writer,
 org.apache.hadoop.hbase.TableName table,
 byte[] region,
 long seq)
                              throws IOException

Throws:

IOException

createEmptyEntry

private static org.apache.hadoop.hbase.wal.WAL.Entry createEmptyEntry(org.apache.hadoop.hbase.TableName table,
 byte[] region,
 long seq)

injectEmptyFile

private void injectEmptyFile(String suffix,
 boolean closeFile)
                      throws IOException

Throws:

IOException

logsAreEqual

private boolean logsAreEqual(org.apache.hadoop.fs.Path p1,
 org.apache.hadoop.fs.Path p2)
                      throws IOException

Throws:

IOException