Package buildbot :: Module interfaces :: Class IBuildStatus
[frames] | no frames]

Class IBuildStatus

source code

zope.interface.Interface --+
                           |
                          IBuildStatus

I represent the status of a single Build/BuildRequest. It could be in-progress or finished.

Instance Methods
implementor of IBuilderStatus
getBuilder()
Return the BuilderStatus that owns this build.
source code
 
isFinished()
Return a boolean.
source code
 
waitUntilFinished()
Return a Deferred that will fire when the build finishes.
source code
 
getProperty(propname)
Return the value of the build property with the given name.
source code
 
getReason()
Return a string that indicates why the build was run.
source code
 
getSourceStamp()
Return a SourceStamp object which can be used to re-create the source tree that this build used.
source code
 
getChanges()
Return a list of Change objects which represent which source changes went into the build.
source code
 
getResponsibleUsers()
Return a list of Users who are to blame for the changes that went into this build.
source code
 
getInterestedUsers()
Return a list of Users who will want to know about the results of this build.
source code
 
getNumber()
Within each builder, each Build has a number.
source code
 
getPreviousBuild()
Convenience method.
source code
 
getSteps()
Return a list of IBuildStepStatus objects.
source code
 
getTimes()
Returns a tuple of (start, end).
source code
 
getETA()
Returns the number of seconds from now in which the build is expected to finish, or None if we can't make a guess.
source code
 
getCurrentStep()
Return an IBuildStepStatus object representing the currently active step.
source code
 
getSlavename()
Return the name of the buildslave which handled this build.
source code
 
getText()
Returns a list of strings to describe the build.
source code
 
getResults()
Return a constant describing the results of the build: one of the constants in buildbot.status.builder: SUCCESS, WARNINGS, FAILURE, SKIPPED or EXCEPTION.
source code
 
getLogs()
Return a list of logs that describe the build as a whole.
source code
 
getTestResults()
Return a dictionary that maps test-name tuples to ITestResult objects.
source code
 
subscribe(receiver, updateInterval=None)
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.IBuildStatus'
  __iro__ = (<InterfaceClass buildbot.interfaces.IBuildStatus>, ...
  __name__ = 'IBuildStatus'
  __sro__ = (<InterfaceClass buildbot.interfaces.IBuildStatus>, ...
  dependents = <WeakKeyDictionary at 41425880>
Method Details

isFinished()

source code 

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

waitUntilFinished()

source code 

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

getProperty(propname)

source code 

Return the value of the build property with the given name. Raises KeyError if there is no such property on this build.

getReason()

source code 

Return a string that indicates why the build was run. 'changes', 'forced', and 'periodic' are the most likely values. 'try' will be added in the future.

getSourceStamp()

source code 

Return a SourceStamp object which can be used to re-create the source tree that this build used.

This method will return None if the source information is no longer available.

getResponsibleUsers()

source code 

Return a list of Users who are to blame for the changes that went into this build. If anything breaks (at least anything that wasn't already broken), blame them. Specifically, this is the set of users who were responsible for the Changes that went into this build. Each User is a string, corresponding to their name as known by the VC repository.

getInterestedUsers()

source code 

Return a list of Users who will want to know about the results of this build. This is a superset of getResponsibleUsers(): it adds people who are interested in this build but who did not actually make the Changes that went into it (build sheriffs, code-domain owners).

getNumber()

source code 

Within each builder, each Build has a number. Return it.

getPreviousBuild()

source code 

Convenience method. Returns None if the previous build is unavailable.

getSteps()

source code 

Return a list of IBuildStepStatus objects. For invariant builds (those which always use the same set of Steps), this should always return the complete list, however some of the steps may not have started yet (step.getTimes()[0] will be None). For variant builds, this may not be complete (asking again later may give you more of them).

getTimes()

source code 

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

getETA()

source code 

Returns the number of seconds from now in which the build 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 to describe the build. 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.

getLogs()

source code 

Return a list of logs that describe the build as a whole. Some steps will contribute their logs, while others are are less important and will only be accessible through the IBuildStepStatus objects. Each log is an object which implements the IStatusLog interface.

getTestResults()

source code 

Return a dictionary that maps test-name tuples to ITestResult objects. This may return an empty or partially-filled dictionary until the build has completed.

subscribe(receiver, updateInterval=None)

source code 

Register an IStatusReceiver to receive new status events. The receiver will be given stepStarted and stepFinished messages. If 'updateInterval' is non-None, buildETAUpdate messages will be sent 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.IBuildStatus>,
 <InterfaceClass zope.interface.Interface>)

__sro__

Value:
(<InterfaceClass buildbot.interfaces.IBuildStatus>,
 <InterfaceClass zope.interface.Interface>)