Package buildbot :: Package steps :: Module shell :: Class WarningCountingShellCommand

Class WarningCountingShellCommand

                            object --+            
                                     |            
process.properties.PropertiesMixin --+            
                                     |            
           process.buildstep.BuildStep --+        
                                         |        
        process.buildstep.LoggingBuildStep --+    
                                             |    
                                  ShellCommand --+
                                                 |
                                                WarningCountingShellCommand

Known Subclasses:

Instance Methods

__init__(self, warningPattern=None, warningExtractor=None, maxWarnCount=None, directoryEnterPattern=None, directoryLeavePattern=None, suppressionFile=None, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

addSuppression(self, suppressionList)
This method can be used to add patters of warnings that should not be counted.

source code

warnExtractWholeLine(self, line, match)
Extract warning text as the whole line.

source code

warnExtractFromRegexpGroups(self, line, match)
Extract file name, line number, and warning text as groups (1,2,3) of warningPattern match.

source code

maybeAddWarning(self, warnings, line, match)

source code

start(self)

source code

uploadDone(self, dummy)

source code

createSummary(self, log)
Match log lines against warningPattern.

source code

evaluateCommand(self, cmd)

source code

Inherited from ShellCommand: buildCommandKwargs, describe, 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: __provides__, acquireLocks, addCompleteLog, addFactoryArguments, addHTMLLog, addLog, addLogObserver, addURL, failed, finished, getLog, getSlaveName, releaseLocks, runCommand, setBuildSlave, setProgress, setupProgress, slaveVersion, slaveVersionIsOlderThan, startStep

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Inherited from process.properties.PropertiesMixin: __providedBy__, getProperties, getProperty, hasProperty, has_key, render, setProperty

Static Methods
Inherited from `process.buildstep.BuildStep`: `__new__`

Class Variables
	renderables = `['suppressionFile']`
	warnCount = `0`
	warningPattern = `'.warning[: ].'`
	directoryEnterPattern = u'make.: Entering directory [’"`'](....
	directoryLeavePattern = `'make.*: Leaving directory'`
	suppressionFile = `None` hash(x)
	commentEmptyLineRe = `re.compile(r'^\s(#.)?$')`
	suppressionLineRe = `re.compile(r'^\s(.+?)\s:\s(.+?)\s(?::\...`
Inherited from `ShellCommand`: `description`, `descriptionDone`, `descriptionSuffix`, `flunkOnFailure`, `name` Inherited from `process.buildstep.LoggingBuildStep`: `cmd`, `parms`, `progressMetrics` Inherited from `process.buildstep.BuildStep`: `__implemented__`, `alwaysRun`, `build`, `doStepIf`, `flunkOnWarnings`, `haltOnFailure`, `hideStepIf`, `locks`, `progress`, `set_runtime_properties`, `step_status`, `useProgress`, `warnOnFailure`, `warnOnWarnings`

Instance Variables
Inherited from `ShellCommand`: `command`, `lazylogfiles`, `logfiles`

Properties
Inherited from `object`: `__class__`

Method Details

init(self, warningPattern=None, warningExtractor=None, maxWarnCount=None, directoryEnterPattern=None, directoryLeavePattern=None, suppressionFile=None, **kwargs)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

addSuppression(self, suppressionList)

source code

This method can be used to add patters of warnings that should not be counted.

It takes a single argument, a list of patterns.

Each pattern is a 4-tuple (FILE-RE, WARN-RE, START, END).

FILE-RE is a regular expression (string or compiled regexp), or None. If None, the pattern matches all files, else only files matching the regexp. If directoryEnterPattern is specified in the class constructor, matching is against the full path name, eg. src/main.c.

WARN-RE is similarly a regular expression matched against the text of the warning, or None to match all warnings.

START and END form an inclusive line number range to match against. If START is None, there is no lower bound, similarly if END is none there is no upper bound.

warnExtractWholeLine(self, line, match)

source code

Extract warning text as the whole line. No file names or line numbers.

start(self)

source code

Overrides: process.buildstep.BuildStep.start

createSummary(self, log)

source code

Match log lines against warningPattern.

Warnings are collected into another log for this step, and the build-wide 'warnings-count' is updated.

Overrides: process.buildstep.LoggingBuildStep.createSummary

evaluateCommand(self, cmd)

source code

Overrides: process.buildstep.LoggingBuildStep.evaluateCommand

Class Variable Details

directoryEnterPattern

Value:

u'make.*: Entering directory [’"`'](.*)[’'`"]'

suppressionLineRe

Value:

re.compile(r'^\s*(.+?)\s*:\s*(.+?)\s*(?::\s*([0-9]+)(?:-([0-9]+))?\s*)
?$')

Class WarningCountingShellCommand

__init__(self, warningPattern=None, warningExtractor=None, maxWarnCount=None, directoryEnterPattern=None, directoryLeavePattern=None, suppressionFile=None, **kwargs) (Constructor)

addSuppression(self, suppressionList)

warnExtractWholeLine(self, line, match)

start(self)

createSummary(self, log)

evaluateCommand(self, cmd)

directoryEnterPattern

suppressionLineRe

init(self, warningPattern=None, warningExtractor=None, maxWarnCount=None, directoryEnterPattern=None, directoryLeavePattern=None, suppressionFile=None, **kwargs)
(Constructor)