PXY-860 Add metadata to Plugins

interceptor-framework/src/main/java/io/conduktor/gateway/interceptor/Plugin.java

@@ -17,7 +17,15 @@
 
 import org.apache.kafka.common.requests.AbstractRequestResponse;
 
-import java.util.*;
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.nio.charset.Charset;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 
 public interface Plugin {
 
@@ -36,4 +44,30 @@ default Map<Class<?>, List<Interceptor<? extends AbstractRequestResponse>>> getT
                 });
         return result;
     }
+
+    default String readme() {
+        try {
+            return resourceAsString("/META-INF/services/README.md");
+        } catch (Exception e) {
+            return "";
+        }
+    }
+
+    private String resourceAsString(String name) throws IOException, URISyntaxException {
+        return Files.readString(
+                Paths.get(getClass().getResource(name).toURI()),
+                Charset.forName("utf-8"));
+    }
+
+    default List<String> examples() {
+        try {
+            return List.of(resourceAsString("/META-INF/services/example.json"));
+        } catch (Exception e) {
+            return List.of();
+        }
+    }
+
+    default List<String> tags() {
+        return List.of();
+    }
 }

logger-interceptor/pom.xml

@@ -23,6 +23,19 @@
             <artifactId>interceptor-framework</artifactId>
             <version>0.5.0-SNAPSHOT</version>
         </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <version>3.23.1</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <version>5.8.2</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>
@@ -31,7 +44,6 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-jar-plugin</artifactId>
             </plugin>
-
         </plugins>
     </build>
 

logger-interceptor/src/main/java/io/conduktor/example/loggerinterceptor/LoggerInterceptorPlugin.java

@@ -16,6 +16,7 @@
 package io.conduktor.example.loggerinterceptor;
 
 
+import com.google.common.collect.Lists;
 import io.conduktor.gateway.interceptor.Interceptor;
 import io.conduktor.gateway.interceptor.InterceptorConfigurationException;
 import io.conduktor.gateway.interceptor.InterceptorProvider;
@@ -45,4 +46,8 @@ public List<InterceptorProvider<?>> getInterceptors(Map<String, Object> config)
         );
     }
 
+    @Override
+    public List<String> tags() {
+        return List.of("data");
+    }
 }

logger-interceptor/src/main/resources/META-INF/services/README.md

@@ -0,0 +1,3 @@
+# Interceptor
+
+Welcome to Logger interceptor!

logger-interceptor/src/main/resources/META-INF/services/example.json

@@ -0,0 +1,7 @@
+{
+  "pluginClass": "io.conduktor.example.loggerinterceptor.LoggerInterceptorPlugin",
+  "priority": 100,
+  "config": {
+    "loggingStyle": "obiWan"
+  }
+}

logger-interceptor/src/test/java/io/conduktor/example/loggerinterceptor/LoggerInterceptorPluginTest.java

@@ -0,0 +1,28 @@
+package io.conduktor.example.loggerinterceptor;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class LoggerInterceptorPluginTest {
+    @Test
+    void hasReadme() {
+        assertThat(new LoggerInterceptorPlugin().readme())
+                .contains("Welcome to Logger interceptor!");
+    }
+
+    @Test
+    void hasTags() {
+        assertThat(new LoggerInterceptorPlugin().tags())
+                .containsExactly("data");
+    }
+
+    @Test
+    void hasExamples() {
+        assertThat(new LoggerInterceptorPlugin().examples())
+                .hasSize(1);
+        assertThat(new LoggerInterceptorPlugin().examples().get(0))
+                .contains("\"pluginClass\": \"io.conduktor.example.loggerinterceptor.LoggerInterceptorPlugin\"");
+
+    }
+}