← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_source.py

  • Committer: Andrew Bennetts
  • Date: 2008-12-12 03:53:56 UTC
  • mto: This revision was merged to the branch mainline in revision 3900.
  • Revision ID: andrew.bennetts@canonical.com-20081212035356-uqcu89gy4nqf017x
Fix compilation error in _dirstate_helpers_c on SunOS/Solaris. (Jari Aalto)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_source.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
 
2
#   Authors: Robert Collins <robert.collins@canonical.com>
 
3
#            and others
2
4
#
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
12
14
#
13
15
# You should have received a copy of the GNU General Public License
14
16
# 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
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
18
 
17
19
"""These tests are tests about the source code of bzrlib itself.
18
20
 
19
21
They are useful for testing code quality, checking coverage metric etc.
20
22
"""
21
23
 
 
24
# import system imports here
22
25
import os
23
26
import parser
24
27
import re
26
29
import sys
27
30
import token
28
31
 
 
32
#import bzrlib specific imports here
29
33
from bzrlib import (
30
34
    osutils,
31
35
    )
32
36
import bzrlib.branch
33
37
from bzrlib.tests import (
 
38
    KnownFailure,
34
39
    TestCase,
35
40
    TestSkipped,
36
41
    )
38
43
 
39
44
# Files which are listed here will be skipped when testing for Copyright (or
40
45
# GPL) statements.
41
 
COPYRIGHT_EXCEPTIONS = [
42
 
    'bzrlib/_bencode_py.py',
43
 
    'bzrlib/doc_generate/conf.py',
44
 
    'bzrlib/lsprof.py',
45
 
    ]
 
46
COPYRIGHT_EXCEPTIONS = ['bzrlib/lsprof.py']
46
47
 
47
 
LICENSE_EXCEPTIONS = [
48
 
    'bzrlib/_bencode_py.py',
49
 
    'bzrlib/doc_generate/conf.py',
50
 
    'bzrlib/lsprof.py',
51
 
    ]
 
48
LICENSE_EXCEPTIONS = ['bzrlib/lsprof.py']
52
49
# Technically, 'bzrlib/lsprof.py' should be 'bzrlib/util/lsprof.py',
53
50
# (we do not check bzrlib/util/, since that is code bundled from elsewhere)
54
51
# but for compatibility with previous releases, we don't want to move it.
55
 
#
56
 
# sphinx_conf is semi-autogenerated.
57
52
 
58
53
 
59
54
class TestSourceHelper(TestCase):
87
82
        # do not even think of increasing this number. If you think you need to
88
83
        # increase it, then you almost certainly are doing something wrong as
89
84
        # the relationship from working_tree to branch is one way.
90
 
        # Note that this is an exact equality so that when the number drops,
 
85
        # Note that this is an exact equality so that when the number drops, 
91
86
        #it is not given a buffer but rather has this test updated immediately.
92
87
        self.assertEqual(0, occurences)
93
88
 
111
106
 
112
107
        # Avoid the case when bzrlib is packaged in a zip file
113
108
        if not os.path.isdir(source_dir):
114
 
            raise TestSkipped(
115
 
                'Cannot find bzrlib source directory. Expected %s'
116
 
                % source_dir)
 
109
            raise TestSkipped('Cannot find bzrlib source directory. Expected %s'
 
110
                              % source_dir)
117
111
        return source_dir
118
112
 
119
 
    def get_source_files(self, extensions=None):
 
113
    def get_source_files(self):
120
114
        """Yield all source files for bzr and bzrlib
121
 
 
 
115
        
122
116
        :param our_files_only: If true, exclude files from included libraries
123
117
            or plugins.
124
118
        """
125
119
        bzrlib_dir = self.get_bzrlib_dir()
126
 
        if extensions is None:
127
 
            extensions = ('.py',)
128
120
 
129
121
        # This is the front-end 'bzr' script
130
122
        bzr_path = self.get_bzr_path()
135
127
                if d.endswith('.tmp'):
136
128
                    dirs.remove(d)
137
129
            for f in files:
138
 
                for extension in extensions:
139
 
                    if f.endswith(extension):
140
 
                        break
141
 
                else:
142
 
                    # Did not match the accepted extensions
 
130
                if not f.endswith('.py'):
143
131
                    continue
144
132
                yield osutils.pathjoin(root, f)
145
133
 
146
 
    def get_source_file_contents(self, extensions=None):
147
 
        for fname in self.get_source_files(extensions=extensions):
 
134
    def get_source_file_contents(self):
 
135
        for fname in self.get_source_files():
148
136
            f = open(fname, 'rb')
149
137
            try:
150
138
                text = f.read()
153
141
            yield fname, text
154
142
 
155
143
    def is_our_code(self, fname):
156
 
        """True if it's a "real" part of bzrlib rather than external code"""
 
144
        """Return true if it's a "real" part of bzrlib rather than external code"""
157
145
        if '/util/' in fname or '/plugins/' in fname:
158
146
            return False
159
147
        else:
188
176
                          % filename)
189
177
 
190
178
    def test_copyright(self):
191
 
        """Test that all .py and .pyx files have a valid copyright statement"""
 
179
        """Test that all .py files have a valid copyright statement"""
 
180
        # These are files which contain a different copyright statement
 
181
        # and that is okay.
192
182
        incorrect = []
193
183
 
194
184
        copyright_re = re.compile('#\\s*copyright.*(?=\n)', re.I)
195
185
        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'.
 
186
            r'# Copyright \(C\) ' # Opening "# Copyright (C)"
 
