Package org.apache.hadoop.hbase.snapshot

Class TestRestoreSnapshotHelper

java.lang.Object

org.apache.hadoop.hbase.snapshot.TestRestoreSnapshotHelper

Direct Known Subclasses:

TestMobRestoreSnapshotHelper

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

Test the restore/clone operation from a file-system point of view.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.hadoop.fs.Path	archiveDir
protected org.apache.hadoop.conf.Configuration	conf
protected org.apache.hadoop.fs.FileSystem	fs
private static final org.slf4j.Logger	LOG
protected org.apache.hadoop.fs.Path	rootDir
protected static final String	TEST_HFILE
protected static final HBaseTestingUtil	TEST_UTIL

Constructor Summary

Constructors

Constructor	Description
TestRestoreSnapshotHelper()

Method Summary

Modifier and Type	Method	Description
private void	checkNoHFileLinkInTableDir(org.apache.hadoop.hbase.TableName tableName)
private void	createAndAssertSnapshot(org.apache.hadoop.hbase.TableName tableName, String snapshotName)
protected SnapshotTestingUtils.SnapshotMock	createSnapshotMock()
protected void	createTableAndSnapshot(org.apache.hadoop.hbase.TableName tableName, String snapshotName)
private void	flipCompactions(boolean isEnable)
private org.apache.hadoop.hbase.procedure2.ProcedureExecutor<org.apache.hadoop.hbase.master.procedure.MasterProcedureEnv>	getMasterProcedureExecutor()
private org.apache.hadoop.fs.Path	getReferredToFile(String referenceName)
private org.apache.hadoop.hbase.snapshot.RestoreSnapshotHelper	getRestoreHelper(org.apache.hadoop.fs.Path rootDir, org.apache.hadoop.fs.Path snapshotDir, org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription sd, org.apache.hadoop.hbase.client.TableDescriptor htdClone)	Initialize the restore helper, based on the snapshot and table information provided.
private boolean	hasHFileLink(org.apache.hadoop.fs.Path tableDir)
private void	mergeRegions(org.apache.hadoop.hbase.TableName tableName, int mergeCount)
private void	restoreAndVerify(String snapshotName, String tableName)
void	setup()
static void	setupCluster()
protected void	setupConf(org.apache.hadoop.conf.Configuration conf)
void	tearDown()
static void	tearDownCluster()
void	testCopyExpiredSnapshotForScanner()
void	testMultiSnapshotRestoreWithMerge()	Test scenario for HBASE-29346, which addresses the issue where restoring snapshots after region merge operations could lead to missing store file references, potentially resulting in data loss.
void	testNoHFileLinkInRootDir()
void	testRestore()
private void	testRestore(org.apache.hadoop.fs.Path snapshotDir, org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription sd, org.apache.hadoop.hbase.client.TableDescriptor htdClone)	Execute the restore operation
void	testRestoreWithNamespace()
void	testSkipReplayAndUpdateSeqId()
private void	verifyRestore(org.apache.hadoop.fs.Path rootDir, org.apache.hadoop.hbase.client.TableDescriptor sourceHtd, org.apache.hadoop.hbase.client.TableDescriptor htdClone)

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

TEST_UTIL

protected static final HBaseTestingUtil TEST_UTIL

TEST_HFILE

protected static final String TEST_HFILE

See Also:

• Constant Field Values

conf

protected org.apache.hadoop.conf.Configuration conf

archiveDir

protected org.apache.hadoop.fs.Path archiveDir

fs

protected org.apache.hadoop.fs.FileSystem fs

rootDir

protected org.apache.hadoop.fs.Path rootDir

Constructor Details

TestRestoreSnapshotHelper

public TestRestoreSnapshotHelper()

Method Details

setupConf

protected void setupConf(org.apache.hadoop.conf.Configuration conf)

setupCluster

@BeforeAll
public static void setupCluster()
                         throws Exception

Throws:

Exception

tearDownCluster

@AfterAll
public static void tearDownCluster()
                            throws Exception

Throws:

Exception

setup

@BeforeEach
public void setup()
           throws Exception

Throws:

Exception

tearDown

@AfterEach
public void tearDown()
              throws Exception

Throws:

