Merge pull request #40 from jenkinsci/JENKINS-72561

[JENKINS-72561] Fix sidepanel.jelly not being loaded when build/project is not available (plug-ins, folders, etc.)
jenkinsci · Aug 15, 2024 · a85e687 · a85e687
2 parents 1ca2733 + 2771d9e
commit a85e687
Show file tree

Hide file tree

Showing 7 changed files with 99 additions and 97 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@ test-output/
 .project
 **/*~
 .idea
+*.iml
diff --git a/src/main/java/org/tap4j/plugin/TapResult.java b/src/main/java/org/tap4j/plugin/TapResult.java
@@ -30,6 +30,9 @@
 import org.apache.commons.codec.binary.Base64;
 import org.apache.commons.lang.BooleanUtils;
 import org.apache.commons.lang.StringUtils;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
+import org.kohsuke.stapler.Stapler;
 import org.kohsuke.stapler.StaplerRequest;
 import org.kohsuke.stapler.StaplerResponse;
 import org.kohsuke.stapler.export.Exported;
@@ -47,6 +50,7 @@
 import org.tap4j.plugin.util.DiagnosticUtil;
 import org.tap4j.plugin.util.Util;
 
+import javax.annotation.CheckForNull;
 import javax.annotation.Nullable;
 import javax.servlet.ServletOutputStream;
 import java.io.File;
@@ -240,6 +244,16 @@ public void setOwner(Run<?, ?> owner) {
         this.build = owner;
     }
 
+    @Restricted(NoExternalUse.class) // only used from stapler/jelly
+    @CheckForNull
+    public Run<?,?> getOwningRun() {
+        StaplerRequest req = Stapler.getCurrentRequest();
+        if (req == null) {
+            return null;
+        }
+        return req.findAncestorObject(Run.class);
+    }
+
     public List<TestSetMap> getTestSets() {
         return this.testSets;
     }

diff --git a/src/main/java/org/tap4j/plugin/TapTestResultAction.java b/src/main/java/org/tap4j/plugin/TapTestResultAction.java
@@ -30,7 +30,6 @@
 import hudson.model.HealthReportingAction;
 import hudson.model.Job;
 import hudson.model.Run;
-import hudson.tasks.junit.CaseResult;
 import jenkins.model.RunAction2;
 import jenkins.tasks.SimpleBuildStep;
 import jenkins.util.NonLocalizable;
@@ -40,7 +39,6 @@
 
 import java.util.Collection;
 import java.util.Collections;
-import java.util.List;
 
 
 /**
@@ -92,13 +90,6 @@ public int getSkipCount() {
         return tapResult.getSkipped();
     }
 
-    /* (non-Javadoc)
-     * @see hudson.tasks.test.AbstractTestResultAction#getFailedTests()
-     */
-    public List<CaseResult> getFailedTests() {
-        return Collections.emptyList();
-    }
-
     /*
      * (non-Javadoc)
      * @see org.kohsuke.stapler.StaplerProxy#getTarget()

diff --git a/src/main/resources/org/tap4j/plugin/TapProjectAction/floatingBox.jelly b/src/main/resources/org/tap4j/plugin/TapProjectAction/floatingBox.jelly
@@ -1,5 +1,5 @@
 <?jelly escape-by-default='true'?>
-<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form" xmlns:i="jelly:fmt" xmlns:local="local">
+<j:jelly xmlns:j="jelly:core">
     <j:if test="${from.graphActive}">
       <div class="test-trend-caption">
          ${from.graphName}

diff --git a/src/main/resources/org/tap4j/plugin/TapProjectAction/nodata.jelly b/src/main/resources/org/tap4j/plugin/TapProjectAction/nodata.jelly
@@ -1,9 +1,10 @@
 <?jelly escape-by-default='true'?>
-<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler"
-    xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson"
-    xmlns:f="/lib/form" xmlns:i="jelly:fmt">
-    <l:layout>
-        <st:include it="${it.project}" page="sidepanel.jelly"/>
+<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:l="/lib/layout">
+    <l:layout title="">
+        <j:set var="project" value="${it.project}" />
+        <j:if test="${project != null}">
+            <st:include it="${project}" page="sidepanel.jelly" optional="true" />
+        </j:if>
         <l:main-panel>
              <h1>${%header}</h1>
              <h2>${%description}</h2>

diff --git a/src/main/resources/org/tap4j/plugin/TapResult/contents.jelly b/src/main/resources/org/tap4j/plugin/TapResult/contents.jelly
@@ -1,12 +1,4 @@
 <?jelly escape-by-default='true'?>
-<j:jelly
-    xmlns:j="jelly:core" 
-    xmlns:st="jelly:stapler"
-    xmlns:d="jelly:define" 
-    xmlns:l="/lib/layout" 
-    xmlns:t="/lib/hudson"
-    xmlns:f="/lib/form" 
-    xmlns:i="jelly:fmt" 
-    xmlns:tap="/org/tap4j/plugin/tags">
+<j:jelly xmlns:j="jelly:core">
 <pre>${it.getContents(request.getParameter("f"))}</pre>
 </j:jelly>
diff --git a/src/main/resources/org/tap4j/plugin/TapResult/index.jelly b/src/main/resources/org/tap4j/plugin/TapResult/index.jelly
@@ -2,84 +2,87 @@
 <j:jelly
     xmlns:j="jelly:core" 
     xmlns:st="jelly:stapler"
-	xmlns:d="jelly:define" 
-	xmlns:l="/lib/layout" 
-	xmlns:t="/lib/hudson"
-	xmlns:f="/lib/form" 
-	xmlns:i="jelly:fmt" 
+	xmlns:l="/lib/layout"
 	xmlns:tap="/org/tap4j/plugin/tags">
-	<l:layout norefresh="true" css="/plugin/tap/css/tap.css">
-		<st:include it="${it.owner}" page="sidepanel.jelly" />
-		<l:main-panel>
-
-			<h1>TAP Extended Test Results</h1>
-
-			<j:choose>
-				<j:when test="${it.isEmptyTestSet()}">
-					<p>Empty test set</p>
-				</j:when>
-				<j:otherwise>
-				    ${it.updateStats()}
-				    <table width='100%'>
-				        <tr>
-				            <td width='5%'>${it.testSets.size()} files</td>
-				            <td>${it.getTotal()} tests, ${it.passed} ok, ${it.failed} not ok, ${it.skipped} skipped, ${it.toDo} ToDo, ${it.bailOuts} Bail Out!</td>
-				        </tr>
-				    </table>
-
-				    <j:if test="${it.showOnlyFailures}">
-				    	<p><strong>Note:</strong> Displaying only failures</p>
-				    </j:if>
+	<l:layout title="TAP Extended Test Results" norefresh="true">
+		<l:header>
+			<link rel="stylesheet" href="${rootURL}/plugin/tap/css/tap.css" />
+		</l:header>
+	    <j:set var="build" value="${it.owningRun}" />
+	    <j:if test="${build != null}">
+		    <st:include it="${build}" page="sidepanel.jelly" optional="true" />
 
-					<j:forEach var="map" items="${it.testSets}">
-					   <j:choose>
-					     <j:when test="${map.getTestSet().getPlan().isSkip()}">
-						   <p>File: <span class="underline"><a href='${rootURL}/${it.owner.url}artifact/${map.fileName}/*view*/'>${map.fileName}</a></span> (Skipped)</p>
-						 </j:when>
-						 <j:otherwise>
-					       <p>File: <span class="underline"><a href='${rootURL}/${it.owner.url}artifact/${map.fileName}/*view*/'>${map.fileName}</a></span></p>
-						 </j:otherwise>
-					   </j:choose>
-						 <table class="tap" width="100%">
+			<l:main-panel>
+
+				<h1>TAP Extended Test Results</h1>
+
+				<j:choose>
+					<j:when test="${it.isEmptyTestSet()}">
+						<p>Empty test set</p>
+					</j:when>
+					<j:otherwise>
+						${it.updateStats()}
+						<table width='100%'>
 							<tr>
