hudson.scm.IntegrityCheckoutTask Maven / Gradle / Ivy
package hudson.scm;
import java.io.File;
import java.io.IOException;
import java.util.Iterator;
import java.util.List;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import com.mks.api.response.APIException;
import hudson.FilePath;
import hudson.FilePath.FileCallable;
import hudson.model.BuildListener;
import hudson.remoting.VirtualChannel;
public class IntegrityCheckoutTask implements FileCallable
{
private static final long serialVersionUID = 1240357991626897900L;
private static final int CHECKOUT_TRESHOLD = 500;
private final Log logger = LogFactory.getLog(getClass());
private final IntegritySCM scm;
private final IntegrityCMProject siProject;
private final boolean cleanCopy;
private final BuildListener listener;
/**
* Hudson supports building on distributed machines, and the SCM plugin must
* be able to be executed on other machines than the master.
* @param scm Out IntegritySCM object that contains all the configuration information we need
* @param siProject IntegrityCMProject object containing details about the Integrity Project and Members
* @param cleanCopy Indicates whether or not the workspace needs to be cleaned up prior to checking out files
* @param listener The Hudson build listener
*/
public IntegrityCheckoutTask(IntegritySCM scm, IntegrityCMProject siProject, boolean cleanCopy, BuildListener listener)
{
this.scm = scm;
this.siProject = siProject;
this.cleanCopy = cleanCopy;
this.listener = listener;
logger.debug("Integrity Checkout Task Created!");
}
/**
* Creates the folder structure for the project's contents allowing empty folders to be created
* @param workspace
*/
private void createFolderStructure(FilePath workspace)
{
Iterator folders = siProject.getDirList().iterator();
while( folders.hasNext() )
{
File dir = new File(workspace + folders.next());
if( ! dir.isDirectory() )
{
logger.debug("Creating folder: " + dir.getAbsolutePath());
dir.mkdirs();
}
}
}
/**
* This task wraps around the code necessary to checkout Integrity CM Members on remote machines
*/
public Boolean invoke(File workspaceFile, VirtualChannel channel) throws IOException
{
// Figure out where we should be checking out this project
File checkOutDir = (null != scm.getAlternateWorkspace() && scm.getAlternateWorkspace().length() > 0) ?
new File(scm.getAlternateWorkspace()) : workspaceFile;
// Convert the file object to a hudson FilePath (helps us with workspace.deleteContents())
FilePath workspace = new FilePath(checkOutDir.isAbsolute() ? checkOutDir :
new File(workspaceFile.getAbsolutePath() + IntegritySCM.FS + checkOutDir.getPath()));
listener.getLogger().println("Checkout directory is " + workspace);
// Create a fresh API Session as we may/will be executing from another server
APISession api = scm.createAPISession();
// Ensure we've successfully created an API Session
if( null == api )
{
listener.getLogger().println("Failed to establish an API connection to the Integrity Server!");
return false;
}
// If we got here, then APISession was created successfully!
try
{
// Keep count of the open file handles generated on the server
int openFileHandles = 0;
if( cleanCopy )
{
listener.getLogger().println("A clean copy is requested; deleting contents of " + workspace);
logger.debug("Deleting contents of workspace " + workspace);
workspace.deleteContents();
listener.getLogger().println("Populating clean workspace...");
// Create an empty folder structure first
createFolderStructure(workspace);
// Perform a fresh checkout of each file in the member list...
List projectMembers = siProject.getProjectMembers();
for( Iterator it = projectMembers.iterator(); it.hasNext(); )
{
openFileHandles++;
IntegrityCMMember siMember = it.next();
siMember.setWorkspaceDir(""+workspace);
logger.debug("Attempting to checkout file: " + siMember.getTargetFilePath() + " at revision " + siMember.getRevision());
siMember.checkout(api);
// Check to see if we need to release the APISession to clear some file handles
if( openFileHandles % CHECKOUT_TRESHOLD == 0 )
{
api.Terminate();
api = scm.createAPISession();
}
}
// Lets advice the user that we've checked out all the members
listener.getLogger().println("Successfully checked out " + projectMembers.size() + " files!");
}
else // We'll need to update the existing workspace...
{
// Create an empty folder structure first
createFolderStructure(workspace);
// First lets process the adds
List newMembersList = siProject.getAddedMembers();
for( Iterator it = newMembersList.iterator(); it.hasNext(); )
{
openFileHandles++;
IntegrityCMMember siMember = it.next();
siMember.setWorkspaceDir(""+workspace);
logger.debug("Attempting to get new file: " + siMember.getTargetFilePath() + " at revision " + siMember.getRevision());
siMember.checkout(api);
// Check to see if we need to release the APISession to clear some file handles
if( openFileHandles % CHECKOUT_TRESHOLD == 0 )
{
api.Terminate();
api = scm.createAPISession();
}
}
// Next, lets process the updates
List updatedMembersList = siProject.getUpdatedMembers();
for( Iterator it = updatedMembersList.iterator(); it.hasNext(); )
{
openFileHandles++;
IntegrityCMMember siMember = it.next();
siMember.setWorkspaceDir(""+workspace);
logger.debug("Attempting to update file: " + siMember.getTargetFilePath() + " to revision " + siMember.getRevision());
siMember.checkout(api);
// Check to see if we need to release the APISession to clear some file handles
if( openFileHandles % CHECKOUT_TRESHOLD == 0 )
{
api.Terminate();
api = scm.createAPISession();
}
}
// Finally, lets process the drops
List memberDropList = siProject.getDroppedMembers();
for( Iterator it = memberDropList.iterator(); it.hasNext(); )
{
IntegrityCMMember siMember = it.next();
siMember.setWorkspaceDir(""+workspace);
logger.debug("Attempting to drop file: " + siMember.getTargetFilePath() + " was at revision " + siMember.getRevision());
File dropFile = new File(siMember.getTargetFilePath());
if( dropFile.exists() && !dropFile.delete() )
{
listener.getLogger().println("Failed to clean up workspace file " + dropFile.getAbsolutePath() + "!");
return false;
}
}
// Lets advice the user that we've performed the updates to the workspace
listener.getLogger().println("Successfully updated workspace with " + (newMembersList.size() + updatedMembersList.size())
+ " updates and cleaned up " + memberDropList.size() + " files!");
}
}
catch(APIException aex)
{
logger.error("API Exception caught...");
listener.getLogger().println("An API Exception was caught!");
ExceptionHandler eh = new ExceptionHandler(aex);
logger.error(eh.getMessage());
listener.getLogger().println(eh.getMessage());
logger.debug(eh.getCommand() + " returned exit code " + eh.getExitCode());
listener.getLogger().println(eh.getCommand() + " returned exit code " + eh.getExitCode());
aex.printStackTrace();
return false;
}
catch(InterruptedException iex)
{
logger.error("Interrupted Exception caught...");
listener.getLogger().println("An Interrupted Exception was caught!");
logger.error(iex.getMessage());
listener.getLogger().println(iex.getMessage());
listener.getLogger().println("Failed to clean up workspace (" + workspace + ") contents!");
return false;
}
finally
{
// Close out the API Session created on this slave.
api.Terminate();
}
//If we got here, everything is good on the checkout...
return true;
}
}