From d463a30c926331ce4b2b509a9dd5651f8a84c7bf Mon Sep 17 00:00:00 2001 From: Ryan Campbell Date: Thu, 31 Jan 2013 16:08:41 -0600 Subject: [PATCH] Introduce jenkins.slaves.WorkspaceLocator which allows extensions to override the location of the workspace. --- core/src/main/java/hudson/model/Slave.java | 9 +++++ core/src/main/java/jenkins/model/Jenkins.java | 8 ++++ .../java/jenkins/slaves/WorkspaceLocator.java | 38 +++++++++++++++++++ 3 files changed, 55 insertions(+) create mode 100644 core/src/main/java/jenkins/slaves/WorkspaceLocator.java diff --git a/core/src/main/java/hudson/model/Slave.java b/core/src/main/java/hudson/model/Slave.java index 4f9e7827a4..ff5ba010b9 100644 --- a/core/src/main/java/hudson/model/Slave.java +++ b/core/src/main/java/hudson/model/Slave.java @@ -58,6 +58,8 @@ import java.util.Set; import javax.servlet.ServletException; import jenkins.model.Jenkins; +import jenkins.slaves.WorkspaceLocator; + import org.apache.commons.io.IOUtils; import org.kohsuke.stapler.DataBoundConstructor; import org.kohsuke.stapler.HttpResponse; @@ -267,6 +269,13 @@ public abstract class Slave extends Node implements Serializable { } public FilePath getWorkspaceFor(TopLevelItem item) { + for (WorkspaceLocator l : WorkspaceLocator.all()) { + FilePath workspace = l.locate(item, this); + if (workspace != null) { + return workspace; + } + } + FilePath r = getWorkspaceRoot(); if(r==null) return null; // offline return r.child(item.getFullName()); diff --git a/core/src/main/java/jenkins/model/Jenkins.java b/core/src/main/java/jenkins/model/Jenkins.java index deebb958ce..a7ff8d6939 100755 --- a/core/src/main/java/jenkins/model/Jenkins.java +++ b/core/src/main/java/jenkins/model/Jenkins.java @@ -195,6 +195,7 @@ import jenkins.InitReactorRunner; import jenkins.model.ProjectNamingStrategy.DefaultProjectNamingStrategy; import jenkins.security.ConfidentialKey; import jenkins.security.ConfidentialStore; +import jenkins.slaves.WorkspaceLocator; import jenkins.util.io.FileBoolean; import net.sf.json.JSONObject; import org.acegisecurity.AccessDeniedException; @@ -1922,6 +1923,13 @@ public class Jenkins extends AbstractCIBase implements ModifiableTopLevelItemGro } public FilePath getWorkspaceFor(TopLevelItem item) { + for (WorkspaceLocator l : WorkspaceLocator.all()) { + FilePath workspace = l.locate(item, this); + if (workspace != null) { + return workspace; + } + } + return new FilePath(expandVariablesForDirectory(workspaceDir, item)); } diff --git a/core/src/main/java/jenkins/slaves/WorkspaceLocator.java b/core/src/main/java/jenkins/slaves/WorkspaceLocator.java new file mode 100644 index 0000000000..6fe3c06d76 --- /dev/null +++ b/core/src/main/java/jenkins/slaves/WorkspaceLocator.java @@ -0,0 +1,38 @@ +package jenkins.slaves; + +import hudson.ExtensionList; +import hudson.ExtensionPoint; +import hudson.FilePath; +import hudson.model.Node; +import hudson.model.TopLevelItem; +import jenkins.model.Jenkins; + +/** + * Allow extensions to override workspace locations + * on given slaves or projects. + * + * @author ryan.campbell@gmail.com + * @since 1.501 + */ +public abstract class WorkspaceLocator implements ExtensionPoint { + + /** + * Allows extensions to customize the workspace path. The first non-null response + * will determine the path to the workspace on that slave. + * + * @param item The toplevel item + * @param slave The slave + * @return The absolute FilePath to the workspace on the slave. + * Will be created if it doesn't exist. + * + */ + public abstract FilePath locate(TopLevelItem item, Node node); + + + /** + * All registered {@link WorkspaceLocator}s. + */ + public static ExtensionList all() { + return Jenkins.getInstance().getExtensionList(WorkspaceLocator.class); + } +}