~bzr-pqm/bzr/bzr.dev

5967.5.2 by Martin Pool
Make test_source actually comply with pep8 itself
1
# Copyright (C) 2005-2011 Canonical Ltd
1523 by Robert Collins
Test for the number of uses of self.working_tree() in branch.py
2
#
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
#
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
12
#
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1523 by Robert Collins
Test for the number of uses of self.working_tree() in branch.py
16
17
"""These tests are tests about the source code of bzrlib itself.
18
19
They are useful for testing code quality, checking coverage metric etc.
20
"""
21
22
import os
3376.2.1 by Martin Pool
Add test_no_asserts and cleanup test_source
23
import parser
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
24
import re
3376.2.1 by Martin Pool
Add test_no_asserts and cleanup test_source
25
import symbol
1523 by Robert Collins
Test for the number of uses of self.working_tree() in branch.py
26
import sys
3376.2.1 by Martin Pool
Add test_no_asserts and cleanup test_source
27
import token
1523 by Robert Collins
Test for the number of uses of self.working_tree() in branch.py
28
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
29
from bzrlib import (
30
    osutils,
31
    )
1523 by Robert Collins
Test for the number of uses of self.working_tree() in branch.py
32
import bzrlib.branch
3376.2.1 by Martin Pool
Add test_no_asserts and cleanup test_source
33
from bzrlib.tests import (
34
    TestCase,
35
    TestSkipped,
36
    )
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
37
38
2052.3.8 by John Arbash Meinel
Better documentation about the exception variables
39
# Files which are listed here will be skipped when testing for Copyright (or
40
# GPL) statements.
5193.6.24 by Vincent Ladeuil
Add copyrights in placeholder __init__.py files and fix the fallout from bzrlib/doc_generate/conf.py rename.
41
COPYRIGHT_EXCEPTIONS = [
42
    'bzrlib/_bencode_py.py',
43
    'bzrlib/doc_generate/conf.py',
44
    'bzrlib/lsprof.py',
45
    ]
2052.3.5 by John Arbash Meinel
Guide people to how to add files to the list of exceptions
46
5193.6.24 by Vincent Ladeuil
Add copyrights in placeholder __init__.py files and fix the fallout from bzrlib/doc_generate/conf.py rename.
47
LICENSE_EXCEPTIONS = [
48
    'bzrlib/_bencode_py.py',
49
    'bzrlib/doc_generate/conf.py',
50
    'bzrlib/lsprof.py',
51
    ]
2052.3.8 by John Arbash Meinel
Better documentation about the exception variables
52
# Technically, 'bzrlib/lsprof.py' should be 'bzrlib/util/lsprof.py',
53
# (we do not check bzrlib/util/, since that is code bundled from elsewhere)
54
# but for compatibility with previous releases, we don't want to move it.
4634.37.3 by Martin Pool
sphinx autogenerate configuration is exempt from test_source
55
#
56
# sphinx_conf is semi-autogenerated.
2052.3.5 by John Arbash Meinel
Guide people to how to add files to the list of exceptions
57
3572.1.7 by Marius Kruger
Code style and minor changes as per review.
58
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
59
class TestSourceHelper(TestCase):
60
61
    def source_file_name(self, package):
62
        """Return the path of the .py file for package."""
3616.2.7 by Mark Hammond
prefer getattr() over hasattr()
63
        if getattr(sys, "frozen", None) is not None:
3616.2.5 by Mark Hammond
don't try and test source code when we are frozen.
64
            raise TestSkipped("can't test sources in frozen distributions.")
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
65
        path = package.__file__
66
        if path[-1] in 'co':
67
            return path[:-1]
68
        else:
69
            return path
70
71
72
class TestApiUsage(TestSourceHelper):
1523 by Robert Collins
Test for the number of uses of self.working_tree() in branch.py
73
1524 by Robert Collins
Test the uses of WorkingTree from branch.py
74
    def find_occurences(self, rule, filename):
75
        """Find the number of occurences of rule in a file."""
1523 by Robert Collins
Test for the number of uses of self.working_tree() in branch.py
76
        occurences = 0
1524 by Robert Collins
Test the uses of WorkingTree from branch.py
77
        source = file(filename, 'r')
