[Remote Store] Change remote_store setting validation message to make…

… it more clear (opensearch-project#4199) * Change remote_store setting validation message to make it more clear Signed-off-by: Sachin Kale <kalsac@amazon.com>
sachinpkale · Sep 2, 2022 · 9a4ede8 · 9a4ede8
1 parent 4326f5f
commit 9a4ede8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 12 deletions.
diff --git a/server/src/main/java/org/opensearch/cluster/metadata/IndexMetadata.java b/server/src/main/java/org/opensearch/cluster/metadata/IndexMetadata.java
@@ -300,12 +300,12 @@ public void validate(final Boolean value, final Map<Setting<?>, Object> settings
                 final Object replicationType = settings.get(INDEX_REPLICATION_TYPE_SETTING);
                 if (replicationType != ReplicationType.SEGMENT && value == true) {
                     throw new IllegalArgumentException(
-                        "Settings "
+                        "To enable "
                             + INDEX_REMOTE_STORE_ENABLED_SETTING.getKey()
-                            + " cannot be enabled when "
+                            + ", "
                             + INDEX_REPLICATION_TYPE_SETTING.getKey()
-                            + " is set to "
-                            + settings.get(INDEX_REPLICATION_TYPE_SETTING)
+                            + " should be set to "
+                            + ReplicationType.SEGMENT
                     );
                 }
             }

diff --git a/server/src/test/java/org/opensearch/index/IndexSettingsTests.java b/server/src/test/java/org/opensearch/index/IndexSettingsTests.java
@@ -807,10 +807,7 @@ public void testEnablingRemoteStoreFailsWhenReplicationTypeIsDocument() {
             IllegalArgumentException.class,
             () -> IndexMetadata.INDEX_REMOTE_STORE_ENABLED_SETTING.get(indexSettings)
         );
-        assertEquals(
-            "Settings index.remote_store.enabled cannot be enabled when index.replication.type is set to DOCUMENT",
-            iae.getMessage()
-        );
+        assertEquals("To enable index.remote_store.enabled, index.replication.type should be set to SEGMENT", iae.getMessage());
     }
 
     public void testEnablingRemoteStoreFailsWhenReplicationTypeIsDefault() {
@@ -819,9 +816,6 @@ public void testEnablingRemoteStoreFailsWhenReplicationTypeIsDefault() {
             IllegalArgumentException.class,
             () -> IndexMetadata.INDEX_REMOTE_STORE_ENABLED_SETTING.get(indexSettings)
         );
-        assertEquals(
-            "Settings index.remote_store.enabled cannot be enabled when index.replication.type is set to DOCUMENT",
-            iae.getMessage()
-        );
+        assertEquals("To enable index.remote_store.enabled, index.replication.type should be set to SEGMENT", iae.getMessage());
     }
 }