-								<th> </th>
-								<th>Number</th>
-								<th>Description</th>
-								<th>Directive</th>
+								<td width='5%'>${it.testSets.size()} files</td>
+								<td>${it.getTotal()} tests, ${it.passed} ok, ${it.failed} not ok, ${it.skipped} skipped, ${it.toDo} ToDo, ${it.bailOuts} Bail Out!</td>
 							</tr>
-							<j:forEach var="tapLine" items="${map.testSet.tapLines}">
-								<!-- TAP Test Result information -->
-								<tap:line tapLine="${tapLine}" tapFile="${map.fileName}" showOnlyFailures="${it.showOnlyFailures}" />
-							</j:forEach>
 						</table>
-						<br />
-					</j:forEach>
 
-				</j:otherwise>
-			</j:choose>
-
-			<h3><a name="parseErrors">Parse errors</a></h3>
-
-			<j:choose>
-                <j:when test="${it.hasParseErrors() == false}">
-                    <p>No parse errors found</p>
-                </j:when>
-                <j:otherwise>
-                    <table class="tap" width="100%">
-                        <tr>
-                            <th>File name</th>
-                            <th>Cause</th>
-                        </tr>
-                        <j:forEach var="map" items="${it.parseErrorTestSets}">
-                        <tr>
-                            <td><a href='${rootURL}/${it.owner.url}artifact/${map.fileName}/*view*/'>${map.fileName}</a></td>
-                            <td>${map.cause}</td>
-                        </tr>
-                        </j:forEach>
-                     </table>
-                </j:otherwise>
-            </j:choose>
-
-		</l:main-panel>
+						<j:if test="${it.showOnlyFailures}">
+							<p><strong>Note:</strong> Displaying only failures</p>
+						</j:if>
+
+						<j:forEach var="map" items="${it.testSets}">
+						   <j:choose>
+							 <j:when test="${map.getTestSet().getPlan().isSkip()}">
+							   <p>File: <span class="underline"><a href='${rootURL}/${build.url}artifact/${map.fileName}/*view*/'>${map.fileName}</a></span> (Skipped)</p>
+							 </j:when>
+							 <j:otherwise>
+							   <p>File: <span class="underline"><a href='${rootURL}/${build.url}artifact/${map.fileName}/*view*/'>${map.fileName}</a></span></p>
+							 </j:otherwise>
+						   </j:choose>
+							 <table class="tap" width="100%">
+								<tr>
+									<th> </th>
+									<th>Number</th>
+									<th>Description</th>
+									<th>Directive</th>
+								</tr>
+								<j:forEach var="tapLine" items="${map.testSet.tapLines}">
+									<!-- TAP Test Result information -->
+									<tap:line tapLine="${tapLine}" tapFile="${map.fileName}" showOnlyFailures="${it.showOnlyFailures}" />
+								</j:forEach>
+							</table>
+							<br />
+						</j:forEach>
+
+					</j:otherwise>
+				</j:choose>
+
+				<h3><a name="parseErrors">Parse errors</a></h3>
+
+				<j:choose>
+					<j:when test="${it.hasParseErrors() == false}">
+						<p>No parse errors found</p>
+					</j:when>
+					<j:otherwise>
+						<table class="tap" width="100%">
+							<tr>
+								<th>File name</th>
+								<th>Cause</th>
+							</tr>
+							<j:forEach var="map" items="${it.parseErrorTestSets}">
+							<tr>
+								<td><a href='${rootURL}/${build.url}artifact/${map.fileName}/*view*/'>${map.fileName}</a></td>
+								<td>${map.cause}</td>
+							</tr>
+							</j:forEach>
+						 </table>
+					</j:otherwise>
+				</j:choose>
+
+			</l:main-panel>
+		</j:if>
 	</l:layout>
 </j:jelly>
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,3 +6,4 @@ test-output/ @@
     .project
     **/*~
     .idea
+    *.iml