16 from StringIO import StringIO
18 from io import StringIO
21 import cPickle as pickle
26 from io import open as io_open
28 from codecs import open as io_open
32 except ImportError: # No threads, no problems
36 from collections import defaultdict
38 class defaultdict(object):
39 def __init__(self, default_factory=lambda : None):
41 self.default_factory = default_factory
42 def __getitem__(self, key):
43 if key not in self._dict:
44 self._dict[key] = self.default_factory()
45 return self._dict[key]
46 def __setitem__(self, key, value):
47 self._dict[key] = value
49 return repr(self._dict)
54 from distutils.dist import Distribution
55 from distutils.core import Extension
56 from distutils.command.build_ext import build_ext as _build_ext
57 distutils_distro = Distribution()
59 if sys.platform == 'win32':
60 # TODO: Figure out why this hackery (see http://thread.gmane.org/gmane.comp.python.cython.devel/8280/).
61 config_files = distutils_distro.find_config_files()
62 try: config_files.remove('setup.cfg')
63 except ValueError: pass
64 distutils_distro.parse_config_files(config_files)
66 cfgfiles = distutils_distro.find_config_files()
67 try: cfgfiles.remove('setup.cfg')
68 except ValueError: pass
69 distutils_distro.parse_config_files(cfgfiles)
72 'numpy' : 'tag:numpy',
73 'pstats' : 'tag:pstats',
74 'posix' : 'tag:posix',
77 def get_numpy_include_dirs():
79 return [numpy.get_include()]
83 # test name matcher , callable returning list
84 (re.compile('numpy_.*').match, get_numpy_include_dirs),
89 # tests are excluded if 'CurrentPythonVersion OP VersionTuple', i.e.
90 # (2,4) : (operator.lt, ...) excludes ... when PyVer < 2.4.x
91 (2,4) : (operator.lt, lambda x: x in ['run.extern_builtins_T258',
94 (2,5) : (operator.lt, lambda x: x in ['run.any',
96 'run.relativeimport_T542',
97 'run.relativeimport_star_T542',
99 (2,6) : (operator.lt, lambda x: x in ['run.print_function',
101 'run.generators_py', # generators, with statement
102 'run.pure_py', # decorators, with statement
104 (2,7) : (operator.lt, lambda x: x in ['run.withstat_py', # multi context with statement
106 # The next line should start (3,); but this is a dictionary, so
107 # we can only have one (3,) key. Since 2.7 is supposed to be the
108 # last 2.x release, things would have to change drastically for this
110 (2,999): (operator.lt, lambda x: x in ['run.special_methods_T561_py3',
111 'run.test_raisefrom',
113 (3,): (operator.ge, lambda x: x in ['run.non_future_division',
114 'compile.extsetslice',
115 'compile.extdelslice',
116 'run.special_methods_T561_py2']),
119 # files that should not be converted to Python 3 code with 2to3
121 os.path.join('Cython', 'Debugger', 'Tests', 'test_libcython_in_gdb.py'),
122 os.path.join('Cython', 'Debugger', 'Tests', 'test_libpython_in_gdb.py'),
123 os.path.join('Cython', 'Debugger', 'libcython.py'),
124 os.path.join('Cython', 'Debugger', 'libpython.py'),
128 INCLUDE_DIRS = [ d for d in os.getenv('INCLUDE', '').split(os.pathsep) if d ]
129 CFLAGS = os.getenv('CFLAGS', '').split()
132 uncomputed = object()
135 res = f._cache.get(args, uncomputed)
136 if res is uncomputed:
137 res = f._cache[args] = f(*args)
141 def parse_tags(filepath):
142 tags = defaultdict(list)
143 f = io_open(filepath, encoding='ISO-8859-1', errors='replace')
153 tag = line[1:ix].strip()
154 values = line[ix+1:].split(',')
155 tags[tag].extend([value.strip() for value in values])
160 parse_tags = memoize(parse_tags)
163 class build_ext(_build_ext):
164 def build_extension(self, ext):
165 if ext.language == 'c++':
167 try: # Py2.7+ & Py3.2+
168 compiler_obj = self.compiler_obj
169 except AttributeError:
170 compiler_obj = self.compiler
171 compiler_obj.compiler_so.remove('-Wstrict-prototypes')
174 _build_ext.build_extension(self, ext)
176 class ErrorWriter(object):
177 match_error = re.compile('(warning:)?(?:.*:)?\s*([-0-9]+)\s*:\s*([-0-9]+)\s*:\s*(.*)').match
180 self.write = self.output.append
182 def _collect(self, collect_errors, collect_warnings):
183 s = ''.join(self.output)
185 for line in s.split('\n'):
186 match = self.match_error(line)
188 is_warning, line, column, message = match.groups()
189 if (is_warning and collect_warnings) or \
190 (not is_warning and collect_errors):
191 result.append( (int(line), int(column), message.strip()) )
193 return [ "%d:%d: %s" % values for values in result ]
196 return self._collect(True, False)
198 def getwarnings(self):
199 return self._collect(False, True)
202 return self._collect(True, True)
204 class TestBuilder(object):
205 def __init__(self, rootdir, workdir, selectors, exclude_selectors, annotate,
206 cleanup_workdir, cleanup_sharedlibs, with_pyregr, cython_only,
207 languages, test_bugs, fork, language_level):
208 self.rootdir = rootdir
209 self.workdir = workdir
210 self.selectors = selectors
211 self.exclude_selectors = exclude_selectors
212 self.annotate = annotate
213 self.cleanup_workdir = cleanup_workdir
214 self.cleanup_sharedlibs = cleanup_sharedlibs
215 self.with_pyregr = with_pyregr
216 self.cython_only = cython_only
217 self.languages = languages
218 self.test_bugs = test_bugs
220 self.language_level = language_level
222 def build_suite(self):
223 suite = unittest.TestSuite()
224 filenames = os.listdir(self.rootdir)
226 for filename in filenames:
227 path = os.path.join(self.rootdir, filename)
228 if os.path.isdir(path):
229 if filename == 'pyregr' and not self.with_pyregr:
231 if filename == 'broken' and not self.test_bugs:
234 self.handle_directory(path, filename))
235 if sys.platform not in ['win32']:
236 # Non-Windows makefile.
237 if [1 for selector in self.selectors if selector("embedded")] \
238 and not [1 for selector in self.exclude_selectors if selector("embedded")]:
239 suite.addTest(unittest.makeSuite(EmbedTest))
242 def handle_directory(self, path, context):
243 workdir = os.path.join(self.workdir, context)
244 if not os.path.exists(workdir):
247 suite = unittest.TestSuite()
248 filenames = os.listdir(path)
250 for filename in filenames:
251 filepath = os.path.join(path, filename)
252 module, ext = os.path.splitext(filename)
253 if ext not in ('.py', '.pyx', '.srctree'):
255 if filename.startswith('.'):
256 continue # certain emacs backup files
257 tags = parse_tags(filepath)
258 fqmodule = "%s.%s" % (context, module)
259 if not [ 1 for match in self.selectors
260 if match(fqmodule, tags) ]:
262 if self.exclude_selectors:
263 if [1 for match in self.exclude_selectors
264 if match(fqmodule, tags)]:
267 mode = 'run' # default
269 mode = tags['mode'][0]
270 elif context == 'pyregr':
273 if ext == '.srctree':
274 suite.addTest(EndToEndTest(filepath, workdir, self.cleanup_workdir))
277 # Choose the test suite.
279 if not filename.startswith('test_'):
281 test_class = CythonPyregrTestCase
283 if module.startswith("test_"):
284 test_class = CythonUnitTestCase
286 test_class = CythonRunTestCase
288 test_class = CythonCompileTestCase
290 for test in self.build_tests(test_class, path, workdir,
291 module, mode == 'error', tags):
293 if mode == 'run' and ext == '.py':
294 # additionally test file in real Python
295 suite.addTest(PureDoctestTestCase(module, os.path.join(path, filename)))
299 def build_tests(self, test_class, path, workdir, module, expect_errors, tags):
300 if 'werror' in tags['tags']:
301 warning_errors = True
303 warning_errors = False
306 if 'cpp' in tags['tag'] and 'cpp' in self.languages:
309 languages = self.languages[:1]
311 languages = self.languages
312 if 'cpp' in tags['tag'] and 'c' in languages:
313 languages = list(languages)
314 languages.remove('c')
315 tests = [ self.build_test(test_class, path, workdir, module,
316 language, expect_errors, warning_errors)
317 for language in languages ]
320 def build_test(self, test_class, path, workdir, module,
321 language, expect_errors, warning_errors):
322 workdir = os.path.join(workdir, language)
323 if not os.path.exists(workdir):
325 return test_class(path, workdir, module,
327 expect_errors=expect_errors,
328 annotate=self.annotate,
329 cleanup_workdir=self.cleanup_workdir,
330 cleanup_sharedlibs=self.cleanup_sharedlibs,
331 cython_only=self.cython_only,
333 language_level=self.language_level,
334 warning_errors=warning_errors)
336 class CythonCompileTestCase(unittest.TestCase):
337 def __init__(self, test_directory, workdir, module, language='c',
338 expect_errors=False, annotate=False, cleanup_workdir=True,
339 cleanup_sharedlibs=True, cython_only=False, fork=True,
340 language_level=2, warning_errors=False):
341 self.test_directory = test_directory
342 self.workdir = workdir
344 self.language = language
345 self.expect_errors = expect_errors
346 self.annotate = annotate
347 self.cleanup_workdir = cleanup_workdir
348 self.cleanup_sharedlibs = cleanup_sharedlibs
349 self.cython_only = cython_only
351 self.language_level = language_level
352 self.warning_errors = warning_errors
353 unittest.TestCase.__init__(self)
355 def shortDescription(self):
356 return "compiling (%s) %s" % (self.language, self.module)
359 from Cython.Compiler import Options
360 self._saved_options = [ (name, getattr(Options, name))
361 for name in ('warning_errors', 'error_on_unknown_names') ]
362 Options.warning_errors = self.warning_errors
364 if self.workdir not in sys.path:
365 sys.path.insert(0, self.workdir)
368 from Cython.Compiler import Options
369 for name, value in self._saved_options:
370 setattr(Options, name, value)
373 sys.path.remove(self.workdir)
377 del sys.modules[self.module]
380 cleanup_c_files = WITH_CYTHON and self.cleanup_workdir
381 cleanup_lib_files = self.cleanup_sharedlibs
382 if os.path.exists(self.workdir):
383 for rmfile in os.listdir(self.workdir):
384 if not cleanup_c_files:
385 if rmfile[-2:] in (".c", ".h") or rmfile[-4:] == ".cpp":
387 if not cleanup_lib_files and rmfile.endswith(".so") or rmfile.endswith(".dll"):
389 if self.annotate and rmfile.endswith(".html"):
392 rmfile = os.path.join(self.workdir, rmfile)
393 if os.path.isdir(rmfile):
394 shutil.rmtree(rmfile, ignore_errors=True)
400 os.makedirs(self.workdir)
403 self.runCompileTest()
405 def runCompileTest(self):
406 self.compile(self.test_directory, self.module, self.workdir,
407 self.test_directory, self.expect_errors, self.annotate)
409 def find_module_source_file(self, source_file):
410 if not os.path.exists(source_file):
411 source_file = source_file[:-1]
414 def build_target_filename(self, module_name):
415 target = '%s.%s' % (module_name, self.language)
418 def copy_related_files(self, test_directory, target_directory, module_name):
419 is_related = re.compile('%s_.*[.].*' % module_name).match
420 for filename in os.listdir(test_directory):
421 if is_related(filename):
422 shutil.copy(os.path.join(test_directory, filename),
425 def find_source_files(self, workdir, module_name):
426 is_related = re.compile('%s_.*[.]%s' % (module_name, self.language)).match
427 return [self.build_target_filename(module_name)] + [
428 filename for filename in os.listdir(workdir)
429 if is_related(filename) and os.path.isfile(os.path.join(workdir, filename)) ]
431 def split_source_and_output(self, test_directory, module, workdir):
432 source_file = self.find_module_source_file(os.path.join(test_directory, module) + '.pyx')
433 source_and_output = io_open(source_file, 'rU', encoding='ISO-8859-1')
435 out = io_open(os.path.join(workdir, module + os.path.splitext(source_file)[1]),
436 'w', encoding='ISO-8859-1')
437 for line in source_and_output:
439 if line.startswith("_ERRORS"):
445 source_and_output.close()
447 geterrors = out.geterrors
448 except AttributeError:
454 def run_cython(self, test_directory, module, targetdir, incdir, annotate,
455 extra_compile_options=None):
456 include_dirs = INCLUDE_DIRS[:]
458 include_dirs.append(incdir)
459 source = self.find_module_source_file(
460 os.path.join(test_directory, module + '.pyx'))
461 target = os.path.join(targetdir, self.build_target_filename(module))
463 if extra_compile_options is None:
464 extra_compile_options = {}
469 from Cython.Compiler.Main import CompilationOptions
470 from Cython.Compiler.Main import compile as cython_compile
471 from Cython.Compiler.Main import default_options
473 options = CompilationOptions(
475 include_path = include_dirs,
476 output_file = target,
478 use_listing_file = False,
479 cplus = self.language == 'cpp',
480 language_level = self.language_level,
481 generate_pxi = False,
482 evaluate_tree_assertions = True,
483 **extra_compile_options
485 cython_compile(source, options=options,
486 full_module_name=module)
488 def run_distutils(self, test_directory, module, workdir, incdir,
489 extra_extension_args=None):
493 build_extension = build_ext(distutils_distro)
494 build_extension.include_dirs = INCLUDE_DIRS[:]
496 build_extension.include_dirs.append(incdir)
497 build_extension.finalize_options()
499 build_extension.compiler = COMPILER
500 ext_include_dirs = []
501 for match, get_additional_include_dirs in EXT_DEP_INCLUDES:
503 ext_include_dirs += get_additional_include_dirs()
504 ext_compile_flags = CFLAGS[:]
505 if build_extension.compiler == 'mingw32':
506 ext_compile_flags.append('-Wno-format')
507 if extra_extension_args is None:
508 extra_extension_args = {}
510 self.copy_related_files(test_directory, workdir, module)
511 extension = Extension(
513 sources = self.find_source_files(workdir, module),
514 include_dirs = ext_include_dirs,
515 extra_compile_args = ext_compile_flags,
516 **extra_extension_args
518 if self.language == 'cpp':
519 extension.language = 'c++'
520 build_extension.extensions = [extension]
521 build_extension.build_temp = workdir
522 build_extension.build_lib = workdir
523 build_extension.run()
527 def compile(self, test_directory, module, workdir, incdir,
528 expect_errors, annotate):
529 expected_errors = errors = ()
531 expected_errors = self.split_source_and_output(
532 test_directory, module, workdir)
533 test_directory = workdir
536 old_stderr = sys.stderr
538 sys.stderr = ErrorWriter()
539 self.run_cython(test_directory, module, workdir, incdir, annotate)
540 errors = sys.stderr.geterrors()
542 sys.stderr = old_stderr
544 if errors or expected_errors:
546 for expected, error in zip(expected_errors, errors):
547 self.assertEquals(expected, error)
548 if len(errors) < len(expected_errors):
549 expected_error = expected_errors[len(errors)]
550 self.assertEquals(expected_error, None)
551 elif len(errors) > len(expected_errors):
552 unexpected_error = errors[len(expected_errors)]
553 self.assertEquals(None, unexpected_error)
554 except AssertionError:
555 print("\n=== Expected errors: ===")
556 print('\n'.join(expected_errors))
557 print("\n\n=== Got errors: ===")
558 print('\n'.join(errors))
562 if not self.cython_only:
563 self.run_distutils(test_directory, module, workdir, incdir)
565 class CythonRunTestCase(CythonCompileTestCase):
566 def shortDescription(self):
567 return "compiling (%s) and running %s" % (self.language, self.module)
569 def run(self, result=None):
571 result = self.defaultTestResult()
572 result.startTest(self)
576 self.runCompileTest()
577 self.run_tests(result)
579 check_thread_termination()
581 result.addError(self, sys.exc_info())
582 result.stopTest(self)
588 def run_tests(self, result):
589 if not self.cython_only:
590 self.run_doctests(self.module, result)
592 def run_doctests(self, module_name, result):
593 def run_test(result):
594 tests = doctest.DocTestSuite(module_name)
596 run_forked_test(result, run_test, self.shortDescription(), self.fork)
599 def run_forked_test(result, run_func, test_name, fork=True):
600 if not fork or sys.version_info[0] >= 3 or not hasattr(os, 'fork'):
605 # fork to make sure we do not keep the tested module loaded
606 result_handle, result_file = tempfile.mkstemp()
607 os.close(result_handle)
615 partial_result = PartialTestResult(result)
616 run_func(partial_result)
620 # importing failed, try to fake a test class
622 failureException=sys.exc_info()[1],
623 _shortDescription=test_name,
625 partial_result.addError(tests, sys.exc_info())
627 output = open(result_file, 'wb')
628 pickle.dump(partial_result.data(), output)
630 traceback.print_exc()
634 os._exit(result_code)
637 cid, result_code = os.waitpid(child_id, 0)
638 # os.waitpid returns the child's result code in the
639 # upper byte of result_code, and the signal it was
640 # killed by in the lower byte
641 if result_code & 255:
642 raise Exception("Tests in module '%s' were unexpectedly killed by signal %d"%
643 (module_name, result_code & 255))
644 result_code = result_code >> 8
645 if result_code in (0,1):
646 input = open(result_file, 'rb')
648 PartialTestResult.join_results(result, pickle.load(input))
652 raise Exception("Tests in module '%s' exited with status %d" %
653 (module_name, result_code))
655 try: os.unlink(result_file)
658 class PureDoctestTestCase(unittest.TestCase):
659 def __init__(self, module_name, module_path):
660 self.module_name = module_name
661 self.module_path = module_path
662 unittest.TestCase.__init__(self, 'run')
664 def shortDescription(self):
665 return "running pure doctests in %s" % self.module_name
667 def run(self, result=None):
669 result = self.defaultTestResult()
670 loaded_module_name = 'pure_doctest__' + self.module_name
671 result.startTest(self)
676 m = imp.load_source(loaded_module_name, self.module_path)
678 doctest.DocTestSuite(m).run(result)
681 if loaded_module_name in sys.modules:
682 del sys.modules[loaded_module_name]
683 check_thread_termination()
685 result.addError(self, sys.exc_info())
686 result.stopTest(self)
692 is_private_field = re.compile('^_[^_]').match
694 class _FakeClass(object):
695 def __init__(self, **kwargs):
696 self._shortDescription = kwargs.get('module_name')
697 self.__dict__.update(kwargs)
698 def shortDescription(self):
699 return self._shortDescription
701 try: # Py2.7+ and Py3.2+
702 from unittest.runner import _TextTestResult
704 from unittest import _TextTestResult
706 class PartialTestResult(_TextTestResult):
707 def __init__(self, base_result):
708 _TextTestResult.__init__(
709 self, self._StringIO(), True,
710 base_result.dots + base_result.showAll*2)
712 def strip_error_results(self, results):
713 for test_case, error in results:
714 for attr_name in filter(is_private_field, dir(test_case)):
715 if attr_name == '_dt_test':
716 test_case._dt_test = _FakeClass(
717 name=test_case._dt_test.name)
718 elif attr_name != '_shortDescription':
719 setattr(test_case, attr_name, None)
722 self.strip_error_results(self.failures)
723 self.strip_error_results(self.errors)
724 return (self.failures, self.errors, self.testsRun,
725 self.stream.getvalue())
727 def join_results(result, data):
728 """Static method for merging the result back into the main
731 failures, errors, tests_run, output = data
733 result.stream.write(output)
734 result.errors.extend(errors)
735 result.failures.extend(failures)
736 result.testsRun += tests_run
738 join_results = staticmethod(join_results)
740 class _StringIO(StringIO):
741 def writeln(self, line):
742 self.write("%s\n" % line)
745 class CythonUnitTestCase(CythonRunTestCase):
746 def shortDescription(self):
747 return "compiling (%s) tests in %s" % (self.language, self.module)
749 def run_tests(self, result):
750 unittest.defaultTestLoader.loadTestsFromName(self.module).run(result)
753 class CythonPyregrTestCase(CythonRunTestCase):
755 CythonRunTestCase.setUp(self)
756 from Cython.Compiler import Options
757 Options.error_on_unknown_names = False
759 def _run_unittest(self, result, *classes):
760 """Run tests from unittest.TestCase-derived classes."""
761 valid_types = (unittest.TestSuite, unittest.TestCase)
762 suite = unittest.TestSuite()
764 if isinstance(cls, str):
765 if cls in sys.modules:
766 suite.addTest(unittest.findTestCases(sys.modules[cls]))
768 raise ValueError("str arguments must be keys in sys.modules")
769 elif isinstance(cls, valid_types):
772 suite.addTest(unittest.makeSuite(cls))
775 def _run_doctest(self, result, module):
776 self.run_doctests(module, result)
778 def run_tests(self, result):
780 from test import test_support as support
781 except ImportError: # Py3k
782 from test import support
784 def run_test(result):
785 def run_unittest(*classes):
786 return self._run_unittest(result, *classes)
787 def run_doctest(module, verbosity=None):
788 return self._run_doctest(result, module)
790 support.run_unittest = run_unittest
791 support.run_doctest = run_doctest
794 module = __import__(self.module)
795 if hasattr(module, 'test_main'):
797 except (unittest.SkipTest, support.ResourceDenied):
798 result.addSkip(self, 'ok')
800 run_forked_test(result, run_test, self.shortDescription(), self.fork)
802 include_debugger = sys.version_info[:2] > (2, 5)
804 def collect_unittests(path, module_prefix, suite, selectors):
805 def file_matches(filename):
806 return filename.startswith("Test") and filename.endswith(".py")
808 def package_matches(dirname):
809 return dirname == "Tests"
811 loader = unittest.TestLoader()
816 skipped_dirs = ['Cython' + os.path.sep + 'Debugger' + os.path.sep]
818 for dirpath, dirnames, filenames in os.walk(path):
819 if dirpath != path and "__init__.py" not in filenames:
820 skipped_dirs.append(dirpath + os.path.sep)
823 for dir in skipped_dirs:
824 if dirpath.startswith(dir):
828 parentname = os.path.split(dirpath)[-1]
829 if package_matches(parentname):
832 filepath = os.path.join(dirpath, f)[:-len(".py")]
833 modulename = module_prefix + filepath[len(path)+1:].replace(os.path.sep, '.')
834 if not [ 1 for match in selectors if match(modulename) ]:
836 module = __import__(modulename)
837 for x in modulename.split('.')[1:]:
838 module = getattr(module, x)
839 suite.addTests([loader.loadTestsFromModule(module)])
843 def collect_doctests(path, module_prefix, suite, selectors):
844 def package_matches(dirname):
845 if dirname == 'Debugger' and not include_debugger:
847 return dirname not in ("Mac", "Distutils", "Plex")
848 def file_matches(filename):
849 filename, ext = os.path.splitext(filename)
850 blacklist = ['libcython', 'libpython', 'test_libcython_in_gdb',
852 return (ext == '.py' and not
853 '~' in filename and not
854 '#' in filename and not
855 filename.startswith('.') and not
856 filename in blacklist)
857 import doctest, types
858 for dirpath, dirnames, filenames in os.walk(path):
859 for dir in list(dirnames):
860 if not package_matches(dir):
864 if not f.endswith('.py'): continue
865 filepath = os.path.join(dirpath, f)
866 if os.path.getsize(filepath) == 0: continue
867 filepath = filepath[:-len(".py")]
868 modulename = module_prefix + filepath[len(path)+1:].replace(os.path.sep, '.')
869 if not [ 1 for match in selectors if match(modulename) ]:
871 if 'in_gdb' in modulename:
872 # These should only be imported from gdb.
874 module = __import__(modulename)
875 for x in modulename.split('.')[1:]:
876 module = getattr(module, x)
877 if hasattr(module, "__doc__") or hasattr(module, "__test__"):
879 suite.addTest(doctest.DocTestSuite(module))
880 except ValueError: # no tests
884 class EndToEndTest(unittest.TestCase):
886 This is a test of build/*.srctree files, where srctree defines a full
887 directory structure and its header gives a list of commands to run.
889 cython_root = os.path.dirname(os.path.abspath(__file__))
891 def __init__(self, treefile, workdir, cleanup_workdir=True):
892 self.name = os.path.splitext(os.path.basename(treefile))[0]
893 self.treefile = treefile
894 self.workdir = os.path.join(workdir, self.name)
895 self.cleanup_workdir = cleanup_workdir
896 cython_syspath = self.cython_root
897 for path in sys.path[::-1]:
898 if path.startswith(self.cython_root):
899 # Py3 installation and refnanny build prepend their
900 # fixed paths to sys.path => prefer that over the
902 cython_syspath = path + os.pathsep + cython_syspath
903 self.cython_syspath = cython_syspath
904 unittest.TestCase.__init__(self)
906 def shortDescription(self):
907 return "End-to-end %s" % self.name
910 from Cython.TestUtils import unpack_source_tree
911 _, self.commands = unpack_source_tree(self.treefile, self.workdir)
912 self.old_dir = os.getcwd()
913 os.chdir(self.workdir)
914 if self.workdir not in sys.path:
915 sys.path.insert(0, self.workdir)
918 if self.cleanup_workdir:
919 for trial in range(5):
921 shutil.rmtree(self.workdir)
926 os.chdir(self.old_dir)
929 commands = (self.commands
930 .replace("CYTHON", "PYTHON %s" % os.path.join(self.cython_root, 'cython.py'))
931 .replace("PYTHON", sys.executable))
933 old_path = os.environ.get('PYTHONPATH')
934 os.environ['PYTHONPATH'] = self.cython_syspath + os.pathsep + os.path.join(self.cython_syspath, (old_path or ''))
935 for command in commands.split('\n'):
936 if sys.version_info[:2] >= (2,4):
938 p = subprocess.Popen(commands,
939 stderr=subprocess.PIPE,
940 stdout=subprocess.PIPE,
942 out, err = p.communicate()
949 res = os.system(command)
950 self.assertEqual(0, res, "non-zero exit status")
953 os.environ['PYTHONPATH'] = old_path
955 del os.environ['PYTHONPATH']
958 # TODO: Support cython_freeze needed here as well.
959 # TODO: Windows support.
961 class EmbedTest(unittest.TestCase):
963 working_dir = "Demos/embed"
966 self.old_dir = os.getcwd()
967 os.chdir(self.working_dir)
969 "make PYTHON='%s' clean > /dev/null" % sys.executable)
974 "make PYTHON='%s' clean > /dev/null" % sys.executable)
977 os.chdir(self.old_dir)
979 def test_embed(self):
980 from distutils import sysconfig
981 libname = sysconfig.get_config_var('LIBRARY')
982 libdir = sysconfig.get_config_var('LIBDIR')
983 if not os.path.isdir(libdir) or libname not in os.listdir(libdir):
984 libdir = os.path.join(os.path.dirname(sys.executable), '..', 'lib')
985 if not os.path.isdir(libdir) or libname not in os.listdir(libdir):
986 libdir = os.path.join(libdir, 'python%d.%d' % sys.version_info[:2], 'config')
987 if not os.path.isdir(libdir) or libname not in os.listdir(libdir):
988 # report the error for the original directory
989 libdir = sysconfig.get_config_var('LIBDIR')
991 if sys.version_info[0] >=3 and CY3_DIR:
992 cython = os.path.join(CY3_DIR, cython)
993 cython = os.path.abspath(os.path.join('..', '..', cython))
994 self.assert_(os.system(
995 "make PYTHON='%s' CYTHON='%s' LIBDIR1='%s' test > make.output" % (sys.executable, cython, libdir)) == 0)
997 os.remove('make.output')
1001 class MissingDependencyExcluder:
1002 def __init__(self, deps):
1003 # deps: { module name : matcher func }
1004 self.exclude_matchers = []
1005 for mod, matcher in deps.items():
1009 self.exclude_matchers.append(string_selector(matcher))
1010 self.tests_missing_deps = []
1011 def __call__(self, testname, tags=None):
1012 for matcher in self.exclude_matchers:
1013 if matcher(testname, tags):
1014 self.tests_missing_deps.append(testname)
1018 class VersionDependencyExcluder:
1019 def __init__(self, deps):
1020 # deps: { version : matcher func }
1021 from sys import version_info
1022 self.exclude_matchers = []
1023 for ver, (compare, matcher) in deps.items():
1024 if compare(version_info, ver):
1025 self.exclude_matchers.append(matcher)
1026 self.tests_missing_deps = []
1027 def __call__(self, testname, tags=None):
1028 for matcher in self.exclude_matchers:
1029 if matcher(testname):
1030 self.tests_missing_deps.append(testname)
1034 class FileListExcluder:
1036 def __init__(self, list_file):
1040 for line in f.readlines():
1042 if line and line[0] != '#':
1043 self.excludes[line.split()[0]] = True
1047 def __call__(self, testname, tags=None):
1048 return testname in self.excludes or testname.split('.')[-1] in self.excludes
1052 def __init__(self, tag, value):
1056 def __call__(self, testname, tags=None):
1060 return self.value in tags[self.tag]
1062 class RegExSelector:
1064 def __init__(self, pattern_string):
1065 self.pattern = re.compile(pattern_string, re.I|re.U)
1067 def __call__(self, testname, tags=None):
1068 return self.pattern.search(testname)
1070 def string_selector(s):
1073 return RegExSelector(s)
1075 return TagsSelector(s[:ix], s[ix+1:])
1078 def refactor_for_py3(distdir, cy3_dir):
1079 # need to convert Cython sources first
1080 import lib2to3.refactor
1081 from distutils.util import copydir_run_2to3
1082 fixers = [ fix for fix in lib2to3.refactor.get_fixers_from_package("lib2to3.fixes")
1083 if fix.split('fix_')[-1] not in ('next',)
1085 if not os.path.exists(cy3_dir):
1086 os.makedirs(cy3_dir)
1087 import distutils.log as dlog
1088 dlog.set_threshold(dlog.INFO)
1089 copydir_run_2to3(distdir, cy3_dir, fixer_names=fixers,
1093 recursive-exclude Cython *
1094 recursive-include Cython *.py *.pyx *.pxd
1095 recursive-include Cython/Debugger/Tests *
1099 sys.path.insert(0, cy3_dir)
1101 for keep_2x_file in KEEP_2X_FILES:
1102 destfile = os.path.join(cy3_dir, keep_2x_file)
1103 shutil.copy(keep_2x_file, destfile)
1105 class PendingThreadsError(RuntimeError):
1110 def check_thread_termination(ignore_seen=True):
1111 if threading is None: # no threading enabled in CPython
1113 current = threading.currentThread()
1114 blocking_threads = []
1115 for t in threading.enumerate():
1116 if not t.isAlive() or t == current:
1121 blocking_threads.append(t)
1123 for seen in threads_seen:
1127 threads_seen.append(t)
1128 blocking_threads.append(t)
1129 if not blocking_threads:
1131 sys.stderr.write("warning: left-over threads found after running test:\n")
1132 for t in blocking_threads:
1133 sys.stderr.write('...%s\n' % repr(t))
1134 raise PendingThreadsError("left-over threads found after running test")
1138 DISTDIR = os.path.join(os.getcwd(), os.path.dirname(sys.argv[0]))
1140 from optparse import OptionParser
1141 parser = OptionParser()
1142 parser.add_option("--no-cleanup", dest="cleanup_workdir",
1143 action="store_false", default=True,
1144 help="do not delete the generated C files (allows passing --no-cython on next run)")
1145 parser.add_option("--no-cleanup-sharedlibs", dest="cleanup_sharedlibs",
1146 action="store_false", default=True,
1147 help="do not delete the generated shared libary files (allows manual module experimentation)")
1148 parser.add_option("--no-cython", dest="with_cython",
1149 action="store_false", default=True,
1150 help="do not run the Cython compiler, only the C compiler")
1151 parser.add_option("--compiler", dest="compiler", default=None,
1152 help="C compiler type")
1153 parser.add_option("--no-c", dest="use_c",
1154 action="store_false", default=True,
1155 help="do not test C compilation")
1156 parser.add_option("--no-cpp", dest="use_cpp",
1157 action="store_false", default=True,
1158 help="do not test C++ compilation")
1159 parser.add_option("--no-unit", dest="unittests",
1160 action="store_false", default=True,
1161 help="do not run the unit tests")
1162 parser.add_option("--no-doctest", dest="doctests",
1163 action="store_false", default=True,
1164 help="do not run the doctests")
1165 parser.add_option("--no-file", dest="filetests",
1166 action="store_false", default=True,
1167 help="do not run the file based tests")
1168 parser.add_option("--no-pyregr", dest="pyregr",
1169 action="store_false", default=True,
1170 help="do not run the regression tests of CPython in tests/pyregr/")
1171 parser.add_option("--cython-only", dest="cython_only",
1172 action="store_true", default=False,
1173 help="only compile pyx to c, do not run C compiler or run the tests")
1174 parser.add_option("--no-refnanny", dest="with_refnanny",
1175 action="store_false", default=True,
1176 help="do not regression test reference counting")
1177 parser.add_option("--no-fork", dest="fork",
1178 action="store_false", default=True,
1179 help="do not fork to run tests")
1180 parser.add_option("--sys-pyregr", dest="system_pyregr",
1181 action="store_true", default=False,
1182 help="run the regression tests of the CPython installation")
1183 parser.add_option("-x", "--exclude", dest="exclude",
1184 action="append", metavar="PATTERN",
1185 help="exclude tests matching the PATTERN")
1186 parser.add_option("-C", "--coverage", dest="coverage",
1187 action="store_true", default=False,
1188 help="collect source coverage data for the Compiler")
1189 parser.add_option("--coverage-xml", dest="coverage_xml",
1190 action="store_true", default=False,
1191 help="collect source coverage data for the Compiler in XML format")
1192 parser.add_option("-A", "--annotate", dest="annotate_source",
1193 action="store_true", default=True,
1194 help="generate annotated HTML versions of the test source files")
1195 parser.add_option("--no-annotate", dest="annotate_source",
1196 action="store_false",
1197 help="do not generate annotated HTML versions of the test source files")
1198 parser.add_option("-v", "--verbose", dest="verbosity",
1199 action="count", default=0,
1200 help="display test progress, pass twice to print test names")
1201 parser.add_option("-T", "--ticket", dest="tickets",
1203 help="a bug ticket number to run the respective test in 'tests/*'")
1204 parser.add_option("-3", dest="language_level",
1205 action="store_const", const=3, default=2,
1206 help="set language level to Python 3 (useful for running the CPython regression tests)'")
1207 parser.add_option("--xml-output", dest="xml_output_dir", metavar="DIR",
1208 help="write test results in XML to directory DIR")
1209 parser.add_option("--exit-ok", dest="exit_ok", default=False,
1210 action="store_true",
1211 help="exit without error code even on test failures")
1212 parser.add_option("--root-dir", dest="root_dir", default=os.path.join(DISTDIR, 'tests'),
1213 help="working directory")
1214 parser.add_option("--work-dir", dest="work_dir", default=os.path.join(os.getcwd(), 'BUILD'),
1215 help="working directory")
1217 options, cmd_args = parser.parse_args()
1219 ROOTDIR = os.path.abspath(options.root_dir)
1220 WORKDIR = os.path.abspath(options.work_dir)
1222 if sys.version_info[0] >= 3:
1223 options.doctests = False
1224 if options.with_cython:
1226 # try if Cython is installed in a Py3 version
1227 import Cython.Compiler.Main
1229 # back out anything the import process loaded, then
1230 # 2to3 the Cython sources to make them re-importable
1231 cy_modules = [ name for name in sys.modules
1232 if name == 'Cython' or name.startswith('Cython.') ]
1233 for name in cy_modules:
1234 del sys.modules[name]
1235 # hasn't been refactored yet - do it now
1237 CY3_DIR = cy3_dir = os.path.join(WORKDIR, 'Cy3')
1238 if sys.version_info >= (3,1):
1239 refactor_for_py3(DISTDIR, cy3_dir)
1240 elif os.path.isdir(cy3_dir):
1241 sys.path.insert(0, cy3_dir)
1243 options.with_cython = False
1245 WITH_CYTHON = options.with_cython
1247 if options.coverage or options.coverage_xml:
1249 options.coverage = options.coverage_xml = False
1251 from coverage import coverage as _coverage
1252 coverage = _coverage(branch=True)
1257 global CompilationOptions, pyrex_default_options, cython_compile
1258 from Cython.Compiler.Main import \
1259 CompilationOptions, \
1260 default_options as pyrex_default_options, \
1261 compile as cython_compile
1262 from Cython.Compiler import Errors
1263 Errors.LEVEL = 0 # show all warnings
1264 from Cython.Compiler import Options
1265 Options.generate_cleanup_code = 3 # complete cleanup code
1266 from Cython.Compiler import DebugFlags
1267 DebugFlags.debug_temp_code_comments = 1
1270 UNITTEST_MODULE = "Cython"
1271 UNITTEST_ROOT = os.path.join(os.path.dirname(__file__), UNITTEST_MODULE)
1273 if os.path.exists(WORKDIR):
1274 for path in os.listdir(WORKDIR):
1275 if path in ("support", "Cy3"): continue
1276 shutil.rmtree(os.path.join(WORKDIR, path), ignore_errors=True)
1277 if not os.path.exists(WORKDIR):
1278 os.makedirs(WORKDIR)
1280 sys.stderr.write("Python %s\n" % sys.version)
1281 sys.stderr.write("\n")
1283 from Cython.Compiler.Version import version
1284 sys.stderr.write("Running tests against Cython %s\n" % version)
1286 sys.stderr.write("Running tests without Cython.\n")
1288 if options.with_refnanny:
1289 from pyximport.pyxbuild import pyx_to_dll
1290 libpath = pyx_to_dll(os.path.join("Cython", "Runtime", "refnanny.pyx"),
1292 pyxbuild_dir=os.path.join(WORKDIR, "support"))
1293 sys.path.insert(0, os.path.split(libpath)[0])
1294 CFLAGS.append("-DCYTHON_REFNANNY=1")
1296 if options.xml_output_dir and options.fork:
1297 # doesn't currently work together
1298 sys.stderr.write("Disabling forked testing to support XML test output\n")
1299 options.fork = False
1301 if WITH_CYTHON and options.language_level == 3:
1302 sys.stderr.write("Using Cython language level 3.\n")
1304 sys.stderr.write("\n")
1308 for ticket_number in options.tickets:
1310 cmd_args.append('ticket:%s' % ticket_number)
1312 for selector in cmd_args:
1313 if selector.startswith('bugs'):
1317 selectors = [ string_selector(r) for r in cmd_args ]
1319 selectors = [ lambda x, tags=None: True ]
1321 # Chech which external modules are not present and exclude tests
1322 # which depends on them (by prefix)
1324 missing_dep_excluder = MissingDependencyExcluder(EXT_DEP_MODULES)
1325 version_dep_excluder = VersionDependencyExcluder(VER_DEP_MODULES)
1326 exclude_selectors = [missing_dep_excluder, version_dep_excluder] # want to pring msg at exit
1329 exclude_selectors += [ string_selector(r) for r in options.exclude ]
1332 exclude_selectors += [ FileListExcluder(os.path.join(ROOTDIR, "bugs.txt")) ]
1334 if sys.platform in ['win32', 'cygwin'] and sys.version_info < (2,6):
1335 exclude_selectors += [ lambda x: x == "run.specialfloat" ]
1338 if options.compiler:
1339 COMPILER = options.compiler
1342 languages.append('c')
1344 languages.append('cpp')
1346 test_suite = unittest.TestSuite()
1348 if options.unittests:
1349 collect_unittests(UNITTEST_ROOT, UNITTEST_MODULE + ".", test_suite, selectors)
1351 if options.doctests:
1352 collect_doctests(UNITTEST_ROOT, UNITTEST_MODULE + ".", test_suite, selectors)
1354 if options.filetests and languages:
1355 filetests = TestBuilder(ROOTDIR, WORKDIR, selectors, exclude_selectors,
1356 options.annotate_source, options.cleanup_workdir,
1357 options.cleanup_sharedlibs, options.pyregr,
1358 options.cython_only, languages, test_bugs,
1359 options.fork, options.language_level)
1360 test_suite.addTest(filetests.build_suite())
1362 if options.system_pyregr and languages:
1363 sys_pyregr_dir = os.path.join(sys.prefix, 'lib', 'python'+sys.version[:3], 'test')
1364 if os.path.isdir(sys_pyregr_dir):
1365 filetests = TestBuilder(ROOTDIR, WORKDIR, selectors, exclude_selectors,
1366 options.annotate_source, options.cleanup_workdir,
1367 options.cleanup_sharedlibs, True,
1368 options.cython_only, languages, test_bugs,
1369 options.fork, sys.version_info[0])
1370 sys.stderr.write("Including CPython regression tests in %s\n" % sys_pyregr_dir)
1371 test_suite.addTest(filetests.handle_directory(sys_pyregr_dir, 'pyregr'))
1373 if options.xml_output_dir:
1374 from Cython.Tests.xmlrunner import XMLTestRunner
1375 test_runner = XMLTestRunner(output=options.xml_output_dir,
1376 verbose=options.verbosity > 0)
1378 test_runner = unittest.TextTestRunner(verbosity=options.verbosity)
1380 result = test_runner.run(test_suite)
1382 if options.coverage or options.coverage_xml:
1384 ignored_modules = ('Options', 'Version', 'DebugFlags', 'CmdLine')
1385 modules = [ module for name, module in sys.modules.items()
1386 if module is not None and
1387 name.startswith('Cython.Compiler.') and
1388 name[len('Cython.Compiler.'):] not in ignored_modules ]
1389 if options.coverage:
1390 coverage.report(modules, show_missing=0)
1391 if options.coverage_xml:
1392 coverage.xml_report(modules, outfile="coverage-report.xml")
1394 if missing_dep_excluder.tests_missing_deps:
1395 sys.stderr.write("Following tests excluded because of missing dependencies on your system:\n")
1396 for test in missing_dep_excluder.tests_missing_deps:
1397 sys.stderr.write(" %s\n" % test)
1399 if options.with_refnanny:
1401 sys.stderr.write("\n".join([repr(x) for x in refnanny.reflog]))
1408 return_code = not result.wasSuccessful()
1411 check_thread_termination(ignore_seen=False)
1412 sys.exit(return_code)
1413 except PendingThreadsError:
1414 # normal program exit won't kill the threads, do it the hard way here
1415 os._exit(return_code)
1417 if __name__ == '__main__':
1420 except SystemExit: # <= Py2.4 ...
1423 traceback.print_exc()
1425 check_thread_termination(ignore_seen=False)
1426 except PendingThreadsError:
1427 # normal program exit won't kill the threads, do it the hard way here