runtests.py 47.1 KB
Newer Older
1 2
#!/usr/bin/python

3 4 5
import os
import sys
import re
6
import gc
7 8 9 10
import codecs
import shutil
import unittest
import doctest
11
import operator
12
import tempfile
13
import traceback
14 15 16 17
try:
    from StringIO import StringIO
except ImportError:
    from io import StringIO
18 19 20 21 22 23

try:
    import cPickle as pickle
except ImportError:
    import pickle

24 25 26 27 28
try:
    import threading
except ImportError: # No threads, no problems
    threading = None

29

30
WITH_CYTHON = True
Robert Bradshaw's avatar
merge  
Robert Bradshaw committed
31

32
from distutils.dist import Distribution
33
from distutils.core import Extension
34
from distutils.command.build_ext import build_ext as _build_ext
35 36
distutils_distro = Distribution()

37
TEST_DIRS = ['compile', 'errors', 'run', 'wrappers', 'pyregr', 'build']
38
TEST_RUN_DIRS = ['run', 'wrappers', 'pyregr']
39

40 41 42
# Lists external modules, and a matcher matching tests
# which should be excluded if the module is not present.
EXT_DEP_MODULES = {
43
    'numpy' : re.compile('.*\.numpy_.*').match,
44 45
    'pstats' : re.compile('.*\.pstats_.*').match,
    'posix' : re.compile('.*\.posix_.*').match,
46 47
}

48 49 50 51 52 53 54 55 56
def get_numpy_include_dirs():
    import numpy
    return [numpy.get_include()]

EXT_DEP_INCLUDES = [
    # test name matcher , callable returning list
    (re.compile('numpy_.*').match, get_numpy_include_dirs),
]

57
VER_DEP_MODULES = {
58
    # tests are excluded if 'CurrentPythonVersion OP VersionTuple', i.e.
Stefan Behnel's avatar
Stefan Behnel committed
59 60 61 62
    # (2,4) : (operator.lt, ...) excludes ... when PyVer < 2.4.x
    (2,4) : (operator.lt, lambda x: x in ['run.extern_builtins_T258',
                                          'run.builtin_sorted'
                                          ]),
63 64 65
    (2,5) : (operator.lt, lambda x: x in ['run.any',
                                          'run.all',
                                          ]),
66 67
    (2,6) : (operator.lt, lambda x: x in ['run.print_function',
                                          'run.cython3',
68
                                          ]),
69 70 71 72 73
    # The next line should start (3,); but this is a dictionary, so
    # we can only have one (3,) key.  Since 2.7 is supposed to be the
    # last 2.x release, things would have to change drastically for this
    # to be unsafe...
    (2,999): (operator.lt, lambda x: x in ['run.special_methods_T561_py3']),
74
    (3,): (operator.ge, lambda x: x in ['run.non_future_division',
Stefan Behnel's avatar
Stefan Behnel committed
75
                                        'compile.extsetslice',
76 77
                                        'compile.extdelslice',
                                        'run.special_methods_T561_py2']),
78 79
}

80
INCLUDE_DIRS = [ d for d in os.getenv('INCLUDE', '').split(os.pathsep) if d ]
81 82
CFLAGS = os.getenv('CFLAGS', '').split()

83 84 85 86
class build_ext(_build_ext):
    def build_extension(self, ext):
        if ext.language == 'c++':
            try:
87 88 89 90 91
                try: # Py2.7+ & Py3.2+ 
                    compiler_obj = self.compiler_obj
                except AttributeError:
                    compiler_obj = self.compiler
                compiler_obj.compiler_so.remove('-Wstrict-prototypes')
92 93 94
            except Exception:
                pass
        _build_ext.build_extension(self, ext)
95 96

class ErrorWriter(object):
97
    match_error = re.compile('(warning:)?(?:.*:)?\s*([-0-9]+)\s*:\s*([-0-9]+)\s*:\s*(.*)').match
98 99 100 101
    def __init__(self):
        self.output = []
        self.write = self.output.append

102
    def _collect(self, collect_errors, collect_warnings):
103
        s = ''.join(self.output)
104
        result = []
105 106 107
        for line in s.split('\n'):
            match = self.match_error(line)
            if match:
108 109 110
                is_warning, line, column, message = match.groups()
                if (is_warning and collect_warnings) or \
                        (not is_warning and collect_errors):
111 112
                    result.append( (int(line), int(column), message.strip()) )
        result.sort()
Stefan Behnel's avatar
Stefan Behnel committed
113
        return [ "%d:%d: %s" % values for values in result ]
114 115 116 117 118 119 120 121 122

    def geterrors(self):
        return self._collect(True, False)

    def getwarnings(self):
        return self._collect(False, True)

    def getall(self):
        return self._collect(True, True)
123

124
class TestBuilder(object):
125
    def __init__(self, rootdir, workdir, selectors, exclude_selectors, annotate,
126
                 cleanup_workdir, cleanup_sharedlibs, with_pyregr, cython_only,
127
                 languages, test_bugs, fork, language_level):
128 129
        self.rootdir = rootdir
        self.workdir = workdir
130
        self.selectors = selectors
131
        self.exclude_selectors = exclude_selectors
132
        self.annotate = annotate
133
        self.cleanup_workdir = cleanup_workdir
134
        self.cleanup_sharedlibs = cleanup_sharedlibs
135
        self.with_pyregr = with_pyregr
136 137
        self.cython_only = cython_only
        self.languages = languages
138
        self.test_bugs = test_bugs
139
        self.fork = fork
140
        self.language_level = language_level
141 142 143

    def build_suite(self):
        suite = unittest.TestSuite()
144
        test_dirs = TEST_DIRS
145 146 147
        filenames = os.listdir(self.rootdir)
        filenames.sort()
        for filename in filenames:
148 149 150
            if not WITH_CYTHON and filename == "errors":
                # we won't get any errors without running Cython
                continue
151
            path = os.path.join(self.rootdir, filename)
152
            if os.path.isdir(path) and filename in test_dirs:
153 154
                if filename == 'pyregr' and not self.with_pyregr:
                    continue
155
                suite.addTest(
156
                    self.handle_directory(path, filename))
157 158
        if sys.platform not in ['win32'] and sys.version_info[0] < 3:
            # Non-Windows makefile, can't run Cython under Py3.
