← 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: Canonical.com Patch Queue Manager
  • Date: 2009-03-17 07:05:37 UTC
  • mfrom: (4152.1.2 branch.stacked.streams)
  • Revision ID: pqm@pqm.ubuntu.com-20090317070537-zaud24vjs2szna87
(robertc) Add client-side streaming from stacked branches (over
        bzr:// protocols) when the sort order is compatible with doing
        that. (Robert Collins, Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_source.py
1
 
# Copyright (C) 2005-2010 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
 
33
35
    )
34
36
import bzrlib.branch
35
37
from bzrlib.tests import (
 
38
    KnownFailure,
36
39
    TestCase,
37
40
    TestSkipped,
38
41
    )
40
43
 
41
44
# Files which are listed here will be skipped when testing for Copyright (or
42
45
# GPL) statements.
43
 
COPYRIGHT_EXCEPTIONS = [
44
 
    'bzrlib/_bencode_py.py',
45
 
    'bzrlib/doc_generate/conf.py',
46
 
    'bzrlib/lsprof.py',
47
 
    ]
 
46
COPYRIGHT_EXCEPTIONS = ['bzrlib/lsprof.py']
48
47
 
49
 
LICENSE_EXCEPTIONS = [
50
 
    'bzrlib/_bencode_py.py',
51
 
    'bzrlib/doc_generate/conf.py',
52
 
    'bzrlib/lsprof.py',
53
 
    ]
 
48
LICENSE_EXCEPTIONS = ['bzrlib/lsprof.py']
54
49
# Technically, 'bzrlib/lsprof.py' should be 'bzrlib/util/lsprof.py',
55
50
# (we do not check bzrlib/util/, since that is code bundled from elsewhere)
56
51
# but for compatibility with previous releases, we don't want to move it.
57
 
#
58
 
# sphinx_conf is semi-autogenerated.
59
52
 
60
53
 
61
54
class TestSourceHelper(TestCase):
117
110
                              % source_dir)
118
111
        return source_dir
119
112
 
120
 
    def get_source_files(self, extensions=None):
 
113
    def get_source_files(self):
121
114
        """Yield all source files for bzr and bzrlib
122
115
 
123
116
        :param our_files_only: If true, exclude files from included libraries
124
117
            or plugins.
125
118
        """
126
119
        bzrlib_dir = self.get_bzrlib_dir()
127
 
        if extensions is None:
128
 
            extensions = ('.py',)
129
120
 
130
121
        # This is the front-end 'bzr' script
131
122
        bzr_path = self.get_bzr_path()
136
127
                if d.endswith('.tmp'):
137
128
                    dirs.remove(d)
138
129
            for f in files:
139
 
                for extension in extensions:
140
 
                    if f.endswith(extension):
141
 
                        break
142
 
                else:
143
 
                    # Did not match the accepted extensions
 
130
                if not f.endswith('.py'):
144
131
                    continue
145
132
                yield osutils.pathjoin(root, f)
146
133
 
147
 
    def get_source_file_contents(self, extensions=None):
148
 
        for fname in self.get_source_files(extensions=extensions):
 
134
    def get_source_file_contents(self):
 
135
        for fname in self.get_source_files():
149
136
            f = open(fname, 'rb')
150
137
            try:
151
138
                text = f.read()
189
176
                          % filename)
190
177
 
191
178
    def test_copyright(self):
192
 
        """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.
193
182
        incorrect = []
194
183
 
195
184
        copyright_re = re.compile('#\\s*copyright.*(?=\n)', re.I)
199
188
            r'.*Canonical Ltd' # And containing 'Canonical Ltd'
200
189
            )
201
190
 
202
 
        for fname, text in self.get_source_file_contents(
203
 
                extensions=('.py', '.pyx')):
 
191
        for fname, text in self.get_source_file_contents():
204
192
            if self.is_copyright_exception(fname):
205
193
                continue
206
194
            match = copyright_canonical_re.search(text)
235
223
            self.fail('\n'.join(help_text))
236
224
 
237
225
    def test_gpl(self):
238
 
        """Test that all .py and .pyx files have a GPL disclaimer."""
 
226
        """Test that all .py files have a GPL disclaimer"""
239
227
        incorrect = []
240
228
 
241
229
        gpl_txt = """
251
239
#
252
240
# You should have received a copy of the GNU General Public License
253
241
# along with this program; if not, write to the Free Software
254
 
# 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
255
243
"""
256
244
        gpl_re = re.compile(re.escape(gpl_txt), re.MULTILINE)
257
245
 
258
 
        for fname, text in self.get_source_file_contents(
259
 
                extensions=('.py', '.pyx')):
 
246
        for fname, text in self.get_source_file_contents():
260
247
            if self.is_license_exception(fname):
261
248
                continue
262
249
            if not gpl_re.search(text):
291
278
    def test_coding_style(self):
292
279
        """Check if bazaar code conforms to some coding style conventions.
293
280
 
294
 
        Currently we assert that the following is not present:
 
281
        Currently we check for:
295
282
         * any tab characters
 
283
         * trailing white space
296
284
         * non-unix newlines
297
285
         * no newline at end of files
298
 
 
299
 
        Print how many files have
