~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_source.py

  • Committer: Ian Clatworthy
  • Date: 2008-03-27 07:51:10 UTC
  • mto: (3311.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3312.
  • Revision ID: ian.clatworthy@canonical.com-20080327075110-afgd7x03ybju06ez
Reduce evangelism in the User Guide

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
 
#            and others
4
3
#
5
4
# This program is free software; you can redistribute it and/or modify
6
5
# it under the terms of the GNU General Public License as published by
23
22
 
24
23
# import system imports here
25
24
import os
26
 
import parser
27
25
import re
28
 
import symbol
29
26
import sys
30
 
import token
31
27
 
32
28
#import bzrlib specific imports here
33
29
from bzrlib import (
34
30
    osutils,
35
31
    )
36
32
import bzrlib.branch
37
 
from bzrlib.tests import (
38
 
    KnownFailure,
39
 
    TestCase,
40
 
    TestSkipped,
41
 
    )
 
33
from bzrlib.tests import TestCase, TestSkipped
42
34
 
43
35
 
44
36
# Files which are listed here will be skipped when testing for Copyright (or
55
47
 
56
48
    def source_file_name(self, package):
57
49
        """Return the path of the .py file for package."""
58
 
        if getattr(sys, "frozen", None) is not None:
59
 
            raise TestSkipped("can't test sources in frozen distributions.")
60
50
        path = package.__file__
61
51
        if path[-1] in 'co':
62
52
            return path[:-1]
111
101
        return source_dir
112
102
 
113
103
    def get_source_files(self):
114
 
        """Yield all source files for bzr and bzrlib
115
 
        
116
 
        :param our_files_only: If true, exclude files from included libraries
117
 
            or plugins.
118
 
        """
 
104
        """yield all source files for bzr and bzrlib"""
119
105
        bzrlib_dir = self.get_bzrlib_dir()
120
106
 
121
107
        # This is the front-end 'bzr' script
140
126
                f.close()
141
127
            yield fname, text
142
128
 
143
 
    def is_our_code(self, fname):
144
 
        """Return true if it's a "real" part of bzrlib rather than external code"""
145
 
        if '/util/' in fname or '/plugins/' in fname:
146
 
            return False
147
 
        else:
148
 
            return True
149
 
 
150
129
    def is_copyright_exception(self, fname):
151
130
        """Certain files are allowed to be different"""
152
 
        if not self.is_our_code(fname):
 
131
        if '/util/' in fname or '/plugins/' in fname:
153
132
            # We don't ask that external utilities or plugins be
154
133
            # (C) Canonical Ltd
155
134
            return True
 
135
 
156
136
        for exc in COPYRIGHT_EXCEPTIONS:
157
137
            if fname.endswith(exc):
158
138
                return True
 
139
 
159
140
        return False
160
141
 
161
142
    def is_license_exception(self, fname):
162
143
        """Certain files are allowed to be different"""
163
 
        if not self.is_our_code(fname):
 
144
        if '/util/' in fname or '/plugins/' in fname:
 
145
            # We don't ask that external utilities or plugins be
 
146
            # (C) Canonical Ltd
164
147
            return True
 
148
 
165
149
        for exc in LICENSE_EXCEPTIONS:
166
150
            if fname.endswith(exc):
167
151
                return True
 
152
 
168
153
        return False
169
154
 
170
155
    def test_tmpdir_not_in_source_files(self):
268
253
        incorrect = []
269
254
 
270
255
        for fname, text in self.get_source_file_contents():
271
 
            if not self.is_our_code(fname):
 
256
            if '/util/' in fname or '/plugins/' in fname:
272
257
                continue
273
258
            if '\t' in text:
274
259
                incorrect.append(fname)
278
263
              '\nThey should either be replaced by "\\t" or by spaces:'
279
264
              '\n\n    %s'
280
265
              % ('\n    '.join(incorrect)))
281
 
 
282
 
    def test_no_asserts(self):
283
 
        """bzr shouldn't use the 'assert' statement."""
284
 
        # assert causes too much variation between -O and not, and tends to
285
 
        # give bad errors to the user
286
 
        def search(x):
287
 
            # scan down through x for assert statements, report any problems
288
 
            # this is a bit cheesy; it may get some false positives?
289
 
            if x[0] == symbol.assert_stmt:
290
 
                return True
291
 
            elif x[0] == token.NAME:
292
 
                # can't search further down
293
 
                return False
294
 
            for sub in x[1:]:
295
 
                if sub and search(sub):
296
 
                    return True
297
 
            return False
298
 
        badfiles = []
299
 
        for fname, text in self.get_source_file_contents():
300
 
            if not self.is_our_code(fname):
301
 
                continue
302
 
            ast = parser.ast2tuple(parser.suite(''.join(text)))
303
 
            if search(ast):
304
 
                badfiles.append(fname)
305
 
        if badfiles:
306
 
            self.fail(
307
 
                "these files contain an assert statement and should not:\n%s"
308
 
                % '\n'.join(badfiles))