187
            r'(\d+)(, \d+)*' # Followed by a series of dates
 
188
            r'.*Canonical Ltd' # And containing 'Canonical Ltd'
 
189
            )
199
190
 
200
 
        for fname, text in self.get_source_file_contents(
201
 
                extensions=('.py', '.pyx')):
 
191
        for fname, text in self.get_source_file_contents():
202
192
            if self.is_copyright_exception(fname):
203
193
                continue
204
194
            match = copyright_canonical_re.search(text)
228
218
                        ]
229
219
            for fname, comment in incorrect:
230
220
                help_text.append(fname)
231
 
                help_text.append((' ' * 4) + comment)
 
221
                help_text.append((' '*4) + comment)
232
222
 
233
223
            self.fail('\n'.join(help_text))
234
224
 
235
225
    def test_gpl(self):
236
 
        """Test that all .py and .pyx files have a GPL disclaimer."""
 
226
        """Test that all .py files have a GPL disclaimer"""
237
227
        incorrect = []
238
228
 
239
229
        gpl_txt = """
249
239
#
250
240
# You should have received a copy of the GNU General Public License
251
241
# along with this program; if not, write to the Free Software
252
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
242
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
253
243
"""
254
244
        gpl_re = re.compile(re.escape(gpl_txt), re.MULTILINE)
255
245
 
256
 
        for fname, text in self.get_source_file_contents(
257
 
                extensions=('.py', '.pyx')):
 
246
        for fname, text in self.get_source_file_contents():
258
247
            if self.is_license_exception(fname):
259
248
                continue
260
249
            if not gpl_re.search(text):
267
256
                         " LICENSE_EXCEPTIONS in"
268
257
                         " bzrlib/tests/test_source.py",
269
258
                         "Or add the following text to the beginning:",
270
 
                         gpl_txt]
 
259
                         gpl_txt
 
260
                        ]
271
261
            for fname in incorrect:
272
 
                help_text.append((' ' * 4) + fname)
 
262
                help_text.append((' '*4) + fname)
273
263
 
274
264
            self.fail('\n'.join(help_text))
275
265
 
276
 
    def _push_file(self, dict_, fname, line_no):
277
 
        if fname not in dict_:
278
 
            dict_[fname] = [line_no]
279
 
        else:
280
 
            dict_[fname].append(line_no)
281
 
 
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()]
285
 
        files.sort()
286
 
        return message + '\n\n    %s' % ('\n    '.join(files))
287
 
 
288
 
    def test_coding_style(self):
289
 
        """Check if bazaar code conforms to some coding style conventions.
290
 
 
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.
294
 
 
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.
298
 
        """
299
 
        tabs = {}
300
 
        illegal_newlines = {}
301
 
        no_newline_at_eof = []
302
 
        for fname, text in self.get_source_file_contents(
303
 
                extensions=('.py', '.pyx')):
 
266
    def test_no_tabs(self):
 
267
        """bzrlib source files should not contain any tab characters."""
 
268
        incorrect = []
 
269
 
 
270
        for fname, text in self.get_source_file_contents():
304
271
            if not self.is_our_code(fname):
305
272
                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 not lines[-1].endswith('\n'):
315
 
                no_newline_at_eof.append(fname)
316
 
        problems = []
317
 
        if tabs:
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:'))
321
 
        if illegal_newlines:
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:"
328
 
               '\n\n    %s'
329
 
               % ('\n    '.join(no_newline_at_eof)))
330
 
        if problems:
331
 
            self.fail('\n\n'.join(problems))
 
273
            if '\t' in text:
 
274
                incorrect.append(fname)
 
275
 
 
276
        if incorrect:
 
277
            self.fail('Tab characters were found in the following source files.'
 
278
              '\nThey should either be replaced by "\\t" or by spaces:'
 
279
              '\n\n    %s'
 
280
              % ('\n    '.join(incorrect)))
332
281
 
333
282
    def test_no_asserts(self):
334
283
        """bzr shouldn't use the 'assert' statement."""
347
296
                    return True
348
297
            return False
349
298
        badfiles = []
350
 
        assert_re = re.compile(r'\bassert\b')
351
299
        for fname, text in self.get_source_file_contents():
352
300
            if not self.is_our_code(fname):
353
301
                continue
354
 
            if not assert_re.search(text):
355
 
                continue
356
 
            ast = parser.ast2tuple(parser.suite(text))
 
302
            ast = parser.ast2tuple(parser.suite(''.join(text)))
357
303
            if search(ast):
358
304
                badfiles.append(fname)
359
305
        if badfiles:
360
306
            self.fail(
361
307
                "these files contain an assert statement and should not:\n%s"
362
308
                % '\n'.join(badfiles))
363
 
 
364
 
    def test_extension_exceptions(self):
365
 
        """Extension functions should propagate exceptions.
366
 
 
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.
370
 
        """
371
 
        both_exc_and_no_exc = []
372
 
        missing_except = []
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+)',
376
 
                                     re.MULTILINE)
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 '):
391
 
                    sig = sig[4:]
392
 
                if not sig or sig in known_classes:
393
 
                    sig = 'object'
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))
400
 
        error_msg = []
401
 
        if both_exc_and_no_exc:
402
 
            error_msg.append(
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(('', ''))
408
 
        if missing_except:
409
 
            error_msg.append(
410
 
                'The following functions have fixed return types,'
411
 
                ' but no except clause.')
412
 
            error_msg.append(
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(('', ''))
417
 
        if error_msg:
418
 
            self.fail('\n'.join(error_msg))