Add support for icon on sidebar report action

README.md

@@ -37,6 +37,7 @@ Clicking _Publishing options..._ will present you with some additional options:
 * Allow missing report - if `false`, build will be marked as failed if the report directory does not exist.
 * Include files - Optional Ant pattern that specifies what files in the report directory to archive. Defaults to archiving all files in the given report directory.
 * Escape underscores in Report Title - if `true`, underscores in report titles will be escaped to `_5F` along with other non-alphanumeric characters. If `false` they will be left as is.
+* Icon - Optional icon to use for the report. If not provided, a default icon will be used. The icon can be an existing `symbol` or an icon from the reportDir
 
 #### Using with Pipeline Jobs
 

src/main/java/htmlpublisher/HtmlPublisherTarget.java

@@ -75,6 +75,11 @@
      */
     private final boolean allowMissing;
 
+    /**
+     *  The path or symbol of an icon to use for the HTML report in the sidebar (relative to reportDir)
+     */
+    private String icon;
+
     /**
      * Do not use, but keep to maintain compatibility with older releases. See JENKINS-31366.
      */
@@ -162,6 +167,15 @@
         }
     }
 
+    public String getIcon() {
+        return icon;
+    }
+
+    @DataBoundSetter
+    public void setIcon(String icon) {
+        this.icon = StringUtils.trim(icon);
+    }
+
     @DataBoundSetter
     public void setEscapeUnderscores(boolean escapeUnderscores) {
         this.escapeUnderscores = escapeUnderscores;
@@ -266,7 +280,18 @@
         }
 
         public String getIconFileName() {
-            return dir().exists() ? "symbol-document-text" : null;
+            String icon;
+            if (StringUtils.isNotBlank(actualHtmlPublisherTarget.icon)) {
+                if (actualHtmlPublisherTarget.icon.startsWith("symbol-")) {
+                    icon = actualHtmlPublisherTarget.icon;
+                }
+                else {
+                    icon = project.getUrl() + dir().getName() + "/" + actualHtmlPublisherTarget.icon;
+                }
+            } else {
+                icon = "symbol-document-text";
+            }
+            return dir().exists() ? icon : null;
         }
 
         public String getBackToName() {

src/main/resources/htmlpublisher/HtmlPublisherTarget/config.jelly

@@ -43,5 +43,8 @@
     <f:entry field="numberOfWorkers" title="${%numberOfWorkers.title}">
       <f:number/>
     </f:entry>
+    <f:entry field="icon" title="${%icon.title}">
+      <f:textbox />
+    </f:entry>
   </f:advanced>
 </j:jelly>

src/main/resources/htmlpublisher/HtmlPublisherTarget/config.properties

@@ -9,4 +9,5 @@ alwaysLinkToLastBuild.title=Always link to last build
 allowMissing.title=Allow missing report
 escapeUnderscores.title=Escape underscores in Report Title
 useWrapperFileDirectly.title=Use the legacy wrapper file
-numberOfWorkers.title=Number of workers
+numberOfWorkers.title=Number of workers
+icon.title=Icon

src/main/resources/htmlpublisher/HtmlPublisherTarget/help-icon.html

@@ -0,0 +1,3 @@
+<div>
+    The path of an icon or symbol to use for the HTML report (relative to reportDir)
+</div>

src/test/java/htmlpublisher/HtmlPublisherIntegrationTest.java

@@ -312,6 +312,33 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListen
         assertFalse("reportnameB/htmlpublisher-wrapper.html must not exist", new File(build.getRootDir(), "htmlreports/reportnameB/htmlpublisher-wrapper.html").exists());
     }
 
+    @Test
+    public void testIcon() throws Exception {
+        FreeStyleProject p = j.createFreeStyleProject("variable_job");
+        p.getBuildersList().add(new TestBuilder() {
+            public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListener listener) throws InterruptedException, IOException {
+                FilePath ws = build.getWorkspace();
+                ws.child("dirA").child("file1.html").write("hello", "UTF-8");
+                ws.child("dirA").child("file2.html").write("hello", "UTF-8");
+                return true;
+            }
+        });
+        HtmlPublisherTarget target1 = new HtmlPublisherTarget("reportnameB", "dirB", "", true, true, true);
+        target1.setIcon("symbol-cube");
+        HtmlPublisherTarget target2 = new HtmlPublisherTarget("reportnameA", "dirA", "", true, true, false);
+        target2.setIcon("symbol-build");
+
+        List<HtmlPublisherTarget> targets = new ArrayList<>();
+        targets.add(target1);
+        targets.add(target2);
+        p.getPublishersList().add(new HtmlPublisher(targets));
+        AbstractBuild build = j.buildAndAssertSuccess(p);
+        assertTrue("reportnameA/htmlpublisher-wrapper.html must exist", new File(build.getRootDir(), "htmlreports/reportnameA/htmlpublisher-wrapper.html").exists());
+        assertTrue("reportnameA/file1.html must exist", new File(build.getRootDir(), "htmlreports/reportnameA/file1.html").exists());
+        assertTrue("reportnameA/file2.html must exist", new File(build.getRootDir(), "htmlreports/reportnameA/file2.html").exists());
+        assertFalse("reportnameB/htmlpublisher-wrapper.html must not exist", new File(build.getRootDir(), "htmlreports/reportnameB/htmlpublisher-wrapper.html").exists());
+    }
+
     @Test
     public void testPublishesTwoReportsOneJob() throws Exception {
         FreeStyleProject p = j.createFreeStyleProject("variable_job");