Package org.apache.hadoop.hbase.backup.impl

Class TestBackupAdminImpl

java.lang.Object

org.apache.hadoop.hbase.backup.impl.TestBackupAdminImpl

@Tag("org.apache.hadoop.hbase.testclassification.SmallTests")
public class TestBackupAdminImpl
extends Object

Unit tests for BackupAdminImpl.

This class improves test coverage by validating the behavior of key methods in BackupAdminImpl. Some methods are made package-private to enable testing.

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.hadoop.hbase.backup.impl.BackupAdminImpl	backupAdminImpl
private org.apache.hadoop.hbase.backup.impl.BackupSystemTable	mockTable

Constructor Summary

Constructors

Constructor	Description
TestBackupAdminImpl()

Method Summary

Modifier and Type	Method	Description
private org.apache.hadoop.hbase.backup.BackupInfo	createBackupInfo(String id, long ts, org.apache.hadoop.hbase.backup.BackupType type, org.apache.hadoop.hbase.TableName... tables)
private org.apache.hadoop.hbase.backup.BackupInfo	createBackupInfo(String id, org.apache.hadoop.hbase.backup.BackupType type, org.apache.hadoop.hbase.backup.BackupInfo.BackupState state, long ts, String dest, org.apache.hadoop.hbase.TableName... tables)
void	setUp()
void	testCheckIfValidForMerge_failsWhenBackupInfoNotFound()	Verifies that checkIfValidForMerge fails if one of the provided backup IDs is not found in the system table (i.e., null is returned).
void	testCheckIfValidForMerge_failsWhenHoleInImages()	Verifies that checkIfValidForMerge fails when there is a "hole" in the backup sequence — i.e., a required image from the full backup history is missing in the input list.
void	testCheckIfValidForMerge_failsWithDifferentDestinations()	Verifies that checkIfValidForMerge fails when backups come from different destinations.
void	testCheckIfValidForMerge_failsWithFullBackup()	Verifies that checkIfValidForMerge fails if a FULL backup is included.
void	testCheckIfValidForMerge_failsWithNonCompleteState()	Verifies that checkIfValidForMerge fails if any backup is not in COMPLETE state.
void	testCheckIfValidForMerge_validCase()	Verifies that checkIfValidForMerge succeeds with valid INCREMENTAL, COMPLETE images from the same destination and no holes in the backup sequence.
void	testCleanupBackupDir_deletesTargetDirSuccessfully()	Verifies that cleanupBackupDir correctly deletes the target backup directory for a given table and backup ID using the mocked FileSystem.
void	testCleanupBackupDir_throwsIOException()	Verifies that cleanupBackupDir throws an IOException if the FileSystem retrieval fails.
void	testDeleteBackupWhenBackupInfoNotFound()	Tests that when a backup ID is not found, the method logs a warning and returns 0.
void	testDeleteBackupWithAffectedSessions()	Tests that deleteBackup will update other backups by removing the table when it's not the last session.
void	testDeleteBackupWithBulkLoadedFiles()	Tests that deleteBackup will remove bulk-loaded files and handle exceptions gracefully.
void	testDeleteFullBackupWithLastSession()	Tests deleting a FULL backup when it is the last session for all its tables.
void	testFinalizeDelete_addsRetainedTablesBack()	Scenario: - The initial incremental table set contains "table1" and "table2" - Only "table1" still exists in backup history Expectation: - The backup system should delete the existing set - Then re-add a filtered set that includes only "table1"
void	testFinalizeDelete_multipleRoots()	Scenario: - Two backup roots: - root1: one table with valid backup history → should be retained - root2: one table with no history → should not be retained Expectation: - root1 metadata deleted and re-added - root2 metadata only deleted
void	testFinalizeDelete_retainedSetEmpty_doesNotAddBack()	Scenario: - The incremental table set has "tableX" - No backups exist for this table Expectation: - Backup metadata should be deleted - Nothing should be re-added since no tables are retained
void	testGetAffectedBackupSessions()	Tests that when a current incremental backup is found in the history, all later incremental backups for the same table are returned.
void	testGetAffectedBackupSessions_ignoresFullBackupOfOtherTable()	Tests that a full backup for a different table is ignored and does not reset the affected list.
void	testGetAffectedBackupSessions_resetsOnFullBackup()	Tests that if a full backup appears after the current backup, the affected list is reset and incremental backups following that full backup are not included.
void	testGetAffectedBackupSessions_skipsNonMatchingTable()	Tests that backups for other tables are ignored, even if they are incremental and fall after the current backup.
void	testRemoveTableFromBackupImage()	Tests that when a table is removed from a backup image that still contains other tables, it updates the BackupInfo correctly and does not delete the entire backup metadata.
void	testRemoveTableFromBackupImageDeletesWhenLastTableRemoved()	Tests that when the last table in a backup image is removed, the backup metadata is deleted entirely and static cleanup is invoked.

