Package buildbot :: Package status :: Module builder :: Class BuildStepStatus

Class BuildStepStatus

twisted.persisted.styles.Versioned --+
                                     |
                                    BuildStepStatus

I represent a collection of output status for a buildbot.process.step.BuildStep.

Statistics contain any information gleaned from a step that is not in the form of a logfile. As an example, steps that run tests might gather statistics about the number of passed, failed, or skipped tests.

Instance Methods

__getstate__(self)
Get state, adding a version number to it on its way out.

source code

__init__(self, parent, step_number)

source code

__provides__(...)
Special descriptor for class __provides__

__setstate__(self, d)

source code

addHTMLLog(self, name, html)

source code

addLog(self, name)

source code

addURL(self, name, url)

source code

asDict(self)

source code

checkLogfiles(self)

source code

getBuild(self)

source code

getETA(self)

source code

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

source code

getLogs(self)

source code

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

source code

tuple of int, list of strings

getResults(self)
Return a tuple describing the results of the step.

source code

getStatistic(self, name, default=None)
Return the given statistic, if present

source code

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

source code

getTimes(self)

source code

getURLs(self)

source code

hasStatistic(self, name)
Return true if this step has a value for the given statistic.

source code

isFinished(self)

source code

isSkipped(self)

source code

isStarted(self)

source code

isWaitingForLocks(self)

source code

logFinished(self, log)

source code

sendETAUpdate(self, receiver, updateInterval)

source code

setColor(self, color)

source code

setName(self, stepname)

source code

setProgress(self, stepprogress)

source code

setSkipped(self, skipped)

source code

setStatistic(self, name, value)
Set the given statistic.

source code

setText(self, text)

source code

setText2(self, text)

source code

setWaitingForLocks(self, waiting)

source code

stepFinished(self, results)

source code

stepStarted(self)

source code

subscribe(self, receiver, updateInterval=10)

source code

unsubscribe(self, receiver)

source code

upgradeToVersion1(self)

source code

upgradeToVersion2(self)

source code

upgradeToVersion3(self)

source code

waitUntilFinished(self)

source code

Inherited from twisted.persisted.styles.Versioned: __providedBy__, versionUpgrade

Class Variables
	__implemented__ = `<implementedBy buildbot.status.buildstep.Bui...`
	finished = `None` hash(x)
	finishedWatchers = `[]`
	persistenceForgets = `('wasUpgraded')`
	persistenceVersion = `3`
buildbot.status.progress.StepProgress	progress = `None` tracks ETA for the step
	results = `None` hash(x)
	started = `None` hash(x)
	step_number = `None` hash(x)
list of strings	text = `[]` list of short texts that describe the command and its status
list of strings	text2 = `[]` list of short texts added to the overall build description
	updates = `{}`
	watchers = `[]`

Instance Variables
dict of string -> buildbot.status.logfile.LogFile	logs logs of steps
dict	statistics = `{}` results from running this step

Method Details

getstate(self)

source code

Get state, adding a version number to it on its way out.

Overrides: twisted.persisted.styles.Versioned.__getstate__: (inherited documentation)

provides(...)

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that
we can get declarations for objects without instance-specific
interfaces a bit quicker.

For example:

  >>> from zope.interface import Interface
  >>> class IFooFactory(Interface):
  ...     pass
  >>> class IFoo(Interface):
  ...     pass
  >>> class C(object):
  ...     implements(IFoo)
  ...     classProvides(IFooFactory)
  >>> [i.getName() for i in C.__provides__]
  ['IFooFactory']

  >>> [i.getName() for i in C().__provides__]
  ['IFoo']

Overrides: twisted.persisted.styles.Versioned.__provides__

setstate(self, d)

source code

Overrides: twisted.persisted.styles.Versioned.__setstate__

getName(self)

source code

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

getResults(self)

source code

Return a tuple describing the results of the step. '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.

Returns: tuple of int, list of strings: (result, strings)

getText(self)

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.

setStatistic(self, name, value)

source code

Set the given statistic. Usually called by subclasses.

Class Variable Details

implemented

Value:

<implementedBy buildbot.status.buildstep.BuildStepStatus>

Class BuildStepStatus

__getstate__(self)

__provides__(...)

__setstate__(self, d)

getName(self)

getResults(self)

getText(self)

setStatistic(self, name, value)

__implemented__

getstate(self)

provides(...)

setstate(self, d)

implemented