Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 1 | import sys |
| 2 | import os |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 3 | import shutil |
| 4 | from io import StringIO |
Ronald Oussoren | 222e89a | 2011-05-15 16:46:11 +0200 | [diff] [blame] | 5 | import textwrap |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 6 | |
Barry Warsaw | 8cf4eae | 2010-10-16 01:04:07 +0000 | [diff] [blame] | 7 | from distutils.core import Distribution |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 8 | from distutils.command.build_ext import build_ext |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame] | 9 | from distutils import sysconfig |
Tarek Ziadé | c1375d5 | 2009-02-14 14:35:51 +0000 | [diff] [blame] | 10 | from distutils.tests.support import TempdirManager |
Tarek Ziadé | b2e36f1 | 2009-03-31 22:37:55 +0000 | [diff] [blame] | 11 | from distutils.tests.support import LoggingSilencer |
| 12 | from distutils.extension import Extension |
Barry Warsaw | 8cf4eae | 2010-10-16 01:04:07 +0000 | [diff] [blame] | 13 | from distutils.errors import ( |
Ned Deily | d13007f | 2011-06-28 19:43:15 -0700 | [diff] [blame^] | 14 | CompileError, DistutilsPlatformError, DistutilsSetupError, |
| 15 | UnknownFileError) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 16 | |
| 17 | import unittest |
| 18 | from test import support |
Éric Araujo | 70ec44a | 2010-11-06 02:44:43 +0000 | [diff] [blame] | 19 | from test.support import run_unittest |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 20 | |
Christian Heimes | 3e7e069 | 2008-11-25 21:21:32 +0000 | [diff] [blame] | 21 | # http://bugs.python.org/issue4373 |
| 22 | # Don't load the xx module more than once. |
| 23 | ALREADY_TESTED = False |
| 24 | |
Neil Schemenauer | d8f63bb | 2009-02-06 21:42:05 +0000 | [diff] [blame] | 25 | def _get_source_filename(): |
Ned Deily | 58f27b2 | 2011-06-28 00:42:50 -0700 | [diff] [blame] | 26 | # use installed copy if available |
| 27 | tests_f = os.path.join(os.path.dirname(__file__), 'xxmodule.c') |
| 28 | if os.path.exists(tests_f): |
| 29 | return tests_f |
| 30 | # otherwise try using copy from build directory |
Neil Schemenauer | d8f63bb | 2009-02-06 21:42:05 +0000 | [diff] [blame] | 31 | srcdir = sysconfig.get_config_var('srcdir') |
| 32 | return os.path.join(srcdir, 'Modules', 'xxmodule.c') |
| 33 | |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame] | 34 | class BuildExtTestCase(TempdirManager, |
| 35 | LoggingSilencer, |
| 36 | unittest.TestCase): |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 37 | def setUp(self): |
| 38 | # Create a simple test environment |
| 39 | # Note that we're making changes to sys.path |
Tarek Ziadé | 38e3d51 | 2009-02-27 12:58:56 +0000 | [diff] [blame] | 40 | super(BuildExtTestCase, self).setUp() |
Tarek Ziadé | c1375d5 | 2009-02-14 14:35:51 +0000 | [diff] [blame] | 41 | self.tmp_dir = self.mkdtemp() |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame] | 42 | self.sys_path = sys.path, sys.path[:] |
| 43 | sys.path.append(self.tmp_dir) |
Ned Deily | 58f27b2 | 2011-06-28 00:42:50 -0700 | [diff] [blame] | 44 | filename = _get_source_filename() |
| 45 | if os.path.exists(filename): |
| 46 | shutil.copy(filename, self.tmp_dir) |
Tarek Ziadé | 38e3d51 | 2009-02-27 12:58:56 +0000 | [diff] [blame] | 47 | if sys.version > "2.6": |
| 48 | import site |
| 49 | self.old_user_base = site.USER_BASE |
| 50 | site.USER_BASE = self.mkdtemp() |
| 51 | from distutils.command import build_ext |
| 52 | build_ext.USER_BASE = site.USER_BASE |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 53 | |
Barry Warsaw | 8cf4eae | 2010-10-16 01:04:07 +0000 | [diff] [blame] | 54 | def _fixup_command(self, cmd): |
| 55 | # When Python was build with --enable-shared, -L. is not good enough |
| 56 | # to find the libpython<blah>.so. This is because regrtest runs it |
| 57 | # under a tempdir, not in the top level where the .so lives. By the |
| 58 | # time we've gotten here, Python's already been chdir'd to the |
| 59 | # tempdir. |
| 60 | # |
| 61 | # To further add to the fun, we can't just add library_dirs to the |
| 62 | # Extension() instance because that doesn't get plumbed through to the |
| 63 | # final compiler command. |
Barry Warsaw | 4ebfdf0 | 2010-10-22 17:17:51 +0000 | [diff] [blame] | 64 | if (sysconfig.get_config_var('Py_ENABLE_SHARED') and |
| 65 | not sys.platform.startswith('win')): |
Éric Araujo | 68fc9aa | 2010-10-21 23:02:07 +0000 | [diff] [blame] | 66 | runshared = sysconfig.get_config_var('RUNSHARED') |
| 67 | if runshared is None: |
| 68 | cmd.library_dirs = ['.'] |
| 69 | else: |
| 70 | name, equals, value = runshared.partition('=') |
| 71 | cmd.library_dirs = value.split(os.pathsep) |
Barry Warsaw | 8cf4eae | 2010-10-16 01:04:07 +0000 | [diff] [blame] | 72 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 73 | def test_build_ext(self): |
Christian Heimes | 3e7e069 | 2008-11-25 21:21:32 +0000 | [diff] [blame] | 74 | global ALREADY_TESTED |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 75 | xx_c = os.path.join(self.tmp_dir, 'xxmodule.c') |
Ned Deily | 58f27b2 | 2011-06-28 00:42:50 -0700 | [diff] [blame] | 76 | if not os.path.exists(xx_c): |
| 77 | return |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 78 | xx_ext = Extension('xx', [xx_c]) |
| 79 | dist = Distribution({'name': 'xx', 'ext_modules': [xx_ext]}) |
| 80 | dist.package_dir = self.tmp_dir |
| 81 | cmd = build_ext(dist) |
Barry Warsaw | 8cf4eae | 2010-10-16 01:04:07 +0000 | [diff] [blame] | 82 | self._fixup_command(cmd) |
Thomas Heller | 84b7f0c | 2008-05-26 11:51:44 +0000 | [diff] [blame] | 83 | if os.name == "nt": |
| 84 | # On Windows, we must build a debug version iff running |
| 85 | # a debug build of Python |
| 86 | cmd.debug = sys.executable.endswith("_d.exe") |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 87 | cmd.build_lib = self.tmp_dir |
| 88 | cmd.build_temp = self.tmp_dir |
| 89 | |
| 90 | old_stdout = sys.stdout |
| 91 | if not support.verbose: |
| 92 | # silence compiler output |
| 93 | sys.stdout = StringIO() |
| 94 | try: |
| 95 | cmd.ensure_finalized() |
| 96 | cmd.run() |
| 97 | finally: |
| 98 | sys.stdout = old_stdout |
| 99 | |
Christian Heimes | 3e7e069 | 2008-11-25 21:21:32 +0000 | [diff] [blame] | 100 | if ALREADY_TESTED: |
| 101 | return |
| 102 | else: |
| 103 | ALREADY_TESTED = True |
| 104 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 105 | import xx |
| 106 | |
| 107 | for attr in ('error', 'foo', 'new', 'roj'): |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 108 | self.assertTrue(hasattr(xx, attr)) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 109 | |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 110 | self.assertEqual(xx.foo(2, 5), 7) |
| 111 | self.assertEqual(xx.foo(13,15), 28) |
| 112 | self.assertEqual(xx.new().demo(), None) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 113 | doc = 'This is a template module just for instruction.' |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 114 | self.assertEqual(xx.__doc__, doc) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 115 | self.assertTrue(isinstance(xx.Null(), xx.Null)) |
| 116 | self.assertTrue(isinstance(xx.Str(), xx.Str)) |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 117 | |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame] | 118 | def tearDown(self): |
| 119 | # Get everything back to normal |
| 120 | support.unload('xx') |
| 121 | sys.path = self.sys_path[0] |
| 122 | sys.path[:] = self.sys_path[1] |
| 123 | if sys.version > "2.6": |
| 124 | import site |
| 125 | site.USER_BASE = self.old_user_base |
| 126 | from distutils.command import build_ext |
| 127 | build_ext.USER_BASE = self.old_user_base |
| 128 | super(BuildExtTestCase, self).tearDown() |
| 129 | |
Tarek Ziadé | 5874ef1 | 2009-02-05 22:56:14 +0000 | [diff] [blame] | 130 | def test_solaris_enable_shared(self): |
| 131 | dist = Distribution({'name': 'xx'}) |
| 132 | cmd = build_ext(dist) |
| 133 | old = sys.platform |
| 134 | |
| 135 | sys.platform = 'sunos' # fooling finalize_options |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame] | 136 | from distutils.sysconfig import _config_vars |
| 137 | old_var = _config_vars.get('Py_ENABLE_SHARED') |
| 138 | _config_vars['Py_ENABLE_SHARED'] = 1 |
Tarek Ziadé | 5874ef1 | 2009-02-05 22:56:14 +0000 | [diff] [blame] | 139 | try: |
| 140 | cmd.ensure_finalized() |
| 141 | finally: |
| 142 | sys.platform = old |
| 143 | if old_var is None: |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame] | 144 | del _config_vars['Py_ENABLE_SHARED'] |
Tarek Ziadé | 5874ef1 | 2009-02-05 22:56:14 +0000 | [diff] [blame] | 145 | else: |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame] | 146 | _config_vars['Py_ENABLE_SHARED'] = old_var |
Tarek Ziadé | 5874ef1 | 2009-02-05 22:56:14 +0000 | [diff] [blame] | 147 | |
Tarek Ziadé | ff0e500 | 2009-05-12 17:14:01 +0000 | [diff] [blame] | 148 | # make sure we get some library dirs under solaris |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 149 | self.assertTrue(len(cmd.library_dirs) > 0) |
Tarek Ziadé | 5874ef1 | 2009-02-05 22:56:14 +0000 | [diff] [blame] | 150 | |
Tarek Ziadé | 38e3d51 | 2009-02-27 12:58:56 +0000 | [diff] [blame] | 151 | def test_user_site(self): |
| 152 | # site.USER_SITE was introduced in 2.6 |
| 153 | if sys.version < '2.6': |
| 154 | return |
| 155 | |
| 156 | import site |
| 157 | dist = Distribution({'name': 'xx'}) |
| 158 | cmd = build_ext(dist) |
| 159 | |
Tarek Ziadé | be720e0 | 2009-05-09 11:55:12 +0000 | [diff] [blame] | 160 | # making sure the user option is there |
Tarek Ziadé | 38e3d51 | 2009-02-27 12:58:56 +0000 | [diff] [blame] | 161 | options = [name for name, short, lable in |
| 162 | cmd.user_options] |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 163 | self.assertTrue('user' in options) |
Tarek Ziadé | 38e3d51 | 2009-02-27 12:58:56 +0000 | [diff] [blame] | 164 | |
| 165 | # setting a value |
| 166 | cmd.user = 1 |
| 167 | |
| 168 | # setting user based lib and include |
| 169 | lib = os.path.join(site.USER_BASE, 'lib') |
| 170 | incl = os.path.join(site.USER_BASE, 'include') |
| 171 | os.mkdir(lib) |
| 172 | os.mkdir(incl) |
| 173 | |
| 174 | # let's run finalize |
| 175 | cmd.ensure_finalized() |
| 176 | |
| 177 | # see if include_dirs and library_dirs |
| 178 | # were set |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 179 | self.assertTrue(lib in cmd.library_dirs) |
| 180 | self.assertTrue(lib in cmd.rpath) |
| 181 | self.assertTrue(incl in cmd.include_dirs) |
Tarek Ziadé | 38e3d51 | 2009-02-27 12:58:56 +0000 | [diff] [blame] | 182 | |
Tarek Ziadé | b2e36f1 | 2009-03-31 22:37:55 +0000 | [diff] [blame] | 183 | def test_optional_extension(self): |
| 184 | |
| 185 | # this extension will fail, but let's ignore this failure |
| 186 | # with the optional argument. |
| 187 | modules = [Extension('foo', ['xxx'], optional=False)] |
| 188 | dist = Distribution({'name': 'xx', 'ext_modules': modules}) |
| 189 | cmd = build_ext(dist) |
| 190 | cmd.ensure_finalized() |
Tarek Ziadé | 3091129 | 2009-03-31 22:50:54 +0000 | [diff] [blame] | 191 | self.assertRaises((UnknownFileError, CompileError), |
| 192 | cmd.run) # should raise an error |
Tarek Ziadé | b2e36f1 | 2009-03-31 22:37:55 +0000 | [diff] [blame] | 193 | |
| 194 | modules = [Extension('foo', ['xxx'], optional=True)] |
| 195 | dist = Distribution({'name': 'xx', 'ext_modules': modules}) |
| 196 | cmd = build_ext(dist) |
| 197 | cmd.ensure_finalized() |
| 198 | cmd.run() # should pass |
| 199 | |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 200 | def test_finalize_options(self): |
| 201 | # Make sure Python's include directories (for Python.h, pyconfig.h, |
| 202 | # etc.) are in the include search path. |
| 203 | modules = [Extension('foo', ['xxx'], optional=False)] |
| 204 | dist = Distribution({'name': 'xx', 'ext_modules': modules}) |
| 205 | cmd = build_ext(dist) |
| 206 | cmd.finalize_options() |
| 207 | |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame] | 208 | from distutils import sysconfig |
| 209 | py_include = sysconfig.get_python_inc() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 210 | self.assertTrue(py_include in cmd.include_dirs) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 211 | |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame] | 212 | plat_py_include = sysconfig.get_python_inc(plat_specific=1) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 213 | self.assertTrue(plat_py_include in cmd.include_dirs) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 214 | |
| 215 | # make sure cmd.libraries is turned into a list |
| 216 | # if it's a string |
| 217 | cmd = build_ext(dist) |
| 218 | cmd.libraries = 'my_lib' |
| 219 | cmd.finalize_options() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 220 | self.assertEqual(cmd.libraries, ['my_lib']) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 221 | |
| 222 | # make sure cmd.library_dirs is turned into a list |
| 223 | # if it's a string |
| 224 | cmd = build_ext(dist) |
| 225 | cmd.library_dirs = 'my_lib_dir' |
| 226 | cmd.finalize_options() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 227 | self.assertTrue('my_lib_dir' in cmd.library_dirs) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 228 | |
| 229 | # make sure rpath is turned into a list |
| 230 | # if it's a list of os.pathsep's paths |
| 231 | cmd = build_ext(dist) |
| 232 | cmd.rpath = os.pathsep.join(['one', 'two']) |
| 233 | cmd.finalize_options() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 234 | self.assertEqual(cmd.rpath, ['one', 'two']) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 235 | |
| 236 | # XXX more tests to perform for win32 |
| 237 | |
| 238 | # make sure define is turned into 2-tuples |
| 239 | # strings if they are ','-separated strings |
| 240 | cmd = build_ext(dist) |
| 241 | cmd.define = 'one,two' |
| 242 | cmd.finalize_options() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 243 | self.assertEqual(cmd.define, [('one', '1'), ('two', '1')]) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 244 | |
| 245 | # make sure undef is turned into a list of |
| 246 | # strings if they are ','-separated strings |
| 247 | cmd = build_ext(dist) |
| 248 | cmd.undef = 'one,two' |
| 249 | cmd.finalize_options() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 250 | self.assertEqual(cmd.undef, ['one', 'two']) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 251 | |
| 252 | # make sure swig_opts is turned into a list |
| 253 | cmd = build_ext(dist) |
| 254 | cmd.swig_opts = None |
| 255 | cmd.finalize_options() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 256 | self.assertEqual(cmd.swig_opts, []) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 257 | |
| 258 | cmd = build_ext(dist) |
| 259 | cmd.swig_opts = '1 2' |
| 260 | cmd.finalize_options() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 261 | self.assertEqual(cmd.swig_opts, ['1', '2']) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 262 | |
| 263 | def test_check_extensions_list(self): |
| 264 | dist = Distribution() |
| 265 | cmd = build_ext(dist) |
| 266 | cmd.finalize_options() |
| 267 | |
| 268 | #'extensions' option must be a list of Extension instances |
Barry Warsaw | 8cf4eae | 2010-10-16 01:04:07 +0000 | [diff] [blame] | 269 | self.assertRaises(DistutilsSetupError, |
| 270 | cmd.check_extensions_list, 'foo') |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 271 | |
| 272 | # each element of 'ext_modules' option must be an |
| 273 | # Extension instance or 2-tuple |
| 274 | exts = [('bar', 'foo', 'bar'), 'foo'] |
| 275 | self.assertRaises(DistutilsSetupError, cmd.check_extensions_list, exts) |
| 276 | |
| 277 | # first element of each tuple in 'ext_modules' |
| 278 | # must be the extension name (a string) and match |
| 279 | # a python dotted-separated name |
| 280 | exts = [('foo-bar', '')] |
| 281 | self.assertRaises(DistutilsSetupError, cmd.check_extensions_list, exts) |
| 282 | |
| 283 | # second element of each tuple in 'ext_modules' |
| 284 | # must be a ary (build info) |
| 285 | exts = [('foo.bar', '')] |
| 286 | self.assertRaises(DistutilsSetupError, cmd.check_extensions_list, exts) |
| 287 | |
| 288 | # ok this one should pass |
| 289 | exts = [('foo.bar', {'sources': [''], 'libraries': 'foo', |
| 290 | 'some': 'bar'})] |
| 291 | cmd.check_extensions_list(exts) |
| 292 | ext = exts[0] |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 293 | self.assertTrue(isinstance(ext, Extension)) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 294 | |
| 295 | # check_extensions_list adds in ext the values passed |
| 296 | # when they are in ('include_dirs', 'library_dirs', 'libraries' |
| 297 | # 'extra_objects', 'extra_compile_args', 'extra_link_args') |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 298 | self.assertEqual(ext.libraries, 'foo') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 299 | self.assertTrue(not hasattr(ext, 'some')) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 300 | |
| 301 | # 'macros' element of build info dict must be 1- or 2-tuple |
| 302 | exts = [('foo.bar', {'sources': [''], 'libraries': 'foo', |
| 303 | 'some': 'bar', 'macros': [('1', '2', '3'), 'foo']})] |
| 304 | self.assertRaises(DistutilsSetupError, cmd.check_extensions_list, exts) |
| 305 | |
| 306 | exts[0][1]['macros'] = [('1', '2'), ('3',)] |
| 307 | cmd.check_extensions_list(exts) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 308 | self.assertEqual(exts[0].undef_macros, ['3']) |
| 309 | self.assertEqual(exts[0].define_macros, [('1', '2')]) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 310 | |
| 311 | def test_get_source_files(self): |
| 312 | modules = [Extension('foo', ['xxx'], optional=False)] |
| 313 | dist = Distribution({'name': 'xx', 'ext_modules': modules}) |
| 314 | cmd = build_ext(dist) |
| 315 | cmd.ensure_finalized() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 316 | self.assertEqual(cmd.get_source_files(), ['xxx']) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 317 | |
Tarek Ziadé | ff0e500 | 2009-05-12 17:14:01 +0000 | [diff] [blame] | 318 | def test_compiler_option(self): |
| 319 | # cmd.compiler is an option and |
| 320 | # should not be overriden by a compiler instance |
| 321 | # when the command is run |
| 322 | dist = Distribution() |
| 323 | cmd = build_ext(dist) |
| 324 | cmd.compiler = 'unix' |
| 325 | cmd.ensure_finalized() |
| 326 | cmd.run() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 327 | self.assertEqual(cmd.compiler, 'unix') |
Tarek Ziadé | ff0e500 | 2009-05-12 17:14:01 +0000 | [diff] [blame] | 328 | |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 329 | def test_get_outputs(self): |
Tarek Ziadé | ff0e500 | 2009-05-12 17:14:01 +0000 | [diff] [blame] | 330 | tmp_dir = self.mkdtemp() |
| 331 | c_file = os.path.join(tmp_dir, 'foo.c') |
Victor Stinner | 3e2b717 | 2010-11-09 09:32:19 +0000 | [diff] [blame] | 332 | self.write_file(c_file, 'void PyInit_foo(void) {}\n') |
Tarek Ziadé | ff0e500 | 2009-05-12 17:14:01 +0000 | [diff] [blame] | 333 | ext = Extension('foo', [c_file], optional=False) |
| 334 | dist = Distribution({'name': 'xx', |
| 335 | 'ext_modules': [ext]}) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 336 | cmd = build_ext(dist) |
Barry Warsaw | 8cf4eae | 2010-10-16 01:04:07 +0000 | [diff] [blame] | 337 | self._fixup_command(cmd) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 338 | cmd.ensure_finalized() |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 339 | self.assertEqual(len(cmd.get_outputs()), 1) |
Tarek Ziadé | 06fbee1 | 2009-05-10 10:34:01 +0000 | [diff] [blame] | 340 | |
Tarek Ziadé | ff0e500 | 2009-05-12 17:14:01 +0000 | [diff] [blame] | 341 | if os.name == "nt": |
| 342 | cmd.debug = sys.executable.endswith("_d.exe") |
| 343 | |
| 344 | cmd.build_lib = os.path.join(self.tmp_dir, 'build') |
| 345 | cmd.build_temp = os.path.join(self.tmp_dir, 'tempt') |
| 346 | |
| 347 | # issue #5977 : distutils build_ext.get_outputs |
| 348 | # returns wrong result with --inplace |
Tarek Ziadé | 4210c6e | 2009-05-14 20:20:47 +0000 | [diff] [blame] | 349 | other_tmp_dir = os.path.realpath(self.mkdtemp()) |
| 350 | old_wd = os.getcwd() |
| 351 | os.chdir(other_tmp_dir) |
| 352 | try: |
| 353 | cmd.inplace = 1 |
| 354 | cmd.run() |
| 355 | so_file = cmd.get_outputs()[0] |
| 356 | finally: |
| 357 | os.chdir(old_wd) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 358 | self.assertTrue(os.path.exists(so_file)) |
Barry Warsaw | 35f3a2c | 2010-09-03 18:30:30 +0000 | [diff] [blame] | 359 | so_ext = sysconfig.get_config_var('SO') |
| 360 | self.assertTrue(so_file.endswith(so_ext)) |
Tarek Ziadé | ff0e500 | 2009-05-12 17:14:01 +0000 | [diff] [blame] | 361 | so_dir = os.path.dirname(so_file) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 362 | self.assertEqual(so_dir, other_tmp_dir) |
Tarek Ziadé | ff0e500 | 2009-05-12 17:14:01 +0000 | [diff] [blame] | 363 | |
| 364 | cmd.inplace = 0 |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame] | 365 | cmd.compiler = None |
Tarek Ziadé | ff0e500 | 2009-05-12 17:14:01 +0000 | [diff] [blame] | 366 | cmd.run() |
| 367 | so_file = cmd.get_outputs()[0] |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 368 | self.assertTrue(os.path.exists(so_file)) |
Barry Warsaw | 35f3a2c | 2010-09-03 18:30:30 +0000 | [diff] [blame] | 369 | self.assertTrue(so_file.endswith(so_ext)) |
Tarek Ziadé | ff0e500 | 2009-05-12 17:14:01 +0000 | [diff] [blame] | 370 | so_dir = os.path.dirname(so_file) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 371 | self.assertEqual(so_dir, cmd.build_lib) |
Tarek Ziadé | ff0e500 | 2009-05-12 17:14:01 +0000 | [diff] [blame] | 372 | |
Tarek Ziadé | 822eb84 | 2009-05-19 16:22:57 +0000 | [diff] [blame] | 373 | # inplace = 0, cmd.package = 'bar' |
Tarek Ziadé | e10d6de | 2009-07-03 08:33:28 +0000 | [diff] [blame] | 374 | build_py = cmd.get_finalized_command('build_py') |
| 375 | build_py.package_dir = {'': 'bar'} |
Tarek Ziadé | 822eb84 | 2009-05-19 16:22:57 +0000 | [diff] [blame] | 376 | path = cmd.get_ext_fullpath('foo') |
Tarek Ziadé | 0156f91 | 2009-06-29 16:19:22 +0000 | [diff] [blame] | 377 | # checking that the last directory is the build_dir |
Tarek Ziadé | 822eb84 | 2009-05-19 16:22:57 +0000 | [diff] [blame] | 378 | path = os.path.split(path)[0] |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 379 | self.assertEqual(path, cmd.build_lib) |
Tarek Ziadé | 822eb84 | 2009-05-19 16:22:57 +0000 | [diff] [blame] | 380 | |
| 381 | # inplace = 1, cmd.package = 'bar' |
| 382 | cmd.inplace = 1 |
| 383 | other_tmp_dir = os.path.realpath(self.mkdtemp()) |
| 384 | old_wd = os.getcwd() |
| 385 | os.chdir(other_tmp_dir) |
| 386 | try: |
| 387 | path = cmd.get_ext_fullpath('foo') |
| 388 | finally: |
| 389 | os.chdir(old_wd) |
| 390 | # checking that the last directory is bar |
| 391 | path = os.path.split(path)[0] |
| 392 | lastdir = os.path.split(path)[-1] |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 393 | self.assertEqual(lastdir, 'bar') |
Tarek Ziadé | 822eb84 | 2009-05-19 16:22:57 +0000 | [diff] [blame] | 394 | |
Tarek Ziadé | e10d6de | 2009-07-03 08:33:28 +0000 | [diff] [blame] | 395 | def test_ext_fullpath(self): |
Tarek Ziadé | b7815e3 | 2009-07-10 09:14:31 +0000 | [diff] [blame] | 396 | ext = sysconfig.get_config_vars()['SO'] |
Tarek Ziadé | e10d6de | 2009-07-03 08:33:28 +0000 | [diff] [blame] | 397 | # building lxml.etree inplace |
| 398 | #etree_c = os.path.join(self.tmp_dir, 'lxml.etree.c') |
| 399 | #etree_ext = Extension('lxml.etree', [etree_c]) |
| 400 | #dist = Distribution({'name': 'lxml', 'ext_modules': [etree_ext]}) |
| 401 | dist = Distribution() |
Tarek Ziadé | 0156f91 | 2009-06-29 16:19:22 +0000 | [diff] [blame] | 402 | cmd = build_ext(dist) |
| 403 | cmd.inplace = 1 |
| 404 | cmd.distribution.package_dir = {'': 'src'} |
| 405 | cmd.distribution.packages = ['lxml', 'lxml.html'] |
| 406 | curdir = os.getcwd() |
Tarek Ziadé | b7815e3 | 2009-07-10 09:14:31 +0000 | [diff] [blame] | 407 | wanted = os.path.join(curdir, 'src', 'lxml', 'etree' + ext) |
Tarek Ziadé | 0156f91 | 2009-06-29 16:19:22 +0000 | [diff] [blame] | 408 | path = cmd.get_ext_fullpath('lxml.etree') |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 409 | self.assertEqual(wanted, path) |
Tarek Ziadé | 0156f91 | 2009-06-29 16:19:22 +0000 | [diff] [blame] | 410 | |
Tarek Ziadé | e10d6de | 2009-07-03 08:33:28 +0000 | [diff] [blame] | 411 | # building lxml.etree not inplace |
| 412 | cmd.inplace = 0 |
| 413 | cmd.build_lib = os.path.join(curdir, 'tmpdir') |
Tarek Ziadé | b7815e3 | 2009-07-10 09:14:31 +0000 | [diff] [blame] | 414 | wanted = os.path.join(curdir, 'tmpdir', 'lxml', 'etree' + ext) |
Tarek Ziadé | e10d6de | 2009-07-03 08:33:28 +0000 | [diff] [blame] | 415 | path = cmd.get_ext_fullpath('lxml.etree') |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 416 | self.assertEqual(wanted, path) |
Tarek Ziadé | e10d6de | 2009-07-03 08:33:28 +0000 | [diff] [blame] | 417 | |
| 418 | # building twisted.runner.portmap not inplace |
| 419 | build_py = cmd.get_finalized_command('build_py') |
| 420 | build_py.package_dir = {} |
| 421 | cmd.distribution.packages = ['twisted', 'twisted.runner.portmap'] |
| 422 | path = cmd.get_ext_fullpath('twisted.runner.portmap') |
| 423 | wanted = os.path.join(curdir, 'tmpdir', 'twisted', 'runner', |
Tarek Ziadé | b7815e3 | 2009-07-10 09:14:31 +0000 | [diff] [blame] | 424 | 'portmap' + ext) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 425 | self.assertEqual(wanted, path) |
Tarek Ziadé | e10d6de | 2009-07-03 08:33:28 +0000 | [diff] [blame] | 426 | |
| 427 | # building twisted.runner.portmap inplace |
| 428 | cmd.inplace = 1 |
| 429 | path = cmd.get_ext_fullpath('twisted.runner.portmap') |
Tarek Ziadé | b7815e3 | 2009-07-10 09:14:31 +0000 | [diff] [blame] | 430 | wanted = os.path.join(curdir, 'twisted', 'runner', 'portmap' + ext) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 431 | self.assertEqual(wanted, path) |
Tarek Ziadé | e10d6de | 2009-07-03 08:33:28 +0000 | [diff] [blame] | 432 | |
Ronald Oussoren | 222e89a | 2011-05-15 16:46:11 +0200 | [diff] [blame] | 433 | |
| 434 | @unittest.skipUnless(sys.platform == 'darwin', 'test only relevant for MacOSX') |
Ned Deily | d13007f | 2011-06-28 19:43:15 -0700 | [diff] [blame^] | 435 | def test_deployment_target_default(self): |
| 436 | # Issue 9516: Test that, in the absence of the environment variable, |
| 437 | # an extension module is compiled with the same deployment target as |
| 438 | # the interpreter. |
| 439 | self._try_compile_deployment_target('==', None) |
Ronald Oussoren | 222e89a | 2011-05-15 16:46:11 +0200 | [diff] [blame] | 440 | |
Ned Deily | d13007f | 2011-06-28 19:43:15 -0700 | [diff] [blame^] | 441 | @unittest.skipUnless(sys.platform == 'darwin', 'test only relevant for MacOSX') |
| 442 | def test_deployment_target_too_low(self): |
| 443 | # Issue 9516: Test that an extension module is not allowed to be |
| 444 | # compiled with a deployment target less than that of the interpreter. |
| 445 | self.assertRaises(DistutilsPlatformError, |
| 446 | self._try_compile_deployment_target, '>', '10.1') |
| 447 | |
| 448 | @unittest.skipUnless(sys.platform == 'darwin', 'test only relevant for MacOSX') |
| 449 | def test_deployment_target_higher_ok(self): |
| 450 | # Issue 9516: Test that an extension module can be compiled with a |
| 451 | # deployment target higher than that of the interpreter: the ext |
| 452 | # module may depend on some newer OS feature. |
| 453 | deptarget = sysconfig.get_config_var('MACOSX_DEPLOYMENT_TARGET') |
| 454 | if deptarget: |
| 455 | # increment the minor version number (i.e. 10.6 -> 10.7) |
| 456 | deptarget = [int(x) for x in deptarget.split('.')] |
| 457 | deptarget[-1] += 1 |
| 458 | deptarget = '.'.join(str(i) for i in deptarget) |
| 459 | self._try_compile_deployment_target('<', deptarget) |
| 460 | |
| 461 | def _try_compile_deployment_target(self, operator, target): |
Ronald Oussoren | 222e89a | 2011-05-15 16:46:11 +0200 | [diff] [blame] | 462 | orig_environ = os.environ |
| 463 | os.environ = orig_environ.copy() |
| 464 | self.addCleanup(setattr, os, 'environ', orig_environ) |
| 465 | |
Ned Deily | d13007f | 2011-06-28 19:43:15 -0700 | [diff] [blame^] | 466 | if target is None: |
| 467 | if os.environ.get('MACOSX_DEPLOYMENT_TARGET'): |
| 468 | del os.environ['MACOSX_DEPLOYMENT_TARGET'] |
| 469 | else: |
| 470 | os.environ['MACOSX_DEPLOYMENT_TARGET'] = target |
Ronald Oussoren | 222e89a | 2011-05-15 16:46:11 +0200 | [diff] [blame] | 471 | |
Ronald Oussoren | 222e89a | 2011-05-15 16:46:11 +0200 | [diff] [blame] | 472 | deptarget_c = os.path.join(self.tmp_dir, 'deptargetmodule.c') |
| 473 | |
| 474 | with open(deptarget_c, 'w') as fp: |
| 475 | fp.write(textwrap.dedent('''\ |
| 476 | #include <AvailabilityMacros.h> |
| 477 | |
| 478 | int dummy; |
| 479 | |
Ned Deily | d13007f | 2011-06-28 19:43:15 -0700 | [diff] [blame^] | 480 | #if TARGET %s MAC_OS_X_VERSION_MIN_REQUIRED |
| 481 | #else |
Ronald Oussoren | 222e89a | 2011-05-15 16:46:11 +0200 | [diff] [blame] | 482 | #error "Unexpected target" |
| 483 | #endif |
| 484 | |
Ned Deily | d13007f | 2011-06-28 19:43:15 -0700 | [diff] [blame^] | 485 | ''' % operator)) |
Ronald Oussoren | 222e89a | 2011-05-15 16:46:11 +0200 | [diff] [blame] | 486 | |
Ned Deily | d13007f | 2011-06-28 19:43:15 -0700 | [diff] [blame^] | 487 | # get the deployment target that the interpreter was built with |
Ronald Oussoren | 222e89a | 2011-05-15 16:46:11 +0200 | [diff] [blame] | 488 | target = sysconfig.get_config_var('MACOSX_DEPLOYMENT_TARGET') |
| 489 | target = tuple(map(int, target.split('.'))) |
| 490 | target = '%02d%01d0' % target |
Ronald Oussoren | 222e89a | 2011-05-15 16:46:11 +0200 | [diff] [blame] | 491 | deptarget_ext = Extension( |
| 492 | 'deptarget', |
| 493 | [deptarget_c], |
| 494 | extra_compile_args=['-DTARGET=%s'%(target,)], |
| 495 | ) |
| 496 | dist = Distribution({ |
| 497 | 'name': 'deptarget', |
| 498 | 'ext_modules': [deptarget_ext] |
| 499 | }) |
| 500 | dist.package_dir = self.tmp_dir |
| 501 | cmd = build_ext(dist) |
| 502 | cmd.build_lib = self.tmp_dir |
| 503 | cmd.build_temp = self.tmp_dir |
| 504 | |
| 505 | try: |
| 506 | old_stdout = sys.stdout |
| 507 | if not support.verbose: |
| 508 | # silence compiler output |
| 509 | sys.stdout = StringIO() |
| 510 | try: |
| 511 | cmd.ensure_finalized() |
| 512 | cmd.run() |
| 513 | finally: |
| 514 | sys.stdout = old_stdout |
| 515 | |
| 516 | except CompileError: |
| 517 | self.fail("Wrong deployment target during compilation") |
| 518 | |
| 519 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 520 | def test_suite(): |
Neil Schemenauer | d8f63bb | 2009-02-06 21:42:05 +0000 | [diff] [blame] | 521 | src = _get_source_filename() |
| 522 | if not os.path.exists(src): |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 523 | if support.verbose: |
Neil Schemenauer | d8f63bb | 2009-02-06 21:42:05 +0000 | [diff] [blame] | 524 | print('test_build_ext: Cannot find source code (test' |
| 525 | ' must run in python build dir)') |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 526 | return unittest.TestSuite() |
| 527 | else: return unittest.makeSuite(BuildExtTestCase) |
| 528 | |
| 529 | if __name__ == '__main__': |
| 530 | support.run_unittest(test_suite()) |