159 160
            if [1 for selector in self.selectors if selector("embedded")]:
                suite.addTest(unittest.makeSuite(EmbedTest))
161 162
        return suite

163
    def handle_directory(self, path, context):
164 165 166 167
        workdir = os.path.join(self.workdir, context)
        if not os.path.exists(workdir):
            os.makedirs(workdir)

168
        expect_errors = (context == 'errors')
169
        suite = unittest.TestSuite()
170 171 172
        filenames = os.listdir(path)
        filenames.sort()
        for filename in filenames:
173
            if context == "build" and filename.endswith(".srctree"):
174 175
                if not [ 1 for match in self.selectors if match(filename) ]:
                    continue
176 177
                suite.addTest(EndToEndTest(filename, workdir, self.cleanup_workdir))
                continue
178
            if not (filename.endswith(".pyx") or filename.endswith(".py")):
179
                continue
180
            if filename.startswith('.'): continue # certain emacs backup files
181 182
            if context == 'pyregr' and not filename.startswith('test_'):
                continue
183
            module = os.path.splitext(filename)[0]
184 185 186 187
            fqmodule = "%s.%s" % (context, module)
            if not [ 1 for match in self.selectors
                     if match(fqmodule) ]:
                continue
188 189 190
            if self.exclude_selectors:
                if [1 for match in self.exclude_selectors if match(fqmodule)]:
                    continue
191
            if context in TEST_RUN_DIRS:
192
                if module.startswith("test_"):
193
                    test_class = CythonUnitTestCase
194
                else:
195
                    test_class = CythonRunTestCase
196
            else:
197 198 199 200
                test_class = CythonCompileTestCase
            for test in self.build_tests(test_class, path, workdir,
                                         module, expect_errors):
                suite.addTest(test)
201
            if context == 'run' and filename.endswith('.py'):
202 203
                # additionally test file in real Python
                suite.addTest(PureDoctestTestCase(module, os.path.join(path, filename)))
204 205
        return suite

206
    def build_tests(self, test_class, path, workdir, module, expect_errors):
207
        if expect_errors:
Robert Bradshaw's avatar
Robert Bradshaw committed
208 209 210 211
            if 'cpp' in module and 'cpp' in self.languages:
                languages = ['cpp']
            else:
                languages = self.languages[:1]
212 213
        else:
            languages = self.languages
214 215 216
        if 'cpp' in module and 'c' in languages:
            languages = list(languages)
            languages.remove('c')
217 218
        tests = [ self.build_test(test_class, path, workdir, module,
                                  language, expect_errors)
219
                  for language in languages ]
220 221 222 223
        return tests

    def build_test(self, test_class, path, workdir, module,
                   language, expect_errors):
Stefan Behnel's avatar
Stefan Behnel committed
224 225 226
        workdir = os.path.join(workdir, language)
        if not os.path.exists(workdir):
            os.makedirs(workdir)
227 228 229 230 231 232
        return test_class(path, workdir, module,
                          language=language,
                          expect_errors=expect_errors,
                          annotate=self.annotate,
                          cleanup_workdir=self.cleanup_workdir,
                          cleanup_sharedlibs=self.cleanup_sharedlibs,
233
                          cython_only=self.cython_only,
234 235
                          fork=self.fork,
                          language_level=self.language_level)
236

237
class CythonCompileTestCase(unittest.TestCase):
238
    def __init__(self, test_directory, workdir, module, language='c',
239
                 expect_errors=False, annotate=False, cleanup_workdir=True,
240 241
                 cleanup_sharedlibs=True, cython_only=False, fork=True,
                 language_level=2):
242
        self.test_directory = test_directory
243 244
        self.workdir = workdir
        self.module = module
245
        self.language = language
246
        self.expect_errors = expect_errors
247
        self.annotate = annotate
248
        self.cleanup_workdir = cleanup_workdir
249
        self.cleanup_sharedlibs = cleanup_sharedlibs
250
        self.cython_only = cython_only
251
        self.fork = fork
252
        self.language_level = language_level
253 254 255
        unittest.TestCase.__init__(self)

    def shortDescription(self):
256
        return "compiling (%s) %s" % (self.language, self.module)
257

Stefan Behnel's avatar
Stefan Behnel committed
258 259 260 261
    def setUp(self):
        if self.workdir not in sys.path:
            sys.path.insert(0, self.workdir)

262
    def tearDown(self):
Stefan Behnel's avatar
Stefan Behnel committed
263 264 265 266 267 268 269 270
        try:
            sys.path.remove(self.workdir)
        except ValueError:
            pass
        try:
            del sys.modules[self.module]
        except KeyError:
            pass
271
        cleanup_c_files = WITH_CYTHON and self.cleanup_workdir
272
        cleanup_lib_files = self.cleanup_sharedlibs
273
        if os.path.exists(self.workdir):
274
            for rmfile in os.listdir(self.workdir):
275 276 277
                if not cleanup_c_files:
                    if rmfile[-2:] in (".c", ".h") or rmfile[-4:] == ".cpp":
                        continue
278 279
                if not cleanup_lib_files and rmfile.endswith(".so") or rmfile.endswith(".dll"):
                    continue
280 281 282 283 284 285 286 287 288 289 290 291
                if self.annotate and rmfile.endswith(".html"):
                    continue
                try:
                    rmfile = os.path.join(self.workdir, rmfile)
                    if os.path.isdir(rmfile):
                        shutil.rmtree(rmfile, ignore_errors=True)
                    else:
                        os.remove(rmfile)
                except IOError:
                    pass
        else:
            os.makedirs(self.workdir)
292

293
    def runTest(self):
294 295 296
        self.runCompileTest()

    def runCompileTest(self):
297 298
        self.compile(self.test_directory, self.module, self.workdir,
                     self.test_directory, self.expect_errors, self.annotate)
299

300 301 302 303 304
    def find_module_source_file(self, source_file):
        if not os.path.exists(source_file):
            source_file = source_file[:-1]
        return source_file

Stefan Behnel's avatar
Stefan Behnel committed
305 306 307 308
    def build_target_filename(self, module_name):
        target = '%s.%s' % (module_name, self.language)
        return target

309 310 311 312 313 314 315 316
    def copy_related_files(self, test_directory, target_directory, module_name):
        is_related = re.compile('%s_.*[.].*' % module_name).match
        for filename in os.listdir(test_directory):
            if is_related(filename):
                shutil.copy(os.path.join(test_directory, filename),
                            target_directory)

    def find_source_files(self, workdir, module_name):
