From 3b7464c571bebf91587c4c475ca350278775ba7b Mon Sep 17 00:00:00 2001
From: Shivansh Arora <hishiv@amazon.com>
Date: Fri, 12 Apr 2024 00:25:21 +0530
Subject: [PATCH] Added UT

Signed-off-by: Shivansh Arora <hishiv@amazon.com>
---
 .../remote/RemoteClusterStateService.java     | 10 +++++----
 .../RemoteClusterStateServiceTests.java       | 22 ++++++++++++++++++-
 2 files changed, 27 insertions(+), 5 deletions(-)

diff --git a/server/src/main/java/org/opensearch/gateway/remote/RemoteClusterStateService.java b/server/src/main/java/org/opensearch/gateway/remote/RemoteClusterStateService.java
index f3019e827fff2..6f52aa86fb6a1 100644
--- a/server/src/main/java/org/opensearch/gateway/remote/RemoteClusterStateService.java
+++ b/server/src/main/java/org/opensearch/gateway/remote/RemoteClusterStateService.java
@@ -91,6 +91,8 @@ public class RemoteClusterStateService implements Closeable {
     public static final TimeValue GLOBAL_METADATA_UPLOAD_TIMEOUT_DEFAULT = TimeValue.timeValueMillis(20000);
 
     public static final TimeValue METADATA_MANIFEST_UPLOAD_TIMEOUT_DEFAULT = TimeValue.timeValueMillis(20000);
+    public static final TimeValue CLUSTER_STATE_CLEANUP_INTERVAL_DEFAULT = TimeValue.timeValueMillis(60000);
+    public static final TimeValue CLUSTER_STATE_CLEANUP_INTERVAL_MINIMUM = TimeValue.MINUS_ONE;
 
     public static final Setting<TimeValue> INDEX_METADATA_UPLOAD_TIMEOUT_SETTING = Setting.timeSetting(
         "cluster.remote_store.state.index_metadata.upload_timeout",
@@ -155,8 +157,8 @@ public class RemoteClusterStateService implements Closeable {
      */
     public static final Setting<TimeValue> REMOTE_CLUSTER_STATE_CLEANUP_INTERVAL_SETTING = Setting.timeSetting(
         "cluster.remote_store.state.cleanup_interval",
-        TimeValue.timeValueMinutes(5),
-        TimeValue.timeValueMillis(-1),
+        CLUSTER_STATE_CLEANUP_INTERVAL_DEFAULT,
+        CLUSTER_STATE_CLEANUP_INTERVAL_MINIMUM,
         Property.NodeScope,
         Property.Dynamic
     );
@@ -583,8 +585,8 @@ private void updateCleanupInterval(TimeValue updatedInterval) {
         this.staleFileCleanupInterval = updatedInterval;
         logger.info("updated remote state cleanup interval to {}", updatedInterval);
         // After updating the interval, we need to close the current task and create a new one which will run with updated interval
-        if (!this.staleFileDeletionTask.getInterval().equals(updatedInterval)) {
-            this.staleFileDeletionTask.setInterval(updatedInterval);
+        if (staleFileDeletionTask != null && !staleFileDeletionTask.getInterval().equals(updatedInterval)) {
+            staleFileDeletionTask.setInterval(updatedInterval);
         }
     }
 
diff --git a/server/src/test/java/org/opensearch/gateway/remote/RemoteClusterStateServiceTests.java b/server/src/test/java/org/opensearch/gateway/remote/RemoteClusterStateServiceTests.java
index 8e6315a13f93e..fecb09d4404c0 100644
--- a/server/src/test/java/org/opensearch/gateway/remote/RemoteClusterStateServiceTests.java
+++ b/server/src/test/java/org/opensearch/gateway/remote/RemoteClusterStateServiceTests.java
@@ -40,6 +40,7 @@
 import org.opensearch.core.xcontent.NamedXContentRegistry;
 import org.opensearch.gateway.remote.ClusterMetadataManifest.UploadedIndexMetadata;
 import org.opensearch.index.remote.RemoteStoreUtils;
+import org.opensearch.index.translog.transfer.BlobStoreTransferService;
 import org.opensearch.indices.IndicesModule;
 import org.opensearch.repositories.FilterRepository;
 import org.opensearch.repositories.RepositoriesService;
@@ -78,6 +79,8 @@
 import org.mockito.ArgumentMatchers;
 
 import static java.util.stream.Collectors.toList;
+import static org.mockito.ArgumentMatchers.anyInt;
+import static org.opensearch.gateway.remote.RemoteClusterStateService.CLUSTER_STATE_CLEANUP_INTERVAL_DEFAULT;
 import static org.opensearch.gateway.remote.RemoteClusterStateService.DELIMITER;
 import static org.opensearch.gateway.remote.RemoteClusterStateService.FORMAT_PARAMS;
 import static org.opensearch.gateway.remote.RemoteClusterStateService.INDEX_METADATA_CURRENT_CODEC_VERSION;
@@ -1221,10 +1224,27 @@ public void testGlobalMetadataUploadWaitTimeSetting() {
         assertEquals(globalMetadataUploadTimeout, remoteClusterStateService.getGlobalMetadataUploadTimeout().seconds());
     }
 
+    public void testRemoteClusterStateCleanupSetting() {
+        remoteClusterStateService.start();
+        // verify default value
+        assertEquals(
+            CLUSTER_STATE_CLEANUP_INTERVAL_DEFAULT,
+            remoteClusterStateService.getStaleFileCleanupInterval()
+        );
+
+        // verify update interval
+        int cleanupInterval = randomIntBetween(1, 10);
+        Settings newSettings = Settings.builder()
+            .put("cluster.remote_store.state.cleanup_interval", cleanupInterval + "s")
+            .build();
+        clusterSettings.applySettings(newSettings);
+        assertEquals(cleanupInterval, remoteClusterStateService.getStaleFileCleanupInterval().seconds());
+    }
+
     public void testRemoteCleanupTaskScheduled() {
         AbstractAsyncTask cleanupTask = remoteClusterStateService.getStaleFileDeletionTask();
         assertNull(cleanupTask);
-
+        // now the task should be initialized
         remoteClusterStateService.start();
         assertNotNull(remoteClusterStateService.getStaleFileDeletionTask());
         assertTrue(remoteClusterStateService.getStaleFileDeletionTask().mustReschedule());