1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
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.
19
They are useful for testing code quality, checking coverage metric etc.
33
from bzrlib.tests import (
39
# 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',
47
LICENSE_EXCEPTIONS = [
48
'bzrlib/_bencode_py.py',
49
'bzrlib/doc_generate/conf.py',
52
# Technically, 'bzrlib/lsprof.py' should be 'bzrlib/util/lsprof.py',
53
# (we do not check bzrlib/util/, since that is code bundled from elsewhere)
54
# but for compatibility with previous releases, we don't want to move it.
56
# sphinx_conf is semi-autogenerated.
59
class TestSourceHelper(TestCase):
61
def source_file_name(self, package):
62
"""Return the path of the .py file for package."""
63
if getattr(sys, "frozen", None) is not None:
64
raise TestSkipped("can't test sources in frozen distributions.")
65
path = package.__file__
72
class TestApiUsage(TestSourceHelper):
74
def find_occurences(self, rule, filename):
75
"""Find the number of occurences of rule in a file."""
77
source = file(filename, 'r')
79
if line.find(rule) > -1:
83
def test_branch_working_tree(self):
84
"""Test that the number of uses of working_tree in branch is stable."""
85
occurences = self.find_occurences('self.working_tree()',
86
self.source_file_name(bzrlib.branch))
87
# do not even think of increasing this number. If you think you need to
88
# increase it, then you almost certainly are doing something wrong as
89
# the relationship from working_tree to branch is one way.
90
# Note that this is an exact equality so that when the number drops,
91
#it is not given a buffer but rather has this test updated immediately.
92
self.assertEqual(0, occurences)
94
def test_branch_WorkingTree(self):
95
"""Test that the number of uses of working_tree in branch is stable."""
96
occurences = self.find_occurences('WorkingTree',
97
self.source_file_name(bzrlib.branch))
98
# Do not even think of increasing this number. If you think you need to
99
# increase it, then you almost certainly are doing something wrong as
100
# the relationship from working_tree to branch is one way.
101
# As of 20070809, there are no longer any mentions at all.
102
self.assertEqual(0, occurences)
105
class TestSource(TestSourceHelper):
107
def get_bzrlib_dir(self):
108
"""Get the path to the root of bzrlib"""
109
source = self.source_file_name(bzrlib)
110
source_dir = os.path.dirname(source)
112
# Avoid the case when bzrlib is packaged in a zip file
113
if not os.path.isdir(source_dir):
115
'Cannot find bzrlib source directory. Expected %s'
119
def get_source_files(self, extensions=None):
120
"""Yield all source files for bzr and bzrlib
122
:param our_files_only: If true, exclude files from included libraries
125
bzrlib_dir = self.get_bzrlib_dir()
126
if extensions is None:
127
extensions = ('.py',)
129
# This is the front-end 'bzr' script
130
bzr_path = self.get_bzr_path()
133
for root, dirs, files in os.walk(bzrlib_dir):
135
if d.endswith('.tmp'):
138
for extension in extensions:
139
if f.endswith(extension):
142
# Did not match the accepted extensions
144
yield osutils.pathjoin(root, f)
146
def get_source_file_contents(self, extensions=None):
147
for fname in self.get_source_files(extensions=extensions):
148
f = open(fname, 'rb')
155
def is_our_code(self, fname):
156
"""True if it's a "real" part of bzrlib rather than external code"""
157
if '/util/' in fname or '/plugins/' in fname:
162
def is_copyright_exception(self, fname):
163
"""Certain files are allowed to be different"""
164
if not self.is_our_code(fname):
165
# We don't ask that external utilities or plugins be
168
for exc in COPYRIGHT_EXCEPTIONS:
169
if fname.endswith(exc):
173
def is_license_exception(self, fname):
174
"""Certain files are allowed to be different"""
175
if not self.is_our_code(fname):
177
for exc in LICENSE_EXCEPTIONS:
178
if fname.endswith(exc):
182
def test_tmpdir_not_in_source_files(self):
183
"""When scanning for source files, we don't descend test tempdirs"""
184
for filename in self.get_source_files():
185
if re.search(r'test....\.tmp', filename):
186
self.fail("get_source_file() returned filename %r "
187
"from within a temporary directory"
190
def test_copyright(self):
191
"""Test that all .py and .pyx files have a valid copyright statement"""
194
copyright_re = re.compile('#\\s*copyright.*(?=\n)', re.I)
195
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'.
200
for fname, text in self.get_source_file_contents(
201
extensions=('.py', '.pyx')):
202
if self.is_copyright_exception(fname):
204
match = copyright_canonical_re.search(text)
206
match = copyright_re.search(text)
208
incorrect.append((fname, 'found: %s' % (match.group(),)))
210
incorrect.append((fname, 'no copyright line found\n'))
212
if 'by Canonical' in match.group():
213
incorrect.append((fname,
214
'should not have: "by Canonical": %s'
218
help_text = ["Some files have missing or incorrect copyright"
221
"Please either add them to the list of"
222
" COPYRIGHT_EXCEPTIONS in"
223
" bzrlib/tests/test_source.py",
224
# this is broken to prevent a false match
225
"or add '# Copyright (C)"
226
" 2007 Canonical Ltd' to these files:",
229
for fname, comment in incorrect:
230
help_text.append(fname)
231
help_text.append((' ' * 4) + comment)
233
self.fail('\n'.join(help_text))
236
"""Test that all .py and .pyx files have a GPL disclaimer."""
240
# This program is free software; you can redistribute it and/or modify
241
# it under the terms of the GNU General Public License as published by
242
# the Free Software Foundation; either version 2 of the License, or
243
# (at your option) any later version.
245
# This program is distributed in the hope that it will be useful,
246
# but WITHOUT ANY WARRANTY; without even the implied warranty of
247
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
248
# GNU General Public License for more details.
250
# You should have received a copy of the GNU General Public License
251
# along with this program; if not, write to the Free Software
252
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
254
gpl_re = re.compile(re.escape(gpl_txt), re.MULTILINE)
256
for fname, text in self.get_source_file_contents(
257
extensions=('.py', '.pyx')):
258
if self.is_license_exception(fname):
260
if not gpl_re.search(text):
261
incorrect.append(fname)
264
help_text = ['Some files have missing or incomplete GPL statement',
266
"Please either add them to the list of"
267
" LICENSE_EXCEPTIONS in"
268
" bzrlib/tests/test_source.py",
269
"Or add the following text to the beginning:",
271
for fname in incorrect:
272
help_text.append((' ' * 4) + fname)
274
self.fail('\n'.join(help_text))
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))
288
def test_coding_style(self):
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.
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))
333
def test_no_asserts(self):
334
"""bzr shouldn't use the 'assert' statement."""
335
# assert causes too much variation between -O and not, and tends to
336
# give bad errors to the user
338
# scan down through x for assert statements, report any problems
339
# this is a bit cheesy; it may get some false positives?
340
if x[0] == symbol.assert_stmt:
342
elif x[0] == token.NAME:
343
# can't search further down
346
if sub and search(sub):
350
assert_re = re.compile(r'\bassert\b')
351
for fname, text in self.get_source_file_contents():
352
if not self.is_our_code(fname):
354
if not assert_re.search(text):
356
ast = parser.ast2tuple(parser.suite(text))
358
badfiles.append(fname)
361
"these files contain an assert statement and should not:\n%s"
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
