← 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: 2010-09-01 08:02:42 UTC
  • mfrom: (5390.3.3 faster-revert-593560)
  • Revision ID: pqm@pqm.ubuntu.com-20100901080242-esg62ody4frwmy66
(spiv) Avoid repeatedly calling self.target.all_file_ids() in
 InterTree.iter_changes. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_source.py
1
 
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
2
 
#   Authors: Robert Collins <robert.collins@canonical.com>
3
 
#            and others
 
1
# Copyright (C) 2005-2010 Canonical Ltd
4
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
35
33
    )
36
34
import bzrlib.branch
37
35
from bzrlib.tests import (
38
 
    KnownFailure,
39
36
    TestCase,
40
37
    TestSkipped,
41
38
    )
43
40
 
44
41
# Files which are listed here will be skipped when testing for Copyright (or
45
42
# GPL) statements.
46
 
COPYRIGHT_EXCEPTIONS = ['bzrlib/lsprof.py']
 
43
COPYRIGHT_EXCEPTIONS = [
 
44
    'bzrlib/_bencode_py.py',
 
45
    'bzrlib/doc_generate/conf.py',
 
46
    'bzrlib/lsprof.py',
 
47
    ]
47
48
 
48
 
LICENSE_EXCEPTIONS = ['bzrlib/lsprof.py']
 
49
LICENSE_EXCEPTIONS = [
 
50
    'bzrlib/_bencode_py.py',
 
51
    'bzrlib/doc_generate/conf.py',
 
52
    'bzrlib/lsprof.py',
 
53
    ]
49
54
# Technically, 'bzrlib/lsprof.py' should be 'bzrlib/util/lsprof.py',
50
55
# (we do not check bzrlib/util/, since that is code bundled from elsewhere)
51
56
# but for compatibility with previous releases, we don't want to move it.
 
57
#
 
58
# sphinx_conf is semi-autogenerated.
52
59
 
53
60
 
54
61
class TestSourceHelper(TestCase):
284
291
    def test_coding_style(self):
285
292
        """Check if bazaar code conforms to some coding style conventions.
286
293
 
287
 
        Currently we check for:
 
294
        Currently we assert that the following is not present:
288
295
         * any tab characters
289
 
         * trailing white space
290
296
         * non-unix newlines
291
297
         * no newline at end of files
 
298
 
 
299
        Print how many files have
 
300
         * trailing white space
292
301
         * lines longer than 79 chars
293
 
           (only print how many files and lines are in violation)
294
302
        """
295
303
        tabs = {}
296
304
        trailing_ws = {}
321
329
                'Tab characters were found in the following source files.'
322
330
                '\nThey should either be replaced by "\\t" or by spaces:'))
323
331
        if trailing_ws:
324
 
            problems.append(self._format_message(trailing_ws,
325
 
                'Trailing white space was found in the following source files:'
326
 
                ))
 
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)))
327
335
        if illegal_newlines:
328
336
            problems.append(self._format_message(illegal_newlines,
329
337
                'Non-unix newlines were found in the following source files:'))
338
346
               '\n\n    %s'
339
347
               % ('\n    '.join(no_newline_at_eof)))
340
348
        if problems:
341
 
            raise KnownFailure("test_coding_style has failed")
342
349
            self.fail('\n\n'.join(problems))
343
350
 
344
351
    def test_no_asserts(self):
358
365
                    return True
359
366
            return False
360
367
        badfiles = []
 
368
        assert_re = re.compile(r'\bassert\b')
361
369
        for fname, text in self.get_source_file_contents():
362
370
            if not self.is_our_code(fname):
363
371
                continue
364
 
            ast = parser.ast2tuple(parser.suite(''.join(text)))
 
372
            if not assert_re.search(text):
 
373
                continue
 
374
            ast = parser.ast2tuple(parser.suite(text))
365
375
            if search(ast):
366
376
                badfiles.append(fname)
367
377
        if badfiles:
368
378
            self.fail(
369
379
                "these files contain an assert statement and should not:\n%s"
370
380
                % '\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))