Merge pull request #365 from jenkinsci/info-messages

Add a new detail view that shows info and error messages

Author: uhafner

pom.xml

@@ -30,9 +30,9 @@
     <plugin-util-api.version>2.5.1</plugin-util-api.version>
     <data-tables-api.version>1.11.3-4</data-tables-api.version>
     <jquery3-api.version>3.6.0-2</jquery3-api.version>
-    <font-awesome-api.version> 5.15.4-1</font-awesome-api.version>
+    <font-awesome-api.version>5.15.4-3</font-awesome-api.version>
+    <bootstrap5-api.version>5.1.3-3</bootstrap5-api.version>
     <echarts-api.version>5.2.2-1</echarts-api.version>
-    <bootstrap5-api.version>5.1.3-1</bootstrap5-api.version>
 
   </properties>
 

src/main/java/io/jenkins/plugins/forensics/reference/ReferenceBuild.java

@@ -10,9 +10,11 @@
 import edu.hm.hafner.util.VisibleForTesting;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 
+import org.kohsuke.stapler.StaplerProxy;
 import hudson.model.Run;
 import jenkins.model.RunAction2;
 
+import io.jenkins.plugins.bootstrap5.MessagesViewModel;
 import io.jenkins.plugins.util.JenkinsFacade;
 
 import static j2html.TagCreator.*;
@@ -24,7 +26,7 @@
  * @author Ullrich Hafner
  * @see ReferenceRecorder
  */