1523 by Robert Collins
Test for the number of uses of self.working_tree() in branch.py
78
        for line in source:
1524 by Robert Collins
Test the uses of WorkingTree from branch.py
79
            if line.find(rule) > -1:
1523 by Robert Collins
Test for the number of uses of self.working_tree() in branch.py
80
                occurences += 1
1524 by Robert Collins
Test the uses of WorkingTree from branch.py
81
        return occurences
82
83
    def test_branch_working_tree(self):
84
        """Test that the number of uses of working_tree in branch is stable."""
85
        occurences = self.find_occurences('self.working_tree()',
1526 by Robert Collins
Bugfix to source testing logic to get the right path when .py is returned by __file__
86
                                          self.source_file_name(bzrlib.branch))
1523 by Robert Collins
Test for the number of uses of self.working_tree() in branch.py
87
        # do not even think of increasing this number. If you think you need to
88
        # increase it, then you almost certainly are doing something wrong as
89
        # the relationship from working_tree to branch is one way.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
90
        # Note that this is an exact equality so that when the number drops,
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
91
        #it is not given a buffer but rather has this test updated immediately.
92
        self.assertEqual(0, occurences)
1524 by Robert Collins
Test the uses of WorkingTree from branch.py
93
94
    def test_branch_WorkingTree(self):
95
        """Test that the number of uses of working_tree in branch is stable."""
96
        occurences = self.find_occurences('WorkingTree',
1526 by Robert Collins
Bugfix to source testing logic to get the right path when .py is returned by __file__
97
                                          self.source_file_name(bzrlib.branch))
2696.1.1 by Martin Pool
Remove things deprecated in 0.11 and earlier
98
        # Do not even think of increasing this number. If you think you need to
1524 by Robert Collins
Test the uses of WorkingTree from branch.py
99
        # increase it, then you almost certainly are doing something wrong as
100
        # the relationship from working_tree to branch is one way.
2696.1.1 by Martin Pool
Remove things deprecated in 0.11 and earlier
101
        # As of 20070809, there are no longer any mentions at all.
102
        self.assertEqual(0, occurences)
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
103
104
105
class TestSource(TestSourceHelper):
106
107
    def get_bzrlib_dir(self):
108
        """Get the path to the root of bzrlib"""
109
        source = self.source_file_name(bzrlib)
110
        source_dir = os.path.dirname(source)
111
112
        # Avoid the case when bzrlib is packaged in a zip file
113
        if not os.path.isdir(source_dir):
5967.5.2 by Martin Pool
Make test_source actually comply with pep8 itself
114
            raise TestSkipped(
115
                'Cannot find bzrlib source directory. Expected %s'
116
                % source_dir)
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
117
        return source_dir
118
4198.1.1 by John Arbash Meinel
Include pyrex files in our source testing for GPL and Copyright checks.
119
    def get_source_files(self, extensions=None):
3376.2.1 by Martin Pool
Add test_no_asserts and cleanup test_source
120
        """Yield all source files for bzr and bzrlib
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
121
3376.2.1 by Martin Pool
Add test_no_asserts and cleanup test_source
122
        :param our_files_only: If true, exclude files from included libraries
123
            or plugins.
124
        """
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
125
        bzrlib_dir = self.get_bzrlib_dir()
4198.1.1 by John Arbash Meinel
Include pyrex files in our source testing for GPL and Copyright checks.
126
        if extensions is None:
127
            extensions = ('.py',)
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
128
129
        # This is the front-end 'bzr' script
130
        bzr_path = self.get_bzr_path()
131
        yield bzr_path
132
133
        for root, dirs, files in os.walk(bzrlib_dir):
2102.3.1 by mbp at sourcefrog
test_source should avoid walking into tempdirs
134
            for d in dirs:
135
                if d.endswith('.tmp'):
136
                    dirs.remove(d)
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
137
            for f in files:
4198.1.1 by John Arbash Meinel
Include pyrex files in our source testing for GPL and Copyright checks.
138
                for extension in extensions:
139
                    if f.endswith(extension):
140
                        break
141
                else:
142
                    # Did not match the accepted extensions
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
143
                    continue
144
                yield osutils.pathjoin(root, f)
