Package buildbot :: Package steps :: Module shell :: Class ShellCommand
[frames] | no frames]

Class ShellCommand

source code

   process.buildstep.BuildStep --+    
process.buildstep.LoggingBuildStep --+
Known Subclasses:

I run a single shell command on the buildslave. I return FAILURE if the exit code of that command is non-zero, SUCCESS otherwise. To change this behavior, override my .evaluateCommand method.

By default, a failure of this step will mark the whole build as FAILURE. To override this, give me an argument of flunkOnFailure=False .

I create a single Log named 'log' which contains the output of the command. To create additional summary Logs, override my .createSummary method.

The shell command I run (a list of argv strings) can be provided in several ways:

Instance Methods
__init__(self, workdir=None, description=None, descriptionDone=None, command=None, usePTY='slave-config', **kwargs) source code
setStepStatus(self, step_status) source code
setDefaultWorkdir(self, workdir) source code
setCommand(self, command) source code
describe(self, done=False)
Return a list of short strings to describe this step, for the status display.
source code
setupEnvironment(self, cmd) source code
checkForOldSlaveAndLogfiles(self) source code
Begin the step.
source code

Inherited from process.buildstep.LoggingBuildStep: addLogFile, checkDisconnect, commandComplete, createSummary, evaluateCommand, getText, getText2, interrupt, maybeGetText2, setStatus, setupLogfiles, startCommand

Inherited from process.buildstep.BuildStep: acquireLocks, addCompleteLog, addFactoryArguments, addHTMLLog, addLog, addLogObserver, addURL, failed, finished, getLog, getProperty, getSlaveName, getStepFactory, releaseLocks, runCommand, setBuild, setBuildSlave, setProgress, setProperty, setupProgress, slaveVersion, slaveVersionIsOlderThan, startStep

Class Variables
  name = 'shell'
  description = None
  descriptionDone = None
  flunkOnFailure = True

Inherited from process.buildstep.LoggingBuildStep: parms, progressMetrics

Inherited from process.buildstep.BuildStep: alwaysRun, doStepIf, flunkOnWarnings, haltOnFailure, locks, useProgress, warnOnFailure, warnOnWarnings

Instance Variables
  command = None
a list of renderable objects (typically strings or WithProperties instances).
Defaults to False.
a dict mapping log NAMEs to workdir-relative FILENAMEs of their corresponding logfiles.

Inherited from process.buildstep.BuildStep: build, progress, step_status

Method Details

__init__(self, workdir=None, description=None, descriptionDone=None, command=None, usePTY='slave-config', **kwargs)

source code 
Overrides: process.buildstep.BuildStep.__init__

setStepStatus(self, step_status)

source code 
Overrides: process.buildstep.BuildStep.setStepStatus

setDefaultWorkdir(self, workdir)

source code 
Overrides: process.buildstep.BuildStep.setDefaultWorkdir

describe(self, done=False)

source code 

Return a list of short strings to describe this step, for the status display. This uses the first few words of the shell command. You can replace this by setting .description in your subclass, or by overriding this method to describe the step better.

  • done (boolean) - whether the command is complete or not, to improve the way the command is described. done=False is used while the command is still running, so a single imperfect-tense verb is appropriate ('compiling', 'testing', ...) done=True is used when the command has finished, and the default getText() method adds some text, so a simple noun is appropriate ('compile', 'tests' ...)
Overrides: process.buildstep.BuildStep.describe


source code 

Begin the step. Override this method and add code to do local processing, fire off remote commands, etc.

To spawn a command in the buildslave, create a RemoteCommand instance and run it with self.runCommand:

 c = RemoteCommandFoo(args)
 d = self.runCommand(c)

As the step runs, it should send status information to the BuildStepStatus:

 self.step_status.setText(['compile', 'failed'])
 self.step_status.setText2(['4', 'warnings'])

To have some code parse stdio (or other log stream) in realtime, add a LogObserver subclass. This observer can use self.step.setProgress() to provide better progress notification to the step.:

 self.addLogObserver('stdio', MyLogObserver())

To add a LogFile, use self.addLog. Make sure it gets closed when it finishes. When giving a Logfile to a RemoteShellCommand, just ask it to close the log when the command completes:

 log = self.addLog('output')
 cmd = RemoteShellCommand(args)
 cmd.useLog(log, closeWhenFinished=True)

You can also create complete Logfiles with generated text in a single step:

 self.addCompleteLog('warnings', text)

When the step is done, it should call self.finished(result). 'result' will be provided to the buildbot.process.base.Build, and should be one of the constants defined above: SUCCESS, WARNINGS, FAILURE, or SKIPPED.

If the step encounters an exception, it should call self.failed(why). 'why' should be a Failure object. This automatically fails the whole build with an exception. It is a good idea to add self.failed as an errback to any Deferreds you might obtain.

If the step decides it does not need to be run, start() can return the constant SKIPPED. This fires the callback immediately: it is not necessary to call .finished yourself. This can also indicate to the status-reporting mechanism that this step should not be displayed.

A step can be configured to only run under certain conditions. To do this, set the step's doStepIf to a boolean value, or to a function that returns a boolean value. If the value or function result is False, then the step will return SKIPPED without doing anything, otherwise the step will be executed normally. If you set doStepIf to a function, that function should accept one parameter, which will be the Step object itself.

Overrides: process.buildstep.BuildStep.start
(inherited documentation)

Instance Variable Details


a list of renderable objects (typically strings or WithProperties instances). This will be used by start() to create a RemoteShellCommand instance.


Defaults to False. If True, logfiles will be tracked `lazily', meaning they will only be added when and if they are written to. Empty or nonexistent logfiles will be omitted. (Also handled by class LoggingBuildStep.)


a dict mapping log NAMEs to workdir-relative FILENAMEs of their corresponding logfiles. The contents of the file named FILENAME will be put into a LogFile named NAME, ina something approximating real-time. (note that logfiles= is actually handled by our parent class LoggingBuildStep)