Methods inherited from class java.lang.Object

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

Field Details

backupAdminImpl

private org.apache.hadoop.hbase.backup.impl.BackupAdminImpl backupAdminImpl

mockTable

private org.apache.hadoop.hbase.backup.impl.BackupSystemTable mockTable

Constructor Details

TestBackupAdminImpl

public TestBackupAdminImpl()

Method Details

setUp

@BeforeEach
public void setUp()

testFinalizeDelete_addsRetainedTablesBack

@Test
public void testFinalizeDelete_addsRetainedTablesBack()
                                               throws IOException

Scenario: - The initial incremental table set contains "table1" and "table2" - Only "table1" still exists in backup history Expectation: - The backup system should delete the existing set - Then re-add a filtered set that includes only "table1"

Throws:

IOException

testFinalizeDelete_retainedSetEmpty_doesNotAddBack

@Test
public void testFinalizeDelete_retainedSetEmpty_doesNotAddBack()
                                                        throws IOException

Scenario: - The incremental table set has "tableX" - No backups exist for this table Expectation: - Backup metadata should be deleted - Nothing should be re-added since no tables are retained

Throws:

IOException

testFinalizeDelete_multipleRoots

@Test
public void testFinalizeDelete_multipleRoots()
                                      throws IOException

Scenario: - Two backup roots: - root1: one table with valid backup history → should be retained - root2: one table with no history → should not be retained Expectation: - root1 metadata deleted and re-added - root2 metadata only deleted

Throws:

IOException

testCleanupBackupDir_deletesTargetDirSuccessfully

@Test
public void testCleanupBackupDir_deletesTargetDirSuccessfully()
                                                       throws Exception

Verifies that cleanupBackupDir correctly deletes the target backup directory for a given table and backup ID using the mocked FileSystem.

This test ensures: - The correct path is constructed using BackupUtils. - FileSystem#delete is invoked with that path.

Throws:

Exception

testCleanupBackupDir_throwsIOException

@Test
public void testCleanupBackupDir_throwsIOException()
                                            throws Exception

Verifies that cleanupBackupDir throws an IOException if the FileSystem retrieval fails.

This test simulates an exception while trying to obtain the FileSystem, and expects the method to propagate the exception.

Throws:

Exception

testGetAffectedBackupSessions

@Test
public void testGetAffectedBackupSessions()
                                   throws IOException

Tests that when a current incremental backup is found in the history, all later incremental backups for the same table are returned. This simulates rolling forward from the current backup timestamp, capturing newer incremental backups that depend on it.

Throws:

IOException

testGetAffectedBackupSessions_resetsOnFullBackup

@Test
public void testGetAffectedBackupSessions_resetsOnFullBackup()
                                                      throws IOException

Tests that if a full backup appears after the current backup, the affected list is reset and incremental backups following that full backup are not included. This ensures full backups act as a reset boundary.

Throws:

IOException

testGetAffectedBackupSessions_skipsNonMatchingTable

@Test
public void testGetAffectedBackupSessions_skipsNonMatchingTable()
                                                         throws IOException

Tests that backups for other tables are ignored, even if they are incremental and fall after the current backup. Only backups affecting the specified table should be considered.

Throws:

IOException

testGetAffectedBackupSessions_ignoresFullBackupOfOtherTable

