Merge pull request #65 from jenkinsci/messages-view

Add a new detail view that shows info and error messages

Author: uhafner

package-lock.json

@@ -0,0 +1,97 @@
+package io.jenkins.plugins.bootstrap5;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+
+import hudson.model.ModelObject;
+import hudson.model.Run;
+
+/**
+ * A view model to visualize logging messages and errors of a build step.
+ *
+ * @author Ullrich Hafner
+ */
+@SuppressWarnings("PMD.DataClass")
+public class MessagesViewModel implements ModelObject {
+    private final Run<?, ?> owner;
+    private final List<String> errorMessages;
+    private final List<String> infoMessages;
+    private final String displayName;
+
+    /**
+     * Creates a new {@link MessagesViewModel} with info messages only.
+     *
+     * @param owner
+     *         current build as owner of this view
+     * @param displayName
+     *         display name of the step
+     * @param infoMessages
+     *         all info messages that should be shown (should not be empty)
+     */
+    public MessagesViewModel(final Run<?, ?> owner, final String displayName,
+            final List<String> infoMessages) {
+        this(owner, displayName, infoMessages, Collections.emptyList());
+    }
+
+    /**
+     * Creates a new {@link MessagesViewModel} with error and info messages.
+     *
+     * @param owner
+     *         current build as owner of this view
+     * @param displayName
+     *         display name of the step
+     * @param infoMessages
+     *         all info messages that should be shown (should not be empty)
+     * @param errorMessages
+     *         all error messages that should be shown (might be empty)
+     */
+    public MessagesViewModel(final Run<?, ?> owner, final String displayName,
+            final List<String> infoMessages, final List<String> errorMessages) {
+        this.owner = owner;
+        this.errorMessages = asImmutableList(errorMessages);
+        this.infoMessages = asImmutableList(infoMessages);
+
+        this.displayName = displayName + " - " + Messages.Messages_View_Name();
+    }
+
+    private List<String> asImmutableList(final List<String> elements) {
+        return Collections.unmodifiableList(new ArrayList<>(elements));
+    }
+
+    /**
+     * Returns the build as owner of this view model.
+     *
+     * @return the owner
+     */
+    public final Run<?, ?> getOwner() {
+        return owner;
+    }
+
+    @Override
+    public String getDisplayName() {
+        return displayName;
+    }
+
+    /**
+     * Returns the information messages of the step.
+     *
+     * @return the information messages
+     */
+    @SuppressWarnings("unused") // Called by jelly view
+    public Collection<String> getInfoMessages() {
+        return infoMessages;
+    }
+
+    /**
+     * Returns the error messages of the step.
+     *
+     * @return the error messages
+     */
+    @SuppressWarnings("unused") // Called by jelly view
+    public Collection<String> getErrorMessages() {
+        return errorMessages;
+    }
+}
+

src/main/java/io/jenkins/plugins/bootstrap5/MessagesViewModel.java

@@ -0,0 +1 @@
+Messages.View.Name=Messages

src/main/resources/io/jenkins/plugins/bootstrap5/Messages.properties

@@ -0,0 +1,49 @@
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:bs="/bootstrap5">
+
+  <st:header name="Content-Type" value="text/html;charset=UTF-8"/>
+
+  <bs:page it="${it}">
+
+    <j:if test="${size(errors) > 0}">
+      <div class="row py-3">
+        <div class="col">
+          <bs:card title="${%Error Messages}" fontAwesomeIcon="exclamation-triangle">
+
+            <pre>
+              <samp id="errors" class="log-output">
+                <j:forEach var="message" items="${it.errorMessages}">
+                  <div>
+                    ${message}
+                  </div>
+                </j:forEach>
+              </samp>
+            </pre>
+
+          </bs:card>
+        </div>
+      </div>
+    </j:if>
+
+    <div class="row py-3">
+      <div class="col">
+
+        <bs:card title="${%Information Messages}" fontAwesomeIcon="info-circle">
+
+          <pre>
+            <samp id="info" class="log-output">
+              <j:forEach var="message" items="${it.infoMessages}">
+                <div>
+                  ${message}
+                </div>
+              </j:forEach>
+            </samp>
+          </pre>
+        </bs:card>
+
+      </div>
+    </div>
+
+  </bs:page>
+
+</j:jelly>

src/main/resources/io/jenkins/plugins/bootstrap5/MessagesViewModel/index.jelly

@@ -26,6 +26,18 @@ pre {
     color: var(--text-color);
 }
 
+.log-output {
+    font-size: var(--font-size-sm);
+}
+
+.info-page-decorator {
+    fill: #b4b4b4;
+    height: 16px;
+    width: 16px;
+    vertical-align: text-bottom;
+    margin-left: 0.2em;
+}
+
 /* ------------------------------------------------------------------------------------------------------------------- */
 /* Bootstrap Carousel                                                                                                  */
 /* ------------------------------------------------------------------------------------------------------------------- */