317 318
        is_related = re.compile('%s_.*[.]%s' % (module_name, self.language)).match
        return [self.build_target_filename(module_name)] + [
319 320
            filename for filename in os.listdir(workdir)
            if is_related(filename) and os.path.isfile(os.path.join(workdir, filename)) ]
321 322

    def split_source_and_output(self, test_directory, module, workdir):
323 324
        source_file = self.find_module_source_file(os.path.join(test_directory, module) + '.pyx')
        source_and_output = codecs.open(source_file, 'rU', 'ISO-8859-1')
325
        try:
326
            out = codecs.open(os.path.join(workdir, module + os.path.splitext(source_file)[1]),
327 328 329 330 331 332 333 334 335 336
                              'w', 'ISO-8859-1')
            for line in source_and_output:
                last_line = line
                if line.startswith("_ERRORS"):
                    out.close()
                    out = ErrorWriter()
                else:
                    out.write(line)
        finally:
            source_and_output.close()
337 338 339
        try:
            geterrors = out.geterrors
        except AttributeError:
340
            out.close()
341 342 343 344
            return []
        else:
            return geterrors()

345 346
    def run_cython(self, test_directory, module, targetdir, incdir, annotate,
                   extra_compile_options=None):
347 348 349
        include_dirs = INCLUDE_DIRS[:]
        if incdir:
            include_dirs.append(incdir)
350
        source = self.find_module_source_file(
351
            os.path.join(test_directory, module + '.pyx'))
Stefan Behnel's avatar
Stefan Behnel committed
352
        target = os.path.join(targetdir, self.build_target_filename(module))
353 354 355 356 357 358 359 360 361 362 363
        
        if extra_compile_options is None:
            extra_compile_options = {}
        
        try:
            CompilationOptions
        except NameError:
            from Cython.Compiler.Main import CompilationOptions
            from Cython.Compiler.Main import compile as cython_compile
            from Cython.Compiler.Main import default_options
        
364
        options = CompilationOptions(
365
            default_options,
366 367
            include_path = include_dirs,
            output_file = target,
368
            annotate = annotate,
369 370
            use_listing_file = False,
            cplus = self.language == 'cpp',
371
            language_level = self.language_level,
372
            generate_pxi = False,
373
            evaluate_tree_assertions = True,
374
            **extra_compile_options
375
            )
376 377 378
        cython_compile(source, options=options,
                       full_module_name=module)

379 380
    def run_distutils(self, test_directory, module, workdir, incdir, 
                      extra_extension_args=None):
381 382 383 384 385 386 387 388
        cwd = os.getcwd()
        os.chdir(workdir)
        try:
            build_extension = build_ext(distutils_distro)
            build_extension.include_dirs = INCLUDE_DIRS[:]
            if incdir:
                build_extension.include_dirs.append(incdir)
            build_extension.finalize_options()
389 390 391 392
            ext_include_dirs = []
            for match, get_additional_include_dirs in EXT_DEP_INCLUDES:
                if match(module):
                    ext_include_dirs += get_additional_include_dirs()
393
            self.copy_related_files(test_directory, workdir, module)
394 395 396 397
            
            if extra_extension_args is None:
                extra_extension_args = {}
            
398 399
            extension = Extension(
                module,
400
                sources = self.find_source_files(workdir, module),
401
                include_dirs = ext_include_dirs,
402
                extra_compile_args = CFLAGS,
403
                **extra_extension_args
404
                )
405 406
            if self.language == 'cpp':
                extension.language = 'c++'
407 408 409 410 411 412
            build_extension.extensions = [extension]
            build_extension.build_temp = workdir
            build_extension.build_lib  = workdir
            build_extension.run()
        finally:
            os.chdir(cwd)
413

414
    def compile(self, test_directory, module, workdir, incdir,
415
                expect_errors, annotate):
416 417 418
        expected_errors = errors = ()
        if expect_errors:
            expected_errors = self.split_source_and_output(
419 420
                test_directory, module, workdir)
            test_directory = workdir
421

422 423 424 425
        if WITH_CYTHON:
            old_stderr = sys.stderr
            try:
                sys.stderr = ErrorWriter()
426
                self.run_cython(test_directory, module, workdir, incdir, annotate)
427 428 429
                errors = sys.stderr.geterrors()
            finally:
                sys.stderr = old_stderr
430 431

        if errors or expected_errors:
432 433 434 435 436 437 438 439 440 441 442 443
            try:
                for expected, error in zip(expected_errors, errors):
                    self.assertEquals(expected, error)
                if len(errors) < len(expected_errors):
                    expected_error = expected_errors[len(errors)]
                    self.assertEquals(expected_error, None)
                elif len(errors) > len(expected_errors):
                    unexpected_error = errors[len(expected_errors)]
                    self.assertEquals(None, unexpected_error)
            except AssertionError:
                print("\n=== Expected errors: ===")
                print('\n'.join(expected_errors))
Stefan Behnel's avatar
Stefan Behnel committed
444
                print("\n\n=== Got errors: ===")
445 446 447
                print('\n'.join(errors))
                print('\n')
                raise
448
        else:
449
            if not self.cython_only:
450
                self.run_distutils(test_directory, module, workdir, incdir)
451 452

class CythonRunTestCase(CythonCompileTestCase):
453
    def shortDescription(self):
454
        return "compiling (%s) and running %s" % (self.language, self.module)
455 456

    def run(self, result=None):
457 458
        if result is None:
            result = self.defaultTestResult()
Stefan Behnel's avatar
Stefan Behnel committed
459
        result.startTest(self)
460
        try:
Stefan Behnel's avatar
Stefan Behnel committed
461
            self.setUp()
462 463 464 465 466 467
            try:
                self.runCompileTest()
                if not self.cython_only:
                    self.run_doctests(self.module, result)
            finally:
                check_thread_termination()
468 469 470
        except Exception:
            result.addError(self, sys.exc_info())
            result.stopTest(self)
471 472 473 474
        try:
            self.tearDown()
        except Exception:
            pass
475

476
    def run_doctests(self, module_name, result):
477
        if sys.version_info[0] >= 3 or not hasattr(os, 'fork') or not self.fork:
478
            doctest.DocTestSuite(module_name).run(result)
479
            gc.collect()