300
 
         * trailing white space
301
286
         * lines longer than 79 chars
 
287
           (only print how many files and lines are in violation)
302
288
        """
303
289
        tabs = {}
304
290
        trailing_ws = {}
305
291
        illegal_newlines = {}
306
292
        long_lines = {}
307
293
        no_newline_at_eof = []
308
 
        for fname, text in self.get_source_file_contents(
309
 
                extensions=('.py', '.pyx')):
 
294
        for fname, text in self.get_source_file_contents():
310
295
            if not self.is_our_code(fname):
311
296
                continue
312
297
            lines = text.splitlines(True)
329
314
                'Tab characters were found in the following source files.'
330
315
                '\nThey should either be replaced by "\\t" or by spaces:'))
331
316
        if trailing_ws:
332
 
            print ("There are %i lines with trailing white space in %i files."
333
 
                % (sum([len(lines) for f, lines in trailing_ws.items()]),
334
 
                    len(trailing_ws)))
 
317
            problems.append(self._format_message(trailing_ws,
 
318
                'Trailing white space was found in the following source files:'
 
319
                ))
335
320
        if illegal_newlines:
336
321
            problems.append(self._format_message(illegal_newlines,
337
322
                'Non-unix newlines were found in the following source files:'))
346
331
               '\n\n    %s'
347
332
               % ('\n    '.join(no_newline_at_eof)))
348
333
        if problems:
 
334
            raise KnownFailure("test_coding_style has failed")
349
335
            self.fail('\n\n'.join(problems))
350
336
 
351
337
    def test_no_asserts(self):
365
351
                    return True
366
352
            return False
367
353
        badfiles = []
368
 
        assert_re = re.compile(r'\bassert\b')
369
354
        for fname, text in self.get_source_file_contents():
370
355
            if not self.is_our_code(fname):
371
356
                continue
372
 
            if not assert_re.search(text):
373
 
                continue
374
 
            ast = parser.ast2tuple(parser.suite(text))
 
357
            ast = parser.ast2tuple(parser.suite(''.join(text)))
375
358
            if search(ast):
376
359
                badfiles.append(fname)
377
360
        if badfiles:
378
361
            self.fail(
379
362
                "these files contain an assert statement and should not:\n%s"
380
363
                % '\n'.join(badfiles))
381
 
 
382
 
    def test_extension_exceptions(self):
383
 
        """Extension functions should propagate exceptions.
384
 
 
385
 
        Either they should return an object, have an 'except' clause, or have a
386
 
        "# cannot_raise" to indicate that we've audited them and defined them as not
387
 
        raising exceptions.
388
 
        """
389
 
        both_exc_and_no_exc = []
390
 
        missing_except = []
391
 
        class_re = re.compile(r'^(cdef\s+)?(public\s+)?'
392
 
                              r'(api\s+)?class (\w+).*:', re.MULTILINE)
393
 
        extern_class_re = re.compile(r'## extern cdef class (\w+)',
394
 
                                     re.MULTILINE)
395
 
        except_re = re.compile(r'cdef\s+' # start with cdef
396
 
                               r'([\w *]*?)\s*' # this is the return signature
397
 
                               r'(\w+)\s*\(' # the function name
398
 
                               r'[^)]*\)\s*' # parameters
399
 
                               r'(.*)\s*:' # the except clause
400
 
                               r'\s*(#\s*cannot[- _]raise)?' # cannot raise comment
401
 
                              )
402
 
        for fname, text in self.get_source_file_contents(
403
 
                extensions=('.pyx',)):
404
 
            known_classes = set([m[-1] for m in class_re.findall(text)])
405
 
            known_classes.update(extern_class_re.findall(text))
406
 
            cdefs = except_re.findall(text)
407
 
            for sig, func, exc_clause, no_exc_comment in cdefs:
408
 
                if sig.startswith('api '):
409
 
                    sig = sig[4:]
410
 
                if not sig or sig in known_classes:
411
 
                    sig = 'object'
412
 
                if 'nogil' in exc_clause:
413
 
                    exc_clause = exc_clause.replace('nogil', '').strip()
414
 
                if exc_clause and no_exc_comment:
415
 
                    both_exc_and_no_exc.append((fname, func))
416
 
                if sig != 'object' and not (exc_clause or no_exc_comment):
417
 
                    missing_except.append((fname, func))
418
 
        error_msg = []
419
 
        if both_exc_and_no_exc:
420
 
            error_msg.append('The following functions had "cannot raise" comments'
421
 
                             ' but did have an except clause set:')
422
 
            for fname, func in both_exc_and_no_exc:
423
 
                error_msg.append('%s:%s' % (fname, func))
424
 
            error_msg.extend(('', ''))
425
 
        if missing_except:
426
 
            error_msg.append('The following functions have fixed return types,'
427
 
                             ' but no except clause.')
428
 
            error_msg.append('Either add an except or append "# cannot_raise".')
429
 
            for fname, func in missing_except:
430
 
                error_msg.append('%s:%s' % (fname, func))
431
 
            error_msg.extend(('', ''))
432
 
        if error_msg:
433
 
            self.fail('\n'.join(error_msg))