jenkins.plugins.clangscanbuild.commands
Interface BuildContext

All Known Implementing Classes:

BuildContextImpl

public interface BuildContext

This interface abstracts the operations which the xcodebuild commands needs in order to execute. This was done so that unit tests could mock this interface and test command building independently of jenkins.

Author:

Josh Kenneyd

Method Summary

hudson.FilePath	getBuildFolder() Returns the FilePath of the current executing build
hudson.Launcher.ProcStarter	getProcStarter() Returns a ProcStart which is pre-configured to log standard error and out to the build listener.
hudson.FilePath	getWorkspace() Returns workspace location of current executing build
void	log(String message) Logs a message to the build listener.
int	waitForProcess(hudson.Launcher.ProcStarter processStarter) This method starts a process and will not return control until either the process is complete or the process is interrupted.

Method Detail

getBuildFolder

hudson.FilePath getBuildFolder()

Returns the FilePath of the current executing build

Returns:

getWorkspace

hudson.FilePath getWorkspace()

Returns workspace location of current executing build

getProcStarter

hudson.Launcher.ProcStarter getProcStarter()

Returns a ProcStart which is pre-configured to log standard error and out to the build listener. The present working directory is also pre-configured to point to the workspace of the currently executing build.

waitForProcess

int waitForProcess(hudson.Launcher.ProcStarter processStarter)

This method starts a process and will not return control until either the process is complete or the process is interrupted. Caught exceptions (IOException,InterrupredException) are logged to the build listener and a return code of 1 will be returned. Upon success, a return code of 0 is returned.

log

void log(String message)

Logs a message to the build listener.