480 481 482
            return

        # fork to make sure we do not keep the tested module loaded
483
        result_handle, result_file = tempfile.mkstemp()
484
        os.close(result_handle)
485 486 487 488 489
        child_id = os.fork()
        if not child_id:
            result_code = 0
            try:
                try:
490 491 492 493 494 495 496 497 498 499
                    tests = None
                    try:
                        partial_result = PartialTestResult(result)
                        tests = doctest.DocTestSuite(module_name)
                        tests.run(partial_result)
                        gc.collect()
                    except Exception:
                        if tests is None:
                            # importing failed, try to fake a test class
                            tests = _FakeClass(
Craig Citro's avatar
Craig Citro committed
500 501 502
                                failureException=sys.exc_info()[1],
                                _shortDescription=self.shortDescription(),
                                module_name=None)
503 504
                        partial_result.addError(tests, sys.exc_info())
                        result_code = 1
505
                    output = open(result_file, 'wb')
506 507 508
                    pickle.dump(partial_result.data(), output)
                except:
                    traceback.print_exc()
509 510 511 512 513
            finally:
                try: output.close()
                except: pass
                os._exit(result_code)

514 515
        try:
            cid, result_code = os.waitpid(child_id, 0)
Craig Citro's avatar
Craig Citro committed
516 517 518 519 520 521 522
            # os.waitpid returns the child's result code in the
            # upper byte of result_code, and the signal it was
            # killed by in the lower byte
            if result_code & 255:
                raise Exception("Tests in module '%s' were unexpectedly killed by signal %d"%
                                (module_name, result_code & 255))
            result_code = result_code >> 8
523 524 525 526 527 528 529 530
            if result_code in (0,1):
                input = open(result_file, 'rb')
                try:
                    PartialTestResult.join_results(result, pickle.load(input))
                finally:
                    input.close()
            if result_code:
                raise Exception("Tests in module '%s' exited with status %d" %
Craig Citro's avatar
Craig Citro committed
531
                                (module_name, result_code))
532
        finally:
533 534
            try: os.unlink(result_file)
            except: pass
535

536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
class PureDoctestTestCase(unittest.TestCase):
    def __init__(self, module_name, module_path):
        self.module_name = module_name
        self.module_path = module_path
        unittest.TestCase.__init__(self, 'run')

    def shortDescription(self):
        return "running pure doctests in %s" % self.module_name

    def run(self, result=None):
        if result is None:
            result = self.defaultTestResult()
        loaded_module_name = 'pure_doctest__' + self.module_name
        result.startTest(self)
        try:
            self.setUp()

            import imp
            m = imp.load_source(loaded_module_name, self.module_path)
            try:
                doctest.DocTestSuite(m).run(result)
            finally:
                del m
                if loaded_module_name in sys.modules:
                    del sys.modules[loaded_module_name]
561
                check_thread_termination()
562 563 564 565 566 567 568
        except Exception:
            result.addError(self, sys.exc_info())
            result.stopTest(self)
        try:
            self.tearDown()
        except Exception:
            pass
569

570 571 572 573
is_private_field = re.compile('^_[^_]').match

class _FakeClass(object):
    def __init__(self, **kwargs):
574
        self._shortDescription = kwargs.get('module_name')
575
        self.__dict__.update(kwargs)
576 577
    def shortDescription(self):
        return self._shortDescription
578

579 580 581 582 583 584
try: # Py2.7+ and Py3.2+
    from unittest.runner import _TextTestResult
except ImportError:
    from unittest import _TextTestResult

class PartialTestResult(_TextTestResult):
585
    def __init__(self, base_result):
586
        _TextTestResult.__init__(
587 588 589
            self, self._StringIO(), True,
            base_result.dots + base_result.showAll*2)

590 591 592 593 594 595
    def strip_error_results(self, results):
        for test_case, error in results:
            for attr_name in filter(is_private_field, dir(test_case)):
                if attr_name == '_dt_test':
                    test_case._dt_test = _FakeClass(
                        name=test_case._dt_test.name)
Craig Citro's avatar
Craig Citro committed
596
                elif attr_name != '_shortDescription':
597 598
                    setattr(test_case, attr_name, None)

599
    def data(self):
600 601
        self.strip_error_results(self.failures)
        self.strip_error_results(self.errors)
602 603 604 605 606 607 608
        return (self.failures, self.errors, self.testsRun,
                self.stream.getvalue())

    def join_results(result, data):
        """Static method for merging the result back into the main
        result object.
        """
Craig Citro's avatar
Craig Citro committed
609
        failures, errors, tests_run, output = data
610 611 612 613 614 615 616 617 618 619 620 621 622
        if output:
            result.stream.write(output)
        result.errors.extend(errors)
        result.failures.extend(failures)
        result.testsRun += tests_run

    join_results = staticmethod(join_results)

    class _StringIO(StringIO):
        def writeln(self, line):
            self.write("%s\n" % line)


623 624
class CythonUnitTestCase(CythonCompileTestCase):
    def shortDescription(self):
625
        return "compiling (%s) tests in %s" % (self.language, self.module)
626 627 628 629 630 631

    def run(self, result=None):
        if result is None:
            result = self.defaultTestResult()
        result.startTest(self)
        try:
Stefan Behnel's avatar
Stefan Behnel committed
632
            self.setUp()
633 634 635 636 637
            try:
                self.runCompileTest()
                unittest.defaultTestLoader.loadTestsFromName(self.module).run(result)
            finally:
                check_thread_termination()
638 639 640 641 642 643 644 645
        except Exception:
            result.addError(self, sys.exc_info())
            result.stopTest(self)
        try:
            self.tearDown()
        except Exception:
            pass

646
include_debugger = sys.version_info[:2] > (2, 5)
647

648
def collect_unittests(path, module_prefix, suite, selectors):
649 650 651 652 653 654 655
    def file_matches(filename):
        return filename.startswith("Test") and filename.endswith(".py")

    def package_matches(dirname):
        return dirname == "Tests"

    loader = unittest.TestLoader()
656 657 658 659 660 661
    
    if include_debugger:
        skipped_dirs = []
    else:
        cython_dir = os.path.dirname(os.path.abspath(__file__))
        skipped_dirs = [os.path.join(cython_dir, 'Cython', 'Debugger')]
662

663
    for dirpath, dirnames, filenames in os.walk(path):
