Support SVG icons from Jenkins core

Author: strangelookingnerd

src/main/java/com/jenkinsci/plugins/badge/action/AbstractBadgeAction.java

@@ -30,6 +30,9 @@
 import java.io.IOException;
 import java.io.Serial;
 import java.io.Serializable;
+import java.net.HttpURLConnection;
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.util.UUID;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -136,10 +139,33 @@ public String getIcon() {
             case "text.gif" -> "symbol-document-text";
             case "warning.gif" -> "symbol-status-yellow";
             case "yellow.gif" -> Emojis.getIconClassName("yellow_square");
-            default -> Jenkins.RESOURCE_PATH + "/images/16x16/" + icon;
+            default -> {
+                if (isJenkinsResource(Jenkins.RESOURCE_PATH + "/images/16x16/" + icon)) {
+                    yield Jenkins.RESOURCE_PATH + "/images/16x16/" + icon;
+                } else if (isJenkinsResource(Jenkins.RESOURCE_PATH + "/images/svgs/" + icon)) {
+                    yield Jenkins.RESOURCE_PATH + "/images/svgs/" + icon;
+                } else {
+                    LOGGER.log(Level.WARNING, () -> "Icon '" + icon + "' not found as Jenkins resource");
+                    yield icon;
+                }
+            }
         };
     }
 
+    private static boolean isJenkinsResource(String iconPath) {
+        try {
+            String url = Jenkins.get().getRootUrl() + iconPath;
+            HttpURLConnection conn = (HttpURLConnection) new URI(url).toURL().openConnection();
+            conn.setRequestMethod("HEAD");
+            conn.setConnectTimeout(3000);
+            conn.setReadTimeout(3000);
+            return conn.getResponseCode() == 200;
+        } catch (IOException | URISyntaxException ex) {
+            LOGGER.log(Level.WARNING, ex, () -> "Unable to validate Jenkins resource '" + iconPath + "'.");
+            return false;
+        }
+    }
+
     @Whitelisted
     public void setText(String text) {
         this.text = text;

src/main/resources/com/jenkinsci/plugins/badge/dsl/AddBadgeStep/help-icon.html

@@ -24,13 +24,13 @@
     </p>
 
     <p>
-        The plugin also supports the <a href="https://github.com/jenkinsci/jenkins/tree/master/war/src/main/webapp/images/16x16">16x16 icons</a> that are offered by Jenkins.
-        These icons are listed in the <a href="https://plugins.jenkins.io/badge/#plugin-content-icons">plugin documentation</a> and are referenced as "<i>image-name</i>.gif".
-        For example, the following are all valid references to icons included with the plugin:
+        The plugin also supports the <a href="https://github.com/jenkinsci/jenkins/tree/master/war/src/main/webapp/images/16x16">16x16 icons</a> as well as the <a href="https://github.com/jenkinsci/jenkins/tree/master/war/src/main/webapp/images/svgs">SVG icons</a> that are offered by Jenkins.
+        For example, the following are all valid references to icons included by Jenkins:
         <ul>
             <li><code>addBadge icon: 'aborted.gif', text: 'This is a aborted symbol'</code></li>
             <li><code>addBadge icon: 'folder-open.gif', text: 'This is a folder icon'</code></li>
             <li><code>addBadge icon: 'document_edit.gif', text: 'This is a document icon'</code></li>
+            <li><code>addBadge icon: 'error.svg', text: 'This is an error'</code></li>
         </ul>
     </p>
 </div>

src/main/resources/com/jenkinsci/plugins/badge/dsl/AddSummaryStep/help-icon.html

@@ -24,13 +24,13 @@
     </p>
 
     <p>
-        The plugin includes icons as GIF images and also supports the <a href="https://github.com/jenkinsci/jenkins/tree/master/war/src/main/webapp/images/16x16">16x16 icons</a> that are offered by Jenkins.
-        These icons are listed in the <a href="https://plugins.jenkins.io/badge/#plugin-content-icons">plugin documentation</a> and are referenced as "<i>image-name</i>.gif".
-        For example, the following are all valid references to icons that can be used with the plugin:
+        The plugin also supports the <a href="https://github.com/jenkinsci/jenkins/tree/master/war/src/main/webapp/images/16x16">16x16 icons</a> as well as the <a href="https://github.com/jenkinsci/jenkins/tree/master/war/src/main/webapp/images/svgs">SVG icons</a> that are offered by Jenkins.
+        For example, the following are all valid references to icons included by Jenkins:
         <ul>
             <li><code>addSummary icon: 'aborted.gif', text: 'This is a aborted symbol'</code></li>
             <li><code>addSummary icon: 'folder-open.gif', text: 'This is a folder icon'</code></li>
             <li><code>addSummary icon: 'document_edit.gif', text: 'This is a document icon'</code></li>
+            <li><code>addSummary icon: 'error.svg', text: 'This is an error'</code></li>
         </ul>
     </p>
 </div>

src/test/java/com/jenkinsci/plugins/badge/action/AbstractBadgeActionTest.java

@@ -79,9 +79,6 @@ void icon() {
         action.setIcon("");
         assertThat(action.getIcon(), emptyString());
 
-        action.setIcon("icon.png");
-        assertThat(action.getIcon(), is(Jenkins.RESOURCE_PATH + "/images/16x16/icon.png"));
-
         action.setIcon("/relative/url/icon.png");
         assertThat(action.getIcon(), is("/relative/url/icon.png"));
 
@@ -126,8 +123,21 @@ void icon() {
         action.setIcon("yellow.gif");
         assertThat(action.getIcon(), is(Emojis.getIconClassName("yellow_square")));
 
+        // does not exist in core
+        action.setIcon("icon.png");
+        assertThat(action.getIcon(), is("icon.png"));
+
+        // core resource in 16x16
         action.setIcon("blue.gif");
         assertThat(action.getIcon(), is(Jenkins.RESOURCE_PATH + "/images/16x16/blue.gif"));
+
+        // core resource in svgs
+        action.setIcon("error.svg");
+        assertThat(action.getIcon(), is(Jenkins.RESOURCE_PATH + "/images/svgs/error.svg"));
+
+        // can not be validated
+        action.setIcon("[/]");
+        assertThat(action.getIcon(), is("[/]"));
     }
 
     @Test