feat(core): add icon for group and sub-group of plugins

cli/src/test/java/io/kestra/cli/commands/plugins/PluginDocCommandTest.java

@@ -56,18 +56,19 @@ void run() throws IOException, URISyntaxException {
             assertThat(directory.listFiles().length, is(3));
 
             var readme = directory.toPath().resolve("README.md");
-            assertThat(new String(Files.readAllBytes(readme)), is("---\n" +
+            assertThat(new String(Files.readAllBytes(readme)), containsString("---\n" +
                 "title: Plugin template test\n" +
-                "editLink: false\n" +
+                "editLink: false\n\n" +
                 "---\n" +
                 "# Plugin template test\n" +
                 "\n" +
                 "Plugin template for Kestra\n" +
                 "\n" +
                 "This is a more complex description of the plugin.\n" +
                 "\n" +
-                "This is in markdown and will be inline inside the plugin page.\n" +
-                "## Subgroup title\n" +
+                "This is in markdown and will be inline inside the plugin page.\n"));
+            assertThat(new String(Files.readAllBytes(readme)), containsString(
+                "Subgroup title\n" +
                 "    \n" +
                 "Subgroup description\n" +
                 "### Tasks\n" +

core/src/main/java/io/kestra/core/docs/DocumentationGenerator.java

@@ -103,14 +103,18 @@ private static List<Document> index(RegisteredPlugin plugin) throws IOException
             builder.put("classPlugins", pluginDocumentation.getClassPlugins());
         }
 
+        if (pluginDocumentation.getIcon() != null) {
+            builder.put("icon", pluginDocumentation.getIcon());
+        }
+
         if(!plugin.getGuides().isEmpty()) {
             builder.put("guides", plugin.getGuides());
         }
 
         return Collections.singletonList(new Document(
             docPath(plugin),
             render("index", builder.build()),
-            null
+            pluginDocumentation.getIcon()
         ));
     }
 
@@ -187,6 +191,18 @@ public static String icon(RegisteredPlugin plugin, Class<?> cls ) {
         return null;
     }
 
+    @SneakyThrows
+    public static String icon(RegisteredPlugin plugin, String iconName) {
+        InputStream resourceAsStream = plugin.getClassLoader().getResourceAsStream("icons/" + iconName + ".svg");
+        if (resourceAsStream != null) {
+            return Base64.getEncoder().encodeToString(
+                IOUtils.toString(resourceAsStream, Charsets.UTF_8).getBytes(StandardCharsets.UTF_8)
+            );
+        }
+
+        return null;
+    }
+
     private static <T> String docPath(RegisteredPlugin registeredPlugin) {
         String pluginName = Slugify.of(registeredPlugin.title());
 

core/src/main/java/io/kestra/core/docs/PluginDocumentation.java

@@ -19,13 +19,15 @@
 public class PluginDocumentation {
     private String title;
     private String group;
+    private String icon;
     private Map<SubGroup, Map<String, List<ClassPlugin>>> classPlugins;
 
     private Map<String, String> guides;
 
     private PluginDocumentation(RegisteredPlugin plugin) {
         this.title = plugin.title();
         this.group = plugin.group();
+        this.icon = DocumentationGenerator.icon(plugin, "plugin-icon");
 
         this.classPlugins = plugin.allClassGrouped()
             .entrySet()
@@ -46,7 +48,8 @@ private PluginDocumentation(RegisteredPlugin plugin) {
                         var subGroupDescription = pluginSubGroup != null ? pluginSubGroup.description() : null;
                         // hack to avoid adding the subgroup in the task URL when it's the group to keep search engine indexes
                         var subgroupIsGroup = cls.getPackageName().length() <= this.group.length();
-                        var subgroup = new SubGroup(subGroupName, subGroupTitle, subGroupDescription, subgroupIsGroup);
+                        var subGroupIcon = DocumentationGenerator.icon(plugin, cls.getPackageName());
+                        var subgroup = new SubGroup(subGroupName, subGroupTitle, subGroupDescription, subGroupIcon, subgroupIsGroup);
                         builder.subgroup(subgroup);
                     } else {
                         // should never occur
@@ -89,6 +92,7 @@ public static class SubGroup implements Comparable<SubGroup>{
         String name;
         String title;
         String description;
+        String icon;
 
         boolean subgroupIsGroup;
 

core/src/main/resources/docs/index.hbs

@@ -1,18 +1,19 @@
 ---
 title: {{ capitalizeFirst (replace title "-" " ") }}
 editLink: false
+{{#if icon}}icon: {{ icon }}{{~/if}}
 ---
-# {{ capitalizeFirst (replace title "-" " ") }}
+# {{#if icon ~}}<img width="25" src="data:image/svg+xml;base64,{{icon}}" /> {{/if }}{{ capitalizeFirst (replace title "-" " ") }}
 
 {{ description }}
 
 {{ longDescription }}
 
 {{~#each classPlugins }}
     {{~#if @key.title}}
-## {{ @key.title }}
+## {{#if @key.icon ~}}<img width="25" src="data:image/svg+xml;base64,{{@key.icon}}" /> {{/if }}{{ @key.title }}
     {{else}}
-## {{ @key.name }}
+##  {{#if @key.icon ~}}<img width="25" src="data:image/svg+xml;base64,{{@key.icon}}" /> {{/if }}{{ @key.name }}
     {{/if}}
 {{ @key.description }}
 

core/src/test/java/io/kestra/core/docs/DocumentationGeneratorTest.java

@@ -20,14 +20,16 @@
 import jakarta.inject.Inject;
 
 import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.containsString;
-import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.*;
 
 @MicronautTest
 class DocumentationGeneratorTest {
     @Inject
     JsonSchemaGenerator jsonSchemaGenerator;
 
+    @Inject
+    DocumentationGenerator documentationGenerator;
+
     @Test
     void tasks() throws URISyntaxException, IOException {
         Path plugins = Paths.get(Objects.requireNonNull(ClassPluginDocumentationTest.class.getClassLoader().getResource("plugins")).toURI());
@@ -106,4 +108,15 @@ void echo() throws IOException {
         assertThat(render, containsString("Echo"));
         assertThat(render, containsString("- \uD83D\uDD12 Deprecated"));
     }
+
+    @Test
+    void pluginDoc() throws IOException, URISyntaxException {
+        PluginScanner pluginScanner = new PluginScanner(ClassPluginDocumentationTest.class.getClassLoader());
+        RegisteredPlugin core = pluginScanner.scan();
+
+        List<Document> docs = documentationGenerator.generate(core);
+        Document doc = docs.get(0);
+        assertThat(doc.getIcon(), is(notNullValue()));
+        assertThat(doc.getBody(), containsString("##  <img width=\"25\" src=\"data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB3aWR0aD0iMzIiIGhlaWdodD0iMzIiCiAgICAgcHJlc2VydmVBc3BlY3RSYXRpbz0ieE1pZFlNaWQgbWVldCIgdmlld0JveD0iMCAwIDMyIDMyIgogICAgIHN0eWxlPSItbXMtdHJhbnNmb3JtOiByb3RhdGUoMzYwZGVnKTsgLXdlYmtpdC10cmFuc2Zvcm06IHJvdGF0ZSgzNjBkZWcpOyB0cmFuc2Zvcm06IHJvdGF0ZSgzNjBkZWcpOyI+CiAgICA8ZGVmcy8+CiAgICA8cGF0aCBkPSJNMjAgMjRoLTR2Mmg0djNoOHYtOGgtOHptMi0xaDR2NGgtNHoiIGZpbGw9IiMwRDE1MjMiLz4KICAgIDxwYXRoIGQ9Ik00IDIwdjJoNC41ODZMMiAyOC41ODZMMy40MTQgMzBMMTAgMjMuNDE0VjI4aDJ2LThINHoiIGZpbGw9IiMwRDE1MjMiLz4KICAgIDxwYXRoCiAgICAgICAgZD0iTTI0IDVhMy45OTYgMy45OTYgMCAwIDAtMy44NTggM0gxNHYyaDYuMTQyYTMuOTQgMy45NCAwIDAgMCAuNDI1IDEuMDE5TDE0IDE3LjU4NkwxNS40MTQgMTlsNi41NjctNi41NjdBMy45NTIgMy45NTIgMCAwIDAgMjQgMTNhNCA0IDAgMCAwIDAtOHptMCA2YTIgMiAwIDEgMSAyLTJhMi4wMDIgMi4wMDIgMCAwIDEtMiAyeiIKICAgICAgICBmaWxsPSIjMEQxNTIzIi8+CiAgICA8cGF0aCBkPSJNOS42OTMgMTIuNzVhNSA1IDAgMCAxIDAtNy41bDEuMzI0IDEuNWEzIDMgMCAwIDAgMCA0LjUwMXoiIGZpbGw9IiMwRDE1MjMiLz4KICAgIDxwYXRoIGQ9Ik03LjA0NyAxNS43NTFhOSA5IDAgMCAxIDAtMTMuNTAxbDEuMzI0IDEuNWE3IDcgMCAwIDAgMCAxMC41MDF6IiBmaWxsPSIjMEQxNTIzIi8+Cjwvc3ZnPg==\" /> flows"));
+    }
 }