22
23
# import system imports here
30
28
#import bzrlib specific imports here
31
29
from bzrlib import (
34
32
import bzrlib.branch
35
from bzrlib.tests import (
41
# Files which are listed here will be skipped when testing for Copyright (or
43
COPYRIGHT_EXCEPTIONS = ['bzrlib/lsprof.py', 'bzrlib/_bencode_py.py',
44
'bzrlib/doc_generate/sphinx_conf.py']
46
LICENSE_EXCEPTIONS = ['bzrlib/lsprof.py', 'bzrlib/_bencode_py.py',
47
'bzrlib/doc_generate/sphinx_conf.py']
48
# Technically, 'bzrlib/lsprof.py' should be 'bzrlib/util/lsprof.py',
49
# (we do not check bzrlib/util/, since that is code bundled from elsewhere)
50
# but for compatibility with previous releases, we don't want to move it.
52
# sphinx_conf is semi-autogenerated.
33
from bzrlib.tests import TestCase, TestSkipped
55
36
class TestSourceHelper(TestCase):
57
38
def source_file_name(self, package):
58
39
"""Return the path of the .py file for package."""
59
if getattr(sys, "frozen", None) is not None:
60
raise TestSkipped("can't test sources in frozen distributions.")
61
40
path = package.__file__
62
41
if path[-1] in 'co':
148
119
yield fname, text
150
def is_our_code(self, fname):
151
"""Return true if it's a "real" part of bzrlib rather than external code"""
152
if '/util/' in fname or '/plugins/' in fname:
157
def is_copyright_exception(self, fname):
158
"""Certain files are allowed to be different"""
159
if not self.is_our_code(fname):
160
# We don't ask that external utilities or plugins be
163
for exc in COPYRIGHT_EXCEPTIONS:
164
if fname.endswith(exc):
168
def is_license_exception(self, fname):
169
"""Certain files are allowed to be different"""
170
if not self.is_our_code(fname):
172
for exc in LICENSE_EXCEPTIONS:
173
if fname.endswith(exc):
177
def test_tmpdir_not_in_source_files(self):
178
"""When scanning for source files, we don't descend test tempdirs"""
179
for filename in self.get_source_files():
180
if re.search(r'test....\.tmp', filename):
181
self.fail("get_source_file() returned filename %r "
182
"from within a temporary directory"
121
def is_exception(self, fname):
122
"""Certain files are allowed to be different"""
123
if '/util/' in fname:
124
# We don't require external utilities to be (C) Canonical Ltd
127
exceptions = ['bzrlib/lsprof.py']
128
for exc in exceptions:
129
if fname.endswith(exc):
185
134
def test_copyright(self):
186
"""Test that all .py and .pyx files have a valid copyright statement"""
135
"""Test that all .py files have a valid copyright statement"""
136
# These are files which contain a different copyright statement
189
copyright_re = re.compile('#\\s*copyright.*(?=\n)', re.I)
140
copyright_re = re.compile('#\\s*copyright.*\n', re.I)
190
141
copyright_canonical_re = re.compile(
191
142
r'# Copyright \(C\) ' # Opening "# Copyright (C)"
192
143
r'(\d+)(, \d+)*' # Followed by a series of dates
193
144
r'.*Canonical Ltd' # And containing 'Canonical Ltd'
196
for fname, text in self.get_source_file_contents(
197
extensions=('.py', '.pyx')):
198
if self.is_copyright_exception(fname):
147
for fname, text in self.get_source_file_contents():
148
if self.is_exception(fname):
200
150
match = copyright_canonical_re.search(text)
246
191
# You should have received a copy of the GNU General Public License
247
192
# along with this program; if not, write to the Free Software
248
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
193
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
250
195
gpl_re = re.compile(re.escape(gpl_txt), re.MULTILINE)
252
for fname, text in self.get_source_file_contents(
253
extensions=('.py', '.pyx')):
254
if self.is_license_exception(fname):
197
for fname, text in self.get_source_file_contents():
198
if self.is_exception(fname):
256
200
if not gpl_re.search(text):
257
201
incorrect.append(fname)
260
204
help_text = ['Some files have missing or incomplete GPL statement',
262
"Please either add them to the list of"
263
" LICENSE_EXCEPTIONS in"
264
" bzrlib/tests/test_source.py",
265
"Or add the following text to the beginning:",
205
'Please fix the following files to have text:',
268
208
for fname in incorrect:
269
209
help_text.append((' '*4) + fname)
271
211
self.fail('\n'.join(help_text))
273
def _push_file(self, dict_, fname, line_no):
274
if fname not in dict_:
275
dict_[fname] = [line_no]
277
dict_[fname].append(line_no)
279
def _format_message(self, dict_, message):
280
files = ["%s: %s" % (f, ', '.join([str(i+1) for i in lines]))
281
for f, lines in dict_.items()]
283
return message + '\n\n %s' % ('\n '.join(files))
285
def test_coding_style(self):
286
"""Check if bazaar code conforms to some coding style conventions.
288
Currently we assert that the following is not present:
291
* no newline at end of files
293
Print how many files have
294
* trailing white space
295
* lines longer than 79 chars
299
illegal_newlines = {}
301
no_newline_at_eof = []
302
for fname, text in self.get_source_file_contents(
303
extensions=('.py', '.pyx')):
304
if not self.is_our_code(fname):
306
lines = text.splitlines(True)
307
last_line_no = len(lines) - 1
308
for line_no, line in enumerate(lines):
310
self._push_file(tabs, fname, line_no)
311
if not line.endswith('\n') or line.endswith('\r\n'):
312
if line_no != last_line_no: # not no_newline_at_eof
313
self._push_file(illegal_newlines, fname, line_no)
314
if line.endswith(' \n'):
315
self._push_file(trailing_ws, fname, line_no)
317
self._push_file(long_lines, fname, line_no)
318
if not lines[-1].endswith('\n'):
319
no_newline_at_eof.append(fname)
322
problems.append(self._format_message(tabs,
323
'Tab characters were found in the following source files.'
324
'\nThey should either be replaced by "\\t" or by spaces:'))
326
print ("There are %i lines with trailing white space in %i files."
327
% (sum([len(lines) for f, lines in trailing_ws.items()]),
330
problems.append(self._format_message(illegal_newlines,
331
'Non-unix newlines were found in the following source files:'))
333
print ("There are %i lines longer than 79 characters in %i files."
334
% (sum([len(lines) for f, lines in long_lines.items()]),
336
if no_newline_at_eof:
337
no_newline_at_eof.sort()
338
problems.append("The following source files doesn't have a "
339
"newline at the end:"
341
% ('\n '.join(no_newline_at_eof)))
343
self.fail('\n\n'.join(problems))
345
def test_no_asserts(self):
346
"""bzr shouldn't use the 'assert' statement."""
347
# assert causes too much variation between -O and not, and tends to
348
# give bad errors to the user
350
# scan down through x for assert statements, report any problems
351
# this is a bit cheesy; it may get some false positives?
352
if x[0] == symbol.assert_stmt:
354
elif x[0] == token.NAME:
355
# can't search further down
358
if sub and search(sub):
362
assert_re = re.compile(r'\bassert\b')
363
for fname, text in self.get_source_file_contents():
364
if not self.is_our_code(fname):
366
if not assert_re.search(text):
368
ast = parser.ast2tuple(parser.suite(text))
370
badfiles.append(fname)
373
"these files contain an assert statement and should not:\n%s"
374
% '\n'.join(badfiles))
376
def test_extension_exceptions(self):
377
"""Extension functions should propagate exceptions.
379
Either they should return an object, have an 'except' clause, or have a
380
"# cannot_raise" to indicate that we've audited them and defined them as not
383
both_exc_and_no_exc = []
385
class_re = re.compile(r'^(cdef\s+)?(public\s+)?(api\s+)?class (\w+).*:',
387
except_re = re.compile(r'cdef\s+' # start with cdef
388
r'([\w *]*?)\s*' # this is the return signature
389
r'(\w+)\s*\(' # the function name
390
r'[^)]*\)\s*' # parameters
391
r'(.*)\s*:' # the except clause
392
r'\s*(#\s*cannot[- _]raise)?' # cannot raise comment
394
for fname, text in self.get_source_file_contents(
395
extensions=('.pyx',)):
396
known_classes = set([m[-1] for m in class_re.findall(text)])
397
cdefs = except_re.findall(text)
398
for sig, func, exc_clause, no_exc_comment in cdefs:
399
if sig.startswith('api '):
401
if not sig or sig in known_classes:
403
if 'nogil' in exc_clause:
404
exc_clause = exc_clause.replace('nogil', '').strip()
405
if exc_clause and no_exc_comment:
406
both_exc_and_no_exc.append((fname, func))
407
if sig != 'object' and not (exc_clause or no_exc_comment):
408
missing_except.append((fname, func))
410
if both_exc_and_no_exc:
411
error_msg.append('The following functions had "cannot raise" comments'
412
' but did have an except clause set:')
413
for fname, func in both_exc_and_no_exc:
414
error_msg.append('%s:%s' % (fname, func))
415
error_msg.extend(('', ''))
417
error_msg.append('The following functions have fixed return types,'
418
' but no except clause.')
419
error_msg.append('Either add an except or append "# cannot_raise".')
420
for fname, func in missing_except:
421
error_msg.append('%s:%s' % (fname, func))
422
error_msg.extend(('', ''))
424
self.fail('\n'.join(error_msg))
added
removed
bzrlib/tests/test_source.py
