Merge pull request #67 from conduktor/framiere/PXY-860

PXY-860 Add metadata to Plugins

interceptor-framework/pom.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <parent>
         <artifactId>conduktor-gateway</artifactId>
         <groupId>io.conduktor</groupId>
@@ -13,5 +14,18 @@
         <maven.compiler.source>17</maven.compiler.source>
         <maven.compiler.target>17</maven.compiler.target>
     </properties>
-
+    <dependencies>
+        <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>
 </project>

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

@@ -0,0 +1,38 @@
+package io.conduktor.gateway.interceptor;
+
+import org.jetbrains.annotations.NotNull;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+public class MarkdownHeadersUtil {
+    private static final Pattern pattern = Pattern.compile("\\s*([^\\s]+):\\s*(.*+)", Pattern.MULTILINE);
+    public static final String HEADER_SEPARATOR = "---";
+
+    public Map<String, String> extractHeaders(String markdown) {
+        String headers = markdownHeaders(markdown);
+        Matcher matcher = pattern.matcher(headers);
+        Map<String, String> ret = new HashMap<>();
+        while (matcher.find()) {
+            ret.put(matcher.group(1), matcher.group(2));
+        }
+        return ret;
+    }
+
+    @NotNull
+    private String markdownHeaders(String v) {
+        int first = v.indexOf(HEADER_SEPARATOR);
+        if (first == -1) {
+            return "";
+        }
+        String newStr = v.substring(first + HEADER_SEPARATOR.length());
+        int second = newStr.indexOf(HEADER_SEPARATOR);
+        if (second == -1) {
+            return "";
+        }
+
+        return v.substring(first + HEADER_SEPARATOR.length(), second + first + HEADER_SEPARATOR.length());
+    }
+}

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

@@ -15,9 +15,17 @@
 
 package io.conduktor.gateway.interceptor;
 
+import com.google.common.io.Resources;
 import org.apache.kafka.common.requests.AbstractRequestResponse;
 
-import java.util.*;
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import static java.nio.charset.StandardCharsets.UTF_8;
 
 public interface Plugin {
 
@@ -36,4 +44,25 @@ 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 URISyntaxException, IOException {
+        try {
+            return Resources.toString(getClass().getClassLoader().getResource(name).toURI().toURL(), UTF_8);
+        } catch (Exception e) {
+            // support flat classloader
+            return Resources.toString(getClass().getResource(name).toURI().toURL(), UTF_8);
+        }
+    }
+
+    default Map<String, String> tags() {
+        return new MarkdownHeadersUtil().extractHeaders(readme());
+    }
 }

interceptor-framework/src/test/java/io/conduktor/gateway/interceptor/MarkdownHeadersUtilTest.java

@@ -0,0 +1,66 @@
+package io.conduktor.gateway.interceptor;
+
+
+import org.junit.jupiter.api.Test;
+
+import java.util.Map;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class MarkdownHeadersUtilTest {
+    @Test
+    public void validHeader() {
+        assertThat(new MarkdownHeadersUtil().extractHeaders("""
+                ---
+                version: 1.0.1-SNAPSHOT
+                title: Virtual SQL Topic
+                description: Don't reinvent the wheel to filter and project your messages, just use SQL!
+                parent: safeguard
+                ---
+                # Interceptor"""))
+                .containsExactlyInAnyOrderEntriesOf(Map.of(
+                        "version", "1.0.1-SNAPSHOT",
+                        "title", "Virtual SQL Topic",
+                        "description", "Don't reinvent the wheel to filter and project your messages, just use SQL!",
+                        "parent", "safeguard"
+                ));
+    }
+
+    @Test
+    public void emptyHeaders() {
+        assertThat(new MarkdownHeadersUtil().extractHeaders("""
+                ---
+                ---
+                # Interceptor"""))
+                .isEmpty();
+    }
+
+    @Test
+    public void emptyHeader() {
+        assertThat(new MarkdownHeadersUtil().extractHeaders("""
+                ---
+                version: 
+                ---
+                # Interceptor"""))
+                .containsAllEntriesOf(Map.of(
+                        "version", ""
+                ));
+    }
+
+    @Test
+    public void noHeader() {
+        assertThat(new MarkdownHeadersUtil().extractHeaders("""
+                # Interceptor"""))
+                .isEmpty();
+    }
+
+    @Test
+    public void unclosedHeader() {
+        assertThat(new MarkdownHeadersUtil().extractHeaders("""
+                ---
+                title: Virtual SQL Topic
+                # Interceptor"""))
+                .isEmpty();
+    }
+
+}

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;
@@ -44,5 +45,4 @@ public List<InterceptorProvider<?>> getInterceptors(Map<String, Object> config)
                 new InterceptorProvider<>(AbstractResponse.class, new ResponseLoggerInterceptor())
         );
     }
-
 }

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

@@ -0,0 +1,9 @@
+---
+version: 1.0.1-SNAPSHOT
+title: Virtual SQL Topic
+description: Don't reinvent the wheel to filter and project your messages, just use SQL!
+parent: safeguard
+---
+# Interceptor
+
+Welcome to Logger interceptor!

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

@@ -0,0 +1,26 @@
+package io.conduktor.example.loggerinterceptor;
+
+import org.junit.jupiter.api.Test;
+
+import java.util.Map;
+
+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())
+                .containsExactlyInAnyOrderEntriesOf(Map.of(
+                        "version", "1.0.1-SNAPSHOT",
+                        "title", "Virtual SQL Topic",
+                        "description", "Don't reinvent the wheel to filter and project your messages, just use SQL!",
+                        "parent", "safeguard"
+                ));
+    }
+}