145
4198.1.1 by John Arbash Meinel
Include pyrex files in our source testing for GPL and Copyright checks.
146
    def get_source_file_contents(self, extensions=None):
147
        for fname in self.get_source_files(extensions=extensions):
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
148
            f = open(fname, 'rb')
149
            try:
150
                text = f.read()
151
            finally:
152
                f.close()
153
            yield fname, text
154
3376.2.1 by Martin Pool
Add test_no_asserts and cleanup test_source
155
    def is_our_code(self, fname):
5967.5.2 by Martin Pool
Make test_source actually comply with pep8 itself
156
        """True if it's a "real" part of bzrlib rather than external code"""
3376.2.1 by Martin Pool
Add test_no_asserts and cleanup test_source
157
        if '/util/' in fname or '/plugins/' in fname:
158
            return False
159
        else:
160
            return True
161
2052.3.5 by John Arbash Meinel
Guide people to how to add files to the list of exceptions
162
    def is_copyright_exception(self, fname):
163
        """Certain files are allowed to be different"""
3376.2.1 by Martin Pool
Add test_no_asserts and cleanup test_source
164
        if not self.is_our_code(fname):
2084.1.5 by John Arbash Meinel
Don't check plugins for copyright or license
165
            # We don't ask that external utilities or plugins be
166
            # (C) Canonical Ltd
2052.3.5 by John Arbash Meinel
Guide people to how to add files to the list of exceptions
167
            return True
168
        for exc in COPYRIGHT_EXCEPTIONS:
169
            if fname.endswith(exc):
170
                return True
171
        return False
172
173
    def is_license_exception(self, fname):
174
        """Certain files are allowed to be different"""
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
175
        if not self.is_our_code(fname):
2052.3.5 by John Arbash Meinel
Guide people to how to add files to the list of exceptions
176
            return True
177
        for exc in LICENSE_EXCEPTIONS:
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
178
            if fname.endswith(exc):
179
                return True
180
        return False
181
2102.3.1 by mbp at sourcefrog
test_source should avoid walking into tempdirs
182
    def test_tmpdir_not_in_source_files(self):
183
        """When scanning for source files, we don't descend test tempdirs"""
184
        for filename in self.get_source_files():
185
            if re.search(r'test....\.tmp', filename):
186
                self.fail("get_source_file() returned filename %r "
187
                          "from within a temporary directory"
188
                          % filename)
189
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
190
    def test_copyright(self):
4198.1.1 by John Arbash Meinel
Include pyrex files in our source testing for GPL and Copyright checks.
191
        """Test that all .py and .pyx files have a valid copyright statement"""
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
192
        incorrect = []