664 665 666 667 668 669 670 671 672
        if dirpath != path and "__init__.py" not in filenames:
            skipped_dirs.append(dirpath + os.path.sep)
            continue
        skip = False
        for dir in skipped_dirs:
            if dirpath.startswith(dir):
                skip = True
        if skip:
            continue
673 674 675 676 677
        parentname = os.path.split(dirpath)[-1]
        if package_matches(parentname):
            for f in filenames:
                if file_matches(f):
                    filepath = os.path.join(dirpath, f)[:-len(".py")]
678
                    modulename = module_prefix + filepath[len(path)+1:].replace(os.path.sep, '.')
679 680
                    if not [ 1 for match in selectors if match(modulename) ]:
                        continue
681 682 683
                    module = __import__(modulename)
                    for x in modulename.split('.')[1:]:
                        module = getattr(module, x)
Robert Bradshaw's avatar
Robert Bradshaw committed
684
                    suite.addTests([loader.loadTestsFromModule(module)])
685

686 687


688 689
def collect_doctests(path, module_prefix, suite, selectors):
    def package_matches(dirname):
690 691
        if dirname == 'Debugger' and not include_debugger:
            return False
692 693
        return dirname not in ("Mac", "Distutils", "Plex")
    def file_matches(filename):
Mark Florisson's avatar
Mark Florisson committed
694
        filename, ext = os.path.splitext(filename)
695 696
        blacklist = ['libcython', 'libpython', 'test_libcython_in_gdb', 
                     'TestLibCython']
Mark Florisson's avatar
Mark Florisson committed
697 698 699 700 701
        return (ext == '.py' and not
                '~' in filename and not
                '#' in filename and not
                filename.startswith('.') and not
                filename in blacklist)
702 703 704 705 706 707 708
    import doctest, types
    for dirpath, dirnames, filenames in os.walk(path):
        parentname = os.path.split(dirpath)[-1]
        if package_matches(parentname):
            for f in filenames:
                if file_matches(f):
                    if not f.endswith('.py'): continue
Robert Bradshaw's avatar
Robert Bradshaw committed
709 710 711 712
                    filepath = os.path.join(dirpath, f)
                    if os.path.getsize(filepath) == 0: continue
                    if 'no doctest' in open(filepath).next(): continue
                    filepath = filepath[:-len(".py")]
713 714 715 716 717 718 719 720
                    modulename = module_prefix + filepath[len(path)+1:].replace(os.path.sep, '.')
                    if not [ 1 for match in selectors if match(modulename) ]:
                        continue
                    module = __import__(modulename)
                    for x in modulename.split('.')[1:]:
                        module = getattr(module, x)
                    if hasattr(module, "__doc__") or hasattr(module, "__test__"):
                        try:
721
                            suite.addTest(doctest.DocTestSuite(module))
722 723 724
                        except ValueError: # no tests
                            pass

725 726 727 728 729 730

class EndToEndTest(unittest.TestCase):
    """
    This is a test of build/*.srctree files, where srctree defines a full
    directory structure and its header gives a list of commands to run.
    """
Robert Bradshaw's avatar
Robert Bradshaw committed
731 732
    cython_root = os.path.dirname(os.path.abspath(__file__))
    
733 734 735 736
    def __init__(self, treefile, workdir, cleanup_workdir=True):
        self.treefile = treefile
        self.workdir = os.path.join(workdir, os.path.splitext(treefile)[0])
        self.cleanup_workdir = cleanup_workdir
737 738 739 740 741 742 743 744
        cython_syspath = self.cython_root
        for path in sys.path[::-1]:
            if path.startswith(self.cython_root):
                # Py3 installation and refnanny build prepend their
                # fixed paths to sys.path => prefer that over the
                # generic one
                cython_syspath = path + os.pathsep + cython_syspath
        self.cython_syspath = cython_syspath
745 746 747 748 749 750 751
        unittest.TestCase.__init__(self)

    def shortDescription(self):
        return "End-to-end %s" % self.treefile

    def setUp(self):
        from Cython.TestUtils import unpack_source_tree
752 753
        _, self.commands = unpack_source_tree(
            os.path.join('tests', 'build', self.treefile), self.workdir)
754 755 756 757 758 759 760 761 762 763 764 765
        self.old_dir = os.getcwd()
        os.chdir(self.workdir)
        if self.workdir not in sys.path:
            sys.path.insert(0, self.workdir)

    def tearDown(self):
        if self.cleanup_workdir:
            shutil.rmtree(self.workdir)
        os.chdir(self.old_dir)
    
    def runTest(self):
        commands = (self.commands
Robert Bradshaw's avatar
Robert Bradshaw committed
766
            .replace("CYTHON", "PYTHON %s" % os.path.join(self.cython_root, 'cython.py'))
767
            .replace("PYTHON", sys.executable))
768
        try:
Robert Bradshaw's avatar
Robert Bradshaw committed
769
            old_path = os.environ.get('PYTHONPATH')
770
            os.environ['PYTHONPATH'] = os.path.join(self.cython_syspath, (old_path or ''))
Robert Bradshaw's avatar
Robert Bradshaw committed
771 772 773 774 775 776 777 778 779 780
            for command in commands.split('\n'):
                if sys.version_info[:2] >= (2,4):
                    import subprocess
                    p = subprocess.Popen(commands,
                                         stderr=subprocess.PIPE,
                                         stdout=subprocess.PIPE,
                                         shell=True)
                    out, err = p.communicate()
                    res = p.returncode
                    if res != 0:
Stefan Behnel's avatar
Stefan Behnel committed
781 782 783
                        print(command)
                        print(out)
                        print(err)
Robert Bradshaw's avatar
Robert Bradshaw committed
784 785 786
                else:
                    res = os.system(command)
                self.assertEqual(0, res, "non-zero exit status")
787
        finally:
788 789 790 791
            if old_path:
                os.environ['PYTHONPATH'] = old_path
            else:
                del os.environ['PYTHONPATH']
792 793


794 795 796 797 798 799 800 801 802 803
# TODO: Support cython_freeze needed here as well.
# TODO: Windows support.

class EmbedTest(unittest.TestCase):
    
    working_dir = "Demos/embed"
    
    def setUp(self):
        self.old_dir = os.getcwd()
        os.chdir(self.working_dir)
804
        os.system(
805
            "make PYTHON='%s' clean > /dev/null" % sys.executable)
