package hudson; import hudson.matrix.MatrixBuild; import hudson.model.AbstractBuild; import hudson.model.AbstractProject; import hudson.model.Computer; import hudson.model.Describable; import hudson.model.Job; import hudson.model.TaskListener; import hudson.model.listeners.RunListener; import hudson.util.DescriptorList; import hudson.scm.SCM; import java.io.BufferedOutputStream; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.OutputStream; /** * Prepares and provisions workspaces for {@link AbstractProject}s. * *
* * *
* STILL A WORK IN PROGRESS. SUBJECT TO CHANGE! * * TODO: is this per {@link Computer}? Per {@link Job}? * -> probably per slave. * *
* The first piece of this is the custom {@link SCM}, which inherits the * workspace of another job. When this executes, it picks up * {@link WorkspaceSnapshot} from the other job and use it to obtain the workspace. * *
* Then there's {@link RunListener}, which creates a snapshot if * someone else is interested in using a snapshot later. * *
* This method can prepare the underlying file system in preparation * for the later {@link #snapshot(AbstractBuild, FilePath, TaskListener)}. * * TODO : the method needs to be able to see the snapshot would * be later needed. In fact, perhaps we should only call this method * when Hudson knows that a snapshot is later needed? * * @param ws * New workspace should be prepared in this location. This is the same value as * {@code build.getProject().getWorkspace()} but passed separately for convenience. */ public abstract void prepareWorkspace(AbstractBuild,?> build, FilePath ws, TaskListener listener) throws IOException, InterruptedException; /** * When a project is deleted, this method is called to undo the effect of * {@link #prepareWorkspace(AbstractBuild, FilePath, TaskListener)}. */ public abstract void discardWorkspace(AbstractProject,?> project, TaskListener listener) throws IOException, InterruptedException; // public abstract void moveWorkspace(AbstractProject,?> project, File oldWorkspace, File newWorkspace) throws IOException; /** * Obtains the snapshot of the workspace of the given build. * *
* The state of the build when this method is invoked depends on * the project type. Most would call this at the end of the build, * but for example {@link MatrixBuild} would call this after * SCM check out so that the state of the fresh workspace * can be then propagated to elsewhere. * *
* If the implementation of this method needs to store data in a file system,
* do so under {@link AbstractBuild#getRootDir()}, since the lifecycle of
* the snapshot is tied to the life cycle of a build.
*
* @param ws
* New workspace should be prepared in this location. This is the same value as
* {@code build.getProject().getWorkspace()} but passed separately for convenience.
*/
public abstract WorkspaceSnapshot snapshot(AbstractBuild,?> build, FilePath ws, TaskListener listener) throws IOException, InterruptedException;
public abstract FileSystemProvisionerDescriptor getDescriptor();
/**
* A list of available file system provider types.
*/
public static final DescriptorList