193
2052.3.7 by John Arbash Meinel
Use positive lookahead to avoid extra newlines
194
        copyright_re = re.compile('#\\s*copyright.*(?=\n)', re.I)
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
195
        copyright_canonical_re = re.compile(
5967.5.2 by Martin Pool
Make test_source actually comply with pep8 itself
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'.
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
199
4198.1.1 by John Arbash Meinel
Include pyrex files in our source testing for GPL and Copyright checks.
200
        for fname, text in self.get_source_file_contents(
201
                extensions=('.py', '.pyx')):
2052.3.5 by John Arbash Meinel
Guide people to how to add files to the list of exceptions
202
            if self.is_copyright_exception(fname):
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
203
                continue
2052.3.2 by John Arbash Meinel
Change Copyright .. by Canonical to Copyright ... Canonical
204
            match = copyright_canonical_re.search(text)
205
            if not match:
206
                match = copyright_re.search(text)
207
                if match:
208
                    incorrect.append((fname, 'found: %s' % (match.group(),)))
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
209
                else:
210
                    incorrect.append((fname, 'no copyright line found\n'))
2052.3.2 by John Arbash Meinel
Change Copyright .. by Canonical to Copyright ... Canonical
211
            else:
212
                if 'by Canonical' in match.group():
213
                    incorrect.append((fname,
214
                        'should not have: "by Canonical": %s'
215
                        % (match.group(),)))
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
216
217
        if incorrect:
218
            help_text = ["Some files have missing or incorrect copyright"
219
                         " statements.",
2052.3.5 by John Arbash Meinel
Guide people to how to add files to the list of exceptions
220
                         "",
221
                         "Please either add them to the list of"
222
                         " COPYRIGHT_EXCEPTIONS in"
223
                         " bzrlib/tests/test_source.py",
224
                         # this is broken to prevent a false match
225
                         "or add '# Copyright (C)"
2613.1.2 by Martin Pool
Move bencode tests into util.tests
226
                         " 2007 Canonical Ltd' to these files:",
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
227
                         "",
228
                        ]
229
            for fname, comment in incorrect:
230
                help_text.append(fname)
5967.5.2 by Martin Pool
Make test_source actually comply with pep8 itself
231
                help_text.append((' ' * 4) + comment)
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
232
233
            self.fail('\n'.join(help_text))
234
235
    def test_gpl(self):
4198.1.1 by John Arbash Meinel
Include pyrex files in our source testing for GPL and Copyright checks.
236
        """Test that all .py and .pyx files have a GPL disclaimer."""
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
237
        incorrect = []
238
239
        gpl_txt = """
240
# This program is free software; you can redistribute it and/or modify
241
# it under the terms of the GNU General Public License as published by
242
# the Free Software Foundation; either version 2 of the License, or
243
# (at your option) any later version.
244
#
245
# This program is distributed in the hope that it will be useful,
246
# but WITHOUT ANY WARRANTY; without even the implied warranty of
247
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
248
# GNU General Public License for more details.
249
#
250
# You should have received a copy of the GNU General Public License
251
# along with this program; if not, write to the Free Software
4183.7.1 by Sabin Iacob
update FSF mailing address
252
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
253
"""
254
        gpl_re = re.compile(re.escape(gpl_txt), re.MULTILINE)
255
4198.1.1 by John Arbash Meinel
Include pyrex files in our source testing for GPL and Copyright checks.
256
        for fname, text in self.get_source_file_contents(
257
                extensions=('.py', '.pyx')):
2052.3.5 by John Arbash Meinel
Guide people to how to add files to the list of exceptions
258
            if self.is_license_exception(fname):
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
259
                continue
260
            if not gpl_re.search(text):
261
                incorrect.append(fname)
262
263
        if incorrect:
264
            help_text = ['Some files have missing or incomplete GPL statement',
2052.3.5 by John Arbash Meinel
Guide people to how to add files to the list of exceptions
265
                         "",
266
                         "Please either add them to the list of"
267
                         " LICENSE_EXCEPTIONS in"
268
                         " bzrlib/tests/test_source.py",
269
                         "Or add the following text to the beginning:",
5967.5.2 by Martin Pool
Make test_source actually comply with pep8 itself
270
                         gpl_txt]
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
271
            for fname in incorrect:
5967.5.2 by Martin Pool
Make test_source actually comply with pep8 itself
272
                help_text.append((' ' * 4) + fname)
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
273
274
            self.fail('\n'.join(help_text))
2120.2.1 by John Arbash Meinel
Remove tabs from source files, and add a test to keep it that way.
275
3943.7.2 by Marius Kruger
* also check for unix style newlines and note in HACKING that this is what we use.
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):
5967.5.2 by Martin Pool
Make test_source actually comply with pep8 itself
283
        files = ["%s: %s" % (f, ', '.join([str(i + 1) for i in lines]))
3943.7.2 by Marius Kruger
* also check for unix style newlines and note in HACKING that this is what we use.
284
                for f, lines in dict_.items()]
3943.7.3 by Marius Kruger
sort error output
285
        files.sort()
3943.7.2 by Marius Kruger
* also check for unix style newlines and note in HACKING that this is what we use.
286
        return message + '\n\n    %s' % ('\n    '.join(files))
287
3943.7.1 by Marius Kruger
* Change test_no_tabs to test_coding_style and let it check for trailing newlines too.
288
    def test_coding_style(self):
289
        """Check if bazaar code conforms to some coding style conventions.
290
5967.5.1 by Martin Pool
Don't print a message about long lines or trailing newlines.
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.
4210.5.1 by Marius Kruger
don't raise KnownFailure for all coding_style regressions,
294
5967.5.1 by Martin Pool
Don't print a message about long lines or trailing newlines.
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.
3943.7.1 by Marius Kruger
* Change test_no_tabs to test_coding_style and let it check for trailing newlines too.
298
        """
