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 breezy itself.
19
They are useful for testing code quality, checking coverage metric etc.
33
from breezy.tests import (
39
# Files which are listed here will be skipped when testing for Copyright (or
41
COPYRIGHT_EXCEPTIONS = [
42
'breezy/_bencode_py.py',
43
'breezy/doc_generate/conf.py',
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)
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(breezy.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(breezy.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_breezy_dir(self):
108
"""Get the path to the root of breezy"""
109
source = self.source_file_name(breezy)
110
source_dir = os.path.dirname(source)
112
# Avoid the case when breezy is packaged in a zip file
113
if not os.path.isdir(source_dir):
115
'Cannot find breezy source directory. Expected %s'
119
def get_source_files(self, extensions=None):
120
"""Yield all source files for bzr and breezy
122
:param our_files_only: If true, exclude files from included libraries
125
breezy_dir = self.get_breezy_dir()
126
if extensions is None:
127
extensions = ('.py',)
129
# This is the front-end 'bzr' script
130
bzr_path = self.get_brz_path()
133
for root, dirs, files in os.walk(breezy_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 breezy 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):
166
for exc in COPYRIGHT_EXCEPTIONS:
167
if fname.endswith(exc):
171
def is_license_exception(self, fname):
172
"""Certain files are allowed to be different"""
173
if not self.is_our_code(fname):
175
for exc in LICENSE_EXCEPTIONS:
176
if fname.endswith(exc):
180
def test_tmpdir_not_in_source_files(self):
181
"""When scanning for source files, we don't descend test tempdirs"""
182
for filename in self.get_source_files():
183
if re.search(r'test....\.tmp', filename):
184
self.fail("get_source_file() returned filename %r "
185
"from within a temporary directory"
188
def test_copyright(self):
189
"""Test that all .py and .pyx files have a valid copyright statement"""
192
copyright_re = re.compile('#\\s*copyright.*(?=\n)', re.I)
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.
198
for fname, text in self.get_source_file_contents(
199
extensions=('.py', '.pyx')):
200
if self.is_copyright_exception(fname):
202
match = copyright_statement_re.search(text)
204
match = copyright_re.search(text)
206
incorrect.append((fname, 'found: %s' % (match.group(),)))
208
incorrect.append((fname, 'no copyright line found\n'))
210
if 'by Canonical' in match.group():
211
incorrect.append((fname,
212
'should not have: "by Canonical": %s'
216
help_text = ["Some files have missing or incorrect copyright"
219
"Please either add them to the list of"
220
" COPYRIGHT_EXCEPTIONS in"
221
" breezy/tests/test_source.py",
222
# this is broken to prevent a false match
223
"or add '# Copyright (C)"
224
" 2007 Bazaar hackers' to these files:",
227
for fname, comment in incorrect:
228
help_text.append(fname)
229
help_text.append((' ' * 4) + comment)
231
self.fail('\n'.join(help_text))
234
"""Test that all .py and .pyx files have a GPL disclaimer."""
238
# This program is free software; you can redistribute it and/or modify
239
# it under the terms of the GNU General Public License as published by
240
# the Free Software Foundation; either version 2 of the License, or
241
# (at your option) any later version.
243
# This program is distributed in the hope that it will be useful,
244
# but WITHOUT ANY WARRANTY; without even the implied warranty of
245
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
246
# GNU General Public License for more details.
248
# You should have received a copy of the GNU General Public License
249
# along with this program; if not, write to the Free Software
250
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
252
gpl_re = re.compile(re.escape(gpl_txt), re.MULTILINE)
254
for fname, text in self.get_source_file_contents(
255
extensions=('.py', '.pyx')):
256
if self.is_license_exception(fname):
258
if not gpl_re.search(text):
259
incorrect.append(fname)
262
help_text = ['Some files have missing or incomplete GPL statement',
264
"Please either add them to the list of"
265
" LICENSE_EXCEPTIONS in"
266
" breezy/tests/test_source.py",
267
"Or add the following text to the beginning:",
269
for fname in incorrect:
270
help_text.append((' ' * 4) + fname)
272
self.fail('\n'.join(help_text))
274
def _push_file(self, dict_, fname, line_no):
275
if fname not in dict_:
276
dict_[fname] = [line_no]
278
dict_[fname].append(line_no)
280
def _format_message(self, dict_, message):
281
files = sorted(["%s: %s" % (f, ', '.join([str(i + 1) for i in lines]))
282
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
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.
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.
297
illegal_newlines = {}
298
no_newline_at_eof = []
299
for fname, text in self.get_source_file_contents(
300
extensions=('.py', '.pyx')):
301
if not self.is_our_code(fname):
303
lines = text.splitlines(True)
304
last_line_no = len(lines) - 1
305
for line_no, line in enumerate(lines):
307
self._push_file(tabs, fname, line_no)
308
if not line.endswith('\n') or line.endswith('\r\n'):
309
if line_no != last_line_no: # not no_newline_at_eof
310
self._push_file(illegal_newlines, fname, line_no)
311
if not lines[-1].endswith('\n'):
312
no_newline_at_eof.append(fname)
315
problems.append(self._format_message(tabs,
316
'Tab characters were found in the following source files.'
317
'\nThey should either be replaced by "\\t" or by spaces:'))
319
problems.append(self._format_message(illegal_newlines,
320
'Non-unix newlines were found in the following source files:'))
321
if no_newline_at_eof:
322
no_newline_at_eof.sort()
323
problems.append("The following source files doesn't have a "
324
"newline at the end:"
326
% ('\n '.join(no_newline_at_eof)))
328
self.fail('\n\n'.join(problems))
330
def test_no_asserts(self):
331
"""bzr shouldn't use the 'assert' statement."""
332
# assert causes too much variation between -O and not, and tends to
333
# give bad errors to the user
335
# scan down through x for assert statements, report any problems
336
# this is a bit cheesy; it may get some false positives?
337
if x[0] == symbol.assert_stmt:
339
elif x[0] == token.NAME:
340
# can't search further down
343
if sub and search(sub):
347
assert_re = re.compile(r'\bassert\b')
348
for fname, text in self.get_source_file_contents():
349
if not self.is_our_code(fname):
351
if not assert_re.search(text):
353
ast = parser.ast2tuple(parser.suite(text))
355
badfiles.append(fname)
358
"these files contain an assert statement and should not:\n%s"
359
% '\n'.join(badfiles))
361
def test_extension_exceptions(self):
362
"""Extension functions should propagate exceptions.
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.
368
both_exc_and_no_exc = []
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
381
for fname, text in self.get_source_file_contents(
382
extensions=('.pyx',)):
383
known_classes = {m[-1] for m in class_re.findall(text)}
384
known_classes.update(extern_class_re.findall(text))
385
cdefs = except_re.findall(text)
386
for sig, func, exc_clause, no_exc_comment in cdefs:
387
if sig.startswith('api '):
389
if not sig or sig in known_classes:
391
if 'nogil' in exc_clause:
392
exc_clause = exc_clause.replace('nogil', '').strip()
393
if exc_clause and no_exc_comment:
394
both_exc_and_no_exc.append((fname, func))
395
if sig != 'object' and not (exc_clause or no_exc_comment):
396
missing_except.append((fname, func))
398
if both_exc_and_no_exc:
400
'The following functions had "cannot raise" comments'
401
' but did have an except clause set:')
402
for fname, func in both_exc_and_no_exc:
403
error_msg.append('%s:%s' % (fname, func))
404
error_msg.extend(('', ''))
407
'The following functions have fixed return types,'
408
' but no except clause.')
410
'Either add an except or append "# cannot_raise".')
411
for fname, func in missing_except:
412
error_msg.append('%s:%s' % (fname, func))
413
error_msg.extend(('', ''))
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))
added
removed
breezy/tests/test_source.py
