/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_source.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_source.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#   Authors: Robert Collins <robert.collins@canonical.com>
 
1
# Copyright (C) 2005-2010 Canonical Ltd
3
2
#
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
13
12
#
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
 
# 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
17
16
 
18
17
"""These tests are tests about the source code of bzrlib itself.
19
18
 
22
21
 
23
22
# import system imports here
24
23
import os
 
24
import parser
25
25
import re
 
26
import symbol
26
27
import sys
 
28
import token
27
29
 
28
30
#import bzrlib specific imports here
29
31
from bzrlib import (
30
32
    osutils,
31
33
    )
32
34
import bzrlib.branch
33
 
from bzrlib.tests import TestCase, TestSkipped
 
35
from bzrlib.tests import (
 
36
    TestCase,
 
37
    TestSkipped,
 
38
    )
34
39
 
35
40
 
36
41
# Files which are listed here will be skipped when testing for Copyright (or
37
42
# GPL) statements.
38
 
COPYRIGHT_EXCEPTIONS = ['bzrlib/lsprof.py']
 
43
COPYRIGHT_EXCEPTIONS = ['bzrlib/lsprof.py', 'bzrlib/_bencode_py.py',
 
44
    'bzrlib/doc_generate/sphinx_conf.py']
39
45
 
40
 
LICENSE_EXCEPTIONS = ['bzrlib/lsprof.py']
 
46
LICENSE_EXCEPTIONS = ['bzrlib/lsprof.py', 'bzrlib/_bencode_py.py',
 
47
    'bzrlib/doc_generate/sphinx_conf.py']
41
48
# Technically, 'bzrlib/lsprof.py' should be 'bzrlib/util/lsprof.py',
42
49
# (we do not check bzrlib/util/, since that is code bundled from elsewhere)
43
50
# but for compatibility with previous releases, we don't want to move it.
 
51
#
 
52
# sphinx_conf is semi-autogenerated.
44
53
 
45
54
 
46
55
class TestSourceHelper(TestCase):
47
56
 
48
57
    def source_file_name(self, package):
49
58
        """Return the path of the .py file for package."""
 
59
        if getattr(sys, "frozen", None) is not None:
 
60
            raise TestSkipped("can't test sources in frozen distributions.")
50
61
        path = package.__file__
51
62
        if path[-1] in 'co':
52
63
            return path[:-1]
72
83
        # do not even think of increasing this number. If you think you need to
73
84
        # increase it, then you almost certainly are doing something wrong as
74
85
        # the relationship from working_tree to branch is one way.
75
 
        # 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,
76
87
        #it is not given a buffer but rather has this test updated immediately.
77
88
        self.assertEqual(0, occurences)
78
89
 
80
91
        """Test that the number of uses of working_tree in branch is stable."""
81
92
        occurences = self.find_occurences('WorkingTree',
82
93
                                          self.source_file_name(bzrlib.branch))
83
 
        # do not even think of increasing this number. If you think you need to
 
94
        # Do not even think of increasing this number. If you think you need to
84
95
        # increase it, then you almost certainly are doing something wrong as
85
96
        # the relationship from working_tree to branch is one way.
86
 
        # This number should be 4 (import NoWorkingTree and WorkingTree, 
87
 
        # raise NoWorkingTree from working_tree(), and construct a working tree
88
 
        # there) but a merge that regressed this was done before this test was
89
 
        # written. Note that this is an exact equality so that when the number
90
 
        # drops, it is not given a buffer but rather this test updated
91
 
        # immediately.
92
 
        self.assertEqual(2, occurences)
 
97
        # As of 20070809, there are no longer any mentions at all.
 
98
        self.assertEqual(0, occurences)
93
99
 
94
100
 
95
101
class TestSource(TestSourceHelper):
105
111
                              % source_dir)
106
112
        return source_dir
107
113
 
108
 
    def get_source_files(self):
109
 
        """yield all source files for bzr and bzrlib"""
 
114
    def get_source_files(self, extensions=None):
 
115
        """Yield all source files for bzr and bzrlib
 
116
 
 
117
        :param our_files_only: If true, exclude files from included libraries
 
118
            or plugins.
 