806 807 808
    
    def tearDown(self):
        try:
809 810
            os.system(
                "make PYTHON='%s' clean > /dev/null" % sys.executable)
811 812 813 814 815
        except:
            pass
        os.chdir(self.old_dir)
        
    def test_embed(self):
816
        from distutils import sysconfig
817
        libname = sysconfig.get_config_var('LIBRARY')
818
        libdir = sysconfig.get_config_var('LIBDIR')
819 820 821 822 823 824 825
        if not os.path.isdir(libdir) or libname not in os.listdir(libdir):
            libdir = os.path.join(os.path.dirname(sys.executable), '..', 'lib')
            if not os.path.isdir(libdir) or libname not in os.listdir(libdir):
                libdir = os.path.join(libdir, 'python%d.%d' % sys.version_info[:2], 'config')
                if not os.path.isdir(libdir) or libname not in os.listdir(libdir):
                    # report the error for the original directory
                    libdir = sysconfig.get_config_var('LIBDIR')
826
        self.assert_(os.system(
827
            "make PYTHON='%s' LIBDIR1='%s' test > make.output" % (sys.executable, libdir)) == 0)
828 829 830 831
        try:
            os.remove('make.output')
        except OSError:
            pass
832

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
class MissingDependencyExcluder:
    def __init__(self, deps):
        # deps: { module name : matcher func }
        self.exclude_matchers = []
        for mod, matcher in deps.items():
            try:
                __import__(mod)
            except ImportError:
                self.exclude_matchers.append(matcher)
        self.tests_missing_deps = []
    def __call__(self, testname):
        for matcher in self.exclude_matchers:
            if matcher(testname):
                self.tests_missing_deps.append(testname)
                return True
        return False

850 851 852 853 854
class VersionDependencyExcluder:
    def __init__(self, deps):
        # deps: { version : matcher func }
        from sys import version_info
        self.exclude_matchers = []
855 856
        for ver, (compare, matcher) in deps.items():
            if compare(version_info, ver):
857 858 859 860 861 862 863 864 865
                self.exclude_matchers.append(matcher)
        self.tests_missing_deps = []
    def __call__(self, testname):
        for matcher in self.exclude_matchers:
            if matcher(testname):
                self.tests_missing_deps.append(testname)
                return True
        return False

866 867 868 869
class FileListExcluder:

    def __init__(self, list_file):
        self.excludes = {}
870 871 872 873 874 875 876 877
        f = open(list_file)
        try:
            for line in f.readlines():
                line = line.strip()
                if line and line[0] != '#':
                    self.excludes[line.split()[0]] = True
        finally:
            f.close()
878 879
                
    def __call__(self, testname):
880
        return testname in self.excludes or testname.split('.')[-1] in self.excludes
881

882 883 884 885 886 887 888 889 890 891
def refactor_for_py3(distdir, cy3_dir):
    # need to convert Cython sources first
    import lib2to3.refactor
    from distutils.util import copydir_run_2to3
    fixers = [ fix for fix in lib2to3.refactor.get_fixers_from_package("lib2to3.fixes")
               if fix.split('fix_')[-1] not in ('next',)
               ]
    if not os.path.exists(cy3_dir):
        os.makedirs(cy3_dir)
    import distutils.log as dlog
892
    dlog.set_threshold(dlog.INFO)
893 894 895 896 897 898 899 900 901
    copydir_run_2to3(distdir, cy3_dir, fixer_names=fixers,
                     template = '''
                     global-exclude *
                     graft Cython
                     recursive-exclude Cython *
                     recursive-include Cython *.py *.pyx *.pxd
                     ''')
    sys.path.insert(0, cy3_dir)

902 903
class PendingThreadsError(RuntimeError):
    pass
904

905 906 907
threads_seen = []

def check_thread_termination(ignore_seen=True):
908 909 910 911 912 913 914 915 916
    if threading is None: # no threading enabled in CPython
        return
    current = threading.currentThread()
    blocking_threads = []
    for t in threading.enumerate():
        if not t.isAlive() or t == current:
            continue
        t.join(timeout=2)
        if t.isAlive():
917 918 919
            if not ignore_seen:
                blocking_threads.append(t)
                continue
920 921 922 923 924 925
            for seen in threads_seen:
                if t is seen:
                    break
            else:
                threads_seen.append(t)
                blocking_threads.append(t)
926 927 928 929 930
    if not blocking_threads:
        return
    sys.stderr.write("warning: left-over threads found after running test:\n")
    for t in blocking_threads:
        sys.stderr.write('...%s\n'  % repr(t))
931
    raise PendingThreadsError("left-over threads found after running test")
932

933
def main():
934 935 936
    from optparse import OptionParser
    parser = OptionParser()
    parser.add_option("--no-cleanup", dest="cleanup_workdir",
Stefan Behnel's avatar
Stefan Behnel committed
937 938
                      action="store_false", default=True,
                      help="do not delete the generated C files (allows passing --no-cython on next run)")
939 940 941
    parser.add_option("--no-cleanup-sharedlibs", dest="cleanup_sharedlibs",
                      action="store_false", default=True,
                      help="do not delete the generated shared libary files (allows manual module experimentation)")
Stefan Behnel's avatar
Stefan Behnel committed
942 943 944
    parser.add_option("--no-cython", dest="with_cython",
                      action="store_false", default=True,
                      help="do not run the Cython compiler, only the C compiler")
945 946 947 948 949 950
    parser.add_option("--no-c", dest="use_c",
                      action="store_false", default=True,
                      help="do not test C compilation")
    parser.add_option("--no-cpp", dest="use_cpp",
                      action="store_false", default=True,
                      help="do not test C++ compilation")
951 952 953
    parser.add_option("--no-unit", dest="unittests",
                      action="store_false", default=True,
                      help="do not run the unit tests")
954 955 956
    parser.add_option("--no-doctest", dest="doctests",
                      action="store_false", default=True,
                      help="do not run the doctests")
957 958 959
    parser.add_option("--no-file", dest="filetests",
                      action="store_false", default=True,
                      help="do not run the file based tests")
960 961
    parser.add_option("--no-pyregr", dest="pyregr",
                      action="store_false", default=True,
962
                      help="do not run the regression tests of CPython in tests/pyregr/")    
