-
Notifications
You must be signed in to change notification settings - Fork 600
HDDS-13572. SCMSnapshotProvider should not auto-create Ratis directory #9689
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
Merged
Merged
Changes from all commits
Commits
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
Some comments aren't visible on the classic Files Changed page.
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
119 changes: 119 additions & 0 deletions
119
...-hdds/server-scm/src/test/java/org/apache/hadoop/hdds/scm/ha/TestSCMSnapshotProvider.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,119 @@ | ||
| /* | ||
| * 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.hdds.scm.ha; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertNotNull; | ||
| import static org.junit.jupiter.api.Assertions.assertThrows; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
| import static org.mockito.Mockito.mock; | ||
|
|
||
| import java.io.File; | ||
| import java.nio.file.Path; | ||
| import org.apache.hadoop.hdds.HddsConfigKeys; | ||
| import org.apache.hadoop.hdds.conf.OzoneConfiguration; | ||
| import org.apache.hadoop.hdds.scm.ScmConfigKeys; | ||
| import org.apache.hadoop.hdds.security.x509.certificate.client.CertificateClient; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.io.TempDir; | ||
|
|
||
| /** | ||
| * Test cases for {@link SCMSnapshotProvider}. | ||
| */ | ||
| class TestSCMSnapshotProvider { | ||
|
|
||
| /** | ||
| * Test constructor succeeds when both Ratis storage and snapshot directories exist. | ||
| */ | ||
| @Test | ||
| void testConstructorSucceedsWithExistingDirectories(@TempDir Path tempDir) { | ||
| // Setup: Create both directories (simulating initialized SCM) | ||
| OzoneConfiguration conf = createConfig(tempDir); | ||
| String ratisDir = SCMHAUtils.getSCMRatisDirectory(conf); | ||
| String snapshotDir = SCMHAUtils.getSCMRatisSnapshotDirectory(conf); | ||
|
|
||
| assertTrue(new File(ratisDir).mkdirs()); | ||
| assertTrue(new File(snapshotDir).mkdirs()); | ||
|
|
||
| CertificateClient certClient = mock(CertificateClient.class); | ||
|
|
||
| // Test | ||
| SCMSnapshotProvider provider = new SCMSnapshotProvider( | ||
| conf, null, certClient); | ||
|
|
||
| // Verify | ||
| assertNotNull(provider); | ||
| assertNotNull(provider.getScmSnapshotDir()); | ||
| assertTrue(provider.getScmSnapshotDir().exists()); | ||
| assertEquals(snapshotDir, provider.getScmSnapshotDir().getAbsolutePath()); | ||
| } | ||
|
|
||
| /** | ||
| * Test constructor fails when snapshot directory does not exist. | ||
| */ | ||
| @Test | ||
| void testConstructorFailsWhenSnapshotDirMissing(@TempDir Path tempDir) { | ||
| // Setup: Create only Ratis storage directory, not snapshot directory | ||
| OzoneConfiguration conf = createConfig(tempDir); | ||
| String ratisDir = SCMHAUtils.getSCMRatisDirectory(conf); | ||
| assertTrue(new File(ratisDir).mkdirs()); | ||
|
|
||
| CertificateClient certClient = mock(CertificateClient.class); | ||
|
|
||
| // Test & Verify | ||
| IllegalStateException exception = assertThrows( | ||
| IllegalStateException.class, | ||
| () -> new SCMSnapshotProvider(conf, null, certClient)); | ||
|
|
||
| assertTrue(exception.getMessage().contains("Ratis snapshot directory does not exist")); | ||
| } | ||
|
|
||
| /** | ||
| * Test constructor fails when Ratis storage directory does not exist. | ||
| */ | ||
| @Test | ||
| void testConstructorFailsWhenRatisDirMissing(@TempDir Path tempDir) { | ||
| // Setup: Don't create any directories | ||
| OzoneConfiguration conf = createConfig(tempDir); | ||
| CertificateClient certClient = mock(CertificateClient.class); | ||
|
|
||
| // Test & Verify | ||
| IllegalStateException exception = assertThrows( | ||
| IllegalStateException.class, | ||
| () -> new SCMSnapshotProvider(conf, null, certClient)); | ||
|
|
||
| assertTrue(exception.getMessage().contains("Ratis storage directory does not exist")); | ||
| } | ||
|
|
||
| /** | ||
| * Helper method to create OzoneConfiguration with temp directories. | ||
| */ | ||
| private OzoneConfiguration createConfig(Path tempDir) { | ||
| OzoneConfiguration conf = new OzoneConfiguration(); | ||
|
|
||
| String metadataDir = tempDir.resolve("metadata").toString(); | ||
| String ratisStorageDir = tempDir.resolve("ratis").toString(); | ||
| String ratisSnapshotDir = tempDir.resolve("ratis-snapshot").toString(); | ||
|
|
||
| conf.set(HddsConfigKeys.OZONE_METADATA_DIRS, metadataDir); | ||
| conf.set(ScmConfigKeys.OZONE_SCM_HA_RATIS_STORAGE_DIR, ratisStorageDir); | ||
| conf.set(ScmConfigKeys.OZONE_SCM_HA_RATIS_SNAPSHOT_DIR, ratisSnapshotDir); | ||
|
|
||
| return conf; | ||
| } | ||
| } |
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
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
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.
How could older versions with HA do not have the snapshot directory?
I guess it is possible only if older versions is non-HA, then it does not have the snapshot directory. Further, if it is updated to a newer version and enable HA at the same time, it could hit this case. Is it the case?
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.
The Integration Test (Upgrade) covers this scenario. See driver.sh:
SCMHAEnabled=true)In step 2, the cluster already has
SCMHAEnabled=truefrom the old version, so it enters the else branch. The snapshot directory may not exist if the old version didn't trigger a snapshot operation before shutdown.