28
from cStringIO import StringIO
30
33
#import bzrlib specific imports here
31
34
from bzrlib import (
34
40
import bzrlib.branch
35
41
from bzrlib.tests import (
46
from bzrlib.workingtree import WorkingTree
41
49
# 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']
51
COPYRIGHT_EXCEPTIONS = ['bzrlib/lsprof.py']
46
LICENSE_EXCEPTIONS = ['bzrlib/lsprof.py', 'bzrlib/_bencode_py.py',
47
'bzrlib/doc_generate/sphinx_conf.py']
53
LICENSE_EXCEPTIONS = ['bzrlib/lsprof.py']
48
54
# Technically, 'bzrlib/lsprof.py' should be 'bzrlib/util/lsprof.py',
49
55
# (we do not check bzrlib/util/, since that is code bundled from elsewhere)
50
56
# but for compatibility with previous releases, we don't want to move it.
52
# sphinx_conf is semi-autogenerated.
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")
55
107
class TestSourceHelper(TestCase):
246
293
# You should have received a copy of the GNU General Public License
247
294
# along with this program; if not, write to the Free Software
248
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
295
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
250
297
gpl_re = re.compile(re.escape(gpl_txt), re.MULTILINE)
252
for fname, text in self.get_source_file_contents(
253
extensions=('.py', '.pyx')):
299
for fname, text in self.get_source_file_contents():
254
300
if self.is_license_exception(fname):
256
302
if not gpl_re.search(text):
271
317
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))
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)))
285
335
def test_coding_style(self):
286
"""Check if bazaar code conforms to some coding style conventions.
336
""" Check if bazaar code conforms to some coding style conventions.
288
Currently we assert that the following is not present:
338
Currently we check all .py files for:
339
* new trailing white space
341
* new long lines (give warning only)
291
342
* 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))
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())
345
382
def test_no_asserts(self):
346
383
"""bzr shouldn't use the 'assert' statement."""
362
assert_re = re.compile(r'\bassert\b')
363
399
for fname, text in self.get_source_file_contents():
364
400
if not self.is_our_code(fname):
366
if not assert_re.search(text):
368
ast = parser.ast2tuple(parser.suite(text))
402
ast = parser.ast2tuple(parser.suite(''.join(text)))
370
404
badfiles.append(fname)
373
407
"these files contain an assert statement and should not:\n%s"
374
408
% '\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
