1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005-2011 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""These tests are tests about the source code of bzrlib itself.
17
"""These tests are tests about the source code of breezy itself.
19
19
They are useful for testing code quality, checking coverage metric etc.
22
# import system imports here
41
39
# 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']
41
COPYRIGHT_EXCEPTIONS = [
42
'breezy/_bencode_py.py',
43
'breezy/doc_generate/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)
47
LICENSE_EXCEPTIONS = [
48
'breezy/_bencode_py.py',
49
'breezy/doc_generate/conf.py',
52
# Technically, 'breezy/lsprof.py' should be 'breezy/util/lsprof.py',
53
# (we do not check breezy/util/, since that is code bundled from elsewhere)
50
54
# but for compatibility with previous releases, we don't want to move it.
52
56
# sphinx_conf is semi-autogenerated.
70
74
def find_occurences(self, rule, filename):
71
75
"""Find the number of occurences of rule in a file."""
73
source = file(filename, 'r')
77
source = open(filename, 'r')
74
78
for line in source:
75
79
if line.find(rule) > -1:
79
83
def test_branch_working_tree(self):
80
84
"""Test that the number of uses of working_tree in branch is stable."""
81
85
occurences = self.find_occurences('self.working_tree()',
82
self.source_file_name(bzrlib.branch))
86
self.source_file_name(breezy.branch))
83
87
# do not even think of increasing this number. If you think you need to
84
88
# increase it, then you almost certainly are doing something wrong as
85
89
# the relationship from working_tree to branch is one way.
90
94
def test_branch_WorkingTree(self):
91
95
"""Test that the number of uses of working_tree in branch is stable."""
92
96
occurences = self.find_occurences('WorkingTree',
93
self.source_file_name(bzrlib.branch))
97
self.source_file_name(breezy.branch))
94
98
# Do not even think of increasing this number. If you think you need to
95
99
# increase it, then you almost certainly are doing something wrong as
96
100
# the relationship from working_tree to branch is one way.
101
105
class TestSource(TestSourceHelper):
103
def get_bzrlib_dir(self):
104
"""Get the path to the root of bzrlib"""
105
source = self.source_file_name(bzrlib)
107
def get_breezy_dir(self):
108
"""Get the path to the root of breezy"""
109
source = self.source_file_name(breezy)
106
110
source_dir = os.path.dirname(source)
108
# Avoid the case when bzrlib is packaged in a zip file
112
# Avoid the case when breezy is packaged in a zip file
109
113
if not os.path.isdir(source_dir):
110
raise TestSkipped('Cannot find bzrlib source directory. Expected %s'
115
'Cannot find breezy source directory. Expected %s'
112
117
return source_dir
114
119
def get_source_files(self, extensions=None):
115
"""Yield all source files for bzr and bzrlib
120
"""Yield all source files for bzr and breezy
117
122
:param our_files_only: If true, exclude files from included libraries
120
bzrlib_dir = self.get_bzrlib_dir()
125
breezy_dir = self.get_breezy_dir()
121
126
if extensions is None:
122
127
extensions = ('.py',)
124
129
# This is the front-end 'bzr' script
125
bzr_path = self.get_bzr_path()
130
bzr_path = self.get_brz_path()
128
for root, dirs, files in os.walk(bzrlib_dir):
133
for root, dirs, files in os.walk(breezy_dir):
130
135
if d.endswith('.tmp'):
148
153
yield fname, text
150
155
def is_our_code(self, fname):
151
"""Return true if it's a "real" part of bzrlib rather than external code"""
156
"""True if it's a "real" part of breezy rather than external code"""
152
157
if '/util/' in fname or '/plugins/' in fname:
157
162
def is_copyright_exception(self, fname):
158
163
"""Certain files are allowed to be different"""
159
164
if not self.is_our_code(fname):
160
# We don't ask that external utilities or plugins be
163
166
for exc in COPYRIGHT_EXCEPTIONS:
164
167
if fname.endswith(exc):
189
192
copyright_re = re.compile('#\\s*copyright.*(?=\n)', re.I)
190
copyright_canonical_re = re.compile(
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'
193
copyright_statement_re = re.compile(
194
r'# Copyright \(C\) ' # Opening "# Copyright (C)"
195
r'(\d+?)((, |-)\d+)*' # followed by a series of dates
196
r' [^ ]*') # and then whoever.
196
198
for fname, text in self.get_source_file_contents(
197
199
extensions=('.py', '.pyx')):
198
200
if self.is_copyright_exception(fname):
200
match = copyright_canonical_re.search(text)
202
match = copyright_statement_re.search(text)
202
204
match = copyright_re.search(text)
217
219
"Please either add them to the list of"
218
220
" COPYRIGHT_EXCEPTIONS in"
219
" bzrlib/tests/test_source.py",
221
" breezy/tests/test_source.py",
220
222
# this is broken to prevent a false match
221
223
"or add '# Copyright (C)"
222
" 2007 Canonical Ltd' to these files:",
224
" 2007 Bazaar hackers' to these files:",
225
227
for fname, comment in incorrect:
226
228
help_text.append(fname)
227
help_text.append((' '*4) + comment)
229
help_text.append((' ' * 4) + comment)
229
231
self.fail('\n'.join(help_text))
262
264
"Please either add them to the list of"
263
265
" LICENSE_EXCEPTIONS in"
264
" bzrlib/tests/test_source.py",
266
" breezy/tests/test_source.py",
265
267
"Or add the following text to the beginning:",
268
269
for fname in incorrect:
269
help_text.append((' '*4) + fname)
270
help_text.append((' ' * 4) + fname)
271
272
self.fail('\n'.join(help_text))
277
278
dict_[fname].append(line_no)
279
280
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()]
281
files = sorted(["%s: %s" % (f, ', '.join([str(i + 1) for i in lines]))
282
for f, lines in dict_.items()])
283
283
return message + '\n\n %s' % ('\n '.join(files))
285
285
def test_coding_style(self):
286
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
288
Generally we expect PEP8, but we do not generally strictly enforce
289
this, and there are existing files that do not comply. The 'pep8'
290
tool, available separately, will check for more cases.
293
Print how many files have
294
* trailing white space
295
* lines longer than 79 chars
292
This test only enforces conditions that are globally true at the
293
moment, and that should cause a patch to be rejected: spaces rather
294
than tabs, unix newlines, and a newline at the end of the file.
299
297
illegal_newlines = {}
301
298
no_newline_at_eof = []
302
299
for fname, text in self.get_source_file_contents(
303
300
extensions=('.py', '.pyx')):
310
307
self._push_file(tabs, fname, line_no)
311
308
if not line.endswith('\n') or line.endswith('\r\n'):
312
if line_no != last_line_no: # not no_newline_at_eof
309
if line_no != last_line_no: # not no_newline_at_eof
313
310
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
311
if not lines[-1].endswith('\n'):
319
312
no_newline_at_eof.append(fname)
322
315
problems.append(self._format_message(tabs,
323
316
'Tab characters were found in the following source files.'
324
317
'\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()]),
329
318
if illegal_newlines:
330
319
problems.append(self._format_message(illegal_newlines,
331
320
'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
321
if no_newline_at_eof:
337
322
no_newline_at_eof.sort()
338
323
problems.append("The following source files doesn't have a "
376
361
def test_extension_exceptions(self):
377
362
"""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
364
Either they should return an object, have an 'except' clause, or
365
have a "# cannot_raise" to indicate that we've audited them and
366
defined them as not raising exceptions.
383
368
both_exc_and_no_exc = []
384
369
missing_except = []
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
370
class_re = re.compile(r'^(cdef\s+)?(public\s+)?'
371
r'(api\s+)?class (\w+).*:', re.MULTILINE)
372
extern_class_re = re.compile(r'## extern cdef class (\w+)',
374
except_re = re.compile(
375
r'cdef\s+' # start with cdef
376
r'([\w *]*?)\s*' # this is the return signature
377
r'(\w+)\s*\(' # the function name
378
r'[^)]*\)\s*' # parameters
379
r'(.*)\s*:' # the except clause
380
r'\s*(#\s*cannot[- _]raise)?') # cannot raise comment
394
381
for fname, text in self.get_source_file_contents(
395
382
extensions=('.pyx',)):
396
known_classes = set([m[-1] for m in class_re.findall(text)])
383
known_classes = {m[-1] for m in class_re.findall(text)}
384
known_classes.update(extern_class_re.findall(text))
397
385
cdefs = except_re.findall(text)
398
386
for sig, func, exc_clause, no_exc_comment in cdefs:
399
387
if sig.startswith('api '):
408
396
missing_except.append((fname, func))
410
398
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:')
400
'The following functions had "cannot raise" comments'
401
' but did have an except clause set:')
413
402
for fname, func in both_exc_and_no_exc:
414
403
error_msg.append('%s:%s' % (fname, func))
415
404
error_msg.extend(('', ''))
416
405
if missing_except:
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".')
407
'The following functions have fixed return types,'
408
' but no except clause.')
410
'Either add an except or append "# cannot_raise".')
420
411
for fname, func in missing_except:
421
412
error_msg.append('%s:%s' % (fname, func))
422
413
error_msg.extend(('', ''))
424
415
self.fail('\n'.join(error_msg))
417
def test_feature_absolute_import(self):
418
"""Using absolute imports means avoiding unnecesary stat and
421
Make sure that all non-test files have absolute imports enabled.
423
missing_absolute_import = []
424
for fname, text in self.get_source_file_contents(
425
extensions=('.py', '.pyx')):
426
if "/tests/" in fname or "test_" in fname:
427
# We don't really care about tests
429
if not "from __future__ import absolute_import" in text:
430
missing_absolute_import.append(fname)
432
if missing_absolute_import:
434
'The following files do not have absolute_import enabled:\n'
435
'\n' + '\n'.join(missing_absolute_import))