-public class ReferenceBuild implements RunAction2, Serializable {
+public class ReferenceBuild implements RunAction2, Serializable, StaplerProxy {
     private static final long serialVersionUID = -4549516129641755356L;
 
     /**
@@ -33,6 +35,8 @@ public class ReferenceBuild implements RunAction2, Serializable {
      */
     public static final String NO_REFERENCE_BUILD = "-";
 
+    static final String REFERENCE_DETAILS_URL = "reference";
+
     /**
      * Returns a link that can be used in Jelly views to navigate to the reference build.
      *
@@ -182,6 +186,16 @@ public String getIconFileName() {
 
     @Override
     public String getUrlName() {
-        return null;
+        return REFERENCE_DETAILS_URL;
+    }
+
+    /**
+     * Returns the detail view for the messages captured during the computation of the reference build.
+     *
+     * @return the detail view for the messages
+     */
+    @Override
+    public Object getTarget() {
+        return new MessagesViewModel(getOwner(), Messages.Messages_DisplayName(), messages);
     }
 }

src/main/java/io/jenkins/plugins/forensics/reference/ReferenceRecorder.java

@@ -108,6 +108,7 @@ public String getDefaultBranch() {
      * @param targetBranch
      *         the name of the default branch
      */
+    @DataBoundSetter
     public void setTargetBranch(final String targetBranch) {
         this.defaultBranch = StringUtils.stripToEmpty(targetBranch);
     }

src/main/resources/io/jenkins/plugins/forensics/reference/Messages.properties

@@ -1,2 +1,3 @@
 Recorder.DisplayName=Discover reference build
+Messages.DisplayName=Reference build
 FieldValidator.Error.ReferenceJobDoesNotExist=There is no such job - maybe the job has been renamed?

src/main/resources/io/jenkins/plugins/forensics/reference/ReferenceBuild/summary.jelly

@@ -1,25 +1,19 @@
 <?jelly escape-by-default='true'?>
-<j:jelly xmlns:j="jelly:core" xmlns:t="/lib/hudson">
+<j:jelly xmlns:j="jelly:core" xmlns:t="/lib/hudson"  xmlns:fa="/font-awesome">
 
   <t:summary icon="/plugin/forensics-api/icons/crosshair.svg">
 
       <j:choose>
         <j:when test="${it.hasReferenceBuild()}">
-          ${%Reference.Build.Found}
+          ${%reference.found}
+          <fa:image-button label="${%Open log messages}" name="info-circle" tooltip="${%icon.info.tooltip}" url="reference" />
           <ul>
             <li><j:out value="${it.referenceLink}"/></li>
-            <j:forEach var="message" items="${it.messages}">
-              <li>${message}</li>
-            </j:forEach>
           </ul>
         </j:when>
         <j:otherwise>
-          ${%No.Reference.Build}
-          <ul>
-            <j:forEach var="message" items="${it.messages}">
-                <li>${message}</li>
-            </j:forEach>
-          </ul>
+          ${%reference.notFound}
+          <fa:image-button label="${%Open error messages}" name="exclamation-triangle" tooltip="${%icon.error.tooltip}" url="reference" class="fa-image-button-warning"/>
         </j:otherwise>
 
       </j:choose>

src/main/resources/io/jenkins/plugins/forensics/reference/ReferenceBuild/summary.properties

@@ -1,2 +1,4 @@
-Reference.Build.Found=Reference build for delta reports
-No.Reference.Build=No reference build found
+reference.found=Reference build for delta reports
+reference.notFound=No reference build found
+icon.error.tooltip=Some errors have been logged while searching for the reference build, click to see these errors in a details view.
+icon.info.tooltip=Click to see all logging messages while searching for the reference build.

src/test/java/io/jenkins/plugins/forensics/reference/ReferenceBuildTest.java

@@ -8,6 +8,7 @@
 
 import hudson.model.Run;
 
+import io.jenkins.plugins.bootstrap5.MessagesViewModel;
 import io.jenkins.plugins.util.JenkinsFacade;
 
 import static io.jenkins.plugins.forensics.assertions.Assertions.*;
@@ -32,7 +33,6 @@ void shouldAttachBuild() {
         Run<?, ?> newBuild = mock(Run.class);
         referenceBuild.onAttached(newBuild);
         assertThat(referenceBuild).hasOwner(newBuild);
-
         referenceBuild.onLoad(currentBuild);
         assertThat(referenceBuild).hasOwner(currentBuild);
     }
@@ -47,12 +47,20 @@ void shouldHandleMissingReferenceBuild() {
         assertThat(referenceBuild).hasOnlyMessages(MESSAGES);
         assertThat(referenceBuild).hasOwner(currentBuild);
         assertThat(referenceBuild).hasReferenceBuildId(ReferenceBuild.NO_REFERENCE_BUILD);
-        assertThat(referenceBuild).hasReferenceLink("Reference build '-' not found anymore - maybe the build has been renamed or deleted?");
+        assertThat(referenceBuild).hasReferenceLink(
+                "Reference build '-' not found anymore - maybe the build has been renamed or deleted?");
         assertThat(referenceBuild.getReferenceBuild()).isEmpty();
 
         assertThat(referenceBuild.getIconFileName()).isNull();
         assertThat(referenceBuild.getDisplayName()).isNull();
-        assertThat(referenceBuild.getUrlName()).isNull();
+        assertThat(referenceBuild.getUrlName()).isEqualTo(ReferenceBuild.REFERENCE_DETAILS_URL);
+
+        assertThat(referenceBuild.getTarget()).isInstanceOfSatisfying(MessagesViewModel.class,
+                model -> {
+                    assertThat(model.getDisplayName()).isEqualTo("Reference build - Messages");
+                    assertThat(model.getErrorMessages()).isEmpty();
+                    assertThat(model.getInfoMessages()).containsAll(MESSAGES);
+                });
     }
 
     @Test
@@ -70,7 +78,7 @@ void shouldHandleValidReferenceBuild() {
 
         assertThat(referenceBuild.getIconFileName()).isNull();
         assertThat(referenceBuild.getDisplayName()).isNull();
-        assertThat(referenceBuild.getUrlName()).isNull();
+        assertThat(referenceBuild.getUrlName()).isEqualTo(ReferenceBuild.REFERENCE_DETAILS_URL);
     }
 
     @Test
@@ -94,7 +102,6 @@ void shouldHandleValidReferenceBuildId() {
 
         assertThat(referenceBuild.getIconFileName()).isNull();
         assertThat(referenceBuild.getDisplayName()).isNull();
-        assertThat(referenceBuild.getUrlName()).isNull();
+        assertThat(referenceBuild.getUrlName()).isEqualTo(ReferenceBuild.REFERENCE_DETAILS_URL);
     }
-
 }