start(self)
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)
d.addCallback(self.fooDone).addErrback(self.failed)
As the step runs, it should send status information to the
BuildStepStatus:
self.step_status.setColor('red')
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.
-
- Overrides:
buildbot.steps.dummy.Dummy.start (inherited documentation)
|