Package buildbot :: Package steps :: Module shell :: Class Test

Class Test

   process.buildstep.BuildStep --+            
                                 |            
process.buildstep.LoggingBuildStep --+        
                                     |        
                          ShellCommand --+    
                                         |    
               WarningCountingShellCommand --+
                                             |
                                            Test

Known Subclasses:

Instance Methods

setTestResults(self, total=0, failed=0, passed=0, warnings=0)
Called by subclasses to set the relevant statistics; this actually adds to any statistics already present

source code

describe(self, done=False)
Return a list of short strings to describe this step, for the status display.

source code

Inherited from WarningCountingShellCommand: __init__, addSuppression, createSummary, evaluateCommand, maybeAddWarning, start, uploadDone, warnExtractFromRegexpGroups, warnExtractWholeLine

Inherited from ShellCommand: buildCommandKwargs, getWorkdir, setBuild, setCommand, setDefaultWorkdir, setStepStatus, setupEnvironment

Inherited from process.buildstep.LoggingBuildStep: addLogFile, checkDisconnect, commandComplete, getText, getText2, interrupt, maybeGetText2, setStatus, setupLogfiles, startCommand

Inherited from process.buildstep.BuildStep: acquireLocks, addCompleteLog, addFactoryArguments, addHTMLLog, addLog, addLogObserver, addURL, failed, finished, getLog, getProperty, getSlaveName, getStepFactory, releaseLocks, runCommand, setBuildSlave, setProgress, setProperty, setupProgress, slaveVersion, slaveVersionIsOlderThan, startStep

Class Variables
	name = `'test'`
	warnOnFailure = `1`
	description = `['testing']`
	descriptionDone = `['test']`
	command = `['make', 'test']` a list of renderable objects (typically strings or WithProperties instances).
Inherited from `WarningCountingShellCommand`: `commentEmptyLineRe`, `directoryEnterPattern`, `directoryLeavePattern`, `renderables`, `suppressionFile`, `suppressionLineRe`, `warnCount`, `warningPattern` Inherited from `ShellCommand`: `flunkOnFailure` Inherited from `process.buildstep.LoggingBuildStep`: `cmd`, `parms`, `progressMetrics` Inherited from `process.buildstep.BuildStep`: `alwaysRun`, `doStepIf`, `flunkOnWarnings`, `haltOnFailure`, `locks`, `useProgress`, `warnOnWarnings`

Instance Variables

Inherited from ShellCommand: lazylogfiles, logfiles

Inherited from process.buildstep.BuildStep: build, progress, step_status

Method Details

describe(self, done=False)

source code

Return a list of short strings to describe this step, for the status display. This uses the first few words of the shell command. You can replace this by setting .description in your subclass, or by overriding this method to describe the step better.

Parameters:

done - whether the command is complete or not, to improve the way the command is described. done=False is used while the command is still running, so a single imperfect-tense verb is appropriate ('compiling', 'testing', ...) done=True is used when the command has finished, and the default getText() method adds some text, so a simple noun is appropriate ('compile', 'tests' ...)

Overrides: process.buildstep.BuildStep.describe