13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""These tests are tests about the source code of breezy itself.
18
"""These tests are tests about the source code of bzrlib itself.
19
20
They are useful for testing code quality, checking coverage metric etc.
23
# import system imports here
33
from breezy.tests import (
40
# Files which are listed here will be skipped when testing for Copyright (or
42
COPYRIGHT_EXCEPTIONS = [
43
'breezy/_bencode_py.py',
44
'breezy/doc_generate/conf.py',
48
LICENSE_EXCEPTIONS = [
49
'breezy/_bencode_py.py',
50
'breezy/doc_generate/conf.py',
53
# Technically, 'breezy/lsprof.py' should be 'breezy/util/lsprof.py',
54
# (we do not check breezy/util/, since that is code bundled from elsewhere)
55
# but for compatibility with previous releases, we don't want to move it.
57
# sphinx_conf is semi-autogenerated.
60
class TestSourceHelper(TestCase):
62
def source_file_name(self, package):
63
"""Return the path of the .py file for package."""
64
if getattr(sys, "frozen", None) is not None:
65
raise TestSkipped("can't test sources in frozen distributions.")
66
path = package.__file__
73
class TestApiUsage(TestSourceHelper):
27
#import bzrlib specific imports here
28
from bzrlib.tests import TestCase
32
class TestApiUsage(TestCase):
75
34
def find_occurences(self, rule, filename):
76
35
"""Find the number of occurences of rule in a file."""
78
source = open(filename, 'r')
37
source = file(filename, 'r')
79
38
for line in source:
80
39
if line.find(rule) > -1:
43
def source_file_name(self, package):
44
"""Return the path of the .py file for package."""
45
path = package.__file__
84
51
def test_branch_working_tree(self):
85
52
"""Test that the number of uses of working_tree in branch is stable."""
86
53
occurences = self.find_occurences('self.working_tree()',
87
self.source_file_name(breezy.branch))
54
self.source_file_name(bzrlib.branch))
88
55
# do not even think of increasing this number. If you think you need to
89
56
# increase it, then you almost certainly are doing something wrong as
90
57
# the relationship from working_tree to branch is one way.
91
# Note that this is an exact equality so that when the number drops,
92
# it is not given a buffer but rather has this test updated immediately.
93
self.assertEqual(0, occurences)
58
# This number should be 0, but the basis_inventory merge was done
59
# before this test was written. Note that this is an exact equality
60
# so that when the number drops, it is not given a buffer but rather
61
# this test updated immediately.
62
self.assertEqual(2, occurences)
95
64
def test_branch_WorkingTree(self):
96
65
"""Test that the number of uses of working_tree in branch is stable."""
97
66
occurences = self.find_occurences('WorkingTree',
98
self.source_file_name(breezy.branch))
99
# Do not even think of increasing this number. If you think you need to
67
self.source_file_name(bzrlib.branch))
68
# do not even think of increasing this number. If you think you need to
100
69
# increase it, then you almost certainly are doing something wrong as
101
70
# the relationship from working_tree to branch is one way.
102
# As of 20070809, there are no longer any mentions at all.
103
self.assertEqual(0, occurences)
106
class TestSource(TestSourceHelper):
108
def get_breezy_dir(self):
109
"""Get the path to the root of breezy"""
110
source = self.source_file_name(breezy)
111
source_dir = os.path.dirname(source)
113
# Avoid the case when breezy is packaged in a zip file
114
if not os.path.isdir(source_dir):
116
'Cannot find breezy source directory. Expected %s'
120
def get_source_files(self, extensions=None):
121
"""Yield all source files for bzr and breezy
123
:param our_files_only: If true, exclude files from included libraries
126
breezy_dir = self.get_breezy_dir()
127
if extensions is None:
128
extensions = ('.py',)
130
# This is the front-end 'bzr' script
131
bzr_path = self.get_brz_path()
134
for root, dirs, files in os.walk(breezy_dir):
136
if d.endswith('.tmp'):
139
for extension in extensions:
140
if f.endswith(extension):
143
# Did not match the accepted extensions
145
yield osutils.pathjoin(root, f)
147
def get_source_file_contents(self, extensions=None):
148
for fname in self.get_source_files(extensions=extensions):
149
with open(fname, 'r') as f:
150
yield fname, f.read()
152
def is_our_code(self, fname):
153
"""True if it's a "real" part of breezy rather than external code"""
154
if '/util/' in fname or '/plugins/' in fname:
159
def is_copyright_exception(self, fname):
160
"""Certain files are allowed to be different"""
161
if not self.is_our_code(fname):
163
for exc in COPYRIGHT_EXCEPTIONS:
164
if fname.endswith(exc):
168
def is_license_exception(self, fname):
169
"""Certain files are allowed to be different"""
170
if not self.is_our_code(fname):
172
for exc in LICENSE_EXCEPTIONS:
173
if fname.endswith(exc):
177
def test_tmpdir_not_in_source_files(self):
178
"""When scanning for source files, we don't descend test tempdirs"""
179
for filename in self.get_source_files():
180
if re.search(r'test....\.tmp', filename):
181
self.fail("get_source_file() returned filename %r "
182
"from within a temporary directory"
185
def test_copyright(self):
186
"""Test that all .py and .pyx files have a valid copyright statement"""
189
copyright_re = re.compile('#\\s*copyright.*(?=\n)', re.I)
190
copyright_statement_re = re.compile(
191
r'# Copyright \(C\) ' # Opening "# Copyright (C)"
192
r'(\d+?)((, |-)\d+)*' # followed by a series of dates
193
r' [^ ]*') # and then whoever.
195
for fname, text in self.get_source_file_contents(
196
extensions=('.py', '.pyx')):
197
if self.is_copyright_exception(fname):
199
match = copyright_statement_re.search(text)
201
match = copyright_re.search(text)
203
incorrect.append((fname, 'found: %s' % (match.group(),)))
205
incorrect.append((fname, 'no copyright line found\n'))
207
if 'by Canonical' in match.group():
208
incorrect.append((fname,
209
'should not have: "by Canonical": %s'
213
help_text = ["Some files have missing or incorrect copyright"
216
"Please either add them to the list of"
217
" COPYRIGHT_EXCEPTIONS in"
218
" breezy/tests/test_source.py",
219
# this is broken to prevent a false match
220
"or add '# Copyright (C)"
221
" 2007 Bazaar hackers' to these files:",
224
for fname, comment in incorrect:
225
help_text.append(fname)
226
help_text.append((' ' * 4) + comment)
228
self.fail('\n'.join(help_text))
231
"""Test that all .py and .pyx files have a GPL disclaimer."""
235
# This program is free software; you can redistribute it and/or modify
236
# it under the terms of the GNU General Public License as published by
237
# the Free Software Foundation; either version 2 of the License, or
238
# (at your option) any later version.
240
# This program is distributed in the hope that it will be useful,
241
# but WITHOUT ANY WARRANTY; without even the implied warranty of
242
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
243
# GNU General Public License for more details.
245
# You should have received a copy of the GNU General Public License
246
# along with this program; if not, write to the Free Software
247
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
249
gpl_re = re.compile(re.escape(gpl_txt), re.MULTILINE)
251
for fname, text in self.get_source_file_contents(
252
extensions=('.py', '.pyx')):
253
if self.is_license_exception(fname):
255
if not gpl_re.search(text):
256
incorrect.append(fname)
259
help_text = ['Some files have missing or incomplete GPL statement',
261
"Please either add them to the list of"
262
" LICENSE_EXCEPTIONS in"
263
" breezy/tests/test_source.py",
264
"Or add the following text to the beginning:",
266
for fname in incorrect:
267
help_text.append((' ' * 4) + fname)
269
self.fail('\n'.join(help_text))
271
def _push_file(self, dict_, fname, line_no):
272
if fname not in dict_:
273
dict_[fname] = [line_no]
275
dict_[fname].append(line_no)
277
def _format_message(self, dict_, message):
278
files = sorted(["%s: %s" % (f, ', '.join([str(i + 1) for i in lines]))
279
for f, lines in dict_.items()])
280
return message + '\n\n %s' % ('\n '.join(files))
282
def test_coding_style(self):
283
"""Check if bazaar code conforms to some coding style conventions.
285
Generally we expect PEP8, but we do not generally strictly enforce
286
this, and there are existing files that do not comply. The 'pep8'
287
tool, available separately, will check for more cases.
289
This test only enforces conditions that are globally true at the
290
moment, and that should cause a patch to be rejected: spaces rather
291
than tabs, unix newlines, and a newline at the end of the file.
294
illegal_newlines = {}
295
no_newline_at_eof = []
296
for fname, text in self.get_source_file_contents(
297
extensions=('.py', '.pyx')):
298
if not self.is_our_code(fname):
300
lines = text.splitlines(True)
301
last_line_no = len(lines) - 1
302
for line_no, line in enumerate(lines):
304
self._push_file(tabs, fname, line_no)
305
if not line.endswith('\n') or line.endswith('\r\n'):
306
if line_no != last_line_no: # not no_newline_at_eof
307
self._push_file(illegal_newlines, fname, line_no)
308
if not lines[-1].endswith('\n'):
309
no_newline_at_eof.append(fname)
312
problems.append(self._format_message(tabs,
313
'Tab characters were found in the following source files.'
314
'\nThey should either be replaced by "\\t" or by spaces:'))
316
problems.append(self._format_message(illegal_newlines,
317
'Non-unix newlines were found in the following source files:'))
318
if no_newline_at_eof:
319
no_newline_at_eof.sort()
320
problems.append("The following source files doesn't have a "
321
"newline at the end:"
323
% ('\n '.join(no_newline_at_eof)))
325
self.fail('\n\n'.join(problems))
327
def test_flake8(self):
328
self.requireFeature(features.flake8)
329
# Older versions of flake8 don't support the 'paths'
331
new_path = list(sys.path)
333
0, os.path.join(os.path.dirname(__file__), '..', '..', 'tools'))
334
self.overrideAttr(sys, 'path', new_path)
336
from flake8.main.application import Application
337
from flake8.formatting.base import BaseFormatter
339
app.config = u'setup.cfg'
342
class Formatter(BaseFormatter):
351
app.file_checker_manager.report()
353
def handle(self, error):
354
self.errors.append(error)
358
except argparse.ArgumentError as e:
359
self.skipTest('broken flake8: %r' % e)
360
app.formatter = Formatter()
363
self.assertEqual(app.formatter.errors, [])
365
def test_no_asserts(self):
366
"""bzr shouldn't use the 'assert' statement."""
367
# assert causes too much variation between -O and not, and tends to
368
# give bad errors to the user
370
# scan down through x for assert statements, report any problems
371
# this is a bit cheesy; it may get some false positives?
372
if x[0] == symbol.assert_stmt:
374
elif x[0] == token.NAME:
375
# can't search further down
378
if sub and search(sub):
382
assert_re = re.compile(r'\bassert\b')
383
for fname, text in self.get_source_file_contents():
384
if not self.is_our_code(fname):
386
if not assert_re.search(text):
388
st = parser.suite(text)
389
code = parser.st2tuple(st)
391
badfiles.append(fname)
394
"these files contain an assert statement and should not:\n%s"
395
% '\n'.join(badfiles))
397
def test_extension_exceptions(self):
398
"""Extension functions should propagate exceptions.
400
Either they should return an object, have an 'except' clause, or
401
have a "# cannot_raise" to indicate that we've audited them and
402
defined them as not raising exceptions.
404
both_exc_and_no_exc = []
406
common_classes = ('StaticTuple',)
407
class_re = re.compile(r'^(cdef\s+)?(public\s+)?'
408
r'(api\s+)?class (\w+).*:', re.MULTILINE)
409
except_re = re.compile(
410
r'cdef\s+' # start with cdef
411
r'([\w *]*?)\s*' # this is the return signature
412
r'(\w+)\s*\(' # the function name
413
r'[^)]*\)\s*' # parameters
414
r'(.*)\s*:' # the except clause
415
r'\s*(#\s*cannot[- _]raise)?') # cannot raise comment
416
for fname, text in self.get_source_file_contents(
417
extensions=('.pyx',)):
418
known_classes = {m[-1] for m in class_re.findall(text)}
419
known_classes.update(common_classes)
420
cdefs = except_re.findall(text)
421
for sig, func, exc_clause, no_exc_comment in cdefs:
422
if sig.startswith('api '):
424
if not sig or sig in known_classes:
426
if 'nogil' in exc_clause:
427
exc_clause = exc_clause.replace('nogil', '').strip()
428
if exc_clause and no_exc_comment:
429
both_exc_and_no_exc.append((fname, func))
430
if sig != 'object' and not (exc_clause or no_exc_comment):
431
missing_except.append((fname, func))
433
if both_exc_and_no_exc:
435
'The following functions had "cannot raise" comments'
436
' but did have an except clause set:')
437
for fname, func in both_exc_and_no_exc:
438
error_msg.append('%s:%s' % (fname, func))
439
error_msg.extend(('', ''))
442
'The following functions have fixed return types,'
443
' but no except clause.')
445
'Either add an except or append "# cannot_raise".')
446
for fname, func in missing_except:
447
error_msg.append('%s:%s' % (fname, func))
448
error_msg.extend(('', ''))
450
self.fail('\n'.join(error_msg))
71
# This number should be 4 (import NoWorkingTree and WorkingTree,
72
# raise NoWorkingTree from working_tree(), and construct a working tree
73
# there) but a merge that regressed this was done before this test was
74
# written. Note that this is an exact equality so that when the number
75
# drops, it is not given a buffer but rather this test updated
77
self.assertEqual(6, occurences)
added
removed
bzrlib/tests/test_source.py
