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.
44
41
# Files which are listed here will be skipped when testing for Copyright (or
46
COPYRIGHT_EXCEPTIONS = ['bzrlib/lsprof.py']
43
COPYRIGHT_EXCEPTIONS = ['bzrlib/lsprof.py', 'bzrlib/_bencode_py.py',
44
'bzrlib/doc_generate/sphinx_conf.py']
48
LICENSE_EXCEPTIONS = ['bzrlib/lsprof.py']
46
LICENSE_EXCEPTIONS = ['bzrlib/lsprof.py', 'bzrlib/_bencode_py.py',
47
'bzrlib/doc_generate/sphinx_conf.py']
49
48
# Technically, 'bzrlib/lsprof.py' should be 'bzrlib/util/lsprof.py',
50
49
# (we do not check bzrlib/util/, since that is code bundled from elsewhere)
51
50
# but for compatibility with previous releases, we don't want to move it.
52
# sphinx_conf is semi-autogenerated.
54
55
class TestSourceHelper(TestCase):
82
83
# do not even think of increasing this number. If you think you need to
83
84
# increase it, then you almost certainly are doing something wrong as
84
85
# the relationship from working_tree to branch is one way.
85
# Note that this is an exact equality so that when the number drops,
86
# Note that this is an exact equality so that when the number drops,
86
87
#it is not given a buffer but rather has this test updated immediately.
87
88
self.assertEqual(0, occurences)
127
130
if d.endswith('.tmp'):
130
if not f.endswith('.py'):
133
for extension in extensions:
134
if f.endswith(extension):
137
# Did not match the accepted extensions
132
139
yield osutils.pathjoin(root, f)
134
def get_source_file_contents(self):
135
for fname in self.get_source_files():
141
def get_source_file_contents(self, extensions=None):
142
for fname in self.get_source_files(extensions=extensions):
136
143
f = open(fname, 'rb')
240
246
# You should have received a copy of the GNU General Public License
241
247
# along with this program; if not, write to the Free Software
242
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
248
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
244
250
gpl_re = re.compile(re.escape(gpl_txt), re.MULTILINE)
246
for fname, text in self.get_source_file_contents():
252
for fname, text in self.get_source_file_contents(
253
extensions=('.py', '.pyx')):
247
254
if self.is_license_exception(fname):
249
256
if not gpl_re.search(text):
264
271
self.fail('\n'.join(help_text))
266
def test_no_tabs(self):
267
"""bzrlib source files should not contain any tab characters."""
270
for fname, text in self.get_source_file_contents():
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')):
271
304
if not self.is_our_code(fname):
274
incorrect.append(fname)
277
self.fail('Tab characters were found in the following source files.'
278
'\nThey should either be replaced by "\\t" or by spaces:'
280
% ('\n '.join(incorrect)))
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))
282
345
def test_no_asserts(self):
283
346
"""bzr shouldn't use the 'assert' statement."""
362
assert_re = re.compile(r'\bassert\b')
299
363
for fname, text in self.get_source_file_contents():
300
364
if not self.is_our_code(fname):
302
ast = parser.ast2tuple(parser.suite(''.join(text)))
366
if not assert_re.search(text):
368
ast = parser.ast2tuple(parser.suite(text))
304
370
badfiles.append(fname)
307
373
"these files contain an assert statement and should not:\n%s"
308
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
