Package buildbot :: Package status :: Module builder :: Class BuilderStatus

Class BuilderStatus

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

I handle status information for a single process.build.Builder object. That object sends status changes to me (frequently as Events), and I provide them on demand to the various status recipients, like the HTML waterfall display and the live status clients. It also sends build summaries to me, which I log and provide to status clients who aren't interested in seeing details of the individual build steps.

I am responsible for maintaining the list of historic Events and Builds, pruning old ones, and loading them from / saving them to disk.

I live in the buildbot.process.build.Builder object, in the .builder_status attribute.

Instance Methods

__init__(self, buildername, category, master)

source code

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

source code

__setstate__(self, d)

source code

upgradeToVersion1(self)

source code

determineNextBuildNumber(self)
Scan our directory of saved BuildStatus instances to determine what our self.nextBuildNumber should be.

source code

saveYourself(self)

source code

makeBuildFilename(self, number)

source code

touchBuildCache(self, build)

source code

getBuildByNumber(self, number)

source code

prune(self, events_only=False)

source code

getName(self)

source code

getState(self)

source code

getSlaves(self)

source code

getPendingBuildRequestStatuses(self)

source code

getCurrentBuilds(self)

source code

getLastFinishedBuild(self)

source code

getCategory(self)

source code

getBuild(self, number)

source code

getEvent(self, number)

source code

generateFinishedBuilds(self, branches=[], num_builds=None, max_buildnum=None, finished_before=None, max_search=200) source code

eventGenerator(self, branches=[], categories=[], committers=[], minTime=0)
This function creates a generator which will provide all of this Builder's status events, starting with the most recent and progressing backwards in time. source code

subscribe(self, receiver)

source code

unsubscribe(self, receiver)

source code

setSlavenames(self, names)

source code

addEvent(self, text=[]) source code

addPointEvent(self, text=[]) source code

setBigState(self, state)

source code

publishState(self, target=None)

source code

newBuild(self)
The Builder has decided to start a build, but the Build object is not yet ready to report status (it has not finished creating the Steps).

source code

buildStarted(self, s)
Now the BuildStatus object is ready to go (it knows all of its Steps, its ETA, etc), so it is safe to notify our watchers.

source code

asDict(self)

source code

asDict_async(self)
Just like asDict, but with a nonzero pendingBuilds.

source code

getMetrics(self)

source code

__provides__(...)
Special descriptor for class __provides__

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

Class Variables
	persistenceVersion = `1`
	persistenceForgets = `('wasUpgraded')`
	currentBigState = `'offline'`
	basedir = `None` hash(x)
	__implemented__ = `<implementedBy buildbot.status.builder.Build...`

Instance Variables
string	category = `None` user-defined category this builder belongs to; can be used to filter on in status clients

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)

setstate(self, d)

source code

Overrides: twisted.persisted.styles.Versioned.__setstate__

determineNextBuildNumber(self)

source code

Scan our directory of saved BuildStatus instances to determine what our self.nextBuildNumber should be. Set it one larger than the highest-numbered build we discover. This is called by the top-level Status object shortly after we are created or loaded from disk.

newBuild(self)

source code

The Builder has decided to start a build, but the Build object is not yet ready to report status (it has not finished creating the Steps). Create a BuildStatus object that it can use.

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__

Class Variable Details

implemented

Value:

<implementedBy buildbot.status.builder.BuilderStatus>

Class BuilderStatus

__getstate__(self)

__setstate__(self, d)

determineNextBuildNumber(self)

newBuild(self)

__provides__(...)

__implemented__

getstate(self)

setstate(self, d)

provides(...)

implemented