963
    parser.add_option("--cython-only", dest="cython_only",
964 965
                      action="store_true", default=False,
                      help="only compile pyx to c, do not run C compiler or run the tests")
966
    parser.add_option("--no-refnanny", dest="with_refnanny",
Stefan Behnel's avatar
Stefan Behnel committed
967
                      action="store_false", default=True,
968
                      help="do not regression test reference counting")
969 970 971
    parser.add_option("--no-fork", dest="fork",
                      action="store_false", default=True,
                      help="do not fork to run tests")
972 973 974
    parser.add_option("--sys-pyregr", dest="system_pyregr",
                      action="store_true", default=False,
                      help="run the regression tests of the CPython installation")
975 976 977
    parser.add_option("-x", "--exclude", dest="exclude",
                      action="append", metavar="PATTERN",
                      help="exclude tests matching the PATTERN")
978
    parser.add_option("-C", "--coverage", dest="coverage",
Stefan Behnel's avatar
Stefan Behnel committed
979 980
                      action="store_true", default=False,
                      help="collect source coverage data for the Compiler")
981 982 983
    parser.add_option("--coverage-xml", dest="coverage_xml",
                      action="store_true", default=False,
                      help="collect source coverage data for the Compiler in XML format")
Stefan Behnel's avatar
Stefan Behnel committed
984
    parser.add_option("-A", "--annotate", dest="annotate_source",
985
                      action="store_true", default=True,
Stefan Behnel's avatar
Stefan Behnel committed
986
                      help="generate annotated HTML versions of the test source files")
987 988 989
    parser.add_option("--no-annotate", dest="annotate_source",
                      action="store_false",
                      help="do not generate annotated HTML versions of the test source files")
990
    parser.add_option("-v", "--verbose", dest="verbosity",
Stefan Behnel's avatar
Stefan Behnel committed
991 992
                      action="count", default=0,
                      help="display test progress, pass twice to print test names")
993 994
    parser.add_option("-T", "--ticket", dest="tickets",
                      action="append",
995
                      help="a bug ticket number to run the respective test in 'tests/*'")
996 997 998
    parser.add_option("-3", dest="language_level",
                      action="store_const", const=3, default=2,
                      help="set language level to Python 3 (useful for running the CPython regression tests)'")
999 1000
    parser.add_option("--xml-output", dest="xml_output_dir", metavar="DIR",
                      help="write test results in XML to directory DIR")
1001 1002 1003
    parser.add_option("--exit-ok", dest="exit_ok", default=False,
                      action="store_true",
                      help="exit without error code even on test failures")
1004 1005 1006

    options, cmd_args = parser.parse_args()

1007 1008 1009 1010
    DISTDIR = os.path.join(os.getcwd(), os.path.dirname(sys.argv[0]))
    ROOTDIR = os.path.join(DISTDIR, 'tests')
    WORKDIR = os.path.join(os.getcwd(), 'BUILD')

1011 1012
    if sys.version_info[0] >= 3:
        options.doctests = False
1013
        if options.with_cython:
1014 1015 1016 1017
            try:
                # try if Cython is installed in a Py3 version
                import Cython.Compiler.Main
            except Exception:
Stefan Behnel's avatar
Stefan Behnel committed
1018 1019
                # back out anything the import process loaded, then
                # 2to3 the Cython sources to make them re-importable
1020
                cy_modules = [ name for name in sys.modules
Stefan Behnel's avatar
Stefan Behnel committed
1021
                               if name == 'Cython' or name.startswith('Cython.') ]
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
                for name in cy_modules:
                    del sys.modules[name]
                # hasn't been refactored yet - do it now
                cy3_dir = os.path.join(WORKDIR, 'Cy3')
                if sys.version_info >= (3,1):
                    refactor_for_py3(DISTDIR, cy3_dir)
                elif os.path.isdir(cy3_dir):
                    sys.path.insert(0, cy3_dir)
                else:
                    options.with_cython = False
1032

1033
    WITH_CYTHON = options.with_cython
1034

1035
    if options.coverage or options.coverage_xml:
1036
        if not WITH_CYTHON:
Stefan Behnel's avatar
Stefan Behnel committed
1037
            options.coverage = options.coverage_xml = False
1038
        else:
1039
            from coverage import coverage as _coverage
Stefan Behnel's avatar
Stefan Behnel committed
1040
            coverage = _coverage(branch=True)
1041 1042 1043
            coverage.erase()
            coverage.start()

1044
    if WITH_CYTHON:
1045
        global CompilationOptions, pyrex_default_options, cython_compile
1046 1047 1048 1049
        from Cython.Compiler.Main import \
            CompilationOptions, \
            default_options as pyrex_default_options, \
            compile as cython_compile
1050 1051
        from Cython.Compiler import Errors
        Errors.LEVEL = 0 # show all warnings
Stefan Behnel's avatar
Stefan Behnel committed
1052
        from Cython.Compiler import Options
1053
        Options.generate_cleanup_code = 3   # complete cleanup code
Stefan Behnel's avatar
Stefan Behnel committed
1054 1055
        from Cython.Compiler import DebugFlags
        DebugFlags.debug_temp_code_comments = 1
1056

1057
    # RUN ALL TESTS!
1058 1059
    UNITTEST_MODULE = "Cython"
    UNITTEST_ROOT = os.path.join(os.getcwd(), UNITTEST_MODULE)
1060 1061
    if WITH_CYTHON:
        if os.path.exists(WORKDIR):
1062
            for path in os.listdir(WORKDIR):
1063
                if path in ("support", "Cy3"): continue
1064
                shutil.rmtree(os.path.join(WORKDIR, path), ignore_errors=True)
1065 1066
    if not os.path.exists(WORKDIR):
        os.makedirs(WORKDIR)
1067

1068 1069
    sys.stderr.write("Python %s\n" % sys.version)
    sys.stderr.write("\n")
1070 1071
    if WITH_CYTHON:
        from Cython.Compiler.Version import version
1072
        sys.stderr.write("Running tests against Cython %s\n" % version)
1073
    else:
1074
        sys.stderr.write("Running tests without Cython.\n")
1075

1076 1077 1078 1079 1080
    if options.with_refnanny:
        from pyximport.pyxbuild import pyx_to_dll
        libpath = pyx_to_dll(os.path.join("Cython", "Runtime", "refnanny.pyx"),
                             build_in_temp=True,
                             pyxbuild_dir=os.path.join(WORKDIR, "support"))