119
        """
110
120
        bzrlib_dir = self.get_bzrlib_dir()
 
121
        if extensions is None:
 
122
            extensions = ('.py',)
111
123
 
112
124
        # This is the front-end 'bzr' script
113
125
        bzr_path = self.get_bzr_path()
118
130
                if d.endswith('.tmp'):
119
131
                    dirs.remove(d)
120
132
            for f in files:
121
 
                if not f.endswith('.py'):
 
133
                for extension in extensions:
 
134
                    if f.endswith(extension):
 
135
                        break
 
136
                else:
 
137
                    # Did not match the accepted extensions
122
138
                    continue
123
139
                yield osutils.pathjoin(root, f)
124
140
 
125
 
    def get_source_file_contents(self):
126
 
        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):
127
143
            f = open(fname, 'rb')
128
144
            try:
129
145
                text = f.read()
131
147
                f.close()
132
148
            yield fname, text
133
149
 
 
150
    def is_our_code(self, fname):
 
151
        """Return true if it's a "real" part of bzrlib rather than external code"""
 
152
        if '/util/' in fname or '/plugins/' in fname:
 
153
            return False
 
154
        else:
 
155
            return True
 
156
 
134
157
    def is_copyright_exception(self, fname):
135
158
        """Certain files are allowed to be different"""
136
 
        if '/util/' in fname or '/plugins/' in fname:
 
159
        if not self.is_our_code(fname):
137
160
            # We don't ask that external utilities or plugins be
138
161
            # (C) Canonical Ltd
139
162
            return True
140
 
 
141
163
        for exc in COPYRIGHT_EXCEPTIONS:
142
164
            if fname.endswith(exc):
143
165
                return True
144
 
 
145
166
        return False
146
167
 
147
168
    def is_license_exception(self, fname):
148
169
        """Certain files are allowed to be different"""
149
 
        if '/util/' in fname or '/plugins/' in fname:
150
 
            # We don't ask that external utilities or plugins be
151
 
            # (C) Canonical Ltd
 
170
        if not self.is_our_code(fname):
152
171
            return True
153
 
 
154
172
        for exc in LICENSE_EXCEPTIONS:
155
173
            if fname.endswith(exc):
156
174
                return True
157
 
 
158
175
        return False
159
176
 
160
177
    def test_tmpdir_not_in_source_files(self):
166
183
                          % filename)
167
184
 
168
185
    def test_copyright(self):
169
 
        """Test that all .py files have a valid copyright statement"""
170
 
        # These are files which contain a different copyright statement
171
 
        # and that is okay.
 
186
        """Test that all .py and .pyx files have a valid copyright statement"""
172
187
        incorrect = []
173
188
 
174
189
        copyright_re = re.compile('#\\s*copyright.*(?=\n)', re.I)
178
193
            r'.*Canonical Ltd' # And containing 'Canonical Ltd'
179
194
            )
180
195
 
181
 
        for fname, text in self.get_source_file_contents():
 
196
        for fname, text in self.get_source_file_contents(
 
197
                extensions=('.py', '.pyx')):
182
198
            if self.is_copyright_exception(fname):
183
199
                continue
184
200
            match = copyright_canonical_re.search(text)
203
219
                         " bzrlib/tests/test_source.py",
204
220
                         # this is broken to prevent a false match
205
221
                         "or add '# Copyright (C)"
206
 
                         " 2006 Canonical Ltd' to these files:",
 
222
                         " 2007 Canonical Ltd' to these files:",
207
223
                         "",
208
224
                        ]
209
225
            for fname, comment in incorrect:
213
229
            self.fail('\n'.join(help_text))
214
230
 
215
231
    def test_gpl(self):
216
 
        """Test that all .py files have a GPL disclaimer"""
 
232
        """Test that all .py and .pyx files have a GPL disclaimer."""
217
233
        incorrect = []
218
234
 
219
235
        gpl_txt = """
229
245
#
230
246
# You should have received a copy of the GNU General Public License
231
247
# along with this program; if not, write to the Free Software
232
 
# 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
233
249
"""
234
250
        gpl_re = re.compile(re.escape(gpl_txt), re.MULTILINE)
235
251
 
236
 
        for fname, text in self.get_source_file_contents():
 
252
        for fname, text in self.get_source_file_contents(
 
253
                extensions=('.py', '.pyx')):
237
254
            if self.is_license_exception(fname):
238
255
                continue
239
256
            if not gpl_re.search(text):
253
270
 
254
271
            self.fail('\n'.join(help_text))
255
272
 
256
 
    def test_no_tabs(self):
257
 
        """bzrlib source files should not contain any tab characters."""
258
 
        incorrect = []
259
 
 
 
273
    def _push_file(self, dict_, fname, line_no):
 
274
        if fname not in dict_:
 
275
            dict_[fname] = [line_no]
 
276
        else:
 
277
            dict_[fname].append(line_no)
 
278
 
 
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()]
 
282
        files.sort()
 
