org.jenkinsci.plugins.sge

Class SGE

java.lang.Object

org.jenkinsci.plugins.sge.BatchSystem

org.jenkinsci.plugins.sge.SGE

public class SGE
extends BatchSystem

Interface to the Sun Grid Engine (SGE) batch system

Author:

John McGehee Based on the SGE version by Laisvydas Skurevicius

Field Summary

Fields inherited from class org.jenkinsci.plugins.sge.BatchSystem

build, COMMUNICATION_FILE, copyFileToMaster, launcher, listener, masterWorkingDirectory

Constructor Summary

Constructors

Constructor and Description
SGE(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener, String COMMUNICATION_FILE, String masterWorkingDirectory)

Method Summary

Modifier and Type	Method and Description
void	cleanUpFiles(String jobId) cleans up the files created by the batch system
void	createFinishedJobOutputFile(String jobId, int offset) After the job is finished, create a job output file on the slave beginning with the line after the offset through the end of the file.
void	createFormattedRunningJobOutputFile(String outputFileName, int offset, int numberOfLines) While the job is still running, create a file on the slave that begins after the specified offset and ending with line numberOfLines (created by createJobProgressFile method)
void	createJobProgressFile(String jobId, String outputFileName) creates the job output file of the running job in the slave
String	getJobStatus(String jobId) Get the status of the job.
boolean	isEndStatus(String jobStatus)
boolean	isRunningStatus(String jobStatus)
boolean	jobCompletedSuccessfully(String jobStatus)
boolean	jobExitedWithErrors(String jobStatus)
void	killJob(String jobId) kills the job with specified job id in the batch system
void	printErrorLog() prints the error log to the slave console
void	printExitCode(String jobId) prints the exit code to the slave console
void	processStatus(String jobStatus) executes the appropriate actions depending on the status of the job (prints the appropriate messages)
String	submitJob(String jobFileName, boolean sendEmail, String queueType) Submit the job to SGE using the qsub command and return the job number as a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

SGE

public SGE(hudson.model.AbstractBuild<?,?> build,
           hudson.Launcher launcher,
           hudson.model.BuildListener listener,
           String COMMUNICATION_FILE,
           String masterWorkingDirectory)

Method Detail

submitJob

public String submitJob(String jobFileName,
                        boolean sendEmail,
                        String queueType)
                 throws InterruptedException,
                        IOException

Submit the job to SGE using the qsub command and return the job number as a string. Return QSUB_FAILED_JOB_ID if the job could not be submitted. Redefine the Jenkins environment variable `JOB_NAME` as `JENKINS_JOB_NAME` because SGE overwrites `JOB_NAME`.

Specified by:

submitJob in class BatchSystem

Parameters:

jobFileName - name of the job file

sendEmail - specifies if an email should be sent

queueType - the batch system's queue type (if it has one)

Returns:

the job id of the submitted job

Throws:

InterruptedException

IOException

getJobStatus

public String getJobStatus(String jobId)
                    throws IOException,
                           InterruptedException

Description copied from class: BatchSystem

Get the status of the job.

Specified by:

getJobStatus in class BatchSystem

Returns:

the job status of the specified job id

Throws:

IOException

InterruptedException

killJob

public void killJob(String jobId)
             throws InterruptedException

Description copied from class: BatchSystem

kills the job with specified job id in the batch system

Specified by:

killJob in class BatchSystem

Parameters:

jobId - the identifier of the job

Throws:

InterruptedException

processStatus

public void processStatus(String jobStatus)

Description copied from class: BatchSystem

executes the appropriate actions depending on the status of the job (prints the appropriate messages)

Specified by:

processStatus in class BatchSystem

Parameters:

jobStatus - the status of the job

printErrorLog

public void printErrorLog()
                   throws InterruptedException

Description copied from class: BatchSystem

prints the error log to the slave console

Specified by:

printErrorLog in class BatchSystem

Throws:

InterruptedException

printExitCode

public void printExitCode(String jobId)
                   throws InterruptedException,
                          IOException

Description copied from class: BatchSystem

prints the exit code to the slave console

Specified by:

printExitCode in class BatchSystem

Parameters:

jobId - the identifier of the job

Throws:

InterruptedException

IOException

createJobProgressFile

public void createJobProgressFile(String jobId,
                                  String outputFileName)
                           throws InterruptedException,
                                  IOException

Description copied from class: BatchSystem

creates the job output file of the running job in the slave

Specified by:

createJobProgressFile in class BatchSystem

Parameters:

jobId - the identifier of the job

outputFileName - name of the created output file

Throws:

InterruptedException

IOException

createFormattedRunningJobOutputFile

public void createFormattedRunningJobOutputFile(String outputFileName,
                                                int offset,
                                                int numberOfLines)
                                         throws InterruptedException,
                                                IOException

While the job is still running, create a file on the slave that begins after the specified offset and ending with line numberOfLines (created by createJobProgressFile method)

Specified by:

createFormattedRunningJobOutputFile in class BatchSystem

Parameters:

outputFileName - the output file to be formatted

offset - number of lines that should be skipped at the beginning

numberOfLines - the last line in outputFileName to be output

Throws:

InterruptedException

IOException

createFinishedJobOutputFile

public void createFinishedJobOutputFile(String jobId,
                                        int offset)
                                 throws InterruptedException

After the job is finished, create a job output file on the slave beginning with the line after the offset through the end of the file.

Specified by:

createFinishedJobOutputFile in class BatchSystem

Parameters:

jobId - the identifier of the job

offset - number of lines at the beginning of the file that should be skipped

Throws:

InterruptedException

cleanUpFiles

public void cleanUpFiles(String jobId)
                  throws InterruptedException

Description copied from class: BatchSystem

cleans up the files created by the batch system

Specified by:

cleanUpFiles in class BatchSystem

Throws:

InterruptedException

isRunningStatus

public boolean isRunningStatus(String jobStatus)

Specified by:

isRunningStatus in class BatchSystem

Parameters:

jobStatus - the status of the job

Returns:

true if the given job status is a running status

isEndStatus

public boolean isEndStatus(String jobStatus)

Specified by:

isEndStatus in class BatchSystem

Parameters:

jobStatus - the status of the job

Returns:

true if the given job status is an ending state

jobExitedWithErrors

public boolean jobExitedWithErrors(String jobStatus)

Specified by:

jobExitedWithErrors in class BatchSystem

Parameters:

jobStatus - the status of the job

Returns:

true if the job exited with errors

jobCompletedSuccessfully

public boolean jobCompletedSuccessfully(String jobStatus)

Specified by:

jobCompletedSuccessfully in class BatchSystem

Parameters:

jobStatus - the status of the job

Returns:

true if the job completed successfully without errors