Add basic UTs

Signed-off-by: Bhumika Saini <[email protected]>
opensearch-project · Sep 19, 2023 · 33eee39 · 33eee39
1 parent 802b2cc
commit 33eee39
Show file tree

Hide file tree

Showing 3 changed files with 135 additions and 0 deletions.
diff --git a/plugins/repository-s3/src/test/java/org/opensearch/repositories/s3/S3RepositoryTests.java b/plugins/repository-s3/src/test/java/org/opensearch/repositories/s3/S3RepositoryTests.java
@@ -139,6 +139,17 @@ public void testDefaultBufferSize() {
         }
     }
 
+    public void testIsReloadable() {
+        final RepositoryMetadata metadata = new RepositoryMetadata(
+            "dummy-repo",
+            "mock",
+            Settings.EMPTY
+        );
+        try (S3Repository s3repo = createS3Repo(metadata)) {
+            assertTrue(s3repo.isReloadable());
+        }
+    }
+
     private S3Repository createS3Repo(RepositoryMetadata metadata) {
         return new S3Repository(
             metadata,

diff --git a/server/src/main/java/org/opensearch/repositories/fs/ReloadableFsRepository.java b/server/src/main/java/org/opensearch/repositories/fs/ReloadableFsRepository.java
@@ -21,6 +21,11 @@
 
 import java.nio.file.Path;
 
+/**
+ * Extension of {@link FsRepository} that can be reloaded inplace
+ *
+ * @opensearch.internal
+ */
 public class ReloadableFsRepository extends FsRepository {
     private static final Logger logger = LogManager.getLogger(ReloadableFsRepository.class);
 

diff --git a/server/src/test/java/org/opensearch/repositories/fs/ReloadableFsRepositoryTests.java b/server/src/test/java/org/opensearch/repositories/fs/ReloadableFsRepositoryTests.java
@@ -0,0 +1,119 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.repositories.fs;
+
+import org.opensearch.cluster.metadata.RepositoryMetadata;
+import org.opensearch.common.compress.DeflateCompressor;
+import org.opensearch.common.settings.ClusterSettings;
+import org.opensearch.common.settings.Settings;
+import org.opensearch.compress.ZstdCompressor;
+import org.opensearch.core.common.unit.ByteSizeUnit;
+import org.opensearch.core.compress.CompressorRegistry;
+import org.opensearch.core.xcontent.NamedXContentRegistry;
+import org.opensearch.env.Environment;
+import org.opensearch.indices.recovery.RecoverySettings;
+import org.opensearch.repositories.blobstore.BlobStoreTestUtil;
+import org.opensearch.test.OpenSearchTestCase;
+
+import java.nio.file.Path;
+import java.util.Locale;
+
+import static org.junit.Assert.assertTrue;
+
+public class ReloadableFsRepositoryTests extends OpenSearchTestCase {
+    ReloadableFsRepository repository;
+    RepositoryMetadata metadata;
+    Settings settings;
+    Path repo;
+
+    @Override
+    public void setUp() throws Exception {
+        super.setUp();
+
+        repo = createTempDir();
+        settings = Settings.builder()
+            .put(Environment.PATH_HOME_SETTING.getKey(), createTempDir().toAbsolutePath())
+            .put(Environment.PATH_REPO_SETTING.getKey(), repo.toAbsolutePath())
+            .putList(Environment.PATH_DATA_SETTING.getKey(), tmpPaths())
+            .put("location", repo)
+            .put("compress", false)
+            .put("chunk_size", randomIntBetween(100, 1000), ByteSizeUnit.BYTES)
+            .put(FsRepository.BASE_PATH_SETTING.getKey(), "my_base_path")
+            .build();
+        metadata = new RepositoryMetadata("test", "fs", settings);
+        repository = new ReloadableFsRepository(
+            metadata,
+            new Environment(settings, null),
+            NamedXContentRegistry.EMPTY,
+            BlobStoreTestUtil.mockClusterService(),
+            new RecoverySettings(settings, new ClusterSettings(settings, ClusterSettings.BUILT_IN_CLUSTER_SETTINGS))
+        );
+    }
+
+    /**
+     * Validates that {@link ReloadableFsRepository} supports inplace reloading
+     */
+    public void testIsReloadable() {
+        assertTrue(repository.isReloadable());
+    }
+
+    /**
+     * Updates repository metadata of an existing repository to enable default compressor
+     */
+    public void testCompressReload() {
+        assertEquals(CompressorRegistry.none(), repository.getCompressor());
+        updateCompressionTypeToDefault();
+        repository.reload(metadata, true);
+        assertEquals(CompressorRegistry.defaultCompressor(), repository.getCompressor());
+    }
+
+    /**
+     * Updates repository metadata of an existing repository to change compressor type from default to Zstd
+     */
+    public void testCompressionTypeReload() {
+        assertEquals(CompressorRegistry.none(), repository.getCompressor());
+        updateCompressionTypeToDefault();
+        repository = new ReloadableFsRepository(
+            metadata,
+            new Environment(settings, null),
+            NamedXContentRegistry.EMPTY,
+            BlobStoreTestUtil.mockClusterService(),
+            new RecoverySettings(settings, new ClusterSettings(settings, ClusterSettings.BUILT_IN_CLUSTER_SETTINGS))
+        );
+        assertEquals(CompressorRegistry.defaultCompressor(), repository.getCompressor());
+
+        settings = Settings.builder()
+            .put(Environment.PATH_HOME_SETTING.getKey(), createTempDir().toAbsolutePath())
+            .put(Environment.PATH_REPO_SETTING.getKey(), repo.toAbsolutePath())
+            .putList(Environment.PATH_DATA_SETTING.getKey(), tmpPaths())
+            .put("location", repo)
+            .put("compress", true)
+            .put("compression_type", ZstdCompressor.NAME.toLowerCase(Locale.ROOT))
+            .put("chunk_size", randomIntBetween(100, 1000), ByteSizeUnit.BYTES)
+            .put(FsRepository.BASE_PATH_SETTING.getKey(), "my_base_path")
+            .build();
+        metadata = new RepositoryMetadata("test", "fs", settings);
+        repository.reload(metadata, true);
+        assertEquals(CompressorRegistry.getCompressor(ZstdCompressor.NAME.toUpperCase(Locale.ROOT)), repository.getCompressor());
+    }
+
+    private void updateCompressionTypeToDefault() {
+        settings = Settings.builder()
+            .put(Environment.PATH_HOME_SETTING.getKey(), createTempDir().toAbsolutePath())
+            .put(Environment.PATH_REPO_SETTING.getKey(), repo.toAbsolutePath())
+            .putList(Environment.PATH_DATA_SETTING.getKey(), tmpPaths())
+            .put("location", repo)
+            .put("compress", true)
+            .put("compression_type", DeflateCompressor.NAME.toLowerCase(Locale.ROOT))
+            .put("chunk_size", randomIntBetween(100, 1000), ByteSizeUnit.BYTES)
+            .put(FsRepository.BASE_PATH_SETTING.getKey(), "my_base_path")
+            .build();
+        metadata = new RepositoryMetadata("test", "fs", settings);
+    }
+}