@Test
public void testGetAffectedBackupSessions_ignoresFullBackupOfOtherTable()
                                                                 throws IOException

Tests that a full backup for a different table is ignored and does not reset the affected list. Only full backups for the same table act as reset boundaries.

Throws:

IOException

createBackupInfo

private org.apache.hadoop.hbase.backup.BackupInfo createBackupInfo(String id,
 long ts,
 org.apache.hadoop.hbase.backup.BackupType type,
 org.apache.hadoop.hbase.TableName... tables)

testRemoveTableFromBackupImage

@Test
public void testRemoveTableFromBackupImage()
                                    throws IOException

Tests that when a table is removed from a backup image that still contains other tables, it updates the BackupInfo correctly and does not delete the entire backup metadata.

Throws:

IOException

testRemoveTableFromBackupImageDeletesWhenLastTableRemoved

@Test
public void testRemoveTableFromBackupImageDeletesWhenLastTableRemoved()
                                                               throws IOException

Tests that when the last table in a backup image is removed, the backup metadata is deleted entirely and static cleanup is invoked.

Throws:

IOException

testDeleteBackupWhenBackupInfoNotFound

@Test
public void testDeleteBackupWhenBackupInfoNotFound()
                                            throws IOException

Tests that when a backup ID is not found, the method logs a warning and returns 0.

Throws:

IOException

testDeleteFullBackupWithLastSession

@Test
public void testDeleteFullBackupWithLastSession()
                                         throws IOException

Tests deleting a FULL backup when it is the last session for all its tables. Ensures cleanup is called and metadata is deleted, but no other backups are affected.

Throws:

IOException

testDeleteBackupWithAffectedSessions

@Test
public void testDeleteBackupWithAffectedSessions()
                                          throws IOException

Tests that deleteBackup will update other backups by removing the table when it's not the last session.

Throws:

IOException

testDeleteBackupWithBulkLoadedFiles

@Test
public void testDeleteBackupWithBulkLoadedFiles()
                                         throws IOException

Tests that deleteBackup will remove bulk-loaded files and handle exceptions gracefully.

Throws:

IOException

testCheckIfValidForMerge_validCase

@Test
public void testCheckIfValidForMerge_validCase()
                                        throws IOException

Verifies that checkIfValidForMerge succeeds with valid INCREMENTAL, COMPLETE images from the same destination and no holes in the backup sequence.

Throws:

IOException

testCheckIfValidForMerge_failsWithFullBackup

@Test
public void testCheckIfValidForMerge_failsWithFullBackup()
                                                  throws IOException

Verifies that checkIfValidForMerge fails if a FULL backup is included.

Throws:

IOException

testCheckIfValidForMerge_failsWhenBackupInfoNotFound

@Test
public void testCheckIfValidForMerge_failsWhenBackupInfoNotFound()
                                                          throws IOException

Verifies that checkIfValidForMerge fails if one of the provided backup IDs is not found in the system table (i.e., null is returned).

Throws:

IOException

testCheckIfValidForMerge_failsWithDifferentDestinations

@Test
public void testCheckIfValidForMerge_failsWithDifferentDestinations()
                                                             throws IOException

Verifies that checkIfValidForMerge fails when backups come from different destinations.

Throws:

IOException

testCheckIfValidForMerge_failsWithNonCompleteState

@Test
public void testCheckIfValidForMerge_failsWithNonCompleteState()
                                                        throws IOException

Verifies that checkIfValidForMerge fails if any backup is not in COMPLETE state.

Throws:

IOException

testCheckIfValidForMerge_failsWhenHoleInImages

@Test
public void testCheckIfValidForMerge_failsWhenHoleInImages()
                                                    throws IOException

Verifies that checkIfValidForMerge fails when there is a "hole" in the backup sequence — i.e., a required image from the full backup history is missing in the input list.

Throws:

IOException

createBackupInfo

private org.apache.hadoop.hbase.backup.BackupInfo createBackupInfo(String id,
 org.apache.hadoop.hbase.backup.BackupType type,
 org.apache.hadoop.hbase.backup.BackupInfo.BackupState state,
 long ts,
 String dest,
 org.apache.hadoop.hbase.TableName... tables)