-
Notifications
You must be signed in to change notification settings - Fork 3.4k
HBASE-29296 Missing critical snapshot expiration checks #6970
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dParikesit
wants to merge
6
commits into
apache:master
Choose a base branch
from
dParikesit:1-snapshot_expiration_check
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+372
−0
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
2e9ef00
test restore and incremental backup on an expired full backup
dParikesit 8be487c
add snapshot expiration check on restore from a full backup
dParikesit def22fd
add snapshot expiration check for incremental backup on an expired fu…
dParikesit 9053190
test snapshot creation that expires before SnapshotProcedure finishes
dParikesit 475355a
add snapshot expiration check during SNAPSHOT_COMPLETE_SNAPSHOT
dParikesit 894abb9
add ASF licenseand fix formatting for spotless
dParikesit File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
238 changes: 238 additions & 0 deletions
238
hbase-backup/src/test/java/org/apache/hadoop/hbase/backup/TestBackupRestoreExpiry.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,238 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.hadoop.hbase.backup; | ||
|
|
||
| import static org.junit.Assert.assertNotEquals; | ||
| import static org.junit.Assert.assertThrows; | ||
| import static org.junit.Assert.assertTrue; | ||
| import static org.junit.Assert.fail; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import org.apache.hadoop.fs.FileSystem; | ||
| import org.apache.hadoop.fs.LocatedFileStatus; | ||
| import org.apache.hadoop.fs.Path; | ||
| import org.apache.hadoop.fs.RemoteIterator; | ||
| import org.apache.hadoop.hbase.HBaseClassTestRule; | ||
| import org.apache.hadoop.hbase.HBaseTestingUtil; | ||
| import org.apache.hadoop.hbase.HConstants; | ||
| import org.apache.hadoop.hbase.TableName; | ||
| import org.apache.hadoop.hbase.backup.impl.BackupAdminImpl; | ||
| import org.apache.hadoop.hbase.backup.util.BackupUtils; | ||
| import org.apache.hadoop.hbase.client.Admin; | ||
| import org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder; | ||
| import org.apache.hadoop.hbase.client.Connection; | ||
| import org.apache.hadoop.hbase.client.Table; | ||
| import org.apache.hadoop.hbase.client.TableDescriptor; | ||
| import org.apache.hadoop.hbase.client.TableDescriptorBuilder; | ||
| import org.apache.hadoop.hbase.regionserver.HRegion; | ||
| import org.apache.hadoop.hbase.regionserver.LogRoller; | ||
| import org.apache.hadoop.hbase.snapshot.SnapshotTTLExpiredException; | ||
| import org.apache.hadoop.hbase.testclassification.LargeTests; | ||
| import org.apache.hadoop.hbase.util.Bytes; | ||
| import org.apache.hadoop.hbase.util.EnvironmentEdge; | ||
| import org.apache.hadoop.hbase.util.EnvironmentEdgeManager; | ||
| import org.junit.Assert; | ||
| import org.junit.BeforeClass; | ||
| import org.junit.ClassRule; | ||
| import org.junit.Test; | ||
| import org.junit.experimental.categories.Category; | ||
|
|
||
| import org.apache.hbase.thirdparty.com.google.common.collect.Lists; | ||
|
|
||
| @Category(LargeTests.class) | ||
| public class TestBackupRestoreExpiry extends TestBackupBase { | ||
|
|
||
| @ClassRule | ||
| public static final HBaseClassTestRule CLASS_RULE = | ||
| HBaseClassTestRule.forClass(TestBackupRestoreExpiry.class); | ||
|
|
||
| @BeforeClass | ||
| public static void setUp() throws Exception { | ||
| TEST_UTIL = new HBaseTestingUtil(); | ||
| conf1 = TEST_UTIL.getConfiguration(); | ||
| conf1.setLong(HConstants.DEFAULT_SNAPSHOT_TTL_CONFIG_KEY, 30); | ||
| autoRestoreOnFailure = true; | ||
| useSecondCluster = false; | ||
| setUpHelper(); | ||
| } | ||
|
|
||
| public void ensurePreviousBackupTestsAreCleanedUp() throws Exception { | ||
| TEST_UTIL.flush(table1); | ||
| TEST_UTIL.flush(table2); | ||
|
|
||
| TEST_UTIL.truncateTable(table1).close(); | ||
| TEST_UTIL.truncateTable(table2).close(); | ||
|
|
||
| if (TEST_UTIL.getAdmin().tableExists(table1_restore)) { | ||
| TEST_UTIL.flush(table1_restore); | ||
| TEST_UTIL.truncateTable(table1_restore).close(); | ||
| } | ||
|
|
||
| TEST_UTIL.getMiniHBaseCluster().getRegionServerThreads().forEach(rst -> { | ||
| try { | ||
| LogRoller walRoller = rst.getRegionServer().getWalRoller(); | ||
| walRoller.requestRollAll(); | ||
| walRoller.waitUntilWalRollFinished(); | ||
| } catch (Exception ignored) { | ||
| } | ||
| }); | ||
|
|
||
| try (Table table = TEST_UTIL.getConnection().getTable(table1)) { | ||
| loadTable(table); | ||
| } | ||
|
|
||
| try (Table table = TEST_UTIL.getConnection().getTable(table2)) { | ||
| loadTable(table); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void TestSequentially() throws Exception { | ||
| try { | ||
| TestRestoreOnExpiredFullBackup(); | ||
| } catch (Exception e) { | ||
| throw e; | ||
| } finally { | ||
| ensurePreviousBackupTestsAreCleanedUp(); | ||
| } | ||
|
|
||
| try { | ||
| TestIncrementalBackupOnExpiredFullBackup(); | ||
| } catch (Exception e) { | ||
| throw e; | ||
| } finally { | ||
| ensurePreviousBackupTestsAreCleanedUp(); | ||
| } | ||
| } | ||
|
|
||
| public void TestRestoreOnExpiredFullBackup() throws Exception { | ||
| byte[] mobFam = Bytes.toBytes("mob"); | ||
|
|
||
| List<TableName> tables = Lists.newArrayList(table1); | ||
| TableDescriptor newTable1Desc = | ||
| TableDescriptorBuilder.newBuilder(table1Desc).setColumnFamily(ColumnFamilyDescriptorBuilder | ||
| .newBuilder(mobFam).setMobEnabled(true).setMobThreshold(5L).build()).build(); | ||
| TEST_UTIL.getAdmin().modifyTable(newTable1Desc); | ||
|
|
||
| Connection conn = TEST_UTIL.getConnection(); | ||
| BackupAdminImpl backupAdmin = new BackupAdminImpl(conn); | ||
| BackupRequest request = createBackupRequest(BackupType.FULL, tables, BACKUP_ROOT_DIR); | ||
| String fullBackupId = backupAdmin.backupTables(request); | ||
| assertTrue(checkSucceeded(fullBackupId)); | ||
|
|
||
| TableName[] fromTables = new TableName[] { table1 }; | ||
| TableName[] toTables = new TableName[] { table1_restore }; | ||
|
|
||
| EnvironmentEdgeManager.injectEdge(new EnvironmentEdge() { | ||
| // time + 30s | ||
| @Override | ||
| public long currentTime() { | ||
| return System.currentTimeMillis() + (30 * 1000); | ||
| } | ||
| }); | ||
|
|
||
| assertThrows(SnapshotTTLExpiredException.class, () -> { | ||
| backupAdmin.restore(BackupUtils.createRestoreRequest(BACKUP_ROOT_DIR, fullBackupId, false, | ||
| fromTables, toTables, true, true)); | ||
| }); | ||
|
|
||
| EnvironmentEdgeManager.reset(); | ||
| backupAdmin.close(); | ||
| } | ||
|
|
||
| public void TestIncrementalBackupOnExpiredFullBackup() throws Exception { | ||
| byte[] mobFam = Bytes.toBytes("mob"); | ||
|
|
||
| List<TableName> tables = Lists.newArrayList(table1); | ||
| TableDescriptor newTable1Desc = | ||
| TableDescriptorBuilder.newBuilder(table1Desc).setColumnFamily(ColumnFamilyDescriptorBuilder | ||
| .newBuilder(mobFam).setMobEnabled(true).setMobThreshold(5L).build()).build(); | ||
| TEST_UTIL.getAdmin().modifyTable(newTable1Desc); | ||
|
|
||
| Connection conn = TEST_UTIL.getConnection(); | ||
| BackupAdminImpl backupAdmin = new BackupAdminImpl(conn); | ||
| BackupRequest request = createBackupRequest(BackupType.FULL, tables, BACKUP_ROOT_DIR); | ||
| String fullBackupId = backupAdmin.backupTables(request); | ||
| assertTrue(checkSucceeded(fullBackupId)); | ||
|
|
||
| TableName[] fromTables = new TableName[] { table1 }; | ||
| TableName[] toTables = new TableName[] { table1_restore }; | ||
|
|
||
| List<LocatedFileStatus> preRestoreBackupFiles = getBackupFiles(); | ||
| backupAdmin.restore(BackupUtils.createRestoreRequest(BACKUP_ROOT_DIR, fullBackupId, false, | ||
| fromTables, toTables, true, true)); | ||
| List<LocatedFileStatus> postRestoreBackupFiles = getBackupFiles(); | ||
|
|
||
| // Check that the backup files are the same before and after the restore process | ||
| Assert.assertEquals(postRestoreBackupFiles, preRestoreBackupFiles); | ||
| Assert.assertEquals(TEST_UTIL.countRows(table1_restore), NB_ROWS_IN_BATCH); | ||
|
|
||
| int ROWS_TO_ADD = 1_000; | ||
| // different IDs so that rows don't overlap | ||
| insertIntoTable(conn, table1, famName, 3, ROWS_TO_ADD); | ||
| insertIntoTable(conn, table1, mobFam, 4, ROWS_TO_ADD); | ||
|
|
||
| try (Admin admin = conn.getAdmin()) { | ||
| List<HRegion> currentRegions = TEST_UTIL.getHBaseCluster().getRegions(table1); | ||
| for (HRegion region : currentRegions) { | ||
| byte[] name = region.getRegionInfo().getEncodedNameAsBytes(); | ||
| admin.splitRegionAsync(name).get(); | ||
| } | ||
|
|
||
| TEST_UTIL.waitTableAvailable(table1); | ||
|
|
||
| // Make sure we've split regions | ||
| assertNotEquals(currentRegions, TEST_UTIL.getHBaseCluster().getRegions(table1)); | ||
|
|
||
| EnvironmentEdgeManager.injectEdge(new EnvironmentEdge() { | ||
| // time + 30s | ||
| @Override | ||
| public long currentTime() { | ||
| return System.currentTimeMillis() + (30 * 1000); | ||
| } | ||
| }); | ||
|
|
||
| try { | ||
| backupAdmin | ||
| .backupTables(createBackupRequest(BackupType.INCREMENTAL, tables, BACKUP_ROOT_DIR)); | ||
| fail("Should not reach here"); | ||
| } catch (Exception e) { | ||
| if (e instanceof SnapshotTTLExpiredException) { | ||
| throw (SnapshotTTLExpiredException) e; | ||
| } | ||
| } finally { | ||
| EnvironmentEdgeManager.reset(); | ||
| backupAdmin.close(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private List<LocatedFileStatus> getBackupFiles() throws IOException { | ||
| FileSystem fs = TEST_UTIL.getTestFileSystem(); | ||
| RemoteIterator<LocatedFileStatus> iter = fs.listFiles(new Path(BACKUP_ROOT_DIR), true); | ||
| List<LocatedFileStatus> files = new ArrayList<>(); | ||
|
|
||
| while (iter.hasNext()) { | ||
| files.add(iter.next()); | ||
| } | ||
|
|
||
| return files; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the contribution!
For case 3:
I think we don't need to perform checks now, because even if the snapshot has expired, as long as we perform proper checks during the restore process, it should be fine. Let's hear what @Apache9 thinks about it.
If we go with your approach, i think we should also add the same validation logic in
SnapshotManager.java, since HBase also supports creating snapshots without using snapshot procedure, right?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the review!
I agree that it might be fine because we perform checks during the restore process. I just thought that redundant check would make it more consistent. Let's hear what @Apache9 thinks of it.
Oh that's right, I missed that one. Thanks for noticing it, I'll put the check if we agree that preemptive checking is needed