3943.7.2 by Marius Kruger
* also check for unix style newlines and note in HACKING that this is what we use.
299
        tabs = {}
300
        illegal_newlines = {}
3943.7.4 by Marius Kruger
now also check for 'no newline at end of files'
301
        no_newline_at_eof = []
4198.1.1 by John Arbash Meinel
Include pyrex files in our source testing for GPL and Copyright checks.
302
        for fname, text in self.get_source_file_contents(
303
                extensions=('.py', '.pyx')):
3376.2.1 by Martin Pool
Add test_no_asserts and cleanup test_source
304
            if not self.is_our_code(fname):
2234.4.1 by Wouter van Heyst
(John Arbash Meinel) Fix selftest for installed bzr (#80330)
305
                continue
3943.7.2 by Marius Kruger
* also check for unix style newlines and note in HACKING that this is what we use.
306
            lines = text.splitlines(True)
3943.7.4 by Marius Kruger
now also check for 'no newline at end of files'
307
            last_line_no = len(lines) - 1
3943.7.2 by Marius Kruger
* also check for unix style newlines and note in HACKING that this is what we use.
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'):
5967.5.2 by Martin Pool
Make test_source actually comply with pep8 itself
312
                    if line_no != last_line_no:  # not no_newline_at_eof
3943.7.4 by Marius Kruger
now also check for 'no newline at end of files'
313
                        self._push_file(illegal_newlines, fname, line_no)
314
            if not lines[-1].endswith('\n'):
315
                no_newline_at_eof.append(fname)
3943.7.1 by Marius Kruger
* Change test_no_tabs to test_coding_style and let it check for trailing newlines too.
316
        problems = []
317
        if tabs:
3943.7.2 by Marius Kruger
* also check for unix style newlines and note in HACKING that this is what we use.
318
            problems.append(self._format_message(tabs,
3943.7.1 by Marius Kruger
* Change test_no_tabs to test_coding_style and let it check for trailing newlines too.
319
                'Tab characters were found in the following source files.'
3943.7.2 by Marius Kruger
* also check for unix style newlines and note in HACKING that this is what we use.
320
                '\nThey should either be replaced by "\\t" or by spaces:'))
321
        if illegal_newlines:
322
            problems.append(self._format_message(illegal_newlines,
3943.7.4 by Marius Kruger
now also check for 'no newline at end of files'
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)))
3943.7.1 by Marius Kruger
* Change test_no_tabs to test_coding_style and let it check for trailing newlines too.
330
        if problems:
3943.7.4 by Marius Kruger
now also check for 'no newline at end of files'
331
            self.fail('\n\n'.join(problems))
3572.1.3 by Marius Kruger
* move test_coding_style into test_source
332
3376.2.1 by Martin Pool
Add test_no_asserts and cleanup test_source
333
    def test_no_asserts(self):
334
        """bzr shouldn't use the 'assert' statement."""
335
        # assert causes too much variation between -O and not, and tends to
336
        # give bad errors to the user
337
        def search(x):
338
            # scan down through x for assert statements, report any problems
339
            # this is a bit cheesy; it may get some false positives?
340
            if x[0] == symbol.assert_stmt:
341
                return True
342
            elif x[0] == token.NAME:
343
                # can't search further down
344
                return False
345
            for sub in x[1:]:
346
                if sub and search(sub):
347
                    return True
348
            return False
349
        badfiles = []
4699.1.1 by Harald Meland
Make test_no_asserts quicker by doing a regexp check for the presence of any 'assert' word before doing any expensive AST stuff
350
        assert_re = re.compile(r'\bassert\b')
3376.2.1 by Martin Pool
Add test_no_asserts and cleanup test_source
351
        for fname, text in self.get_source_file_contents():
352
            if not self.is_our_code(fname):
353
                continue
4699.1.1 by Harald Meland
Make test_no_asserts quicker by doing a regexp check for the presence of any 'assert' word before doing any expensive AST stuff
354
            if not assert_re.search(text):
355
                continue
356
            ast = parser.ast2tuple(parser.suite(text))
3376.2.1 by Martin Pool
Add test_no_asserts and cleanup test_source
357
            if search(ast):
