attempt to fix rmtree Windows issues in test case
[cython.git] / runtests.py
1 #!/usr/bin/python
2
3 import os
4 import sys
5 import re
6 import gc
7 import codecs
8 import shutil
9 import time
10 import unittest
11 import doctest
12 import operator
13 import tempfile
14 import traceback
15 try:
16     from StringIO import StringIO
17 except ImportError:
18     from io import StringIO
19
20 try:
21     import cPickle as pickle
22 except ImportError:
23     import pickle
24
25 try:
26     import threading
27 except ImportError: # No threads, no problems
28     threading = None
29
30 WITH_CYTHON = True
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 distutils_distro = Distribution()
36
37 if sys.platform == 'win32':
38     # TODO: Figure out why this hackery (see http://thread.gmane.org/gmane.comp.python.cython.devel/8280/).
39     config_files = distutils_distro.find_config_files()
40     try: config_files.remove('setup.cfg')
41     except ValueError: pass
42     distutils_distro.parse_config_files(config_files)
43
44     cfgfiles = distutils_distro.find_config_files()
45     try: cfgfiles.remove('setup.cfg')
46     except ValueError: pass
47     distutils_distro.parse_config_files(cfgfiles)
48
49 TEST_DIRS = ['compile', 'errors', 'run', 'wrappers', 'pyregr', 'build']
50 TEST_RUN_DIRS = ['run', 'wrappers', 'pyregr']
51
52 # Lists external modules, and a matcher matching tests
53 # which should be excluded if the module is not present.
54 EXT_DEP_MODULES = {
55     'numpy' : re.compile('.*\.numpy_.*').match,
56     'pstats' : re.compile('.*\.pstats_.*').match,
57     'posix' : re.compile('.*\.posix_.*').match,
58 }
59
60 def get_numpy_include_dirs():
61     import numpy
62     return [numpy.get_include()]
63
64 EXT_DEP_INCLUDES = [
65     # test name matcher , callable returning list
66     (re.compile('numpy_.*').match, get_numpy_include_dirs),
67 ]
68
69 VER_DEP_MODULES = {
70     # tests are excluded if 'CurrentPythonVersion OP VersionTuple', i.e.
71     # (2,4) : (operator.lt, ...) excludes ... when PyVer < 2.4.x
72     (2,4) : (operator.lt, lambda x: x in ['run.extern_builtins_T258',
73                                           'run.builtin_sorted'
74                                           ]),
75     (2,5) : (operator.lt, lambda x: x in ['run.any',
76                                           'run.all',
77                                           ]),
78     (2,6) : (operator.lt, lambda x: x in ['run.print_function',
79                                           'run.cython3',
80                                           'run.pure_py', # decorators, with statement
81                                           ]),
82     # The next line should start (3,); but this is a dictionary, so
83     # we can only have one (3,) key.  Since 2.7 is supposed to be the
84     # last 2.x release, things would have to change drastically for this
85     # to be unsafe...
86     (2,999): (operator.lt, lambda x: x in ['run.special_methods_T561_py3']),
87     (3,): (operator.ge, lambda x: x in ['run.non_future_division',
88                                         'compile.extsetslice',
89                                         'compile.extdelslice',
90                                         'run.special_methods_T561_py2']),
91 }
92
93 # files that should not be converted to Python 3 code with 2to3
94 KEEP_2X_FILES = [
95     os.path.join('Cython', 'Debugger', 'Tests', 'test_libcython_in_gdb.py'),
96     os.path.join('Cython', 'Debugger', 'Tests', 'test_libpython_in_gdb.py'),
97     os.path.join('Cython', 'Debugger', 'libcython.py'),
98     os.path.join('Cython', 'Debugger', 'libpython.py'),
99 ]
100
101
102 INCLUDE_DIRS = [ d for d in os.getenv('INCLUDE', '').split(os.pathsep) if d ]
103 CFLAGS = os.getenv('CFLAGS', '').split()
104
105 class build_ext(_build_ext):
106     def build_extension(self, ext):
107         if ext.language == 'c++':
108             try:
109                 try: # Py2.7+ & Py3.2+
110                     compiler_obj = self.compiler_obj
111                 except AttributeError:
112                     compiler_obj = self.compiler
113                 compiler_obj.compiler_so.remove('-Wstrict-prototypes')
114             except Exception:
115                 pass
116         _build_ext.build_extension(self, ext)
117
118 class ErrorWriter(object):
119     match_error = re.compile('(warning:)?(?:.*:)?\s*([-0-9]+)\s*:\s*([-0-9]+)\s*:\s*(.*)').match
120     def __init__(self):
121         self.output = []
122         self.write = self.output.append
123
124     def _collect(self, collect_errors, collect_warnings):
125         s = ''.join(self.output)
126         result = []
127         for line in s.split('\n'):
128             match = self.match_error(line)
129             if match:
130                 is_warning, line, column, message = match.groups()
131                 if (is_warning and collect_warnings) or \
132                         (not is_warning and collect_errors):
133                     result.append( (int(line), int(column), message.strip()) )
134         result.sort()
135         return [ "%d:%d: %s" % values for values in result ]
136
137     def geterrors(self):
138         return self._collect(True, False)
139
140     def getwarnings(self):
141         return self._collect(False, True)
142
143     def getall(self):
144         return self._collect(True, True)
145
146 class TestBuilder(object):
147     def __init__(self, rootdir, workdir, selectors, exclude_selectors, annotate,
148                  cleanup_workdir, cleanup_sharedlibs, with_pyregr, cython_only,
149                  languages, test_bugs, fork, language_level):
150         self.rootdir = rootdir
151         self.workdir = workdir
152         self.selectors = selectors
153         self.exclude_selectors = exclude_selectors
154         self.annotate = annotate
155         self.cleanup_workdir = cleanup_workdir
156         self.cleanup_sharedlibs = cleanup_sharedlibs
157         self.with_pyregr = with_pyregr
158         self.cython_only = cython_only
159         self.languages = languages
160         self.test_bugs = test_bugs
161         self.fork = fork
162         self.language_level = language_level
163
164     def build_suite(self):
165         suite = unittest.TestSuite()
166         test_dirs = TEST_DIRS
167         filenames = os.listdir(self.rootdir)
168         filenames.sort()
169         for filename in filenames:
170             if not WITH_CYTHON and filename == "errors":
171                 # we won't get any errors without running Cython
172                 continue
173             path = os.path.join(self.rootdir, filename)
174             if os.path.isdir(path) and filename in test_dirs:
175                 if filename == 'pyregr' and not self.with_pyregr:
176                     continue
177                 suite.addTest(
178                     self.handle_directory(path, filename))
179         if sys.platform not in ['win32'] and sys.version_info[0] < 3:
180             # Non-Windows makefile, can't run Cython under Py3.
181             if [1 for selector in self.selectors if selector("embedded")] \
182                 and not [1 for selector in self.exclude_selectors if selector("embedded")]:
183                 suite.addTest(unittest.makeSuite(EmbedTest))
184         return suite
185
186     def handle_directory(self, path, context):
187         workdir = os.path.join(self.workdir, context)
188         if not os.path.exists(workdir):
189             os.makedirs(workdir)
190
191         expect_errors = (context == 'errors')
192         suite = unittest.TestSuite()
193         filenames = os.listdir(path)
194         filenames.sort()
195         for filename in filenames:
196             if context == "build" and filename.endswith(".srctree"):
197                 if not [ 1 for match in self.selectors if match(filename) ]:
198                     continue
199                 if self.exclude_selectors:
200                     if [1 for match in self.exclude_selectors if match(filename)]:
201                         continue
202                 suite.addTest(EndToEndTest(os.path.join(path, filename), workdir, self.cleanup_workdir))
203                 continue
204             if not (filename.endswith(".pyx") or filename.endswith(".py")):
205                 continue
206             if filename.startswith('.'): continue # certain emacs backup files
207             if context == 'pyregr' and not filename.startswith('test_'):
208                 continue
209             module = os.path.splitext(filename)[0]
210             fqmodule = "%s.%s" % (context, module)
211             if not [ 1 for match in self.selectors
212                      if match(fqmodule) ]:
213                 continue
214             if self.exclude_selectors:
215                 if [1 for match in self.exclude_selectors if match(fqmodule)]:
216                     continue
217             if context == 'pyregr':
218                 test_class = CythonPyregrTestCase
219             elif context in TEST_RUN_DIRS:
220                 if module.startswith("test_"):
221                     test_class = CythonUnitTestCase
222                 else:
223                     test_class = CythonRunTestCase
224             else:
225                 test_class = CythonCompileTestCase
226             for test in self.build_tests(test_class, path, workdir,
227                                          module, expect_errors):
228                 suite.addTest(test)
229             if context == 'run' and filename.endswith('.py'):
230                 # additionally test file in real Python
231                 suite.addTest(PureDoctestTestCase(module, os.path.join(path, filename)))
232         return suite
233
234     def build_tests(self, test_class, path, workdir, module, expect_errors):
235         if expect_errors:
236             if 'cpp' in module and 'cpp' in self.languages:
237                 languages = ['cpp']
238             else:
239                 languages = self.languages[:1]
240         else:
241             languages = self.languages
242         if 'cpp' in module and 'c' in languages:
243             languages = list(languages)
244             languages.remove('c')
245         tests = [ self.build_test(test_class, path, workdir, module,
246                                   language, expect_errors)
247                   for language in languages ]
248         return tests
249
250     def build_test(self, test_class, path, workdir, module,
251                    language, expect_errors):
252         workdir = os.path.join(workdir, language)
253         if not os.path.exists(workdir):
254             os.makedirs(workdir)
255         return test_class(path, workdir, module,
256                           language=language,
257                           expect_errors=expect_errors,
258                           annotate=self.annotate,
259                           cleanup_workdir=self.cleanup_workdir,
260                           cleanup_sharedlibs=self.cleanup_sharedlibs,
261                           cython_only=self.cython_only,
262                           fork=self.fork,
263                           language_level=self.language_level)
264
265 class CythonCompileTestCase(unittest.TestCase):
266     def __init__(self, test_directory, workdir, module, language='c',
267                  expect_errors=False, annotate=False, cleanup_workdir=True,
268                  cleanup_sharedlibs=True, cython_only=False, fork=True,
269                  language_level=2):
270         self.test_directory = test_directory
271         self.workdir = workdir
272         self.module = module
273         self.language = language
274         self.expect_errors = expect_errors
275         self.annotate = annotate
276         self.cleanup_workdir = cleanup_workdir
277         self.cleanup_sharedlibs = cleanup_sharedlibs
278         self.cython_only = cython_only
279         self.fork = fork
280         self.language_level = language_level
281         unittest.TestCase.__init__(self)
282
283     def shortDescription(self):
284         return "compiling (%s) %s" % (self.language, self.module)
285
286     def setUp(self):
287         if self.workdir not in sys.path:
288             sys.path.insert(0, self.workdir)
289
290     def tearDown(self):
291         try:
292             sys.path.remove(self.workdir)
293         except ValueError:
294             pass
295         try:
296             del sys.modules[self.module]
297         except KeyError:
298             pass
299         cleanup_c_files = WITH_CYTHON and self.cleanup_workdir
300         cleanup_lib_files = self.cleanup_sharedlibs
301         if os.path.exists(self.workdir):
302             for rmfile in os.listdir(self.workdir):
303                 if not cleanup_c_files:
304                     if rmfile[-2:] in (".c", ".h") or rmfile[-4:] == ".cpp":
305                         continue
306                 if not cleanup_lib_files and rmfile.endswith(".so") or rmfile.endswith(".dll"):
307                     continue
308                 if self.annotate and rmfile.endswith(".html"):
309                     continue
310                 try:
311                     rmfile = os.path.join(self.workdir, rmfile)
312                     if os.path.isdir(rmfile):
313                         shutil.rmtree(rmfile, ignore_errors=True)
314                     else:
315                         os.remove(rmfile)
316                 except IOError:
317                     pass
318         else:
319             os.makedirs(self.workdir)
320
321     def runTest(self):
322         self.runCompileTest()
323
324     def runCompileTest(self):
325         self.compile(self.test_directory, self.module, self.workdir,
326                      self.test_directory, self.expect_errors, self.annotate)
327
328     def find_module_source_file(self, source_file):
329         if not os.path.exists(source_file):
330             source_file = source_file[:-1]
331         return source_file
332
333     def build_target_filename(self, module_name):
334         target = '%s.%s' % (module_name, self.language)
335         return target
336
337     def copy_related_files(self, test_directory, target_directory, module_name):
338         is_related = re.compile('%s_.*[.].*' % module_name).match
339         for filename in os.listdir(test_directory):
340             if is_related(filename):
341                 shutil.copy(os.path.join(test_directory, filename),
342                             target_directory)
343
344     def find_source_files(self, workdir, module_name):
345         is_related = re.compile('%s_.*[.]%s' % (module_name, self.language)).match
346         return [self.build_target_filename(module_name)] + [
347             filename for filename in os.listdir(workdir)
348             if is_related(filename) and os.path.isfile(os.path.join(workdir, filename)) ]
349
350     def split_source_and_output(self, test_directory, module, workdir):
351         source_file = self.find_module_source_file(os.path.join(test_directory, module) + '.pyx')
352         source_and_output = codecs.open(source_file, 'rU', 'ISO-8859-1')
353         try:
354             out = codecs.open(os.path.join(workdir, module + os.path.splitext(source_file)[1]),
355                               'w', 'ISO-8859-1')
356             for line in source_and_output:
357                 last_line = line
358                 if line.startswith("_ERRORS"):
359                     out.close()
360                     out = ErrorWriter()
361                 else:
362                     out.write(line)
363         finally:
364             source_and_output.close()
365         try:
366             geterrors = out.geterrors
367         except AttributeError:
368             out.close()
369             return []
370         else:
371             return geterrors()
372
373     def run_cython(self, test_directory, module, targetdir, incdir, annotate,
374                    extra_compile_options=None):
375         include_dirs = INCLUDE_DIRS[:]
376         if incdir:
377             include_dirs.append(incdir)
378         source = self.find_module_source_file(
379             os.path.join(test_directory, module + '.pyx'))
380         target = os.path.join(targetdir, self.build_target_filename(module))
381
382         if extra_compile_options is None:
383             extra_compile_options = {}
384
385         try:
386             CompilationOptions
387         except NameError:
388             from Cython.Compiler.Main import CompilationOptions
389             from Cython.Compiler.Main import compile as cython_compile
390             from Cython.Compiler.Main import default_options
391
392         options = CompilationOptions(
393             default_options,
394             include_path = include_dirs,
395             output_file = target,
396             annotate = annotate,
397             use_listing_file = False,
398             cplus = self.language == 'cpp',
399             language_level = self.language_level,
400             generate_pxi = False,
401             evaluate_tree_assertions = True,
402             **extra_compile_options
403             )
404         cython_compile(source, options=options,
405                        full_module_name=module)
406
407     def run_distutils(self, test_directory, module, workdir, incdir,
408                       extra_extension_args=None):
409         cwd = os.getcwd()
410         os.chdir(workdir)
411         try:
412             build_extension = build_ext(distutils_distro)
413             build_extension.include_dirs = INCLUDE_DIRS[:]
414             if incdir:
415                 build_extension.include_dirs.append(incdir)
416             build_extension.finalize_options()
417             ext_include_dirs = []
418             for match, get_additional_include_dirs in EXT_DEP_INCLUDES:
419                 if match(module):
420                     ext_include_dirs += get_additional_include_dirs()
421             self.copy_related_files(test_directory, workdir, module)
422
423             if extra_extension_args is None:
424                 extra_extension_args = {}
425
426             extension = Extension(
427                 module,
428                 sources = self.find_source_files(workdir, module),
429                 include_dirs = ext_include_dirs,
430                 extra_compile_args = CFLAGS,
431                 **extra_extension_args
432                 )
433             if self.language == 'cpp':
434                 extension.language = 'c++'
435             build_extension.extensions = [extension]
436             build_extension.build_temp = workdir
437             build_extension.build_lib  = workdir
438             build_extension.run()
439         finally:
440             os.chdir(cwd)
441
442     def compile(self, test_directory, module, workdir, incdir,
443                 expect_errors, annotate):
444         expected_errors = errors = ()
445         if expect_errors:
446             expected_errors = self.split_source_and_output(
447                 test_directory, module, workdir)
448             test_directory = workdir
449
450         if WITH_CYTHON:
451             old_stderr = sys.stderr
452             try:
453                 sys.stderr = ErrorWriter()
454                 self.run_cython(test_directory, module, workdir, incdir, annotate)
455                 errors = sys.stderr.geterrors()
456             finally:
457                 sys.stderr = old_stderr
458
459         if errors or expected_errors:
460             try:
461                 for expected, error in zip(expected_errors, errors):
462                     self.assertEquals(expected, error)
463                 if len(errors) < len(expected_errors):
464                     expected_error = expected_errors[len(errors)]
465                     self.assertEquals(expected_error, None)
466                 elif len(errors) > len(expected_errors):
467                     unexpected_error = errors[len(expected_errors)]
468                     self.assertEquals(None, unexpected_error)
469             except AssertionError:
470                 print("\n=== Expected errors: ===")
471                 print('\n'.join(expected_errors))
472                 print("\n\n=== Got errors: ===")
473                 print('\n'.join(errors))
474                 print('\n')
475                 raise
476         else:
477             if not self.cython_only:
478                 self.run_distutils(test_directory, module, workdir, incdir)
479
480 class CythonRunTestCase(CythonCompileTestCase):
481     def shortDescription(self):
482         return "compiling (%s) and running %s" % (self.language, self.module)
483
484     def run(self, result=None):
485         if result is None:
486             result = self.defaultTestResult()
487         result.startTest(self)
488         try:
489             self.setUp()
490             try:
491                 self.runCompileTest()
492                 self.run_tests(result)
493             finally:
494                 check_thread_termination()
495         except Exception:
496             result.addError(self, sys.exc_info())
497             result.stopTest(self)
498         try:
499             self.tearDown()
500         except Exception:
501             pass
502
503     def run_tests(self, result):
504         if not self.cython_only:
505             self.run_doctests(self.module, result)
506
507     def run_doctests(self, module_name, result):
508         if sys.version_info[0] >= 3 or not hasattr(os, 'fork') or not self.fork:
509             doctest.DocTestSuite(module_name).run(result)
510             gc.collect()
511             return
512
513         # fork to make sure we do not keep the tested module loaded
514         result_handle, result_file = tempfile.mkstemp()
515         os.close(result_handle)
516         child_id = os.fork()
517         if not child_id:
518             result_code = 0
519             try:
520                 try:
521                     tests = None
522                     try:
523                         partial_result = PartialTestResult(result)
524                         tests = doctest.DocTestSuite(module_name)
525                         tests.run(partial_result)
526                         gc.collect()
527                     except Exception:
528                         if tests is None:
529                             # importing failed, try to fake a test class
530                             tests = _FakeClass(
531                                 failureException=sys.exc_info()[1],
532                                 _shortDescription=self.shortDescription(),
533                                 module_name=None)
534                         partial_result.addError(tests, sys.exc_info())
535                         result_code = 1
536                     output = open(result_file, 'wb')
537                     pickle.dump(partial_result.data(), output)
538                 except:
539                     traceback.print_exc()
540             finally:
541                 try: output.close()
542                 except: pass
543                 os._exit(result_code)
544
545         try:
546             cid, result_code = os.waitpid(child_id, 0)
547             # os.waitpid returns the child's result code in the
548             # upper byte of result_code, and the signal it was
549             # killed by in the lower byte
550             if result_code & 255:
551                 raise Exception("Tests in module '%s' were unexpectedly killed by signal %d"%
552                                 (module_name, result_code & 255))
553             result_code = result_code >> 8
554             if result_code in (0,1):
555                 input = open(result_file, 'rb')
556                 try:
557                     PartialTestResult.join_results(result, pickle.load(input))
558                 finally:
559                     input.close()
560             if result_code:
561                 raise Exception("Tests in module '%s' exited with status %d" %
562                                 (module_name, result_code))
563         finally:
564             try: os.unlink(result_file)
565             except: pass
566
567 class PureDoctestTestCase(unittest.TestCase):
568     def __init__(self, module_name, module_path):
569         self.module_name = module_name
570         self.module_path = module_path
571         unittest.TestCase.__init__(self, 'run')
572
573     def shortDescription(self):
574         return "running pure doctests in %s" % self.module_name
575
576     def run(self, result=None):
577         if result is None:
578             result = self.defaultTestResult()
579         loaded_module_name = 'pure_doctest__' + self.module_name
580         result.startTest(self)
581         try:
582             self.setUp()
583
584             import imp
585             m = imp.load_source(loaded_module_name, self.module_path)
586             try:
587                 doctest.DocTestSuite(m).run(result)
588             finally:
589                 del m
590                 if loaded_module_name in sys.modules:
591                     del sys.modules[loaded_module_name]
592                 check_thread_termination()
593         except Exception:
594             result.addError(self, sys.exc_info())
595             result.stopTest(self)
596         try:
597             self.tearDown()
598         except Exception:
599             pass
600
601 is_private_field = re.compile('^_[^_]').match
602
603 class _FakeClass(object):
604     def __init__(self, **kwargs):
605         self._shortDescription = kwargs.get('module_name')
606         self.__dict__.update(kwargs)
607     def shortDescription(self):
608         return self._shortDescription
609
610 try: # Py2.7+ and Py3.2+
611     from unittest.runner import _TextTestResult
612 except ImportError:
613     from unittest import _TextTestResult
614
615 class PartialTestResult(_TextTestResult):
616     def __init__(self, base_result):
617         _TextTestResult.__init__(
618             self, self._StringIO(), True,
619             base_result.dots + base_result.showAll*2)
620
621     def strip_error_results(self, results):
622         for test_case, error in results:
623             for attr_name in filter(is_private_field, dir(test_case)):
624                 if attr_name == '_dt_test':
625                     test_case._dt_test = _FakeClass(
626                         name=test_case._dt_test.name)
627                 elif attr_name != '_shortDescription':
628                     setattr(test_case, attr_name, None)
629
630     def data(self):
631         self.strip_error_results(self.failures)
632         self.strip_error_results(self.errors)
633         return (self.failures, self.errors, self.testsRun,
634                 self.stream.getvalue())
635
636     def join_results(result, data):
637         """Static method for merging the result back into the main
638         result object.
639         """
640         failures, errors, tests_run, output = data
641         if output:
642             result.stream.write(output)
643         result.errors.extend(errors)
644         result.failures.extend(failures)
645         result.testsRun += tests_run
646
647     join_results = staticmethod(join_results)
648
649     class _StringIO(StringIO):
650         def writeln(self, line):
651             self.write("%s\n" % line)
652
653
654 class CythonUnitTestCase(CythonRunTestCase):
655     def shortDescription(self):
656         return "compiling (%s) tests in %s" % (self.language, self.module)
657
658     def run_tests(self, result):
659         unittest.defaultTestLoader.loadTestsFromName(self.module).run(result)
660
661
662 class CythonPyregrTestCase(CythonRunTestCase):
663     def _run_unittest(self, result, *classes):
664         """Run tests from unittest.TestCase-derived classes."""
665         valid_types = (unittest.TestSuite, unittest.TestCase)
666         suite = unittest.TestSuite()
667         for cls in classes:
668             if isinstance(cls, str):
669                 if cls in sys.modules:
670                     suite.addTest(unittest.findTestCases(sys.modules[cls]))
671                 else:
672                     raise ValueError("str arguments must be keys in sys.modules")
673             elif isinstance(cls, valid_types):
674                 suite.addTest(cls)
675             else:
676                 suite.addTest(unittest.makeSuite(cls))
677         suite.run(result)
678
679     def _run_doctest(self, result, module):
680         self.run_doctests(module, result)
681
682     def run_tests(self, result):
683         try:
684             from test import test_support as support
685         except ImportError: # Py3k
686             from test import support
687
688         def run_unittest(*classes):
689             return self._run_unittest(result, *classes)
690         def run_doctest(module, verbosity=None):
691             return self._run_doctest(result, module)
692
693         support.run_unittest = run_unittest
694         support.run_doctest = run_doctest
695
696         try:
697             module = __import__(self.module)
698             if hasattr(module, 'test_main'):
699                 module.test_main()
700         except (unittest.SkipTest, support.ResourceDenied):
701             result.addSkip(self, 'ok')
702
703 include_debugger = sys.version_info[:2] > (2, 5)
704
705 def collect_unittests(path, module_prefix, suite, selectors):
706     def file_matches(filename):
707         return filename.startswith("Test") and filename.endswith(".py")
708
709     def package_matches(dirname):
710         return dirname == "Tests"
711
712     loader = unittest.TestLoader()
713
714     if include_debugger:
715         skipped_dirs = []
716     else:
717         skipped_dirs = ['Cython' + os.path.sep + 'Debugger' + os.path.sep]
718
719     for dirpath, dirnames, filenames in os.walk(path):
720         if dirpath != path and "__init__.py" not in filenames:
721             skipped_dirs.append(dirpath + os.path.sep)
722             continue
723         skip = False
724         for dir in skipped_dirs:
725             if dirpath.startswith(dir):
726                 skip = True
727         if skip:
728             continue
729         parentname = os.path.split(dirpath)[-1]
730         if package_matches(parentname):
731             for f in filenames:
732                 if file_matches(f):
733                     filepath = os.path.join(dirpath, f)[:-len(".py")]
734                     modulename = module_prefix + filepath[len(path)+1:].replace(os.path.sep, '.')
735                     if not [ 1 for match in selectors if match(modulename) ]:
736                         continue
737                     module = __import__(modulename)
738                     for x in modulename.split('.')[1:]:
739                         module = getattr(module, x)
740                     suite.addTests([loader.loadTestsFromModule(module)])
741
742
743
744 def collect_doctests(path, module_prefix, suite, selectors):
745     def package_matches(dirname):
746         if dirname == 'Debugger' and not include_debugger:
747             return False
748         return dirname not in ("Mac", "Distutils", "Plex")
749     def file_matches(filename):
750         filename, ext = os.path.splitext(filename)
751         blacklist = ['libcython', 'libpython', 'test_libcython_in_gdb',
752                      'TestLibCython']
753         return (ext == '.py' and not
754                 '~' in filename and not
755                 '#' in filename and not
756                 filename.startswith('.') and not
757                 filename in blacklist)
758     import doctest, types
759     for dirpath, dirnames, filenames in os.walk(path):
760         for dir in list(dirnames):
761             if not package_matches(dir):
762                 dirnames.remove(dir)
763         for f in filenames:
764             if file_matches(f):
765                 if not f.endswith('.py'): continue
766                 filepath = os.path.join(dirpath, f)
767                 if os.path.getsize(filepath) == 0: continue
768                 filepath = filepath[:-len(".py")]
769                 modulename = module_prefix + filepath[len(path)+1:].replace(os.path.sep, '.')
770                 if not [ 1 for match in selectors if match(modulename) ]:
771                     continue
772                 if 'in_gdb' in modulename:
773                     # These should only be imported from gdb.
774                     continue
775                 module = __import__(modulename)
776                 for x in modulename.split('.')[1:]:
777                     module = getattr(module, x)
778                 if hasattr(module, "__doc__") or hasattr(module, "__test__"):
779                     try:
780                         suite.addTest(doctest.DocTestSuite(module))
781                     except ValueError: # no tests
782                         pass
783
784
785 class EndToEndTest(unittest.TestCase):
786     """
787     This is a test of build/*.srctree files, where srctree defines a full
788     directory structure and its header gives a list of commands to run.
789     """
790     cython_root = os.path.dirname(os.path.abspath(__file__))
791
792     def __init__(self, treefile, workdir, cleanup_workdir=True):
793         self.name = os.path.splitext(os.path.basename(treefile))[0]
794         self.treefile = treefile
795         self.workdir = os.path.join(workdir, self.name)
796         self.cleanup_workdir = cleanup_workdir
797         cython_syspath = self.cython_root
798         for path in sys.path[::-1]:
799             if path.startswith(self.cython_root):
800                 # Py3 installation and refnanny build prepend their
801                 # fixed paths to sys.path => prefer that over the
802                 # generic one
803                 cython_syspath = path + os.pathsep + cython_syspath
804         self.cython_syspath = cython_syspath
805         unittest.TestCase.__init__(self)
806
807     def shortDescription(self):
808         return "End-to-end %s" % self.name
809
810     def setUp(self):
811         from Cython.TestUtils import unpack_source_tree
812         _, self.commands = unpack_source_tree(self.treefile, self.workdir)
813         self.old_dir = os.getcwd()
814         os.chdir(self.workdir)
815         if self.workdir not in sys.path:
816             sys.path.insert(0, self.workdir)
817
818     def tearDown(self):
819         if self.cleanup_workdir:
820             for trial in range(5):
821                 try:
822                     shutil.rmtree(self.workdir)
823                 except OSError:
824                     time.sleep(0.1)
825                 else:
826                     break
827         os.chdir(self.old_dir)
828
829     def runTest(self):
830         commands = (self.commands
831             .replace("CYTHON", "PYTHON %s" % os.path.join(self.cython_root, 'cython.py'))
832             .replace("PYTHON", sys.executable))
833         try:
834             old_path = os.environ.get('PYTHONPATH')
835             os.environ['PYTHONPATH'] = self.cython_syspath + os.pathsep + os.path.join(self.cython_syspath, (old_path or ''))
836             for command in commands.split('\n'):
837                 if sys.version_info[:2] >= (2,4):
838                     import subprocess
839                     p = subprocess.Popen(commands,
840                                          stderr=subprocess.PIPE,
841                                          stdout=subprocess.PIPE,
842                                          shell=True)
843                     out, err = p.communicate()
844                     res = p.returncode
845                     if res != 0:
846                         print(command)
847                         print(out)
848                         print(err)
849                 else:
850                     res = os.system(command)
851                 self.assertEqual(0, res, "non-zero exit status")
852         finally:
853             if old_path:
854                 os.environ['PYTHONPATH'] = old_path
855             else:
856                 del os.environ['PYTHONPATH']
857
858
859 # TODO: Support cython_freeze needed here as well.
860 # TODO: Windows support.
861
862 class EmbedTest(unittest.TestCase):
863
864     working_dir = "Demos/embed"
865
866     def setUp(self):
867         self.old_dir = os.getcwd()
868         os.chdir(self.working_dir)
869         os.system(
870             "make PYTHON='%s' clean > /dev/null" % sys.executable)
871
872     def tearDown(self):
873         try:
874             os.system(
875                 "make PYTHON='%s' clean > /dev/null" % sys.executable)
876         except:
877             pass
878         os.chdir(self.old_dir)
879
880     def test_embed(self):
881         from distutils import sysconfig
882         libname = sysconfig.get_config_var('LIBRARY')
883         libdir = sysconfig.get_config_var('LIBDIR')
884         if not os.path.isdir(libdir) or libname not in os.listdir(libdir):
885             libdir = os.path.join(os.path.dirname(sys.executable), '..', 'lib')
886             if not os.path.isdir(libdir) or libname not in os.listdir(libdir):
887                 libdir = os.path.join(libdir, 'python%d.%d' % sys.version_info[:2], 'config')
888                 if not os.path.isdir(libdir) or libname not in os.listdir(libdir):
889                     # report the error for the original directory
890                     libdir = sysconfig.get_config_var('LIBDIR')
891         self.assert_(os.system(
892             "make PYTHON='%s' LIBDIR1='%s' test > make.output" % (sys.executable, libdir)) == 0)
893         try:
894             os.remove('make.output')
895         except OSError:
896             pass
897
898 class MissingDependencyExcluder:
899     def __init__(self, deps):
900         # deps: { module name : matcher func }
901         self.exclude_matchers = []
902         for mod, matcher in deps.items():
903             try:
904                 __import__(mod)
905             except ImportError:
906                 self.exclude_matchers.append(matcher)
907         self.tests_missing_deps = []
908     def __call__(self, testname):
909         for matcher in self.exclude_matchers:
910             if matcher(testname):
911                 self.tests_missing_deps.append(testname)
912                 return True
913         return False
914
915 class VersionDependencyExcluder:
916     def __init__(self, deps):
917         # deps: { version : matcher func }
918         from sys import version_info
919         self.exclude_matchers = []
920         for ver, (compare, matcher) in deps.items():
921             if compare(version_info, ver):
922                 self.exclude_matchers.append(matcher)
923         self.tests_missing_deps = []
924     def __call__(self, testname):
925         for matcher in self.exclude_matchers:
926             if matcher(testname):
927                 self.tests_missing_deps.append(testname)
928                 return True
929         return False
930
931 class FileListExcluder:
932
933     def __init__(self, list_file):
934         self.excludes = {}
935         f = open(list_file)
936         try:
937             for line in f.readlines():
938                 line = line.strip()
939                 if line and line[0] != '#':
940                     self.excludes[line.split()[0]] = True
941         finally:
942             f.close()
943
944     def __call__(self, testname):
945         return testname in self.excludes or testname.split('.')[-1] in self.excludes
946
947 def refactor_for_py3(distdir, cy3_dir):
948     # need to convert Cython sources first
949     import lib2to3.refactor
950     from distutils.util import copydir_run_2to3
951     fixers = [ fix for fix in lib2to3.refactor.get_fixers_from_package("lib2to3.fixes")
952                if fix.split('fix_')[-1] not in ('next',)
953                ]
954     if not os.path.exists(cy3_dir):
955         os.makedirs(cy3_dir)
956     import distutils.log as dlog
957     dlog.set_threshold(dlog.INFO)
958     copydir_run_2to3(distdir, cy3_dir, fixer_names=fixers,
959                      template = '''
960                      global-exclude *
961                      graft Cython
962                      recursive-exclude Cython *
963                      recursive-include Cython *.py *.pyx *.pxd
964                      recursive-include Cython/Debugger/Tests *
965                      include runtests.py
966                      ''')
967     sys.path.insert(0, cy3_dir)
968
969     for keep_2x_file in KEEP_2X_FILES:
970         destfile = os.path.join(cy3_dir, keep_2x_file)
971         shutil.copy(keep_2x_file, destfile)
972
973 class PendingThreadsError(RuntimeError):
974     pass
975
976 threads_seen = []
977
978 def check_thread_termination(ignore_seen=True):
979     if threading is None: # no threading enabled in CPython
980         return
981     current = threading.currentThread()
982     blocking_threads = []
983     for t in threading.enumerate():
984         if not t.isAlive() or t == current:
985             continue
986         t.join(timeout=2)
987         if t.isAlive():
988             if not ignore_seen:
989                 blocking_threads.append(t)
990                 continue
991             for seen in threads_seen:
992                 if t is seen:
993                     break
994             else:
995                 threads_seen.append(t)
996                 blocking_threads.append(t)
997     if not blocking_threads:
998         return
999     sys.stderr.write("warning: left-over threads found after running test:\n")
1000     for t in blocking_threads:
1001         sys.stderr.write('...%s\n'  % repr(t))
1002     raise PendingThreadsError("left-over threads found after running test")
1003
1004 def main():
1005
1006     DISTDIR = os.path.join(os.getcwd(), os.path.dirname(sys.argv[0]))
1007
1008     from optparse import OptionParser
1009     parser = OptionParser()
1010     parser.add_option("--no-cleanup", dest="cleanup_workdir",
1011                       action="store_false", default=True,
1012                       help="do not delete the generated C files (allows passing --no-cython on next run)")
1013     parser.add_option("--no-cleanup-sharedlibs", dest="cleanup_sharedlibs",
1014                       action="store_false", default=True,
1015                       help="do not delete the generated shared libary files (allows manual module experimentation)")
1016     parser.add_option("--no-cython", dest="with_cython",
1017                       action="store_false", default=True,
1018                       help="do not run the Cython compiler, only the C compiler")
1019     parser.add_option("--no-c", dest="use_c",
1020                       action="store_false", default=True,
1021                       help="do not test C compilation")
1022     parser.add_option("--no-cpp", dest="use_cpp",
1023                       action="store_false", default=True,
1024                       help="do not test C++ compilation")
1025     parser.add_option("--no-unit", dest="unittests",
1026                       action="store_false", default=True,
1027                       help="do not run the unit tests")
1028     parser.add_option("--no-doctest", dest="doctests",
1029                       action="store_false", default=True,
1030                       help="do not run the doctests")
1031     parser.add_option("--no-file", dest="filetests",
1032                       action="store_false", default=True,
1033                       help="do not run the file based tests")
1034     parser.add_option("--no-pyregr", dest="pyregr",
1035                       action="store_false", default=True,
1036                       help="do not run the regression tests of CPython in tests/pyregr/")
1037     parser.add_option("--cython-only", dest="cython_only",
1038                       action="store_true", default=False,
1039                       help="only compile pyx to c, do not run C compiler or run the tests")
1040     parser.add_option("--no-refnanny", dest="with_refnanny",
1041                       action="store_false", default=True,
1042                       help="do not regression test reference counting")
1043     parser.add_option("--no-fork", dest="fork",
1044                       action="store_false", default=True,
1045                       help="do not fork to run tests")
1046     parser.add_option("--sys-pyregr", dest="system_pyregr",
1047                       action="store_true", default=False,
1048                       help="run the regression tests of the CPython installation")
1049     parser.add_option("-x", "--exclude", dest="exclude",
1050                       action="append", metavar="PATTERN",
1051                       help="exclude tests matching the PATTERN")
1052     parser.add_option("-C", "--coverage", dest="coverage",
1053                       action="store_true", default=False,
1054                       help="collect source coverage data for the Compiler")
1055     parser.add_option("--coverage-xml", dest="coverage_xml",
1056                       action="store_true", default=False,
1057                       help="collect source coverage data for the Compiler in XML format")
1058     parser.add_option("-A", "--annotate", dest="annotate_source",
1059                       action="store_true", default=True,
1060                       help="generate annotated HTML versions of the test source files")
1061     parser.add_option("--no-annotate", dest="annotate_source",
1062                       action="store_false",
1063                       help="do not generate annotated HTML versions of the test source files")
1064     parser.add_option("-v", "--verbose", dest="verbosity",
1065                       action="count", default=0,
1066                       help="display test progress, pass twice to print test names")
1067     parser.add_option("-T", "--ticket", dest="tickets",
1068                       action="append",
1069                       help="a bug ticket number to run the respective test in 'tests/*'")
1070     parser.add_option("-3", dest="language_level",
1071                       action="store_const", const=3, default=2,
1072                       help="set language level to Python 3 (useful for running the CPython regression tests)'")
1073     parser.add_option("--xml-output", dest="xml_output_dir", metavar="DIR",
1074                       help="write test results in XML to directory DIR")
1075     parser.add_option("--exit-ok", dest="exit_ok", default=False,
1076                       action="store_true",
1077                       help="exit without error code even on test failures")
1078     parser.add_option("--root-dir", dest="root_dir", default=os.path.join(DISTDIR, 'tests'),
1079                       help="working directory")
1080     parser.add_option("--work-dir", dest="work_dir", default=os.path.join(os.getcwd(), 'BUILD'),
1081                       help="working directory")
1082
1083     options, cmd_args = parser.parse_args()
1084
1085     ROOTDIR = os.path.abspath(options.root_dir)
1086     WORKDIR = os.path.abspath(options.work_dir)
1087
1088     if sys.version_info[0] >= 3:
1089         options.doctests = False
1090         if options.with_cython:
1091             try:
1092                 # try if Cython is installed in a Py3 version
1093                 import Cython.Compiler.Main
1094             except Exception:
1095                 # back out anything the import process loaded, then
1096                 # 2to3 the Cython sources to make them re-importable
1097                 cy_modules = [ name for name in sys.modules
1098                                if name == 'Cython' or name.startswith('Cython.') ]
1099                 for name in cy_modules:
1100                     del sys.modules[name]
1101                 # hasn't been refactored yet - do it now
1102                 cy3_dir = os.path.join(WORKDIR, 'Cy3')
1103                 if sys.version_info >= (3,1):
1104                     refactor_for_py3(DISTDIR, cy3_dir)
1105                 elif os.path.isdir(cy3_dir):
1106                     sys.path.insert(0, cy3_dir)
1107                 else:
1108                     options.with_cython = False
1109
1110     WITH_CYTHON = options.with_cython
1111
1112     if options.coverage or options.coverage_xml:
1113         if not WITH_CYTHON:
1114             options.coverage = options.coverage_xml = False
1115         else:
1116             from coverage import coverage as _coverage
1117             coverage = _coverage(branch=True)
1118             coverage.erase()
1119             coverage.start()
1120
1121     if WITH_CYTHON:
1122         global CompilationOptions, pyrex_default_options, cython_compile
1123         from Cython.Compiler.Main import \
1124             CompilationOptions, \
1125             default_options as pyrex_default_options, \
1126             compile as cython_compile
1127         from Cython.Compiler import Errors
1128         Errors.LEVEL = 0 # show all warnings
1129         from Cython.Compiler import Options
1130         Options.generate_cleanup_code = 3   # complete cleanup code
1131         from Cython.Compiler import DebugFlags
1132         DebugFlags.debug_temp_code_comments = 1
1133
1134     # RUN ALL TESTS!
1135     UNITTEST_MODULE = "Cython"
1136     UNITTEST_ROOT = os.path.join(os.path.dirname(__file__), UNITTEST_MODULE)
1137     if WITH_CYTHON:
1138         if os.path.exists(WORKDIR):
1139             for path in os.listdir(WORKDIR):
1140                 if path in ("support", "Cy3"): continue
1141                 shutil.rmtree(os.path.join(WORKDIR, path), ignore_errors=True)
1142     if not os.path.exists(WORKDIR):
1143         os.makedirs(WORKDIR)
1144
1145     sys.stderr.write("Python %s\n" % sys.version)
1146     sys.stderr.write("\n")
1147     if WITH_CYTHON:
1148         from Cython.Compiler.Version import version
1149         sys.stderr.write("Running tests against Cython %s\n" % version)
1150     else:
1151         sys.stderr.write("Running tests without Cython.\n")
1152
1153     if options.with_refnanny:
1154         from pyximport.pyxbuild import pyx_to_dll
1155         libpath = pyx_to_dll(os.path.join("Cython", "Runtime", "refnanny.pyx"),
1156                              build_in_temp=True,
1157                              pyxbuild_dir=os.path.join(WORKDIR, "support"))
1158         sys.path.insert(0, os.path.split(libpath)[0])
1159         CFLAGS.append("-DCYTHON_REFNANNY=1")
1160
1161     if options.xml_output_dir and options.fork:
1162         # doesn't currently work together
1163         sys.stderr.write("Disabling forked testing to support XML test output\n")
1164         options.fork = False
1165
1166     if WITH_CYTHON and options.language_level == 3:
1167         sys.stderr.write("Using Cython language level 3.\n")
1168
1169     sys.stderr.write("\n")
1170
1171     test_bugs = False
1172     if options.tickets:
1173         for ticket_number in options.tickets:
1174             test_bugs = True
1175             cmd_args.append('.*T%s$' % ticket_number)
1176     if not test_bugs:
1177         for selector in cmd_args:
1178             if selector.startswith('bugs'):
1179                 test_bugs = True
1180
1181     import re
1182     selectors = [ re.compile(r, re.I|re.U).search for r in cmd_args ]
1183     if not selectors:
1184         selectors = [ lambda x:True ]
1185
1186     # Chech which external modules are not present and exclude tests
1187     # which depends on them (by prefix)
1188
1189     missing_dep_excluder = MissingDependencyExcluder(EXT_DEP_MODULES)
1190     version_dep_excluder = VersionDependencyExcluder(VER_DEP_MODULES)
1191     exclude_selectors = [missing_dep_excluder, version_dep_excluder] # want to pring msg at exit
1192
1193     if options.exclude:
1194         exclude_selectors += [ re.compile(r, re.I|re.U).search for r in options.exclude ]
1195
1196     if not test_bugs:
1197         exclude_selectors += [ FileListExcluder(os.path.join(ROOTDIR, "bugs.txt")) ]
1198
1199     if sys.platform in ['win32', 'cygwin'] and sys.version_info < (2,6):
1200         exclude_selectors += [ lambda x: x == "run.specialfloat" ]
1201
1202     languages = []
1203     if options.use_c:
1204         languages.append('c')
1205     if options.use_cpp:
1206         languages.append('cpp')
1207
1208     test_suite = unittest.TestSuite()
1209
1210     if options.unittests:
1211         collect_unittests(UNITTEST_ROOT, UNITTEST_MODULE + ".", test_suite, selectors)
1212
1213     if options.doctests:
1214         collect_doctests(UNITTEST_ROOT, UNITTEST_MODULE + ".", test_suite, selectors)
1215
1216     if options.filetests and languages:
1217         filetests = TestBuilder(ROOTDIR, WORKDIR, selectors, exclude_selectors,
1218                                 options.annotate_source, options.cleanup_workdir,
1219                                 options.cleanup_sharedlibs, options.pyregr,
1220                                 options.cython_only, languages, test_bugs,
1221                                 options.fork, options.language_level)
1222         test_suite.addTest(filetests.build_suite())
1223
1224     if options.system_pyregr and languages:
1225         filetests = TestBuilder(ROOTDIR, WORKDIR, selectors, exclude_selectors,
1226                                 options.annotate_source, options.cleanup_workdir,
1227                                 options.cleanup_sharedlibs, True,
1228                                 options.cython_only, languages, test_bugs,
1229                                 options.fork, options.language_level)
1230         test_suite.addTest(
1231             filetests.handle_directory(
1232                 os.path.join(sys.prefix, 'lib', 'python'+sys.version[:3], 'test'),
1233                 'pyregr'))
1234
1235     if options.xml_output_dir:
1236         from Cython.Tests.xmlrunner import XMLTestRunner
1237         test_runner = XMLTestRunner(output=options.xml_output_dir,
1238                                     verbose=options.verbosity > 0)
1239     else:
1240         test_runner = unittest.TextTestRunner(verbosity=options.verbosity)
1241
1242     result = test_runner.run(test_suite)
1243
1244     if options.coverage or options.coverage_xml:
1245         coverage.stop()
1246         ignored_modules = ('Options', 'Version', 'DebugFlags', 'CmdLine')
1247         modules = [ module for name, module in sys.modules.items()
1248                     if module is not None and
1249                     name.startswith('Cython.Compiler.') and
1250                     name[len('Cython.Compiler.'):] not in ignored_modules ]
1251         if options.coverage:
1252             coverage.report(modules, show_missing=0)
1253         if options.coverage_xml:
1254             coverage.xml_report(modules, outfile="coverage-report.xml")
1255
1256     if missing_dep_excluder.tests_missing_deps:
1257         sys.stderr.write("Following tests excluded because of missing dependencies on your system:\n")
1258         for test in missing_dep_excluder.tests_missing_deps:
1259             sys.stderr.write("   %s\n" % test)
1260
1261     if options.with_refnanny:
1262         import refnanny
1263         sys.stderr.write("\n".join([repr(x) for x in refnanny.reflog]))
1264
1265     print("ALL DONE")
1266
1267     if options.exit_ok:
1268         return_code = 0
1269     else:
1270         return_code = not result.wasSuccessful()
1271
1272     try:
1273         check_thread_termination(ignore_seen=False)
1274         sys.exit(return_code)
1275     except PendingThreadsError:
1276         # normal program exit won't kill the threads, do it the hard way here
1277         os._exit(return_code)
1278
1279 if __name__ == '__main__':
1280     try:
1281         main()
1282     except SystemExit: # <= Py2.4 ...
1283         raise
1284     except Exception:
1285         traceback.print_exc()
1286         try:
1287             check_thread_termination(ignore_seen=False)
1288         except PendingThreadsError:
1289             # normal program exit won't kill the threads, do it the hard way here
1290             os._exit(1)