Add alternate name for Plugin

Signed-off-by: Dinu John <[email protected]>
dinujoh · Sep 21, 2024 · d620d08 · d620d08
1 parent 915c7b1
commit d620d08
Show file tree

Hide file tree

Showing 6 changed files with 77 additions and 2 deletions.
diff --git a/...per-api/src/main/java/org/opensearch/dataprepper/model/annotations/DataPrepperPlugin.java b/...per-api/src/main/java/org/opensearch/dataprepper/model/annotations/DataPrepperPlugin.java
@@ -33,6 +33,8 @@
 public @interface DataPrepperPlugin {
     String DEFAULT_DEPRECATED_NAME = "";
 
+    String DEFAULT_ALTERNATE_NAME = "";
+
     /**
      *
      * @return Name of the plugin which should be unique for the type
@@ -46,6 +48,12 @@
      */
     String deprecatedName() default DEFAULT_DEPRECATED_NAME;
 
+    /**
+     *
+     * @return Alternate name of the plugin which should be unique for the type
+     */
+    String alternateName() default DEFAULT_ALTERNATE_NAME;
+
     /**
      * The class type for this plugin.
      *

diff --git a/...in-framework/src/main/java/org/opensearch/dataprepper/plugin/ClasspathPluginProvider.java b/...in-framework/src/main/java/org/opensearch/dataprepper/plugin/ClasspathPluginProvider.java
@@ -17,6 +17,7 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
+import static org.opensearch.dataprepper.model.annotations.DataPrepperPlugin.DEFAULT_ALTERNATE_NAME;
 import static org.opensearch.dataprepper.model.annotations.DataPrepperPlugin.DEFAULT_DEPRECATED_NAME;
 
 /**
@@ -78,6 +79,7 @@ private Map<String, Map<Class<?>, Class<?>>> scanForPlugins() {
             supportTypeToPluginTypeMap.put(supportedType, concretePluginClass);
 
             addOptionalDeprecatedPluginName(pluginsMap, concretePluginClass);
+            addOptionalAlternatePluginName(pluginsMap, concretePluginClass);
         }
 
         return pluginsMap;
@@ -96,4 +98,18 @@ private void addOptionalDeprecatedPluginName(
             supportTypeToPluginTypeMap.put(supportedType, concretePluginClass);
         }
     }
+
+    private void addOptionalAlternatePluginName(
+            final Map<String, Map<Class<?>, Class<?>>> pluginsMap,
+            final Class<?> concretePluginClass) {
+        final DataPrepperPlugin dataPrepperPluginAnnotation = concretePluginClass.getAnnotation(DataPrepperPlugin.class);
+        final String alternatePluginName = dataPrepperPluginAnnotation.alternateName();
+        final Class<?> supportedType = dataPrepperPluginAnnotation.pluginType();
+
+        if (!alternatePluginName.equals(DEFAULT_ALTERNATE_NAME)) {
+            final Map<Class<?>, Class<?>> supportTypeToPluginTypeMap =
+                    pluginsMap.computeIfAbsent(alternatePluginName, k -> new HashMap<>());
+            supportTypeToPluginTypeMap.put(supportedType, concretePluginClass);
+        }
+    }
 }
diff --git a/...ramework/src/test/java/org/opensearch/dataprepper/plugin/ClasspathPluginProviderTest.java b/...ramework/src/test/java/org/opensearch/dataprepper/plugin/ClasspathPluginProviderTest.java
@@ -28,6 +28,7 @@
 import static org.mockito.BDDMockito.given;
 import static org.mockito.BDDMockito.then;
 import static org.mockito.Mockito.mock;
+import static org.opensearch.dataprepper.model.annotations.DataPrepperPlugin.DEFAULT_ALTERNATE_NAME;
 import static org.opensearch.dataprepper.model.annotations.DataPrepperPlugin.DEFAULT_DEPRECATED_NAME;
 
 class ClasspathPluginProviderTest {
@@ -105,6 +106,27 @@ void findPlugin_should_return_plugin_if_found_for_deprecated_name_and_type_using
         assertThat(optionalPlugin.get(), equalTo(TestSource.class));
     }
 
+    @Test
+    void findPlugin_should_return_empty_for_default_alternate_name() {
+        given(reflections.getTypesAnnotatedWith(DataPrepperPlugin.class))
+                .willReturn(new HashSet<>(List.of(TestSource.class)));
+
+        final Optional<Class<? extends Source>> optionalPlugin = createObjectUnderTest().findPluginClass(Source.class, DEFAULT_ALTERNATE_NAME);
+        assertThat(optionalPlugin, notNullValue());
+        assertThat(optionalPlugin.isPresent(), equalTo(false));
+    }
+
+    @Test
+    void findPlugin_should_return_plugin_if_found_for_alternate_name_and_type_using_pluginType() {
+        given(reflections.getTypesAnnotatedWith(DataPrepperPlugin.class))
+                .willReturn(new HashSet<>(List.of(TestSource.class)));
+
+        final Optional<Class<? extends Source>> optionalPlugin = createObjectUnderTest().findPluginClass(Source.class, "test_source_alternate_name");
+        assertThat(optionalPlugin, notNullValue());
+        assertThat(optionalPlugin.isPresent(), equalTo(true));
+        assertThat(optionalPlugin.get(), equalTo(TestSource.class));
+    }
+
     @Nested
     class WithPredefinedPlugins {
 

diff --git a/...n-framework/src/test/java/org/opensearch/dataprepper/plugin/DefaultPluginFactoryTest.java b/...n-framework/src/test/java/org/opensearch/dataprepper/plugin/DefaultPluginFactoryTest.java
@@ -401,4 +401,33 @@ void loadPlugin_should_create_a_new_instance_of_the_first_plugin_found_with_corr
             verify(beanFactoryProvider).get();
         }
     }
+
+    @Nested
+    class WithAlternatePluginName {
+        private static final String TEST_SINK_ALTERNATE_NAME = "test_sink_alternate_name";
+        private Class expectedPluginClass;
+
+        @BeforeEach
+        void setUp() {
+            expectedPluginClass = TestSink.class;
+            given(pluginSetting.getName()).willReturn(TEST_SINK_ALTERNATE_NAME);
+
+            given(firstPluginProvider.findPluginClass(baseClass, TEST_SINK_ALTERNATE_NAME))
+                    .willReturn(Optional.of(expectedPluginClass));
+        }
+
+        @Test
+        void loadPlugin_should_create_a_new_instance_of_the_first_plugin_found_with_correct_name_and_alternate_name() {
+            final TestSink expectedInstance = mock(TestSink.class);
+            final Object convertedConfiguration = mock(Object.class);
+            given(pluginConfigurationConverter.convert(PluginSetting.class, pluginSetting))
+                    .willReturn(convertedConfiguration);
+            given(pluginCreator.newPluginInstance(eq(expectedPluginClass), any(ComponentPluginArgumentsContext.class), eq(TEST_SINK_ALTERNATE_NAME)))
+                    .willReturn(expectedInstance);
+
+            assertThat(createObjectUnderTest().loadPlugin(baseClass, pluginSetting), equalTo(expectedInstance));
+            MatcherAssert.assertThat(expectedInstance.getClass().getAnnotation(DataPrepperPlugin.class).alternateName(), equalTo(TEST_SINK_ALTERNATE_NAME));
+            verify(beanFactoryProvider).get();
+        }
+    }
 }
diff --git a/...pper-plugin-framework/src/test/java/org/opensearch/dataprepper/plugins/test/TestSink.java b/...pper-plugin-framework/src/test/java/org/opensearch/dataprepper/plugins/test/TestSink.java
@@ -16,7 +16,7 @@
 import java.util.stream.Collectors;
 import java.time.Instant;
 
-@DataPrepperPlugin(name = "test_sink", deprecatedName = "test_sink_deprecated_name", pluginType = Sink.class)
+@DataPrepperPlugin(name = "test_sink", alternateName = "test_sink_alternate_name", deprecatedName = "test_sink_deprecated_name", pluginType = Sink.class)
 public class TestSink implements Sink<Record<String>> {
     public boolean isShutdown = false;
     private final List<Record<String>> collectedRecords;

diff --git a/...er-plugin-framework/src/test/java/org/opensearch/dataprepper/plugins/test/TestSource.java b/...er-plugin-framework/src/test/java/org/opensearch/dataprepper/plugins/test/TestSource.java
@@ -16,7 +16,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-@DataPrepperPlugin(name = "test_source", deprecatedName = "test_source_deprecated_name", pluginType = Source.class)
+@DataPrepperPlugin(name = "test_source", alternateName = "test_source_alternate_name", deprecatedName = "test_source_deprecated_name", pluginType = Source.class)
 public class TestSource implements Source<Record<String>> {
     public static final List<Record<String>> TEST_DATA = Stream.of("TEST")
             .map(Record::new).collect(Collectors.toList());