1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
|
# This file is part of Buildbot. Buildbot is free software: you can
# redistribute it and/or modify it under the terms of the GNU General Public
# License as published by the Free Software Foundation, version 2.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright Buildbot Team Members
import re
from buildbot.status.results import SUCCESS, FAILURE, WARNINGS
from buildbot.steps.shell import ShellCommand
from buildbot import config
try:
import cStringIO
StringIO = cStringIO.StringIO
except ImportError:
from StringIO import StringIO
class BuildEPYDoc(ShellCommand):
name = "epydoc"
command = ["make", "epydocs"]
description = ["building", "epydocs"]
descriptionDone = ["epydoc"]
def createSummary(self, log):
import_errors = 0
warnings = 0
errors = 0
for line in StringIO(log.getText()):
if line.startswith("Error importing "):
import_errors += 1
if line.find("Warning: ") != -1:
warnings += 1
if line.find("Error: ") != -1:
errors += 1
self.descriptionDone = self.descriptionDone[:]
if import_errors:
self.descriptionDone.append("ierr=%d" % import_errors)
if warnings:
self.descriptionDone.append("warn=%d" % warnings)
if errors:
self.descriptionDone.append("err=%d" % errors)
self.import_errors = import_errors
self.warnings = warnings
self.errors = errors
def evaluateCommand(self, cmd):
if cmd.didFail():
return FAILURE
if self.warnings or self.errors:
return WARNINGS
return SUCCESS
class PyFlakes(ShellCommand):
name = "pyflakes"
command = ["make", "pyflakes"]
description = ["running", "pyflakes"]
descriptionDone = ["pyflakes"]
flunkOnFailure = False
flunkingIssues = ["undefined"] # any pyflakes lines like this cause FAILURE
MESSAGES = ("unused", "undefined", "redefs", "import*", "misc")
def __init__(self, *args, **kwargs):
# PyFlakes return 1 for both warnings and errors. We
# categorize this initially as WARNINGS so that
# evaluateCommand below can inspect the results more closely.
kwargs['decodeRC'] = {0: SUCCESS, 1: WARNINGS}
ShellCommand.__init__(self, *args, **kwargs)
def createSummary(self, log):
counts = {}
summaries = {}
for m in self.MESSAGES:
counts[m] = 0
summaries[m] = []
first = True
for line in StringIO(log.getText()).readlines():
# the first few lines might contain echoed commands from a 'make
# pyflakes' step, so don't count these as warnings. Stop ignoring
# the initial lines as soon as we see one with a colon.
if first:
if line.find(":") != -1:
# there's the colon, this is the first real line
first = False
# fall through and parse the line
else:
# skip this line, keep skipping non-colon lines
continue
if line.find("imported but unused") != -1:
m = "unused"
elif line.find("*' used; unable to detect undefined names") != -1:
m = "import*"
elif line.find("undefined name") != -1:
m = "undefined"
elif line.find("redefinition of unused") != -1:
m = "redefs"
else:
m = "misc"
summaries[m].append(line)
counts[m] += 1
self.descriptionDone = self.descriptionDone[:]
for m in self.MESSAGES:
if counts[m]:
self.descriptionDone.append("%s=%d" % (m, counts[m]))
self.addCompleteLog(m, "".join(summaries[m]))
self.setProperty("pyflakes-%s" % m, counts[m], "pyflakes")
self.setProperty("pyflakes-total", sum(counts.values()), "pyflakes")
def evaluateCommand(self, cmd):
if cmd.didFail():
return FAILURE
for m in self.flunkingIssues:
if self.getProperty("pyflakes-%s" % m):
return FAILURE
if self.getProperty("pyflakes-total"):
return WARNINGS
return SUCCESS
class PyLint(ShellCommand):
'''A command that knows about pylint output.
It is a good idea to add --output-format=parseable to your
command, since it includes the filename in the message.
'''
name = "pylint"
description = ["running", "pylint"]
descriptionDone = ["pylint"]
# pylint's return codes (see pylint(1) for details)
# 1 - 16 will be bit-ORed
RC_OK = 0
RC_FATAL = 1
RC_ERROR = 2
RC_WARNING = 4
RC_REFACTOR = 8
RC_CONVENTION = 16
RC_USAGE = 32
# Using the default text output, the message format is :
# MESSAGE_TYPE: LINE_NUM:[OBJECT:] MESSAGE
# with --output-format=parseable it is: (the outer brackets are literal)
# FILE_NAME:LINE_NUM: [MESSAGE_TYPE[, OBJECT]] MESSAGE
# message type consists of the type char and 4 digits
# The message types:
MESSAGES = {
'C': "convention", # for programming standard violation
'R': "refactor", # for bad code smell
'W': "warning", # for python specific problems
'E': "error", # for much probably bugs in the code
'F': "fatal", # error prevented pylint from further processing.
'I': "info",
}
flunkingIssues = ["F", "E"] # msg categories that cause FAILURE
_re_groupname = 'errtype'
_msgtypes_re_str = '(?P<%s>[%s])' % (_re_groupname, ''.join(MESSAGES.keys()))
_default_line_re = re.compile(r'^%s(\d{4})?: *\d+(,\d+)?:.+' % _msgtypes_re_str)
_parseable_line_re = re.compile(r'[^:]+:\d+: \[%s(\d{4})?[,\]] .+' % _msgtypes_re_str)
def createSummary(self, log):
counts = {}
summaries = {}
for m in self.MESSAGES:
counts[m] = 0
summaries[m] = []
line_re = None # decide after first match
for line in StringIO(log.getText()).readlines():
if not line_re:
# need to test both and then decide on one
if self._parseable_line_re.match(line):
line_re = self._parseable_line_re
elif self._default_line_re.match(line):
line_re = self._default_line_re
else: # no match yet
continue
mo = line_re.match(line)
if mo:
msgtype = mo.group(self._re_groupname)
assert msgtype in self.MESSAGES
summaries[msgtype].append(line)
counts[msgtype] += 1
self.descriptionDone = self.descriptionDone[:]
for msg, fullmsg in self.MESSAGES.items():
if counts[msg]:
self.descriptionDone.append("%s=%d" % (fullmsg, counts[msg]))
self.addCompleteLog(fullmsg, "".join(summaries[msg]))
self.setProperty("pylint-%s" % fullmsg, counts[msg])
self.setProperty("pylint-total", sum(counts.values()))
def evaluateCommand(self, cmd):
if cmd.rc & (self.RC_FATAL|self.RC_ERROR|self.RC_USAGE):
return FAILURE
for msg in self.flunkingIssues:
if self.getProperty("pylint-%s" % self.MESSAGES[msg]):
return FAILURE
if self.getProperty("pylint-total"):
return WARNINGS
return SUCCESS
class Sphinx(ShellCommand):
''' A Step to build sphinx documentation '''
name = "sphinx"
description = ["running", "sphinx"]
descriptionDone = ["sphinx"]
haltOnFailure = True
def __init__(self, sphinx_sourcedir='.', sphinx_builddir=None,
sphinx_builder=None, sphinx = 'sphinx-build', tags = [],
defines = {}, mode='incremental', **kwargs):
if sphinx_builddir is None:
# Who the heck is not interested in the built doc ?
config.error("Sphinx argument sphinx_builddir is required")
if mode not in ('incremental', 'full'):
config.error("Sphinx argument mode has to be 'incremental' or" +
"'full' is required")
self.warnings = 0
self.success = False
ShellCommand.__init__(self, **kwargs)
# build the command
command = [sphinx]
if sphinx_builder is not None:
command.extend(['-b', sphinx_builder])
for tag in tags:
command.extend(['-t', tag])
for key in sorted(defines):
if defines[key] is None:
command.extend(['-D', key])
elif isinstance(defines[key], bool):
command.extend(['-D',
'%s=%d' % (key, defines[key] and 1 or 0)])
else:
command.extend(['-D', '%s=%s' % (key, defines[key])])
if mode == 'full':
command.extend(['-E']) # Don't use a saved environment
command.extend([sphinx_sourcedir, sphinx_builddir])
self.setCommand(command)
def createSummary(self, log):
msgs = ['WARNING', 'ERROR', 'SEVERE']
warnings = []
for line in log.getText().split('\n'):
if (line.startswith('build succeeded')
or line.startswith('no targets are out of date.')):
self.success = True
else:
for msg in msgs:
if msg in line:
warnings.append(line)
self.warnings += 1
if self.warnings > 0:
self.addCompleteLog('warnings', "\n".join(warnings))
self.step_status.setStatistic('warnings', self.warnings)
def evaluateCommand(self, cmd):
if self.success:
if self.warnings == 0:
return SUCCESS
else:
return WARNINGS
else:
return FAILURE
def describe(self, done=False):
if not done:
return ["building"]
description = [self.name]
description.append('%d warnings' % self.warnings)
return description
|
