Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 1 | """Support code for distutils test cases.""" |
Tarek Ziadé | c1375d5 | 2009-02-14 14:35:51 +0000 | [diff] [blame] | 2 | import os |
Éric Araujo | 6e3ad87 | 2011-08-21 17:02:07 +0200 | [diff] [blame] | 3 | import sys |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 4 | import shutil |
| 5 | import tempfile |
Éric Araujo | def15da | 2011-08-20 06:27:18 +0200 | [diff] [blame] | 6 | import unittest |
| 7 | import sysconfig |
Tarek Ziadé | 430fb63 | 2009-10-18 11:34:51 +0000 | [diff] [blame] | 8 | from copy import deepcopy |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 9 | |
Fred Drake | edcac8f | 2004-08-03 18:53:07 +0000 | [diff] [blame] | 10 | from distutils import log |
Tarek Ziadé | 31d4607 | 2009-09-21 13:55:19 +0000 | [diff] [blame] | 11 | from distutils.log import DEBUG, INFO, WARN, ERROR, FATAL |
Tarek Ziadé | baf5180 | 2009-03-31 21:37:16 +0000 | [diff] [blame] | 12 | from distutils.core import Distribution |
Fred Drake | edcac8f | 2004-08-03 18:53:07 +0000 | [diff] [blame] | 13 | |
Éric Araujo | def15da | 2011-08-20 06:27:18 +0200 | [diff] [blame] | 14 | |
Fred Drake | edcac8f | 2004-08-03 18:53:07 +0000 | [diff] [blame] | 15 | class LoggingSilencer(object): |
| 16 | |
| 17 | def setUp(self): |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 18 | super().setUp() |
Fred Drake | edcac8f | 2004-08-03 18:53:07 +0000 | [diff] [blame] | 19 | self.threshold = log.set_threshold(log.FATAL) |
Tarek Ziadé | 5af55c6 | 2009-05-16 16:52:13 +0000 | [diff] [blame] | 20 | # catching warnings |
| 21 | # when log will be replaced by logging |
| 22 | # we won't need such monkey-patch anymore |
| 23 | self._old_log = log.Log._log |
| 24 | log.Log._log = self._log |
| 25 | self.logs = [] |
Fred Drake | edcac8f | 2004-08-03 18:53:07 +0000 | [diff] [blame] | 26 | |
| 27 | def tearDown(self): |
| 28 | log.set_threshold(self.threshold) |
Tarek Ziadé | 5af55c6 | 2009-05-16 16:52:13 +0000 | [diff] [blame] | 29 | log.Log._log = self._old_log |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 30 | super().tearDown() |
Fred Drake | edcac8f | 2004-08-03 18:53:07 +0000 | [diff] [blame] | 31 | |
Tarek Ziadé | 5af55c6 | 2009-05-16 16:52:13 +0000 | [diff] [blame] | 32 | def _log(self, level, msg, args): |
Tarek Ziadé | 31d4607 | 2009-09-21 13:55:19 +0000 | [diff] [blame] | 33 | if level not in (DEBUG, INFO, WARN, ERROR, FATAL): |
| 34 | raise ValueError('%s wrong log level' % str(level)) |
Tarek Ziadé | 5af55c6 | 2009-05-16 16:52:13 +0000 | [diff] [blame] | 35 | self.logs.append((level, msg, args)) |
| 36 | |
| 37 | def get_logs(self, *levels): |
| 38 | def _format(msg, args): |
| 39 | if len(args) == 0: |
| 40 | return msg |
| 41 | return msg % args |
| 42 | return [_format(msg, args) for level, msg, args |
| 43 | in self.logs if level in levels] |
| 44 | |
| 45 | def clear_logs(self): |
| 46 | self.logs = [] |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 47 | |
Éric Araujo | def15da | 2011-08-20 06:27:18 +0200 | [diff] [blame] | 48 | |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 49 | class TempdirManager(object): |
| 50 | """Mix-in class that handles temporary directories for test cases. |
| 51 | |
| 52 | This is intended to be used with unittest.TestCase. |
| 53 | """ |
| 54 | |
| 55 | def setUp(self): |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 56 | super().setUp() |
Antoine Pitrou | 4fc80b6 | 2011-08-25 18:32:02 +0200 | [diff] [blame] | 57 | self.old_cwd = os.getcwd() |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 58 | self.tempdirs = [] |
| 59 | |
| 60 | def tearDown(self): |
Antoine Pitrou | 4fc80b6 | 2011-08-25 18:32:02 +0200 | [diff] [blame] | 61 | # Restore working dir, for Solaris and derivatives, where rmdir() |
| 62 | # on the current directory fails. |
| 63 | os.chdir(self.old_cwd) |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 64 | super().tearDown() |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 65 | while self.tempdirs: |
| 66 | d = self.tempdirs.pop() |
Tarek Ziadé | c1375d5 | 2009-02-14 14:35:51 +0000 | [diff] [blame] | 67 | shutil.rmtree(d, os.name in ('nt', 'cygwin')) |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 68 | |
| 69 | def mkdtemp(self): |
| 70 | """Create a temporary directory that will be cleaned up. |
| 71 | |
| 72 | Returns the path of the directory. |
| 73 | """ |
| 74 | d = tempfile.mkdtemp() |
| 75 | self.tempdirs.append(d) |
| 76 | return d |
| 77 | |
Tarek Ziadé | baf5180 | 2009-03-31 21:37:16 +0000 | [diff] [blame] | 78 | def write_file(self, path, content='xxx'): |
Tarek Ziadé | 0d0506e | 2009-02-16 21:49:12 +0000 | [diff] [blame] | 79 | """Writes a file in the given path. |
| 80 | |
| 81 | |
| 82 | path can be a string or a sequence. |
| 83 | """ |
| 84 | if isinstance(path, (list, tuple)): |
| 85 | path = os.path.join(*path) |
| 86 | f = open(path, 'w') |
| 87 | try: |
| 88 | f.write(content) |
| 89 | finally: |
| 90 | f.close() |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 91 | |
Tarek Ziadé | baf5180 | 2009-03-31 21:37:16 +0000 | [diff] [blame] | 92 | def create_dist(self, pkg_name='foo', **kw): |
| 93 | """Will generate a test environment. |
| 94 | |
| 95 | This function creates: |
| 96 | - a Distribution instance using keywords |
| 97 | - a temporary directory with a package structure |
| 98 | |
| 99 | It returns the package directory and the distribution |
| 100 | instance. |
| 101 | """ |
| 102 | tmp_dir = self.mkdtemp() |
| 103 | pkg_dir = os.path.join(tmp_dir, pkg_name) |
| 104 | os.mkdir(pkg_dir) |
| 105 | dist = Distribution(attrs=kw) |
| 106 | |
| 107 | return pkg_dir, dist |
| 108 | |
Éric Araujo | def15da | 2011-08-20 06:27:18 +0200 | [diff] [blame] | 109 | |
Fred Drake | b8ab8b6 | 2004-06-17 20:14:50 +0000 | [diff] [blame] | 110 | class DummyCommand: |
| 111 | """Class to store options for retrieval via set_undefined_options().""" |
| 112 | |
| 113 | def __init__(self, **kwargs): |
| 114 | for kw, val in kwargs.items(): |
| 115 | setattr(self, kw, val) |
| 116 | |
| 117 | def ensure_finalized(self): |
| 118 | pass |
Tarek Ziadé | 29bbb96 | 2009-05-10 12:02:35 +0000 | [diff] [blame] | 119 | |
Éric Araujo | def15da | 2011-08-20 06:27:18 +0200 | [diff] [blame] | 120 | |
Tarek Ziadé | 29bbb96 | 2009-05-10 12:02:35 +0000 | [diff] [blame] | 121 | class EnvironGuard(object): |
| 122 | |
| 123 | def setUp(self): |
| 124 | super(EnvironGuard, self).setUp() |
Tarek Ziadé | 430fb63 | 2009-10-18 11:34:51 +0000 | [diff] [blame] | 125 | self.old_environ = deepcopy(os.environ) |
Tarek Ziadé | 29bbb96 | 2009-05-10 12:02:35 +0000 | [diff] [blame] | 126 | |
| 127 | def tearDown(self): |
Tarek Ziadé | 430fb63 | 2009-10-18 11:34:51 +0000 | [diff] [blame] | 128 | for key, value in self.old_environ.items(): |
| 129 | if os.environ.get(key) != value: |
| 130 | os.environ[key] = value |
| 131 | |
| 132 | for key in tuple(os.environ.keys()): |
| 133 | if key not in self.old_environ: |
| 134 | del os.environ[key] |
| 135 | |
Tarek Ziadé | 29bbb96 | 2009-05-10 12:02:35 +0000 | [diff] [blame] | 136 | super(EnvironGuard, self).tearDown() |
Éric Araujo | def15da | 2011-08-20 06:27:18 +0200 | [diff] [blame] | 137 | |
| 138 | |
| 139 | def copy_xxmodule_c(directory): |
| 140 | """Helper for tests that need the xxmodule.c source file. |
| 141 | |
| 142 | Example use: |
| 143 | |
Éric Araujo | e1e1331 | 2011-08-20 07:25:39 +0200 | [diff] [blame] | 144 | def test_compile(self): |
| 145 | copy_xxmodule_c(self.tmpdir) |
Éric Araujo | 52b201f | 2011-08-21 12:53:37 +0200 | [diff] [blame] | 146 | self.assertIn('xxmodule.c', os.listdir(self.tmpdir)) |
Éric Araujo | def15da | 2011-08-20 06:27:18 +0200 | [diff] [blame] | 147 | |
| 148 | If the source file can be found, it will be copied to *directory*. If not, |
| 149 | the test will be skipped. Errors during copy are not caught. |
| 150 | """ |
| 151 | filename = _get_xxmodule_path() |
| 152 | if filename is None: |
| 153 | raise unittest.SkipTest('cannot find xxmodule.c (test must run in ' |
| 154 | 'the python build dir)') |
| 155 | shutil.copy(filename, directory) |
| 156 | |
| 157 | |
| 158 | def _get_xxmodule_path(): |
| 159 | srcdir = sysconfig.get_config_var('srcdir') |
| 160 | candidates = [ |
| 161 | # use installed copy if available |
| 162 | os.path.join(os.path.dirname(__file__), 'xxmodule.c'), |
| 163 | # otherwise try using copy from build directory |
| 164 | os.path.join(srcdir, 'Modules', 'xxmodule.c'), |
| 165 | # srcdir mysteriously can be $srcdir/Lib/distutils/tests when |
| 166 | # this file is run from its parent directory, so walk up the |
| 167 | # tree to find the real srcdir |
| 168 | os.path.join(srcdir, '..', '..', '..', 'Modules', 'xxmodule.c'), |
| 169 | ] |
| 170 | for path in candidates: |
| 171 | if os.path.exists(path): |
| 172 | return path |
Éric Araujo | 6e3ad87 | 2011-08-21 17:02:07 +0200 | [diff] [blame] | 173 | |
| 174 | |
| 175 | def fixup_build_ext(cmd): |
Éric Araujo | 175eb99 | 2011-08-24 01:29:10 +0200 | [diff] [blame] | 176 | """Function needed to make build_ext tests pass. |
Éric Araujo | 6e3ad87 | 2011-08-21 17:02:07 +0200 | [diff] [blame] | 177 | |
Éric Araujo | 024de54 | 2011-09-01 23:37:56 +0200 | [diff] [blame] | 178 | When Python was built with --enable-shared on Unix, -L. is not enough to |
| 179 | find libpython<blah>.so, because regrtest runs in a tempdir, not in the |
| 180 | source directory where the .so lives. |
Éric Araujo | 175eb99 | 2011-08-24 01:29:10 +0200 | [diff] [blame] | 181 | |
| 182 | When Python was built with in debug mode on Windows, build_ext commands |
| 183 | need their debug attribute set, and it is not done automatically for |
| 184 | some reason. |
| 185 | |
| 186 | This function handles both of these things. Example use: |
Éric Araujo | 6e3ad87 | 2011-08-21 17:02:07 +0200 | [diff] [blame] | 187 | |
| 188 | cmd = build_ext(dist) |
| 189 | support.fixup_build_ext(cmd) |
| 190 | cmd.ensure_finalized() |
Ned Deily | cf550dc | 2012-02-03 02:42:16 +0100 | [diff] [blame] | 191 | |
| 192 | Unlike most other Unix platforms, Mac OS X embeds absolute paths |
| 193 | to shared libraries into executables, so the fixup is not needed there. |
Éric Araujo | 6e3ad87 | 2011-08-21 17:02:07 +0200 | [diff] [blame] | 194 | """ |
Éric Araujo | 175eb99 | 2011-08-24 01:29:10 +0200 | [diff] [blame] | 195 | if os.name == 'nt': |
| 196 | cmd.debug = sys.executable.endswith('_d.exe') |
| 197 | elif sysconfig.get_config_var('Py_ENABLE_SHARED'): |
| 198 | # To further add to the shared builds fun on Unix, we can't just add |
| 199 | # library_dirs to the Extension() instance because that doesn't get |
| 200 | # plumbed through to the final compiler command. |
Éric Araujo | 6e3ad87 | 2011-08-21 17:02:07 +0200 | [diff] [blame] | 201 | runshared = sysconfig.get_config_var('RUNSHARED') |
| 202 | if runshared is None: |
| 203 | cmd.library_dirs = ['.'] |
| 204 | else: |
Ned Deily | cf550dc | 2012-02-03 02:42:16 +0100 | [diff] [blame] | 205 | if sys.platform == 'darwin': |
| 206 | cmd.library_dirs = [] |
| 207 | else: |
| 208 | name, equals, value = runshared.partition('=') |
| 209 | cmd.library_dirs = value.split(os.pathsep) |