Package buildbot :: Module interfaces :: Class IBuildStepStatus

Class IBuildStepStatus

zope.interface.Interface --+
                           |
                          IBuildStepStatus

I hold status for a single BuildStep.

Instance Methods

getName()
Returns a short string with the name of this step.

source code

getBuild()
Returns the IBuildStatus object which contains this step.

source code

getTimes()
Returns a tuple of (start, end).

source code

getExpectations()
Returns a list of tuples (name, current, target).

source code

getURLs()
Returns a dictionary of URLs.

source code

getLogs()
Returns a list of IStatusLog objects.

source code

isFinished()
Return a boolean.

source code

waitUntilFinished()
Return a Deferred that will fire when the step finishes.

source code

getETA()
Returns the number of seconds from now in which the step is expected to finish, or None if we can't make a guess.

source code

getText()
Returns a list of strings which describe the step.

source code

getResults()
Return a tuple describing the results of the step: (result, strings).

source code

subscribe(receiver, updateInterval=10)
Register an IStatusReceiver to receive new status events.

source code

unsubscribe(receiver)
Unregister an IStatusReceiver.

source code

Class Variables
	__bases__ = `(<InterfaceClass zope.interface.Interface>)`
	__identifier__ = `'buildbot.interfaces.IBuildStepStatus'`
	__iro__ = `(<InterfaceClass buildbot.interfaces.IBuildStepStatu...`
	__name__ = `'IBuildStepStatus'`
	__sro__ = `(<InterfaceClass buildbot.interfaces.IBuildStepStatu...`
	dependents = `<WeakKeyDictionary at 41513256>`

Method Details

getName()

source code

Returns a short string with the name of this step. This string may have spaces in it.

getTimes()

source code

Returns a tuple of (start, end). 'start' and 'end' are the times (seconds since the epoch) when the Step started and finished. If the step has not yet started, 'start' will be None. If the step is still running, 'end' will be None.

getExpectations()

source code

Returns a list of tuples (name, current, target). Each tuple describes a single axis along which the step's progress can be measured. 'name' is a string which describes the axis itself, like 'filesCompiled' or 'tests run' or 'bytes of output'. 'current' is a number with the progress made so far, while 'target' is the value that we expect (based upon past experience) to get to when the build is finished.

'current' will change over time until the step is finished. It is 'None' until the step starts. When the build is finished, 'current' may or may not equal 'target' (which is merely the expectation based upon previous builds).

getURLs()

source code

Returns a dictionary of URLs. Each key is a link name (a short string, like 'results' or 'coverage'), and each value is a URL. These links will be displayed along with the LogFiles.

getLogs()

source code

Returns a list of IStatusLog objects. If the step has not yet finished, this list may be incomplete (asking again later may give you more of them).

isFinished()

source code

Return a boolean. True means the step has finished, False means it is still running.

waitUntilFinished()

source code

Return a Deferred that will fire when the step finishes. If the step has already finished, this deferred will fire right away. The callback is given this IBuildStepStatus instance as an argument.

getETA()

source code

Returns the number of seconds from now in which the step is expected to finish, or None if we can't make a guess. This guess will be refined over time.

getText()

source code

Returns a list of strings which describe the step. These are intended to be displayed in a narrow column. If more space is available, the caller should join them together with spaces before presenting them to the user.

getResults()

source code

Return a tuple describing the results of the step: (result, strings). 'result' is one of the constants in buildbot.status.builder: SUCCESS, WARNINGS, FAILURE, or SKIPPED. 'strings' is an optional list of strings that the step wants to append to the overall build's results. These strings are usually more terse than the ones returned by getText(): in particular, successful Steps do not usually contribute any text to the overall build.

subscribe(receiver, updateInterval=10)

source code

Register an IStatusReceiver to receive new status events. The receiver will be given logStarted and logFinished messages. It will also be given a ETAUpdate message every 'updateInterval' seconds.

unsubscribe(receiver)

source code

Unregister an IStatusReceiver. No further status messgaes will be delivered.

Class Variable Details

iro

Value:

(<InterfaceClass buildbot.interfaces.IBuildStepStatus>,
 <InterfaceClass zope.interface.Interface>)

sro

Value:

(<InterfaceClass buildbot.interfaces.IBuildStepStatus>,
 <InterfaceClass zope.interface.Interface>)

Class IBuildStepStatus

getName()

getTimes()

getExpectations()

getURLs()

getLogs()

isFinished()

waitUntilFinished()

getETA()

getText()

getResults()

subscribe(receiver, updateInterval=10)

unsubscribe(receiver)

__iro__

__sro__

iro

sro