1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
39
41
# Files which are listed here will be skipped when testing for Copyright (or
41
COPYRIGHT_EXCEPTIONS = [
42
'bzrlib/_bencode_py.py',
43
'bzrlib/doc_generate/conf.py',
43
COPYRIGHT_EXCEPTIONS = ['bzrlib/lsprof.py', 'bzrlib/_bencode_py.py',
44
'bzrlib/doc_generate/sphinx_conf.py']
47
LICENSE_EXCEPTIONS = [
48
'bzrlib/_bencode_py.py',
49
'bzrlib/doc_generate/conf.py',
46
LICENSE_EXCEPTIONS = ['bzrlib/lsprof.py', 'bzrlib/_bencode_py.py',
47
'bzrlib/doc_generate/sphinx_conf.py']
52
48
# Technically, 'bzrlib/lsprof.py' should be 'bzrlib/util/lsprof.py',
53
49
# (we do not check bzrlib/util/, since that is code bundled from elsewhere)
54
50
# but for compatibility with previous releases, we don't want to move it.
112
108
# Avoid the case when bzrlib is packaged in a zip file
113
109
if not os.path.isdir(source_dir):
115
'Cannot find bzrlib source directory. Expected %s'
110
raise TestSkipped('Cannot find bzrlib source directory. Expected %s'
117
112
return source_dir
119
114
def get_source_files(self, extensions=None):
153
148
yield fname, text
155
150
def is_our_code(self, fname):
156
"""True if it's a "real" part of bzrlib rather than external code"""
151
"""Return true if it's a "real" part of bzrlib rather than external code"""
157
152
if '/util/' in fname or '/plugins/' in fname:
194
189
copyright_re = re.compile('#\\s*copyright.*(?=\n)', re.I)
195
190
copyright_canonical_re = re.compile(
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'.
191
r'# Copyright \(C\) ' # Opening "# Copyright (C)"
192
r'(\d+)(, \d+)*' # Followed by a series of dates
193
r'.*Canonical Ltd' # And containing 'Canonical Ltd'
200
196
for fname, text in self.get_source_file_contents(
201
197
extensions=('.py', '.pyx')):
229
225
for fname, comment in incorrect:
230
226
help_text.append(fname)
231
help_text.append((' ' * 4) + comment)
227
help_text.append((' '*4) + comment)
233
229
self.fail('\n'.join(help_text))
267
263
" LICENSE_EXCEPTIONS in"
268
264
" bzrlib/tests/test_source.py",
269
265
"Or add the following text to the beginning:",
271
268
for fname in incorrect:
272
help_text.append((' ' * 4) + fname)
269
help_text.append((' '*4) + fname)
274
271
self.fail('\n'.join(help_text))
280
277
dict_[fname].append(line_no)
282
279
def _format_message(self, dict_, message):
283
files = ["%s: %s" % (f, ', '.join([str(i + 1) for i in lines]))
280
files = ["%s: %s" % (f, ', '.join([str(i+1) for i in lines]))
284
281
for f, lines in dict_.items()]
286
283
return message + '\n\n %s' % ('\n '.join(files))
288
285
def test_coding_style(self):
289
286
"""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.
288
Currently we assert that the following is not present:
291
* no newline at end of files
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.
293
Print how many files have
294
* trailing white space
295
* lines longer than 79 chars
300
299
illegal_newlines = {}
301
301
no_newline_at_eof = []
302
302
for fname, text in self.get_source_file_contents(
303
303
extensions=('.py', '.pyx')):
310
310
self._push_file(tabs, fname, line_no)
311
311
if not line.endswith('\n') or line.endswith('\r\n'):
312
if line_no != last_line_no: # not no_newline_at_eof
312
if line_no != last_line_no: # not no_newline_at_eof
313
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)
314
318
if not lines[-1].endswith('\n'):
315
319
no_newline_at_eof.append(fname)
318
322
problems.append(self._format_message(tabs,
319
323
'Tab characters were found in the following source files.'
320
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()]),
321
329
if illegal_newlines:
322
330
problems.append(self._format_message(illegal_newlines,
323
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()]),
324
336
if no_newline_at_eof:
325
337
no_newline_at_eof.sort()
326
338
problems.append("The following source files doesn't have a "
364
376
def test_extension_exceptions(self):
365
377
"""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.
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
371
383
both_exc_and_no_exc = []
372
384
missing_except = []
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
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
384
394
for fname, text in self.get_source_file_contents(
385
395
extensions=('.pyx',)):
386
396
known_classes = set([m[-1] for m in class_re.findall(text)])
387
known_classes.update(extern_class_re.findall(text))
388
397
cdefs = except_re.findall(text)
389
398
for sig, func, exc_clause, no_exc_comment in cdefs:
390
399
if sig.startswith('api '):
399
408
missing_except.append((fname, func))
401
410
if both_exc_and_no_exc:
403
'The following functions had "cannot raise" comments'
404
' but did have an except clause set:')
411
error_msg.append('The following functions had "cannot raise" comments'
412
' but did have an except clause set:')
405
413
for fname, func in both_exc_and_no_exc:
406
414
error_msg.append('%s:%s' % (fname, func))
407
415
error_msg.extend(('', ''))
408
416
if missing_except:
410
'The following functions have fixed return types,'
411
' but no except clause.')
413
'Either add an except or append "# cannot_raise".')
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".')
414
420
for fname, func in missing_except:
415
421
error_msg.append('%s:%s' % (fname, func))
416
422
error_msg.extend(('', ''))
added
removed
bzrlib/tests/test_source.py
