Package buildbot :: Package steps :: Module dummy :: Class Dummy
[frames] | no frames]

Class Dummy

source code

process.buildstep.BuildStep --+
Known Subclasses:

I am a dummy no-op step, which runs entirely on the master, and simply waits 5 seconds before finishing with SUCCESS

Instance Methods
__init__(self, timeout=5, **kwargs) source code
Begin the step.
source code
interrupt(self, reason)
Halt the command, either because the user has decided to cancel the build ('reason' is a string), or because the slave has disconnected ('reason' is a ConnectionLost Failure).
source code
done(self) source code

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

Class Variables
  haltOnFailure = True
  flunkOnFailure = True
  name = 'dummy'

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

Instance Variables

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

Method Details

__init__(self, timeout=5, **kwargs)

source code 
  • timeout (int) - the number of seconds to delay before completing
Overrides: process.buildstep.BuildStep.__init__


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)

interrupt(self, reason)

source code 

Halt the command, either because the user has decided to cancel the build ('reason' is a string), or because the slave has disconnected ('reason' is a ConnectionLost Failure). Any further local processing should be skipped, and the Step completed with an error status. The results text should say something useful like ['step', 'interrupted'] or ['remote', 'lost']

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