Registering disable user-agent setting with OpenSearch (#16052)

* Registering allowlist setting in user-agent Signed-off-by: Sarat Vemulapalli <vemulapallisarat@gmail.com> * Adding unit tests Signed-off-by: Sarat Vemulapalli <vemulapallisarat@gmail.com> --------- Signed-off-by: Sarat Vemulapalli <vemulapallisarat@gmail.com> (cherry picked from commit 78860ac) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Sep 27, 2024 · 3feb628 · 3feb628
1 parent 3056f89
commit 3feb628
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/modules/ingest-geoip/src/test/java/org/opensearch/ingest/geoip/IngestGeoIpPluginTests.java b/modules/ingest-geoip/src/test/java/org/opensearch/ingest/geoip/IngestGeoIpPluginTests.java
@@ -35,6 +35,7 @@
 import com.maxmind.geoip2.model.AbstractResponse;
 
 import org.opensearch.common.network.InetAddresses;
+import org.opensearch.common.settings.Setting;
 import org.opensearch.common.settings.Settings;
 import org.opensearch.env.TestEnvironment;
 import org.opensearch.ingest.Processor;
@@ -126,6 +127,12 @@ public void testAllowListNotSpecified() throws IOException {
         }
     }
 
+    public void testSettingsRegistration() {
+        final IngestGeoIpModulePlugin plugin = new IngestGeoIpModulePlugin();
+        final List<Setting<?>> settings = plugin.getSettings();
+        assertTrue(settings.contains(IngestGeoIpModulePlugin.PROCESSORS_ALLOWLIST_SETTING));
+    }
+
     private void runAllowListTest(List<String> allowList) throws IOException {
         Settings.Builder settingsBuilder = Settings.builder();
         createDb(settingsBuilder);

diff --git a/...ngest-user-agent/src/main/java/org/opensearch/ingest/useragent/IngestUserAgentPlugin.java b/...ngest-user-agent/src/main/java/org/opensearch/ingest/useragent/IngestUserAgentPlugin.java
@@ -44,6 +44,7 @@
 import java.nio.file.Path;
 import java.nio.file.PathMatcher;
 import java.nio.file.StandardOpenOption;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
@@ -152,6 +153,6 @@ static Map<String, UserAgentParser> createUserAgentParsers(Path userAgentConfigD
 
     @Override
     public List<Setting<?>> getSettings() {
-        return Collections.singletonList(CACHE_SIZE_SETTING);
+        return Arrays.asList(CACHE_SIZE_SETTING, PROCESSORS_ALLOWLIST_SETTING);
     }
 }
diff --git a/...-user-agent/src/test/java/org/opensearch/ingest/useragent/IngestUserAgentPluginTests.java b/...-user-agent/src/test/java/org/opensearch/ingest/useragent/IngestUserAgentPluginTests.java
@@ -8,6 +8,7 @@
 
 package org.opensearch.ingest.useragent;
 
+import org.opensearch.common.settings.Setting;
 import org.opensearch.common.settings.Settings;
 import org.opensearch.env.TestEnvironment;
 import org.opensearch.ingest.Processor;
@@ -87,6 +88,12 @@ public void testAllowListNotSpecified() throws IOException {
         }
     }
 
+    public void testSettingsRegistration() {
+        final IngestUserAgentModulePlugin plugin = new IngestUserAgentModulePlugin();
+        final List<Setting<?>> settings = plugin.getSettings();
+        assertTrue(settings.contains(IngestUserAgentModulePlugin.PROCESSORS_ALLOWLIST_SETTING));
+    }
+
     private void runAllowListTest(List<String> allowList) throws IOException {
         final Settings settings = settingsBuilder.putList(IngestUserAgentPlugin.PROCESSORS_ALLOWLIST_SETTING.getKey(), allowList).build();
         try (IngestUserAgentPlugin plugin = new IngestUserAgentPlugin()) {