15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
17
"""These tests are tests about the source code of bzrlib itself.
21
19
They are useful for testing code quality, checking coverage metric etc.
24
# import system imports here
28
from cStringIO import StringIO
33
#import bzrlib specific imports here
34
29
from bzrlib import (
40
32
import bzrlib.branch
41
33
from bzrlib.tests import (
46
from bzrlib.workingtree import WorkingTree
49
39
# Files which are listed here will be skipped when testing for Copyright (or
51
COPYRIGHT_EXCEPTIONS = ['bzrlib/lsprof.py']
41
COPYRIGHT_EXCEPTIONS = [
42
'bzrlib/_bencode_py.py',
43
'bzrlib/doc_generate/conf.py',
53
LICENSE_EXCEPTIONS = ['bzrlib/lsprof.py']
47
LICENSE_EXCEPTIONS = [
48
'bzrlib/_bencode_py.py',
49
'bzrlib/doc_generate/conf.py',
54
52
# Technically, 'bzrlib/lsprof.py' should be 'bzrlib/util/lsprof.py',
55
53
# (we do not check bzrlib/util/, since that is code bundled from elsewhere)
56
54
# but for compatibility with previous releases, we don't want to move it.
59
def check_coding_style(old_filename, oldlines, new_filename, newlines, to_file,
60
allow_binary=False, sequence_matcher=None,
61
path_encoding='utf8'):
62
"""text_differ to be passed to diff.DiffText, which checks code style """
63
if allow_binary is False:
64
textfile.check_text_lines(oldlines)
65
textfile.check_text_lines(newlines)
67
if sequence_matcher is None:
68
sequence_matcher = patiencediff.PatienceSequenceMatcher
70
started = [False] #trick to access parent scoped variable
71
def start_if_needed():
73
to_file.write('+++ %s\n' % new_filename)
76
def check_newlines(j1, j2):
77
for i, line in enumerate(newlines[j1:j2]):
78
bad_ws_match = re.match(r'^(([\t]*)(.*?)([\t ]*))(\r?\n)?$', line)
80
line_content = bad_ws_match.group(1)
81
has_leading_tabs = bool(bad_ws_match.group(2))
82
has_trailing_whitespace = bool(bad_ws_match.group(4))
85
to_file.write('line %i has leading tabs: "%s"\n'% (
86
i+1+j1, line_content))
87
if has_trailing_whitespace:
89
to_file.write('line %i has trailing whitespace: "%s"\n'% (
90
i+1+j1, line_content))
91
if len(line_content) > 79:
93
'\nFile %s\nline %i is longer than 79 characters:'
94
'\n"%s"'% (new_filename, i+1+j1, line_content))
96
for group in sequence_matcher(None, oldlines, newlines
97
).get_grouped_opcodes(0):
98
for tag, i1, i2, j1, j2 in group:
99
if tag == 'replace' or tag == 'insert':
100
check_newlines(j1, j2)
102
if len(newlines) == j2 and not newlines[j2-1].endswith('\n'):
104
to_file.write("\\ No newline at end of file\n")
56
# sphinx_conf is semi-autogenerated.
107
59
class TestSourceHelper(TestCase):
231
190
def test_copyright(self):
232
"""Test that all .py files have a valid copyright statement"""
233
# These are files which contain a different copyright statement
191
"""Test that all .py and .pyx files have a valid copyright statement"""
237
194
copyright_re = re.compile('#\\s*copyright.*(?=\n)', re.I)
238
195
copyright_canonical_re = re.compile(
239
r'# Copyright \(C\) ' # Opening "# Copyright (C)"
240
r'(\d+)(, \d+)*' # Followed by a series of dates
241
r'.*Canonical Ltd' # And containing 'Canonical Ltd'
196
r'# Copyright \(C\) ' # Opening "# Copyright (C)"
197
r'(\d+)(, \d+)*' # followed by a series of dates
198
r'.*Canonical Ltd') # and containing 'Canonical Ltd'.
244
for fname, text in self.get_source_file_contents():
200
for fname, text in self.get_source_file_contents(
201
extensions=('.py', '.pyx')):
245
202
if self.is_copyright_exception(fname):
247
204
match = copyright_canonical_re.search(text)
293
250
# You should have received a copy of the GNU General Public License
294
251
# along with this program; if not, write to the Free Software
295
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
252
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
297
254
gpl_re = re.compile(re.escape(gpl_txt), re.MULTILINE)
299
for fname, text in self.get_source_file_contents():
256
for fname, text in self.get_source_file_contents(
257
extensions=('.py', '.pyx')):
300
258
if self.is_license_exception(fname):
302
260
if not gpl_re.search(text):
309
267
" LICENSE_EXCEPTIONS in"
310
268
" bzrlib/tests/test_source.py",
311
269
"Or add the following text to the beginning:",
314
271
for fname in incorrect:
315
help_text.append((' '*4) + fname)
272
help_text.append((' ' * 4) + fname)
317
274
self.fail('\n'.join(help_text))
319
def test_no_tabs(self):
320
"""bzrlib source files should not contain any tab characters."""
323
for fname, text in self.get_source_file_contents():
324
if not self.is_our_code(fname):
327
incorrect.append(fname)
330
self.fail('Tab characters were found in the following source files.'
331
'\nThey should either be replaced by "\\t" or by spaces:'
333
% ('\n '.join(incorrect)))
276
def _push_file(self, dict_, fname, line_no):
277
if fname not in dict_:
278
dict_[fname] = [line_no]
280
dict_[fname].append(line_no)
282
def _format_message(self, dict_, message):
283
files = ["%s: %s" % (f, ', '.join([str(i + 1) for i in lines]))
284
for f, lines in dict_.items()]
286
return message + '\n\n %s' % ('\n '.join(files))
335
288
def test_coding_style(self):
336
""" Check if bazaar code conforms to some coding style conventions.
338
Currently we check all .py files for:
339
* new trailing white space
341
* new long lines (give warning only)
342
* no newline at end of files
289
"""Check if bazaar code conforms to some coding style conventions.
291
Generally we expect PEP8, but we do not generally strictly enforce
292
this, and there are existing files that do not comply. The 'pep8'
293
tool, available separately, will check for more cases.
295
This test only enforces conditions that are globally true at the
296
moment, and that should cause a patch to be rejected: spaces rather
297
than tabs, unix newlines, and a newline at the end of the file.
344
bzr_dir = osutils.dirname(self.get_bzrlib_dir())
346
wt = WorkingTree.open(bzr_dir)
349
'Could not open bazaar working tree %s'
351
diff_output = StringIO()
355
old_tree = new_tree.basis_tree()
360
iterator = new_tree.iter_changes(old_tree)
361
for (file_id, paths, changed_content, versioned, parent,
362
name, kind, executable) in iterator:
363
if (changed_content and paths[1].endswith('.py')):
364
if kind == ('file', 'file'):
365
diff_text = diff.DiffText(old_tree, new_tree,
367
text_differ=check_coding_style)
368
diff_text.diff(file_id, paths[0], paths[1],
371
check_coding_style(name[0], (), name[1],
372
new_tree.get_file(file_id).readlines(),
379
if len(diff_output.getvalue()) > 0:
380
self.fail("Unacceptable coding style:\n" + diff_output.getvalue())
300
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 not lines[-1].endswith('\n'):
315
no_newline_at_eof.append(fname)
318
problems.append(self._format_message(tabs,
319
'Tab characters were found in the following source files.'
320
'\nThey should either be replaced by "\\t" or by spaces:'))
322
problems.append(self._format_message(illegal_newlines,
323
'Non-unix newlines were found in the following source files:'))
324
if no_newline_at_eof:
325
no_newline_at_eof.sort()
326
problems.append("The following source files doesn't have a "
327
"newline at the end:"
329
% ('\n '.join(no_newline_at_eof)))
331
self.fail('\n\n'.join(problems))
382
333
def test_no_asserts(self):
383
334
"""bzr shouldn't use the 'assert' statement."""
350
assert_re = re.compile(r'\bassert\b')
399
351
for fname, text in self.get_source_file_contents():
400
352
if not self.is_our_code(fname):
402
ast = parser.ast2tuple(parser.suite(''.join(text)))
354
if not assert_re.search(text):
356
ast = parser.ast2tuple(parser.suite(text))
404
358
badfiles.append(fname)
407
361
"these files contain an assert statement and should not:\n%s"
408
362
% '\n'.join(badfiles))
364
def test_extension_exceptions(self):
365
"""Extension functions should propagate exceptions.
367
Either they should return an object, have an 'except' clause, or
368
have a "# cannot_raise" to indicate that we've audited them and
369
defined them as not raising exceptions.
371
both_exc_and_no_exc = []
373
class_re = re.compile(r'^(cdef\s+)?(public\s+)?'
374
r'(api\s+)?class (\w+).*:', re.MULTILINE)
375
extern_class_re = re.compile(r'## extern cdef class (\w+)',
377
except_re = re.compile(
378
r'cdef\s+' # start with cdef
379
r'([\w *]*?)\s*' # this is the return signature
380
r'(\w+)\s*\(' # the function name
381
r'[^)]*\)\s*' # parameters
382
r'(.*)\s*:' # the except clause
383
r'\s*(#\s*cannot[- _]raise)?') # cannot raise comment
384
for fname, text in self.get_source_file_contents(
385
extensions=('.pyx',)):
386
known_classes = set([m[-1] for m in class_re.findall(text)])
387
known_classes.update(extern_class_re.findall(text))
388
cdefs = except_re.findall(text)
389
for sig, func, exc_clause, no_exc_comment in cdefs:
390
if sig.startswith('api '):
392
if not sig or sig in known_classes:
394
if 'nogil' in exc_clause:
395
exc_clause = exc_clause.replace('nogil', '').strip()
396
if exc_clause and no_exc_comment:
397
both_exc_and_no_exc.append((fname, func))
398
if sig != 'object' and not (exc_clause or no_exc_comment):
399
missing_except.append((fname, func))
401
if both_exc_and_no_exc:
403
'The following functions had "cannot raise" comments'
404
' but did have an except clause set:')
405
for fname, func in both_exc_and_no_exc:
406
error_msg.append('%s:%s' % (fname, func))
407
error_msg.extend(('', ''))
410
'The following functions have fixed return types,'
411
' but no except clause.')
413
'Either add an except or append "# cannot_raise".')
414
for fname, func in missing_except:
415
error_msg.append('%s:%s' % (fname, func))
416
error_msg.extend(('', ''))
418
self.fail('\n'.join(error_msg))
added
removed
bzrlib/tests/test_source.py