283
        return message + '\n\n    %s' % ('\n    '.join(files))
 
284
 
 
285
    def test_coding_style(self):
 
286
        """Check if bazaar code conforms to some coding style conventions.
 
287
 
 
288
        Currently we assert that the following is not present:
 
289
         * any tab characters
 
290
         * non-unix newlines
 
291
         * no newline at end of files
 
292
 
 
293
        Print how many files have
 
294
         * trailing white space
 
295
         * lines longer than 79 chars
 
296
        """
 
297
        tabs = {}
 
298
        trailing_ws = {}
 
299
        illegal_newlines = {}
 
300
        long_lines = {}
 
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):
 
305
                continue
 
306
            lines = text.splitlines(True)
 
307
            last_line_no = len(lines) - 1
 
308
            for line_no, line in enumerate(lines):
 
309
                if '\t' in line:
 
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)
 
316
                if len(line) > 80:
 
317
                    self._push_file(long_lines, fname, line_no)
 
318
            if not lines[-1].endswith('\n'):
 
319
                no_newline_at_eof.append(fname)
 
320
        problems = []
 
321
        if tabs:
 
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:'))
 
325
        if trailing_ws:
 
326
            print ("There are %i lines with trailing white space in %i files."
 
327
                % (sum([len(lines) for f, lines in trailing_ws.items()]),
 
328
                    len(trailing_ws)))
 
329
        if illegal_newlines:
 
330
            problems.append(self._format_message(illegal_newlines,
 
331
                'Non-unix newlines were found in the following source files:'))
 
332
        if long_lines:
 
333
            print ("There are %i lines longer than 79 characters in %i files."
 
334
                % (sum([len(lines) for f, lines in long_lines.items()]),
 
335
                    len(long_lines)))
 
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:"
 
340
               '\n\n    %s'
 
341
               % ('\n    '.join(no_newline_at_eof)))
 
342
        if problems:
 
343
            self.fail('\n\n'.join(problems))
 
344
 
 
345
    def test_no_asserts(self):
 
346
        """bzr shouldn't use the 'assert' statement."""
 
347
        # assert causes too much variation between -O and not, and tends to
 
348
        # give bad errors to the user
 
349
        def search(x):
 
350
            # scan down through x for assert statements, report any problems
 
351
            # this is a bit cheesy; it may get some false positives?
 
352
            if x[0] == symbol.assert_stmt:
 
353
                return True
 
354
            elif x[0] == token.NAME:
 
355
                # can't search further down
 
356
                return False
 
357
            for sub in x[1:]:
 
358
                if sub and search(sub):
 
359
                    return True
 
360
            return False
 
361
        badfiles = []
 
362
        assert_re = re.compile(r'\bassert\b')
260
363
        for fname, text in self.get_source_file_contents():
261
 
            if '/util/' in fname or '/plugins/' in fname:
262
 
                continue
263
 
            if '\t' in text:
264
 
                incorrect.append(fname)
265
 
 
266
 
        if incorrect:
267
 
            self.fail('Tab characters were found in the following source files.'
268
 
              '\nThey should either be replaced by "\\t" or by spaces:'
269
 
              '\n\n    %s'
270
 
              % ('\n    '.join(incorrect)))
 
364
            if not self.is_our_code(fname):
 
365
                continue
 
366
            if not assert_re.search(text):
 
367
                continue
 
368
            ast = parser.ast2tuple(parser.suite(text))
 
369
            if search(ast):
 
370
                badfiles.append(fname)
 
371
        if badfiles:
 
372
            self.fail(
 
373
                "these files contain an assert statement and should not:\n%s"
 
374
                % '\n'.join(badfiles))
 
375
 
 
376
    def test_extension_exceptions(self):
 
377
        """Extension functions should propagate exceptions.
 
378
 
 
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
 
381
        raising exceptions.
 
382
        """
 
383
        both_exc_and_no_exc = []
 
384
        missing_except = []
 
385
        class_re = re.compile(r'^(cdef\s+)?(public\s+)?(api\s+)?class (\w+).*:',
 
386
                              re.MULTILINE)
 
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
 
393
                              )
 
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 '):
 
400
                    sig = sig[4:]
 
401
                if not sig or sig in known_classes:
 
402
                    sig = 'object'
 
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))
 
409
        error_msg = []
 
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(('', ''))
 
416
        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".')
 
420
            for fname, func in missing_except:
 
421
                error_msg.append('%s:%s' % (fname, func))
 
422
            error_msg.extend(('', ''))
 
423
        if error_msg:
 
424
            self.fail('\n'.join(error_msg))