org.jenkinsci.plugins.lsf

Class BatchBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

org.jenkinsci.plugins.lsf.BatchBuilder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep

public class BatchBuilder
extends hudson.tasks.Builder

Author:

Laisvydas Skurevicius

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchBuilder.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
BatchBuilder(String job, String filesToDownload, String downloadDestination, String filesToSend, int checkFrequencyMinutes, boolean sendEmail)

Method Summary

Modifier and Type	Method and Description
protected void	cleanUpFiles(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener, String jobFileName, String jobId) cleans up the temporary files in the master and the slave
protected void	downloadFiles(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) downloads the selected files from slave to master
int	getCheckFrequencyMinutes()
BatchBuilder.DescriptorImpl	getDescriptor()
String	getDownloadDestination()
String	getFilesToDownload()
String	getFilesToSend()
String	getJob()
protected String	getQueueType(hudson.model.AbstractBuild<?,?> build)
boolean	getSendEmail()
protected String	getSlaveWorkingDirectory(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
String	getUploadedFiles()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) This is where the interaction between Jenkins and LSF happens.
protected void	printJobOutput(hudson.model.BuildListener listener, String output) prints the given output to console
protected String	sendFiles(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) sends the selected files to the slave machine
protected void	sendJobToSlave(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener, String sendFilesShellCommands, String jobFileName) sends the job script file to slave
protected void	setPermissionOnJobFile(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener, String jobFileName) sets the correct permission on the job file

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BatchBuilder

@DataBoundConstructor
public BatchBuilder(String job,
                                           String filesToDownload,
                                           String downloadDestination,
                                           String filesToSend,
                                           int checkFrequencyMinutes,
                                           boolean sendEmail)

Parameters:

job -

filesToDownload -

downloadDestination -

filesToSend -

checkFrequencyMinutes -

sendEmail -

Method Detail

getJob

public String getJob()

getFilesToDownload

public String getFilesToDownload()

getCheckFrequencyMinutes

public int getCheckFrequencyMinutes()

getFilesToSend

public String getFilesToSend()

getDownloadDestination

public String getDownloadDestination()

getSendEmail

public boolean getSendEmail()

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws InterruptedException,
                       IOException

This is where the interaction between Jenkins and LSF happens.

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Parameters:

build -

launcher -

listener -

Returns:

Throws:

InterruptedException

IOException

printJobOutput

protected void printJobOutput(hudson.model.BuildListener listener,
                              String output)

prints the given output to console

Parameters:

listener -

output -

getQueueType

protected String getQueueType(hudson.model.AbstractBuild<?,?> build)

Parameters:

build -

Returns:

queue type from the cloud

getSlaveWorkingDirectory

protected String getSlaveWorkingDirectory(hudson.model.AbstractBuild<?,?> build,
                                          hudson.Launcher launcher,
                                          hudson.model.BuildListener listener)
                                   throws InterruptedException,
                                          IOException

Parameters:

build -

launcher -

listener -

Returns:

current working directory in the slave machine

Throws:

InterruptedException

IOException

sendFiles

protected String sendFiles(hudson.model.AbstractBuild<?,?> build,
                           hudson.Launcher launcher,
                           hudson.model.BuildListener listener)
                    throws IOException,
                           InterruptedException

sends the selected files to the slave machine

Parameters:

build -

launcher -

listener -

Returns:

shell commands for sending files to batch system

Throws:

IOException

InterruptedException

downloadFiles

protected void downloadFiles(hudson.model.AbstractBuild<?,?> build,
                             hudson.Launcher launcher,
                             hudson.model.BuildListener listener)
                      throws InterruptedException,
                             IOException

downloads the selected files from slave to master

Parameters:

build -

launcher -

listener -

Throws:

InterruptedException

IOException

sendJobToSlave

protected void sendJobToSlave(hudson.model.AbstractBuild<?,?> build,
                              hudson.Launcher launcher,
                              hudson.model.BuildListener listener,
                              String sendFilesShellCommands,
                              String jobFileName)
                       throws IOException,
                              InterruptedException

sends the job script file to slave

Parameters:

build -

launcher -

listener -

sendFilesShellCommands -

jobFileName -

Throws:

IOException

InterruptedException

setPermissionOnJobFile

protected void setPermissionOnJobFile(hudson.model.AbstractBuild<?,?> build,
                                      hudson.Launcher launcher,
                                      hudson.model.BuildListener listener,
                                      String jobFileName)
                               throws InterruptedException

sets the correct permission on the job file

Parameters:

build -

launcher -

listener -

jobFileName -

Throws:

InterruptedException

cleanUpFiles

protected void cleanUpFiles(hudson.model.AbstractBuild<?,?> build,
                            hudson.Launcher launcher,
                            hudson.model.BuildListener listener,
                            String jobFileName,
                            String jobId)
                     throws InterruptedException

cleans up the temporary files in the master and the slave

Parameters:

build -

launcher -

listener -

jobFileName -

jobId -

Throws:

InterruptedException

getDescriptor

public BatchBuilder.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

Overrides:

getDescriptor in class hudson.tasks.Builder

getUploadedFiles

public String getUploadedFiles()