Merge pull request #1 from smootoo/queued-contexts-log-and-visualise

Log the QueuedContexts collection each time it changes.

Author: SteveDonie

src/main/java/org/jenkins/plugins/lockableresources/LockableResourcesManager.java

@@ -556,6 +556,9 @@ public synchronized void unreserve(List<LockableResource> resources) {
 				nextContextLogger,
 				resourceNamesToUnreserve);
 		this.queuedContexts.remove(nextContext);
+		if (LOGGER.isLoggable(Level.FINE)) {
+			LOGGER.log(Level.FINE, "Queued Contexts " + this.queuedContexts);
+		}
 
 		// resourceNamesToUnreserve contains the names of the previous resources.
 		// requiredResourceForNextContext contains the resource objects which are required for the next context.
@@ -751,13 +754,19 @@ public synchronized void queueContext(StepContext context, List<LockableResource
 		}
 
 		this.queuedContexts.add(new QueuedContextStruct(context, requiredResources, resourceDescription));
+		if (LOGGER.isLoggable(Level.FINE)) {
+			LOGGER.log(Level.FINE, "Queued Contexts " + this.queuedContexts);
+		}
 		save();
 	}
 
 	public synchronized boolean unqueueContext(StepContext context) {
 		for (Iterator<QueuedContextStruct> iter = this.queuedContexts.listIterator(); iter.hasNext(); ) {
 			if (iter.next().getContext() == context) {
 				iter.remove();
+				if (LOGGER.isLoggable(Level.FINE)) {
+					LOGGER.log(Level.FINE, "Queued Contexts " + this.queuedContexts);
+				}
 				save();
 				return true;
 			}
@@ -770,6 +779,14 @@ public static LockableResourcesManager get() {
 				.getDescriptorOrDie(LockableResourcesManager.class);
 	}
 
+	public synchronized int getQueuedContextsSize() {
+		return this.queuedContexts.size();
+	}
+
+	public synchronized ArrayList<QueuedContextStruct> getQueuedContexts() {
+		return new ArrayList<>(this.queuedContexts);
+	}
+
 	public synchronized void save() {
                 if(BulkChange.contains(this))
                     return;

src/main/java/org/jenkins/plugins/lockableresources/actions/LockableResourcesRootAction.java

@@ -28,6 +28,7 @@
 import org.jenkins.plugins.lockableresources.LockableResource;
 import org.jenkins.plugins.lockableresources.LockableResourcesManager;
 import org.jenkins.plugins.lockableresources.Messages;
+import org.jenkins.plugins.lockableresources.queue.QueuedContextStruct;
 import org.kohsuke.stapler.StaplerRequest;
 import org.kohsuke.stapler.StaplerResponse;
 
@@ -88,6 +89,14 @@ public int getNumberOfAllLabels() {
 		return LockableResourcesManager.get().getAllLabels().size();
 	}
 
+	public ArrayList<QueuedContextStruct> getQueuedContexts() {
+		return LockableResourcesManager.get().getQueuedContexts();
+	}
+
+	public int getNumberQueuedContexts() {
+		return LockableResourcesManager.get().getQueuedContextsSize();
+	}
+
 	public void doUnlock(StaplerRequest req, StaplerResponse rsp)
 			throws IOException, ServletException {
 		Jenkins.getInstance().checkPermission(UNLOCK);

src/main/java/org/jenkins/plugins/lockableresources/queue/QueuedContextStruct.java

@@ -11,10 +11,11 @@
 import java.io.Serializable;
 import java.util.List;
 
+import hudson.model.Run;
 import org.jenkinsci.plugins.workflow.steps.StepContext;
-import org.jenkins.plugins.lockableresources.queue.LockableResourcesStruct;
 
 import edu.umd.cs.findbugs.annotations.Nullable;
+import org.kohsuke.stapler.export.Exported;
 
 /*
  * This class is used to queue pipeline contexts
@@ -38,6 +39,10 @@ public class QueuedContextStruct implements Serializable {
 	 */
 	private String resourceDescription;
 
+	// build information in the requesting context. Useful for displaying on the ui and logging
+	private transient volatile Run<?, ?> build = null;
+	private transient volatile String buildExternalizableId = null;
+
 	/*
 	 * Constructor for the QueuedContextStruct class.
 	 */
@@ -54,6 +59,34 @@ public StepContext getContext() {
 		return this.context;
 	}
 
+	@Exported
+	public String getBuildExternalizableId() {
+		if (this.buildExternalizableId == null) {
+			// getting the externalizableId can fail for many reasons, set to null if it fails for some reason
+			try {
+				buildExternalizableId = this.context.get(Run.class).getExternalizableId();
+			} catch (Exception e) {
+				buildExternalizableId = null;
+			}
+		}
+		return this.buildExternalizableId;
+	}
+
+	public Run<?, ?> getBuild() {
+		if (build == null) {
+			build = Run.fromExternalizableId(getBuildExternalizableId());
+		}
+		return build;
+	}
+
+	@Exported
+	public String getBuildName() {
+		if (getBuild() != null)
+			return getBuild().getFullDisplayName();
+		else
+			return null;
+	}
+
 	/*
 	 * Gets the required resources.
 	 */
@@ -64,9 +97,15 @@ public List<LockableResourcesStruct> getResources() {
 	/*
 	 * Gets the resource description for logging messages.
 	 */
+	@Exported
 	public String getResourceDescription() {
 		return this.resourceDescription;
 	}
 
 	private static final long serialVersionUID = 1L;
+
+	@Override
+	public String toString() {
+		return "Build(" + getBuildExternalizableId() + ") Resource(" + resourceDescription + ")";
+	}
 }

src/main/resources/org/jenkins/plugins/lockableresources/actions/LockableResourcesRootAction/index.jelly

@@ -131,6 +131,31 @@ function reset_resource_${i}() {
 			</table>
 </j:if>
 
+<h3>Resource queue</h3>
+<j:choose>
+    <j:when test="${it.getNumberQueuedContexts() != 0}">
+       <table class="pane" style="width: 50%;">
+            <tbody>
+                <tr>
+                    <td class="pane-header">Resource requested</td>
+                    <td class="pane-header">Requested by</td>
+                </tr>
+                <j:forEach var="context" items="${it.getQueuedContexts()}">
+                    <tr>
+                        <td class="pane" >${context.resourceDescription}</td>
+                        <td class="pane" >
+                            <a href="${rootURL}/${context.build.url}">
+                                ${context.build.fullDisplayName}
+                            </a>
+                        </td>
+                    </tr>
+                </j:forEach>
+            </tbody>
+        </table>
+    </j:when>
+    <j:otherwise><h4>Empty</h4></j:otherwise>
+</j:choose>
+
 		</l:main-panel>
 	</l:layout>
 </j:jelly>