Exception

createSnapshotMock

protected SnapshotTestingUtils.SnapshotMock createSnapshotMock()
                                                        throws IOException

Throws:

IOException

testRestore

@Test
public void testRestore()
                 throws IOException

Throws:

IOException

testRestoreWithNamespace

@Test
public void testRestoreWithNamespace()
                              throws IOException

Throws:

IOException

testNoHFileLinkInRootDir

@Test
public void testNoHFileLinkInRootDir()
                              throws IOException

Throws:

IOException

testSkipReplayAndUpdateSeqId

@Test
public void testSkipReplayAndUpdateSeqId()
                                  throws Exception

Throws:

Exception

testCopyExpiredSnapshotForScanner

@Test
public void testCopyExpiredSnapshotForScanner()
                                       throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

testMultiSnapshotRestoreWithMerge

@Test
public void testMultiSnapshotRestoreWithMerge()
                                       throws IOException,
InterruptedException

Test scenario for HBASE-29346, which addresses the issue where restoring snapshots after region merge operations could lead to missing store file references, potentially resulting in data loss.

This test performs the following steps:

1. Creates a table with multiple regions.
2. Inserts data into each region and flushes to create store files.
3. Takes snapshot of the table and performs restore.
4. Disable compactions, merge regions, create a new snapshot, and restore that snapshot on the same restore path.
5. Verifies data integrity by scanning all data post region re-open.

Throws:

IOException

InterruptedException

createAndAssertSnapshot

private void createAndAssertSnapshot(org.apache.hadoop.hbase.TableName tableName,
 String snapshotName)
                              throws org.apache.hadoop.hbase.snapshot.SnapshotCreationException,
IllegalArgumentException,
IOException

Throws:

org.apache.hadoop.hbase.snapshot.SnapshotCreationException

IllegalArgumentException

IOException

flipCompactions

private void flipCompactions(boolean isEnable)

mergeRegions

private void mergeRegions(org.apache.hadoop.hbase.TableName tableName,
 int mergeCount)
                   throws IOException

Throws:

IOException

getMasterProcedureExecutor

private org.apache.hadoop.hbase.procedure2.ProcedureExecutor<org.apache.hadoop.hbase.master.procedure.MasterProcedureEnv> getMasterProcedureExecutor()

createTableAndSnapshot

protected void createTableAndSnapshot(org.apache.hadoop.hbase.TableName tableName,
 String snapshotName)
                               throws IOException

Throws:

IOException

checkNoHFileLinkInTableDir

private void checkNoHFileLinkInTableDir(org.apache.hadoop.hbase.TableName tableName)
                                 throws IOException

Throws:

IOException

hasHFileLink

private boolean hasHFileLink(org.apache.hadoop.fs.Path tableDir)
                      throws IOException

Throws:

IOException

restoreAndVerify

private void restoreAndVerify(String snapshotName,
 String tableName)
                       throws IOException

Throws:

IOException

verifyRestore

private void verifyRestore(org.apache.hadoop.fs.Path rootDir,
 org.apache.hadoop.hbase.client.TableDescriptor sourceHtd,
 org.apache.hadoop.hbase.client.TableDescriptor htdClone)
                    throws IOException

Throws:

IOException

testRestore

private void testRestore(org.apache.hadoop.fs.Path snapshotDir,
 org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription sd,
 org.apache.hadoop.hbase.client.TableDescriptor htdClone)
                  throws IOException

Execute the restore operation

Parameters:

snapshotDir - The snapshot directory to use as "restore source"

sd - The snapshot descriptor

htdClone - The HTableDescriptor of the table to restore/clone.

Throws:

IOException

getRestoreHelper

private org.apache.hadoop.hbase.snapshot.RestoreSnapshotHelper getRestoreHelper(org.apache.hadoop.fs.Path rootDir,
 org.apache.hadoop.fs.Path snapshotDir,
 org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription sd,
 org.apache.hadoop.hbase.client.TableDescriptor htdClone)
                                                                         throws IOException

Initialize the restore helper, based on the snapshot and table information provided.

Throws:

IOException

getReferredToFile

private org.apache.hadoop.fs.Path getReferredToFile(String referenceName)