358
                badfiles.append(fname)
359
        if badfiles:
3376.2.7 by Martin Pool
Treat assert statements in our code as a hard error
360
            self.fail(
3376.2.1 by Martin Pool
Add test_no_asserts and cleanup test_source
361
                "these files contain an assert statement and should not:\n%s"
362
                % '\n'.join(badfiles))
4634.117.5 by John Arbash Meinel
Add a test_source test, to ensure that all funcs have either an except
363
364
    def test_extension_exceptions(self):
365
        """Extension functions should propagate exceptions.
366
5967.5.2 by Martin Pool
Make test_source actually comply with pep8 itself
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.
4634.117.5 by John Arbash Meinel
Add a test_source test, to ensure that all funcs have either an except
370
        """
371
        both_exc_and_no_exc = []
372
        missing_except = []
5365.5.29 by John Arbash Meinel
Handle test_source and extensions. Also define an 'extern' protocol, to allow
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)
5967.5.2 by Martin Pool
Make test_source actually comply with pep8 itself
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
4634.117.5 by John Arbash Meinel
Add a test_source test, to ensure that all funcs have either an except
384
        for fname, text in self.get_source_file_contents(
385
                extensions=('.pyx',)):
4932.1.2 by John Arbash Meinel
Clean up _simple_set.pyx, and handle 'nogil'.
386
            known_classes = set([m[-1] for m in class_re.findall(text)])
5365.5.29 by John Arbash Meinel
Handle test_source and extensions. Also define an 'extern' protocol, to allow
387
            known_classes.update(extern_class_re.findall(text))
4634.117.5 by John Arbash Meinel
Add a test_source test, to ensure that all funcs have either an except
388
            cdefs = except_re.findall(text)
389
            for sig, func, exc_clause, no_exc_comment in cdefs:
4932.1.2 by John Arbash Meinel
Clean up _simple_set.pyx, and handle 'nogil'.
390
                if sig.startswith('api '):
391
                    sig = sig[4:]
4634.117.8 by John Arbash Meinel
Use a class regex to find other signatures to exclude.
392
                if not sig or sig in known_classes:
4634.117.5 by John Arbash Meinel
Add a test_source test, to ensure that all funcs have either an except
393
                    sig = 'object'
4932.1.2 by John Arbash Meinel
Clean up _simple_set.pyx, and handle 'nogil'.
394
                if 'nogil' in exc_clause:
395
                    exc_clause = exc_clause.replace('nogil', '').strip()
4634.117.5 by John Arbash Meinel
Add a test_source test, to ensure that all funcs have either an except
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:
5967.5.2 by Martin Pool
Make test_source actually comply with pep8 itself
402
            error_msg.append(
403
                'The following functions had "cannot raise" comments'
404
                ' but did have an except clause set:')
4634.117.5 by John Arbash Meinel
Add a test_source test, to ensure that all funcs have either an except
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:
5967.5.2 by Martin Pool
Make test_source actually comply with pep8 itself
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".')
4634.117.5 by John Arbash Meinel
Add a test_source test, to ensure that all funcs have either an except
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))
6379.6.2 by Jelmer Vernooij
add test to make sure absolute_import is enabled.
419
420
    def test_feature_absolute_import(self):
421
        """Using absolute imports means avoiding unnecesary stat and
422
        open calls.
423
424
        Make sure that all non-test files have absolute imports enabled.
425
        """
426
        missing_absolute_import = []
427
        for fname, text in self.get_source_file_contents(
428
                extensions=('.py', )):
6379.6.3 by Jelmer Vernooij
Use absolute_import.
429
            if "/tests/" in fname or "test_" in fname:
6379.6.2 by Jelmer Vernooij
add test to make sure absolute_import is enabled.
430
                # We don't really care about tests
431
                continue
6379.6.3 by Jelmer Vernooij
Use absolute_import.
432
            if not "from __future__ import absolute_import" in text:
6379.6.2 by Jelmer Vernooij
add test to make sure absolute_import is enabled.
433
                missing_absolute_import.append(fname)
434
435
        if missing_absolute_import:
436
            self.fail(
437
                'The following files do not have absolute_import enabled:\n'
438
                '\n' + '\n'.join(missing_absolute_import))