buildbot.status.builder.BuildStatus

Package buildbot :: Package status :: Module builder :: Class BuildStatus

Class BuildStatus

Versioned --+
            |
           BuildStatus

Method Summary
	`__init__(self, parent, number)`
	`__getstate__(self)`
	`__setstate__(self, d)`
	`addStepWithName(self, name)` The Build is setting up, and has added a new BuildStep to its list.
	`addTestResult(self, result)`
	`buildFinished(self)`
	`buildStarted(self, build)` The Build has been set up and is about to be started.
	`generateLogfileName(self, stepname, logname)` Return a filename (relative to the Builder's base directory) where the logfile's contents can be stored uniquely.
`BuilderStatus`	`getBuilder(self)`
	`getChanges(self)`
	`getColor(self)`
	`getCurrentStep(self)`
	`getETA(self)`
	`getInterestedUsers(self)`
	`getLogs(self)`
	`getNumber(self)`
	`getPreviousBuild(self)`
	`getProperty(self, propname)`
	`getReason(self)`
	`getResponsibleUsers(self)`
	`getResults(self)`
	`getSlavename(self)`
	`getSourceStamp(self)`
	`getSteps(self)` Return a list of IBuildStepStatus objects.
	`getTestResults(self)`
	`getText(self)`
	`getTimes(self)`
	`isFinished(self)`
	`pruneLogs(self)`
	`pruneSteps(self)`
	`saveYourself(self)`
	`sendETAUpdate(self, receiver, updateInterval)`
	`setBlamelist(self, blamelist)`
	`setColor(self, color)`
	`setProgress(self, progress)`
	`setProperty(self, propname, value)`
	`setReason(self, reason)`
	`setResults(self, results)`
	`setSlavename(self, slavename)`
	`setSourceStamp(self, sourceStamp)`
	`setText(self, text)`
	`stepStarted(self, step)`
	`subscribe(self, receiver, updateInterval)`
	`unsubscribe(self, receiver)`
	`upgradeLogfiles(self)`
	`upgradeToVersion1(self)`
	`upgradeToVersion2(self)`
	`waitUntilFinished(self)`
Inherited from Versioned
	`versionUpgrade(self)` (internal) Do a version upgrade.

Class Variable Summary
`Implements`	`__implemented__` = `<implementedBy buildbot.status.builder...`
`ClassProvides`	`__provides__` = `<zope.interface.declarations.ClassProvide...`
`list`	`blamelist` = `[]`
`list`	`changes` = `[]`
`NoneType`	`color` = None
`NoneType`	`currentStep` = None
`NoneType`	`finished` = None
`list`	`finishedWatchers` = `[]`
`int`	`persistenceVersion` = 2
`NoneType`	`progress` = None
`NoneType`	`reason` = None
`NoneType`	`results` = None
`str`	`slavename` = `'???'`
`NoneType`	`source` = None
`NoneType`	`started` = None
`dict`	`testResults` = `{}`
`list`	`text` = `[]`
`dict`	`updates` = `{}`
`list`	`watchers` = `[]`
Inherited from Versioned
`ClassProvides`	`__providedBy__` = `<zope.interface.declarations.ClassProvi...`
`tuple`	`persistenceForgets` = `()`

Method Details

init(self, parent, number)
(Constructor)

Parameters:: parent
(type=BuilderStatus); number
(type=int)

addStepWithName(self, name)

The Build is setting up, and has added a new BuildStep to its list. Create a BuildStepStatus object to which it can send status updates.

buildStarted(self, build)

The Build has been set up and is about to be started. It can now be safely queried, so it is time to announce the new build.

generateLogfileName(self, stepname, logname)

Return a filename (relative to the Builder's base directory) where the logfile's contents can be stored uniquely.

The base filename is made by combining our build number, the Step's name, and the log's name, then removing unsuitable characters. The filename is then made unique by appending _0, _1, etc, until it does not collide with any other logfile.

These files are kept in the Builder's basedir (rather than a per-Build subdirectory) because that makes cleanup easier: cron and find will help get rid of the old logs, but the empty directories are more of a hassle to remove.

getBuilder(self)

Returns:: BuilderStatus

getSteps(self)

Return a list of IBuildStepStatus objects. For invariant builds (those which always use the same set of Steps), this should be 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).

Class Variable Details

implemented

Type:: Implements
Value:: <implementedBy buildbot.status.builder.BuildStatus>

provides

Type:: ClassProvides
Value:: <zope.interface.declarations.ClassProvides object at 0x40652dac>

blamelist

Type:: list
Value:: []

changes

Type:: list
Value:: []

color

Type:: NoneType
Value:: None

currentStep

Type:: NoneType
Value:: None

finished

Type:: NoneType
Value:: None

finishedWatchers

Type:: list
Value:: []

persistenceVersion

Type:: int
Value:: 2

progress

Type:: NoneType
Value:: None

reason

Type:: NoneType
Value:: None

results

Type:: NoneType
Value:: None

slavename

Type:: str
Value:: '???'

source

Type:: NoneType
Value:: None

started

Type:: NoneType
Value:: None

testResults

Type:: dict
Value:: {}

text

Type:: list
Value:: []

updates

Type:: dict
Value:: {}

watchers

Type:: list
Value:: []

Generated by Epydoc 2.1 on Sun Dec 10 22:04:44 2006

http://epydoc.sf.net