Merge pull request jenkinsci#49 from sheepdreamofandroids/result-var

Result variable for DSL

Author: amuniz

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

@@ -26,6 +26,10 @@ public class LockStep extends AbstractStepImpl implements Serializable {
 
 	public int quantity = 0;
 
+	/** name of environment variable to store locked resources in */
+	@CheckForNull
+	public String variable = null;
+
 	public boolean inversePrecedence = false;
 
 	// it should be LockStep() - without params. But keeping this for backward compatibility
@@ -49,6 +53,13 @@ public void setLabel(String label) {
 		}
 	}
 
+	@DataBoundSetter
+	public void setVariable(String variable) {
+		if (variable != null && !variable.isEmpty()) {
+			this.variable = variable;
+		}
+	}
+
 	@DataBoundSetter
 	public void setQuantity(int quantity) {
 		this.quantity = quantity;

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

@@ -1,5 +1,6 @@
 package org.jenkins.plugins.lockableresources;
 
+import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.logging.Level;
@@ -8,17 +9,23 @@
 import org.jenkins.plugins.lockableresources.queue.LockableResourcesStruct;
 import org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl;
 import org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback;
+import org.jenkinsci.plugins.workflow.steps.BodyInvoker;
+import org.jenkinsci.plugins.workflow.steps.EnvironmentExpander;
 import org.jenkinsci.plugins.workflow.steps.StepContext;
 import org.jenkinsci.plugins.workflow.steps.StepContextParameter;
 
+import com.google.common.base.Joiner;
 import com.google.inject.Inject;
 
+import hudson.EnvVars;
 import hudson.model.Run;
 import hudson.model.TaskListener;
 
 public class LockStepExecution extends AbstractStepExecutionImpl {
 
-	@Inject(optional = true)
+	private static final Joiner COMMA_JOINER = Joiner.on(',');
+
+    @Inject(optional = true)
 	private LockStep step;
 
 	@StepContextParameter
@@ -44,14 +51,14 @@ public boolean start() throws Exception {
 		LockableResourcesStruct resourceHolder = new LockableResourcesStruct(resources, step.label, step.quantity);
 		// determine if there are enough resources available to proceed
 		List<LockableResource> available = LockableResourcesManager.get().checkResourcesAvailability(resourceHolder, listener.getLogger(), null);
-		if (available == null || !LockableResourcesManager.get().lock(available, run, getContext(), step.toString(), step.inversePrecedence)) {
+		if (available == null || !LockableResourcesManager.get().lock(available, run, getContext(), step.toString(), step.variable, step.inversePrecedence)) {
 			listener.getLogger().println("[" + step + "] is locked, waiting...");
 			LockableResourcesManager.get().queueContext(getContext(), resourceHolder, step.toString());
 		} // proceed is called inside lock if execution is possible
 		return false;
 	}
 
-	public static void proceed(List<String> resourcenames, StepContext context, String resourceDescription, boolean inversePrecedence) {
+	public static void proceed(final List<String> resourcenames, StepContext context, String resourceDescription, final String variable, boolean inversePrecedence) {
 		Run<?, ?> r = null;
 		try {
 			r = context.get(Run.class);
@@ -62,10 +69,26 @@ public static void proceed(List<String> resourcenames, StepContext context, Stri
 		}
 
 		LOGGER.finest("Lock acquired on [" + resourceDescription + "] by " + r.getExternalizableId());
-		context.newBodyInvoker().
-			withCallback(new Callback(resourcenames, resourceDescription, inversePrecedence)).
-			withDisplayName(null).
-			start();
+		try {
+			BodyInvoker bodyInvoker = context.newBodyInvoker().
+				withCallback(new Callback(resourcenames, resourceDescription, inversePrecedence)).
+				withDisplayName(null);
+			if(variable != null && variable.length()>0)
+				// set the variable for the duration of the block
+				bodyInvoker.withContext(EnvironmentExpander.merge(context.get(EnvironmentExpander.class), new EnvironmentExpander() {
+					@Override
+					public void expand(EnvVars env) throws IOException, InterruptedException {
+						final String resources = COMMA_JOINER.join(resourcenames);
+								LOGGER.finest("Setting [" + variable + "] to [" + resources
+										+ "] for the duration of the block");
+						
+						env.override(variable, resources);
+					}
+				}));
+			bodyInvoker.start();
+		} catch (IOException | InterruptedException e) {
+			throw new RuntimeException(e);
+		}
 	}
 
 	private static final class Callback extends BodyExecutionCallback.TailCall {

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

@@ -277,14 +277,15 @@ private boolean checkCurrentResourcesStatus(List<LockableResource> selected,
 	}
 
 	public synchronized boolean lock(List<LockableResource> resources, Run<?, ?> build, @Nullable StepContext context) {
-		return lock(resources, build, context, null, false);
+		return lock(resources, build, context, null, null, false);
 	}
 
 	/**
 	 * Try to lock the resource and return true if locked.
 	 */
 	public synchronized boolean lock(List<LockableResource> resources,
-			Run<?, ?> build, @Nullable StepContext context, @Nullable String logmessage, boolean inversePrecedence) {
+			Run<?, ?> build, @Nullable StepContext context, @Nullable String logmessage,
+			final String variable, boolean inversePrecedence) {
 		boolean needToWait = false;
 
 		for (LockableResource r : resources) {
@@ -305,7 +306,7 @@ public synchronized boolean lock(List<LockableResource> resources,
 				for (LockableResource resource : resources) {
 					resourceNames.add(resource.getName());
 				}
-				LockStepExecution.proceed(resourceNames, context, logmessage, inversePrecedence);
+				LockStepExecution.proceed(resourceNames, context, logmessage, variable, inversePrecedence);
 			}
 		}
 		save();
@@ -419,7 +420,7 @@ public synchronized void unlockNames(@Nullable List<String> resourceNamesToUnLoc
 			freeResources(freeResources, build);
 
 			// continue with next context
-			LockStepExecution.proceed(resourceNamesToLock, nextContext.getContext(), nextContext.getResourceDescription(), inversePrecedence);
+			LockStepExecution.proceed(resourceNamesToLock, nextContext.getContext(), nextContext.getResourceDescription(), nextContext.getResources().requiredVar, inversePrecedence);
 		}
 		save();
 	}

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

@@ -71,6 +71,11 @@ public LockableResourcesStruct(@Nullable List<String> resources) {
 		this(resources, null, 0);
 	}
 
+	public LockableResourcesStruct(@Nullable List<String> resources, @Nullable String label, int quantity, String variable) {
+		this(resources, label, quantity);
+		requiredVar = variable;
+	}
+
 	public LockableResourcesStruct(@Nullable List<String> resources, @Nullable String label, int quantity) {
 		required = new ArrayList<LockableResource>();
 		if (resources != null) {

src/test/java/org/jenkins/plugins/lockableresources/LockStepTest.java

@@ -69,15 +69,16 @@ public void evaluate() throws Throwable {
 				LockableResourcesManager.get().createResourceWithLabel("resource1", "label1");
 				WorkflowJob p = story.j.jenkins.createProject(WorkflowJob.class, "p");
 				p.setDefinition(new CpsFlowDefinition(
-						"lock(label: 'label1') {\n" +
-						"	echo 'Resource locked'\n" +
+						"lock(label: 'label1', variable: 'var') {\n" +
+						"	echo \"Resource locked: ${env.var}\"\n" +
 						"}\n" +
 						"echo 'Finish'"
 				));
 				WorkflowRun b1 = p.scheduleBuild2(0).waitForStart();
 				story.j.waitForCompletion(b1);
 				story.j.assertBuildStatus(Result.SUCCESS, b1);
 				story.j.assertLogContains("Lock released on resource [Label: label1]", b1);
+				story.j.assertLogContains("Resource locked: resource1", b1);
 			}
 		});
 	}