1081
        sys.path.insert(0, os.path.split(libpath)[0])
1082
        CFLAGS.append("-DCYTHON_REFNANNY=1")
1083

Stefan Behnel's avatar
Stefan Behnel committed
1084 1085 1086 1087 1088
    if options.xml_output_dir and options.fork:
        # doesn't currently work together
        sys.stderr.write("Disabling forked testing to support XML test output\n")
        options.fork = False

1089 1090 1091 1092 1093
    if WITH_CYTHON and options.language_level == 3:
        sys.stderr.write("Using Cython language level 3.\n")

    sys.stderr.write("\n")

1094
    test_bugs = False
Stefan Behnel's avatar
Stefan Behnel committed
1095 1096 1097
    if options.tickets:
        for ticket_number in options.tickets:
            test_bugs = True
1098
            cmd_args.append('.*T%s$' % ticket_number)
1099 1100 1101 1102
    if not test_bugs:
        for selector in cmd_args:
            if selector.startswith('bugs'):
                test_bugs = True
1103

1104
    import re
1105
    selectors = [ re.compile(r, re.I|re.U).search for r in cmd_args ]
1106 1107 1108
    if not selectors:
        selectors = [ lambda x:True ]

1109 1110 1111 1112
    # Chech which external modules are not present and exclude tests
    # which depends on them (by prefix)

    missing_dep_excluder = MissingDependencyExcluder(EXT_DEP_MODULES) 
1113 1114
    version_dep_excluder = VersionDependencyExcluder(VER_DEP_MODULES) 
    exclude_selectors = [missing_dep_excluder, version_dep_excluder] # want to pring msg at exit
1115

1116 1117
    if options.exclude:
        exclude_selectors += [ re.compile(r, re.I|re.U).search for r in options.exclude ]
1118 1119 1120
    
    if not test_bugs:
        exclude_selectors += [ FileListExcluder("tests/bugs.txt") ]
1121 1122 1123
    
    if sys.platform in ['win32', 'cygwin'] and sys.version_info < (2,6):
        exclude_selectors += [ lambda x: x == "run.specialfloat" ]
1124

1125 1126 1127 1128 1129 1130
    languages = []
    if options.use_c:
        languages.append('c')
    if options.use_cpp:
        languages.append('cpp')

1131 1132 1133
    test_suite = unittest.TestSuite()

    if options.unittests:
1134
        collect_unittests(UNITTEST_ROOT, UNITTEST_MODULE + ".", test_suite, selectors)
1135

1136 1137
    if options.doctests:
        collect_doctests(UNITTEST_ROOT, UNITTEST_MODULE + ".", test_suite, selectors)
1138

1139
    if options.filetests and languages:
1140
        filetests = TestBuilder(ROOTDIR, WORKDIR, selectors, exclude_selectors,
1141
                                options.annotate_source, options.cleanup_workdir,
Stefan Behnel's avatar
Stefan Behnel committed
1142
                                options.cleanup_sharedlibs, options.pyregr,
1143
                                options.cython_only, languages, test_bugs,
1144
                                options.fork, options.language_level)
1145 1146
        test_suite.addTest(filetests.build_suite())

1147
    if options.system_pyregr and languages:
Stefan Behnel's avatar
Stefan Behnel committed
1148
        filetests = TestBuilder(ROOTDIR, WORKDIR, selectors, exclude_selectors,
1149
                                options.annotate_source, options.cleanup_workdir,
Stefan Behnel's avatar
Stefan Behnel committed
1150
                                options.cleanup_sharedlibs, True,
1151
                                options.cython_only, languages, test_bugs,
1152
                                options.fork, options.language_level)
1153 1154 1155 1156
        test_suite.addTest(
            filetests.handle_directory(
                os.path.join(sys.prefix, 'lib', 'python'+sys.version[:3], 'test'),
                'pyregr'))
1157

Stefan Behnel's avatar
Stefan Behnel committed
1158
    if options.xml_output_dir:
1159
        from Cython.Tests.xmlrunner import XMLTestRunner
Stefan Behnel's avatar
Stefan Behnel committed
1160 1161
        test_runner = XMLTestRunner(output=options.xml_output_dir,
                                    verbose=options.verbosity > 0)
1162 1163 1164 1165
    else:
        test_runner = unittest.TextTestRunner(verbosity=options.verbosity)

    result = test_runner.run(test_suite)
1166

1167
    if options.coverage or options.coverage_xml:
1168
        coverage.stop()
1169
        ignored_modules = ('Options', 'Version', 'DebugFlags', 'CmdLine')
1170 1171 1172 1173
        modules = [ module for name, module in sys.modules.items()
                    if module is not None and
                    name.startswith('Cython.Compiler.') and 
                    name[len('Cython.Compiler.'):] not in ignored_modules ]
1174 1175 1176
        if options.coverage:
            coverage.report(modules, show_missing=0)
        if options.coverage_xml:
1177
            coverage.xml_report(modules, outfile="coverage-report.xml")
1178 1179 1180 1181 1182

    if missing_dep_excluder.tests_missing_deps:
        sys.stderr.write("Following tests excluded because of missing dependencies on your system:\n")
        for test in missing_dep_excluder.tests_missing_deps:
            sys.stderr.write("   %s\n" % test)
1183

1184
    if options.with_refnanny:
Dag Sverre Seljebotn's avatar
Dag Sverre Seljebotn committed
1185
        import refnanny
1186
        sys.stderr.write("\n".join([repr(x) for x in refnanny.reflog]))
1187

1188 1189
    print("ALL DONE")

1190
    if options.exit_ok:
1191
        return_code = 0
1192
    else:
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
        return_code = not result.wasSuccessful()

    try:
        check_thread_termination(ignore_seen=False)
        sys.exit(return_code)
    except PendingThreadsError:
        # normal program exit won't kill the threads, do it the hard way here
        os._exit(return_code)

if __name__ == '__main__':
    try:
        main()
Stefan Behnel's avatar
Stefan Behnel committed
1205 1206
    except SystemExit: # <= Py2.4 ...
        raise
1207 1208 1209 1210 1211 1212 1213
    except Exception:
        traceback.print_exc()
        try:
            check_thread_termination(ignore_seen=False)
        except PendingThreadsError:
            # normal program exit won't kill the threads, do it the hard way here
            os._exit(1)