-
Notifications
You must be signed in to change notification settings - Fork 306
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added implicit PRUNE mode warning & Handling invalid data-storage-mod…
…e file (#8369)
- Loading branch information
1 parent
0060e81
commit 437da16
Showing
7 changed files
with
210 additions
and
50 deletions.
There are no files selected for viewing
This file contains 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 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
48 changes: 48 additions & 0 deletions
48
storage/src/main/java/tech/pegasys/teku/storage/server/DatabaseStorageModeFileHelper.java
This file contains 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,48 @@ | ||
| /* | ||
| * Copyright Consensys Software Inc., 2024 | ||
| * | ||
| * Licensed 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 tech.pegasys.teku.storage.server; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.UncheckedIOException; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.util.Optional; | ||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
|
|
||
| public class DatabaseStorageModeFileHelper { | ||
|
|
||
| private static final Logger LOG = LogManager.getLogger(); | ||
|
|
||
| public static Optional<StateStorageMode> readStateStorageMode(final Path path) { | ||
| if (!Files.exists(path)) { | ||
| return Optional.empty(); | ||
| } | ||
|
|
||
| try { | ||
| final StateStorageMode dbStorageMode = | ||
| StateStorageMode.valueOf(Files.readString(path).trim()); | ||
| LOG.debug("Read previous storage mode as {}", dbStorageMode); | ||
| return Optional.of(dbStorageMode); | ||
| } catch (final IllegalArgumentException ex) { | ||
| throw DatabaseStorageException.unrecoverable( | ||
| "Invalid database storage mode file (" | ||
| + path | ||
| + "). Run your node using '--data-storage-mode' option to configure the correct storage mode.", | ||
| ex); | ||
| } catch (final IOException ex) { | ||
| throw new UncheckedIOException("Failed to read storage mode from file", ex); | ||
| } | ||
| } | ||
| } |
This file contains 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 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
65 changes: 65 additions & 0 deletions
65
...age/src/test/java/tech/pegasys/teku/storage/server/DatabaseStorageModeFileHelperTest.java
This file contains 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,65 @@ | ||
| /* | ||
| * Copyright Consensys Software Inc., 2024 | ||
| * | ||
| * Licensed 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 tech.pegasys.teku.storage.server; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.assertj.core.api.Assertions.assertThatThrownBy; | ||
| import static org.junit.jupiter.api.Assertions.fail; | ||
| import static tech.pegasys.teku.storage.server.VersionedDatabaseFactory.STORAGE_MODE_PATH; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.io.TempDir; | ||
|
|
||
| class DatabaseStorageModeFileHelperTest { | ||
|
|
||
| @Test | ||
| public void shouldReadValidStorageModeFile(@TempDir final Path tempDir) { | ||
| final Path dbStorageModeFile = | ||
| createDatabaseStorageModeFile(tempDir, StateStorageMode.MINIMAL.toString()); | ||
| assertThat(DatabaseStorageModeFileHelper.readStateStorageMode(dbStorageModeFile)) | ||
| .hasValue(StateStorageMode.MINIMAL); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldReadEmptyWhenFileDoesNotExist(@TempDir final Path tempDir) { | ||
| final Path dbStorageModeFile = tempDir.resolve("foo"); | ||
| assertThat(DatabaseStorageModeFileHelper.readStateStorageMode(dbStorageModeFile)).isEmpty(); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldThrowErrorIfFileHasInvalidValue(@TempDir final Path tempDir) { | ||
| final Path dbStorageModeFile = createDatabaseStorageModeFile(tempDir, "hello"); | ||
| assertThatThrownBy(() -> DatabaseStorageModeFileHelper.readStateStorageMode(dbStorageModeFile)) | ||
| .isInstanceOf(DatabaseStorageException.class); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldThrowErrorIfFileIsEmpty(@TempDir final Path tempDir) { | ||
| final Path dbStorageModeFile = createDatabaseStorageModeFile(tempDir, ""); | ||
| assertThatThrownBy(() -> DatabaseStorageModeFileHelper.readStateStorageMode(dbStorageModeFile)) | ||
| .isInstanceOf(DatabaseStorageException.class); | ||
| } | ||
|
|
||
| private Path createDatabaseStorageModeFile(final Path path, final String value) { | ||
| try { | ||
| return Files.writeString(path.resolve(STORAGE_MODE_PATH), value); | ||
| } catch (IOException e) { | ||
| fail(e); | ||
| return null; | ||
| } | ||
| } | ||
| } |
This file contains 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